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-14 14:07+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:1660
872 #: ../src/guestfs-actions.pod:1664 ../src/guestfs-actions.pod:1668
873 #: ../src/guestfs-actions.pod:1672 ../src/guestfs-actions.pod:1680
874 #: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1688
875 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1702
876 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1844
877 #: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1853
878 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1919
879 #: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1928
880 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2852
881 #: ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2867
882 #: ../src/guestfs-actions.pod:2874 ../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:1099
888 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
889 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119
890 #: ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127
891 #: ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141
892 #: ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235
893 #: ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244
894 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291
895 #: ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300
896 #: ../fish/guestfish-actions.pod:1927 ../fish/guestfish-actions.pod:1933
897 #: ../fish/guestfish-actions.pod:1941 ../fish/guestfish-actions.pod:1948
898 #: ../fish/guestfish-actions.pod:1955 ../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:1915 ../src/guestfs-actions.pod:2842
3314 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
3315 #: ../fish/guestfish-actions.pod:1923 ../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:6163
5141 #: ../fish/guestfish-actions.pod:4066
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:858 ../src/guestfs-actions.pod:1039
5948 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1077
5949 #: ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1179
5950 #: ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1212
5951 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1302
5952 #: ../src/guestfs-actions.pod:1333 ../src/guestfs-actions.pod:1358
5953 #: ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:1506
5954 #: ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1755
5955 #: ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1864
5956 #: ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:2472
5957 #: ../src/guestfs-actions.pod:2533 ../src/guestfs-actions.pod:2568
5958 #: ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:3623
5959 #: ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3837
5960 #: ../src/guestfs-actions.pod:3851 ../src/guestfs-actions.pod:3864
5961 #: ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3893
5962 #: ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:4001
5963 #: ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4038
5964 #: ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:4084
5965 #: ../src/guestfs-actions.pod:4119 ../src/guestfs-actions.pod:4138
5966 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4192
5967 #: ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4240
5968 #: ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4269
5969 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4301
5970 #: ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4414
5971 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4478
5972 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4514
5973 #: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4544
5974 #: ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4575
5975 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4610
5976 #: ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4753
5977 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4803
5978 #: ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:4834
5979 #: ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:4864
5980 #: ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:4894
5981 #: ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4962
5982 #: ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5021
5983 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:5052
5984 #: ../src/guestfs-actions.pod:5101 ../src/guestfs-actions.pod:5147
5985 #: ../src/guestfs-actions.pod:5201 ../src/guestfs-actions.pod:5237
5986 #: ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5289
5987 #: ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5441
5988 #: ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5520
5989 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5570
5990 #: ../src/guestfs-actions.pod:5636 ../src/guestfs-actions.pod:5653
5991 #: ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5680
5992 #: ../src/guestfs-actions.pod:5969 ../src/guestfs-actions.pod:5988
5993 #: ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6021
5994 #: ../src/guestfs-actions.pod:6033 ../src/guestfs-actions.pod:6047
5995 #: ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073
5996 #: ../src/guestfs-actions.pod:6089 ../src/guestfs-actions.pod:6110
5997 #: ../src/guestfs-actions.pod:6129 ../src/guestfs-actions.pod:6148
5998 #: ../src/guestfs-actions.pod:6178 ../src/guestfs-actions.pod:6196
5999 #: ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6237
6000 #: ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6277
6001 #: ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6313
6002 #: ../src/guestfs-actions.pod:6341 ../src/guestfs-actions.pod:6365
6003 #: ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6408
6004 #: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6442
6005 #: ../src/guestfs-actions.pod:6461 ../src/guestfs-actions.pod:6498
6006 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6561
6007 #: ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6804
6008 #: ../src/guestfs-actions.pod:6816 ../src/guestfs-actions.pod:6829
6009 #: ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6864
6010 #: ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6890
6011 #: ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6918
6012 #: ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:6994
6013 #: ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7026
6014 #: ../src/guestfs-actions.pod:7043 ../src/guestfs-actions.pod:7056
6015 #: ../src/guestfs-actions.pod:7076 ../src/guestfs-actions.pod:7112
6016 #: ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:7167
6017 #: ../src/guestfs-actions.pod:7180 ../src/guestfs-actions.pod:7198
6018 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7268
6019 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7399
6020 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7468
6021 #: ../src/guestfs-actions.pod:7481 ../src/guestfs-actions.pod:7526
6022 #: ../src/guestfs-actions.pod:7559 ../src/guestfs-actions.pod:7620
6023 #: ../src/guestfs-actions.pod:7646 ../src/guestfs-actions.pod:7713
6024 #: ../src/guestfs-actions.pod:7732 ../src/guestfs-actions.pod:7761
6025 msgid "This function returns 0 on success or -1 on error."
6029 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6030 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6031 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6033 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6038 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6039 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1511
6040 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2027
6041 #: ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:4934
6042 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5242
6043 #: ../src/guestfs-actions.pod:6506 ../src/guestfs-actions.pod:6536
6044 #: ../src/guestfs-actions.pod:6569 ../src/guestfs-actions.pod:6628
6045 #: ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7654
6046 #: ../src/guestfs-actions.pod:7824 ../fish/guestfish-actions.pod:31
6047 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6048 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346
6049 #: ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3079
6050 #: ../fish/guestfish-actions.pod:3286 ../fish/guestfish-actions.pod:3400
6051 #: ../fish/guestfish-actions.pod:3448 ../fish/guestfish-actions.pod:4328
6052 #: ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4373
6053 #: ../fish/guestfish-actions.pod:4411 ../fish/guestfish-actions.pod:5046
6054 #: ../fish/guestfish-actions.pod:5144
6056 "Deprecated functions will not be removed from the API, but the fact that "
6057 "they are deprecated indicates that there are problems with correct use of "
6062 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6063 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1978
6064 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2179
6065 #: ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3630
6066 #: ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:6198
6067 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6429
6068 #: ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:7045
6069 #: ../src/guestfs-actions.pod:7568
6070 msgid "(Added in 0.3)"
6074 #: ../src/guestfs-actions.pod:41
6075 msgid "guestfs_add_domain"
6079 #: ../src/guestfs-actions.pod:43
6083 " guestfs_add_domain (guestfs_h *g,\n"
6084 " const char *dom,\n"
6090 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6091 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2813
6092 #: ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4948
6093 #: ../src/guestfs-actions.pod:5165
6095 "You may supply a list of optional arguments to this call. Use zero or more "
6096 "of the following pairs of parameters, and terminate the list with C<-1> on "
6097 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6101 #: ../src/guestfs-actions.pod:53
6104 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6105 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6106 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6107 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6108 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6113 #: ../src/guestfs-actions.pod:59
6115 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6116 "It works by connecting to libvirt, requesting the domain and domain XML from "
6117 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6122 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6124 "The number of disks added is returned. This operation is atomic: if an "
6125 "error is returned, then no disks are added."
6129 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6131 "This function does some minimal checks to make sure the libvirt domain is "
6132 "not running (unless C<readonly> is true). In a future version we will try "
6133 "to acquire the libvirt lock on each disk."
6137 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6139 "Disks must be accessible locally. This often means that adding disks from a "
6140 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6141 "unless those disks are accessible via the same device path locally too."
6145 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6147 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6148 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6149 "libvirt URI (or one set through an environment variable, see the libvirt "
6150 "documentation for full details)."
6154 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6156 "The optional C<live> flag controls whether this call will try to connect to "
6157 "a running virtual machine C<guestfsd> process if it sees a suitable "
6158 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6159 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6160 "DAEMONS> for more information."
6164 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6166 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6167 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6168 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6173 #: ../src/guestfs-actions.pod:94
6175 "The other optional parameters are passed directly through to "
6176 "C<guestfs_add_drive_opts>."
6180 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6181 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6182 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6183 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1378
6184 #: ../src/guestfs-actions.pod:1734 ../src/guestfs-actions.pod:1937
6185 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2088
6186 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:2166
6187 #: ../src/guestfs-actions.pod:2459 ../src/guestfs-actions.pod:2931
6188 #: ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:5124
6189 #: ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5750
6190 #: ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:7153
6191 #: ../src/guestfs-actions.pod:7579 ../src/guestfs-actions.pod:7592
6192 #: ../src/guestfs-actions.pod:7605
6193 msgid "On error this function returns -1."
6197 #: ../src/guestfs-actions.pod:99
6198 msgid "(Added in 1.7.4)"
6202 #: ../src/guestfs-actions.pod:101
6203 msgid "guestfs_add_domain_va"
6207 #: ../src/guestfs-actions.pod:103
6211 " guestfs_add_domain_va (guestfs_h *g,\n"
6212 " const char *dom,\n"
6218 #: ../src/guestfs-actions.pod:108
6219 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6223 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6224 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6225 #: ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:880
6226 #: ../src/guestfs-actions.pod:2897 ../src/guestfs-actions.pod:2909
6227 #: ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4706
6228 #: ../src/guestfs-actions.pod:4976 ../src/guestfs-actions.pod:4988
6229 #: ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5225
6230 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6234 #: ../src/guestfs-actions.pod:112
6235 msgid "guestfs_add_domain_argv"
6239 #: ../src/guestfs-actions.pod:114
6243 " guestfs_add_domain_argv (guestfs_h *g,\n"
6244 " const char *dom,\n"
6245 " const struct guestfs_add_domain_argv *optargs);\n"
6250 #: ../src/guestfs-actions.pod:119
6251 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6255 #: ../src/guestfs-actions.pod:123
6256 msgid "guestfs_add_drive"
6260 #: ../src/guestfs-actions.pod:125
6264 " guestfs_add_drive (guestfs_h *g,\n"
6265 " const char *filename);\n"
6270 #: ../src/guestfs-actions.pod:129
6272 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6273 "optional parameters, so the disk is added writable, with the format being "
6274 "detected automatically."
6278 #: ../src/guestfs-actions.pod:133
6280 "Automatic detection of the format opens you up to a potential security hole "
6281 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6282 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6283 "you should think about replacing calls to this function with calls to "
6284 "C<guestfs_add_drive_opts>, and specifying the format."
6288 #: ../src/guestfs-actions.pod:144
6289 msgid "guestfs_add_drive_opts"
6293 #: ../src/guestfs-actions.pod:146
6297 " guestfs_add_drive_opts (guestfs_h *g,\n"
6298 " const char *filename,\n"
6304 #: ../src/guestfs-actions.pod:156
6307 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6308 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6309 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6314 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6316 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6317 "The first time you call this function, the disk appears as C</dev/sda>, the "
6318 "second time as C</dev/sdb>, and so on."
6322 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6324 "You don't necessarily need to be root when using libguestfs. However you "
6325 "obviously do need sufficient permissions to access the filename for whatever "
6326 "operations you want to perform (ie. read access if you just want to read the "
6327 "image or write access if you want to modify the image)."
6331 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6332 msgid "This call checks that C<filename> exists."
6336 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4642
6337 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3090
6338 msgid "The optional arguments are:"
6342 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6344 msgstr "C<readonly>"
6347 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6349 "If true then the image is treated as read-only. Writes are still allowed, "
6350 "but they are stored in a temporary snapshot overlay which is discarded at "
6351 "the end. The disk that you add is not modified."
6355 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6360 #: ../src/guestfs-actions.pod:185
6362 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6363 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6364 "Possible formats include C<raw> and C<qcow2>."
6368 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6370 "Automatic detection of the format opens you up to a potential security hole "
6371 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6372 "RHBZ#642934. Specifying the format closes this security hole."
6376 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6381 #: ../src/guestfs-actions.pod:196
6383 "This rarely-used option lets you emulate the behaviour of the deprecated "
6384 "C<guestfs_add_drive_with_if> call (q.v.)"
6388 #: ../src/guestfs-actions.pod:203
6389 msgid "(Added in 1.5.23)"
6393 #: ../src/guestfs-actions.pod:205
6394 msgid "guestfs_add_drive_opts_va"
6398 #: ../src/guestfs-actions.pod:207
6402 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6403 " const char *filename,\n"
6409 #: ../src/guestfs-actions.pod:212
6410 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6414 #: ../src/guestfs-actions.pod:216
6415 msgid "guestfs_add_drive_opts_argv"
6419 #: ../src/guestfs-actions.pod:218
6423 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6424 " const char *filename,\n"
6425 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6430 #: ../src/guestfs-actions.pod:223
6431 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6435 #: ../src/guestfs-actions.pod:227
6436 msgid "guestfs_add_drive_ro"
6440 #: ../src/guestfs-actions.pod:229
6444 " guestfs_add_drive_ro (guestfs_h *g,\n"
6445 " const char *filename);\n"
6450 #: ../src/guestfs-actions.pod:233
6452 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6453 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6454 "disk is added read-only, with the format being detected automatically."
6458 #: ../src/guestfs-actions.pod:240
6459 msgid "(Added in 1.0.38)"
6463 #: ../src/guestfs-actions.pod:242
6464 msgid "guestfs_add_drive_ro_with_if"
6468 #: ../src/guestfs-actions.pod:244
6472 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6473 " const char *filename,\n"
6474 " const char *iface);\n"
6479 #: ../src/guestfs-actions.pod:249
6481 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6482 "QEMU interface emulation to use at run time."
6486 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6487 #: ../src/guestfs-actions.pod:2418
6488 msgid "(Added in 1.0.84)"
6492 #: ../src/guestfs-actions.pod:263
6493 msgid "guestfs_add_drive_with_if"
6497 #: ../src/guestfs-actions.pod:265
6501 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6502 " const char *filename,\n"
6503 " const char *iface);\n"
6508 #: ../src/guestfs-actions.pod:270
6510 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6511 "QEMU interface emulation to use at run time."
6515 #: ../src/guestfs-actions.pod:284
6516 msgid "guestfs_aug_clear"
6520 #: ../src/guestfs-actions.pod:286
6524 " guestfs_aug_clear (guestfs_h *g,\n"
6525 " const char *augpath);\n"
6530 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6532 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6533 "L<augtool(1)> C<clear> command."
6537 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2168
6538 msgid "(Added in 1.3.4)"
6542 #: ../src/guestfs-actions.pod:297
6543 msgid "guestfs_aug_close"
6547 #: ../src/guestfs-actions.pod:299
6551 " guestfs_aug_close (guestfs_h *g);\n"
6556 #: ../src/guestfs-actions.pod:302
6558 "Close the current Augeas handle and free up any resources used by it. After "
6559 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6560 "any other Augeas functions."
6564 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6565 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6566 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6567 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6568 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6569 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6570 #: ../src/guestfs-actions.pod:5827
6571 msgid "(Added in 0.7)"
6575 #: ../src/guestfs-actions.pod:311
6576 msgid "guestfs_aug_defnode"
6580 #: ../src/guestfs-actions.pod:313
6583 " struct guestfs_int_bool *\n"
6584 " guestfs_aug_defnode (guestfs_h *g,\n"
6585 " const char *name,\n"
6586 " const char *expr,\n"
6587 " const char *val);\n"
6592 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6594 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6598 #: ../src/guestfs-actions.pod:322
6600 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6601 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6602 "containing that single node."
6606 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6608 "On success this returns a pair containing the number of nodes in the "
6609 "nodeset, and a boolean flag if a node was created."
6613 #: ../src/guestfs-actions.pod:330
6615 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6616 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6620 #: ../src/guestfs-actions.pod:336
6621 msgid "guestfs_aug_defvar"
6625 #: ../src/guestfs-actions.pod:338
6629 " guestfs_aug_defvar (guestfs_h *g,\n"
6630 " const char *name,\n"
6631 " const char *expr);\n"
6636 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6638 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6639 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6643 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6645 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6646 "evaluates to something which is not a nodeset."
6650 #: ../src/guestfs-actions.pod:354
6651 msgid "guestfs_aug_get"
6655 #: ../src/guestfs-actions.pod:356
6659 " guestfs_aug_get (guestfs_h *g,\n"
6660 " const char *augpath);\n"
6665 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6667 "Look up the value associated with C<path>. If C<path> matches exactly one "
6668 "node, the C<value> is returned."
6672 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:920
6673 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:998
6674 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1117
6675 #: ../src/guestfs-actions.pod:1247 ../src/guestfs-actions.pod:1264
6676 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:1417
6677 #: ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1717
6678 #: ../src/guestfs-actions.pod:1880 ../src/guestfs-actions.pod:1897
6679 #: ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2000
6680 #: ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2191
6681 #: ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2587
6682 #: ../src/guestfs-actions.pod:2677 ../src/guestfs-actions.pod:2781
6683 #: ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:3014
6684 #: ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063
6685 #: ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3156
6686 #: ../src/guestfs-actions.pod:3176 ../src/guestfs-actions.pod:3196
6687 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:4176
6688 #: ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4456
6689 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5555
6690 #: ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:5903
6691 #: ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6589
6692 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6622
6693 #: ../src/guestfs-actions.pod:6653 ../src/guestfs-actions.pod:7327
6694 #: ../src/guestfs-actions.pod:7346 ../src/guestfs-actions.pod:7364
6695 #: ../src/guestfs-actions.pod:7538 ../src/guestfs-actions.pod:7818
6697 "This function returns a string, or NULL on error. I<The caller must free "
6698 "the returned string after use>."
6702 #: ../src/guestfs-actions.pod:368
6703 msgid "guestfs_aug_init"
6707 #: ../src/guestfs-actions.pod:370
6711 " guestfs_aug_init (guestfs_h *g,\n"
6712 " const char *root,\n"
6718 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6720 "Create a new Augeas handle for editing configuration files. If there was "
6721 "any previous Augeas handle associated with this guestfs session, then it is "
6726 #: ../src/guestfs-actions.pod:379
6727 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6731 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6733 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6737 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6739 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6740 "logical I<or> of the following integers:"
6744 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6745 msgid "C<AUG_SAVE_BACKUP> = 1"
6746 msgstr "C<AUG_SAVE_BACKUP> = 1"
6749 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6750 msgid "Keep the original file with a C<.augsave> extension."
6754 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6755 msgid "C<AUG_SAVE_NEWFILE> = 2"
6756 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6759 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6761 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6762 "original. Overrides C<AUG_SAVE_BACKUP>."
6766 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6767 msgid "C<AUG_TYPE_CHECK> = 4"
6768 msgstr "C<AUG_TYPE_CHECK> = 4"
6771 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6772 msgid "Typecheck lenses (can be expensive)."
6776 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6777 msgid "C<AUG_NO_STDINC> = 8"
6778 msgstr "C<AUG_NO_STDINC> = 8"
6781 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6782 msgid "Do not use standard load path for modules."
6786 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6787 msgid "C<AUG_SAVE_NOOP> = 16"
6788 msgstr "C<AUG_SAVE_NOOP> = 16"
6791 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6792 msgid "Make save a no-op, just record what would have been changed."
6796 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6797 msgid "C<AUG_NO_LOAD> = 32"
6798 msgstr "C<AUG_NO_LOAD> = 32"
6801 #: ../src/guestfs-actions.pod:414
6802 msgid "Do not load the tree in C<guestfs_aug_init>."
6806 #: ../src/guestfs-actions.pod:418
6807 msgid "To close the handle, you can call C<guestfs_aug_close>."
6811 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6812 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6816 #: ../src/guestfs-actions.pod:426
6817 msgid "guestfs_aug_insert"
6821 #: ../src/guestfs-actions.pod:428
6825 " guestfs_aug_insert (guestfs_h *g,\n"
6826 " const char *augpath,\n"
6827 " const char *label,\n"
6833 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6835 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6836 "or after C<path> (depending on the boolean flag C<before>)."
6840 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6842 "C<path> must match exactly one existing node in the tree, and C<label> must "
6843 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6847 #: ../src/guestfs-actions.pod:446
6848 msgid "guestfs_aug_load"
6852 #: ../src/guestfs-actions.pod:448
6856 " guestfs_aug_load (guestfs_h *g);\n"
6861 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6862 msgid "Load files into the tree."
6863 msgstr "Завантажити файли до ієрархії."
6866 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6867 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6871 #: ../src/guestfs-actions.pod:460
6872 msgid "guestfs_aug_ls"
6876 #: ../src/guestfs-actions.pod:462
6880 " guestfs_aug_ls (guestfs_h *g,\n"
6881 " const char *augpath);\n"
6886 #: ../src/guestfs-actions.pod:466
6888 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6889 "sorting the resulting nodes into alphabetical order."
6893 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6894 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1136
6895 #: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1451
6896 #: ../src/guestfs-actions.pod:1554 ../src/guestfs-actions.pod:1573
6897 #: ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:2263
6898 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2298
6899 #: ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2365
6900 #: ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2485
6901 #: ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:3116
6902 #: ../src/guestfs-actions.pod:3392 ../src/guestfs-actions.pod:3706
6903 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3743
6904 #: ../src/guestfs-actions.pod:3805 ../src/guestfs-actions.pod:3910
6905 #: ../src/guestfs-actions.pod:4318 ../src/guestfs-actions.pod:5085
6906 #: ../src/guestfs-actions.pod:5697 ../src/guestfs-actions.pod:5823
6907 #: ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:6669
6908 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6785
6909 #: ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6955
6910 #: ../src/guestfs-actions.pod:7431 ../src/guestfs-actions.pod:7451
6911 #: ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7670
6912 #: ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7775
6913 #: ../src/guestfs-actions.pod:7794 ../src/guestfs-actions.pod:7840
6914 #: ../src/guestfs-actions.pod:7859
6916 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6917 ">), or NULL if there was an error. I<The caller must free the strings and "
6918 "the array after use>."
6922 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1061
6923 #: ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1489
6924 #: ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3501
6925 #: ../src/guestfs-actions.pod:4159 ../src/guestfs-actions.pod:4209
6926 #: ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4429
6927 #: ../src/guestfs-actions.pod:4592 ../src/guestfs-actions.pod:5089
6928 #: ../src/guestfs-actions.pod:5638 ../src/guestfs-actions.pod:6035
6929 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6061
6930 #: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:7169
6931 #: ../src/guestfs-actions.pod:7182 ../src/guestfs-actions.pod:7415
6932 #: ../src/guestfs-actions.pod:7658
6933 msgid "(Added in 0.8)"
6937 #: ../src/guestfs-actions.pod:475
6938 msgid "guestfs_aug_match"
6942 #: ../src/guestfs-actions.pod:477
6946 " guestfs_aug_match (guestfs_h *g,\n"
6947 " const char *augpath);\n"
6952 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6954 "Returns a list of paths which match the path expression C<path>. The "
6955 "returned paths are sufficiently qualified so that they match exactly one "
6956 "node in the current tree."
6960 #: ../src/guestfs-actions.pod:491
6961 msgid "guestfs_aug_mv"
6965 #: ../src/guestfs-actions.pod:493
6969 " guestfs_aug_mv (guestfs_h *g,\n"
6970 " const char *src,\n"
6971 " const char *dest);\n"
6976 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6978 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6979 "C<dest> is overwritten if it exists."
6983 #: ../src/guestfs-actions.pod:505
6984 msgid "guestfs_aug_rm"
6988 #: ../src/guestfs-actions.pod:507
6992 " guestfs_aug_rm (guestfs_h *g,\n"
6993 " const char *augpath);\n"
6998 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6999 msgid "Remove C<path> and all of its children."
7003 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7004 msgid "On success this returns the number of entries which were removed."
7008 #: ../src/guestfs-actions.pod:519
7009 msgid "guestfs_aug_save"
7013 #: ../src/guestfs-actions.pod:521
7017 " guestfs_aug_save (guestfs_h *g);\n"
7022 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7023 msgid "This writes all pending changes to disk."
7027 #: ../src/guestfs-actions.pod:526
7029 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7034 #: ../src/guestfs-actions.pod:533
7035 msgid "guestfs_aug_set"
7039 #: ../src/guestfs-actions.pod:535
7043 " guestfs_aug_set (guestfs_h *g,\n"
7044 " const char *augpath,\n"
7045 " const char *val);\n"
7050 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7051 msgid "Set the value associated with C<path> to C<val>."
7055 #: ../src/guestfs-actions.pod:542
7057 "In the Augeas API, it is possible to clear a node by setting the value to "
7058 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7059 "this call. Instead you must use the C<guestfs_aug_clear> call."
7063 #: ../src/guestfs-actions.pod:551
7064 msgid "guestfs_available"
7068 #: ../src/guestfs-actions.pod:553
7072 " guestfs_available (guestfs_h *g,\n"
7073 " char *const *groups);\n"
7078 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7080 "This command is used to check the availability of some groups of "
7081 "functionality in the appliance, which not all builds of the libguestfs "
7082 "appliance will be able to provide."
7086 #: ../src/guestfs-actions.pod:561
7088 "The libguestfs groups, and the functions that those groups correspond to, "
7089 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7090 "runtime by calling C<guestfs_available_all_groups>."
7094 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7096 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7097 "\"]> would check for the availability of the Linux inotify functions and "
7098 "Augeas (configuration file editing) functions."
7102 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7103 msgid "The command returns no error if I<all> requested groups are available."
7107 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7109 "It fails with an error if one or more of the requested groups is unavailable "
7114 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7116 "If an unknown group name is included in the list of groups then an error is "
7121 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7123 msgstr "I<Нотатки:>"
7126 #: ../src/guestfs-actions.pod:585
7127 msgid "You must call C<guestfs_launch> before calling this function."
7131 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7133 "The reason is because we don't know what groups are supported by the "
7134 "appliance/daemon until it is running and can be queried."
7138 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7140 "If a group of functions is available, this does not necessarily mean that "
7141 "they will work. You still have to check for errors when calling individual "
7142 "API functions even if they are available."
7146 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7148 "It is usually the job of distro packagers to build complete functionality "
7149 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7150 "with all requirements satisfied, will support everything."
7154 #: ../src/guestfs-actions.pod:607
7156 "This call was added in version C<1.0.80>. In previous versions of "
7157 "libguestfs all you could do would be to speculatively execute a command to "
7158 "find out if the daemon implemented it. See also C<guestfs_version>."
7162 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1234
7163 msgid "(Added in 1.0.80)"
7167 #: ../src/guestfs-actions.pod:618
7168 msgid "guestfs_available_all_groups"
7172 #: ../src/guestfs-actions.pod:620
7176 " guestfs_available_all_groups (guestfs_h *g);\n"
7181 #: ../src/guestfs-actions.pod:623
7183 "This command returns a list of all optional groups that this daemon knows "
7184 "about. Note this returns both supported and unsupported groups. To find "
7185 "out which ones the daemon can actually support you have to call "
7186 "C<guestfs_available> on each member of the returned list."
7190 #: ../src/guestfs-actions.pod:629
7191 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7195 #: ../src/guestfs-actions.pod:635
7196 msgid "(Added in 1.3.15)"
7200 #: ../src/guestfs-actions.pod:637
7201 msgid "guestfs_base64_in"
7205 #: ../src/guestfs-actions.pod:639
7209 " guestfs_base64_in (guestfs_h *g,\n"
7210 " const char *base64file,\n"
7211 " const char *filename);\n"
7216 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7218 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7222 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7223 msgid "(Added in 1.3.5)"
7227 #: ../src/guestfs-actions.pod:651
7228 msgid "guestfs_base64_out"
7232 #: ../src/guestfs-actions.pod:653
7236 " guestfs_base64_out (guestfs_h *g,\n"
7237 " const char *filename,\n"
7238 " const char *base64file);\n"
7243 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7245 "This command downloads the contents of C<filename>, writing it out to local "
7246 "file C<base64file> encoded as base64."
7250 #: ../src/guestfs-actions.pod:665
7251 msgid "guestfs_blockdev_flushbufs"
7255 #: ../src/guestfs-actions.pod:667
7259 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7260 " const char *device);\n"
7265 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7267 "This tells the kernel to flush internal buffers associated with C<device>."
7271 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7272 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7273 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7274 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7275 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7276 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7277 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7278 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7279 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7280 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7281 msgid "This uses the L<blockdev(8)> command."
7285 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7286 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7287 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7288 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7289 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7290 msgid "(Added in 0.9.3)"
7294 #: ../src/guestfs-actions.pod:680
7295 msgid "guestfs_blockdev_getbsz"
7299 #: ../src/guestfs-actions.pod:682
7303 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7304 " const char *device);\n"
7309 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7310 msgid "This returns the block size of a device."
7314 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7315 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7317 "(Note this is different from both I<size in blocks> and I<filesystem block "
7322 #: ../src/guestfs-actions.pod:697
7323 msgid "guestfs_blockdev_getro"
7327 #: ../src/guestfs-actions.pod:699
7331 " guestfs_blockdev_getro (guestfs_h *g,\n"
7332 " const char *device);\n"
7337 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7339 "Returns a boolean indicating if the block device is read-only (true if read-"
7340 "only, false if not)."
7344 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1472
7345 #: ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1976
7346 #: ../src/guestfs-actions.pod:1987 ../src/guestfs-actions.pod:2059
7347 #: ../src/guestfs-actions.pod:2114 ../src/guestfs-actions.pod:2129
7348 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177
7349 #: ../src/guestfs-actions.pod:3213 ../src/guestfs-actions.pod:3229
7350 #: ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3409
7351 #: ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3438
7352 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3468
7353 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3499
7354 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526
7355 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3555
7356 #: ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3583
7357 #: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:5326
7358 msgid "This function returns a C truth value on success or -1 on error."
7362 #: ../src/guestfs-actions.pod:712
7363 msgid "guestfs_blockdev_getsize64"
7367 #: ../src/guestfs-actions.pod:714
7371 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7372 " const char *device);\n"
7377 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7378 msgid "This returns the size of the device in bytes."
7382 #: ../src/guestfs-actions.pod:720
7383 msgid "See also C<guestfs_blockdev_getsz>."
7387 #: ../src/guestfs-actions.pod:728
7388 msgid "guestfs_blockdev_getss"
7392 #: ../src/guestfs-actions.pod:730
7396 " guestfs_blockdev_getss (guestfs_h *g,\n"
7397 " const char *device);\n"
7402 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7404 "This returns the size of sectors on a block device. Usually 512, but can be "
7405 "larger for modern devices."
7409 #: ../src/guestfs-actions.pod:737
7411 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7416 #: ../src/guestfs-actions.pod:746
7417 msgid "guestfs_blockdev_getsz"
7421 #: ../src/guestfs-actions.pod:748
7425 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7426 " const char *device);\n"
7431 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7433 "This returns the size of the device in units of 512-byte sectors (even if "
7434 "the sectorsize isn't 512 bytes ... weird)."
7438 #: ../src/guestfs-actions.pod:755
7440 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7441 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7445 #: ../src/guestfs-actions.pod:765
7446 msgid "guestfs_blockdev_rereadpt"
7450 #: ../src/guestfs-actions.pod:767
7454 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7455 " const char *device);\n"
7460 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7461 msgid "Reread the partition table on C<device>."
7465 #: ../src/guestfs-actions.pod:779
7466 msgid "guestfs_blockdev_setbsz"
7470 #: ../src/guestfs-actions.pod:781
7474 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7475 " const char *device,\n"
7476 " int blocksize);\n"
7481 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7482 msgid "This sets the block size of a device."
7486 #: ../src/guestfs-actions.pod:797
7487 msgid "guestfs_blockdev_setro"
7491 #: ../src/guestfs-actions.pod:799
7495 " guestfs_blockdev_setro (guestfs_h *g,\n"
7496 " const char *device);\n"
7501 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7502 msgid "Sets the block device named C<device> to read-only."
7506 #: ../src/guestfs-actions.pod:811
7507 msgid "guestfs_blockdev_setrw"
7511 #: ../src/guestfs-actions.pod:813
7515 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7516 " const char *device);\n"
7521 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7522 msgid "Sets the block device named C<device> to read-write."
7526 #: ../src/guestfs-actions.pod:825
7527 msgid "guestfs_btrfs_filesystem_resize"
7531 #: ../src/guestfs-actions.pod:827
7535 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
7536 " const char *mountpoint,\n"
7542 #: ../src/guestfs-actions.pod:837
7545 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
7550 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
7551 msgid "This command resizes a btrfs filesystem."
7555 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
7557 "Note that unlike other resize calls, the filesystem has to be mounted and "
7558 "the parameter is the mountpoint not the device (this is a requirement of "
7563 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5176
7564 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3411
7565 msgid "The optional parameters are:"
7569 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5180
7570 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3415
7572 #| msgid "C<inspector>"
7574 msgstr "C<inspector>"
7577 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
7579 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7580 "resized to the maximum size."
7584 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
7586 #| msgid "See L<guestfish(1)>."
7587 msgid "See also L<btrfs(8)>."
7588 msgstr "Див. L<guestfish(1)>."
7591 #: ../src/guestfs-actions.pod:860
7592 msgid "guestfs_btrfs_filesystem_resize_va"
7596 #: ../src/guestfs-actions.pod:862
7600 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
7601 " const char *mountpoint,\n"
7607 #: ../src/guestfs-actions.pod:867
7608 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
7612 #: ../src/guestfs-actions.pod:871
7613 msgid "guestfs_btrfs_filesystem_resize_argv"
7617 #: ../src/guestfs-actions.pod:873
7621 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
7622 " const char *mountpoint,\n"
7623 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
7628 #: ../src/guestfs-actions.pod:878
7629 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
7633 #: ../src/guestfs-actions.pod:882
7634 msgid "guestfs_case_sensitive_path"
7638 #: ../src/guestfs-actions.pod:884
7642 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7643 " const char *path);\n"
7648 #: ../src/guestfs-actions.pod:888 ../fish/guestfish-actions.pod:574
7650 "This can be used to resolve case insensitive paths on a filesystem which is "
7651 "case sensitive. The use case is to resolve paths which you have read from "
7652 "Windows configuration files or the Windows Registry, to the true path."
7656 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:579
7658 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7659 "(and probably others), which is that although the underlying filesystem is "
7660 "case-insensitive, the driver exports the filesystem to Linux as case-"
7665 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:584
7667 "One consequence of this is that special directories such as C<c:\\windows> "
7668 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7669 "precise details of how they were created. In Windows itself this would not "
7674 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:590
7676 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7681 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:593
7683 "This function resolves the true case of each element in the path and returns "
7684 "the case-sensitive path."
7688 #: ../src/guestfs-actions.pod:910
7690 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7691 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7692 "how the directories were originally created under Windows)."
7696 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:601
7697 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7701 #: ../src/guestfs-actions.pod:918
7702 msgid "See also C<guestfs_realpath>."
7706 #: ../src/guestfs-actions.pod:923 ../src/guestfs-actions.pod:7349
7707 msgid "(Added in 1.0.75)"
7711 #: ../src/guestfs-actions.pod:925
7716 #: ../src/guestfs-actions.pod:927
7720 " guestfs_cat (guestfs_h *g,\n"
7721 " const char *path);\n"
7726 #: ../src/guestfs-actions.pod:931 ../src/guestfs-actions.pod:5813
7727 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3825
7728 msgid "Return the contents of the file named C<path>."
7732 #: ../src/guestfs-actions.pod:933
7734 "Note that this function cannot correctly handle binary files (specifically, "
7735 "files containing C<\\0> character which is treated as end of string). For "
7736 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7737 "functions which have a more complex interface."
7741 #: ../src/guestfs-actions.pod:941 ../src/guestfs-actions.pod:1120
7742 #: ../src/guestfs-actions.pod:1140 ../src/guestfs-actions.pod:1436
7743 #: ../src/guestfs-actions.pod:1455 ../src/guestfs-actions.pod:1558
7744 #: ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1823
7745 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2302
7746 #: ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2369
7747 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:2415
7748 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5621
7749 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5778
7750 #: ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:6734
7751 #: ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6935
7752 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:7622
7753 #: ../src/guestfs-actions.pod:7648 ../src/guestfs-actions.pod:7674
7754 #: ../src/guestfs-actions.pod:7693 ../src/guestfs-actions.pod:7779
7755 #: ../src/guestfs-actions.pod:7798 ../src/guestfs-actions.pod:7844
7756 #: ../src/guestfs-actions.pod:7863 ../fish/guestfish-actions.pod:617
7757 #: ../fish/guestfish-actions.pod:752 ../fish/guestfish-actions.pod:764
7758 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:950
7759 #: ../fish/guestfish-actions.pod:1017 ../fish/guestfish-actions.pod:1027
7760 #: ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1520
7761 #: ../fish/guestfish-actions.pod:1530 ../fish/guestfish-actions.pod:1558
7762 #: ../fish/guestfish-actions.pod:1573 ../fish/guestfish-actions.pod:1583
7763 #: ../fish/guestfish-actions.pod:1602 ../fish/guestfish-actions.pod:3695
7764 #: ../fish/guestfish-actions.pod:3710 ../fish/guestfish-actions.pod:3786
7765 #: ../fish/guestfish-actions.pod:3803 ../fish/guestfish-actions.pod:3818
7766 #: ../fish/guestfish-actions.pod:4472 ../fish/guestfish-actions.pod:4518
7767 #: ../fish/guestfish-actions.pod:4603 ../fish/guestfish-actions.pod:4618
7768 #: ../fish/guestfish-actions.pod:5022 ../fish/guestfish-actions.pod:5040
7769 #: ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5067
7770 #: ../fish/guestfish-actions.pod:5116 ../fish/guestfish-actions.pod:5126
7771 #: ../fish/guestfish-actions.pod:5155 ../fish/guestfish-actions.pod:5165
7773 "Because of the message protocol, there is a transfer limit of somewhere "
7774 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7778 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:3727
7779 #: ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:3826
7780 #: ../src/guestfs-actions.pod:3914 ../src/guestfs-actions.pod:4322
7781 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5701
7782 #: ../src/guestfs-actions.pod:5715 ../src/guestfs-actions.pod:7502
7783 #: ../src/guestfs-actions.pod:7516
7784 msgid "(Added in 0.4)"
7788 #: ../src/guestfs-actions.pod:946
7789 msgid "guestfs_checksum"
7793 #: ../src/guestfs-actions.pod:948
7797 " guestfs_checksum (guestfs_h *g,\n"
7798 " const char *csumtype,\n"
7799 " const char *path);\n"
7804 #: ../src/guestfs-actions.pod:953 ../fish/guestfish-actions.pod:624
7806 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7810 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:627
7812 "The type of checksum to compute is given by the C<csumtype> parameter which "
7813 "must have one of the following values:"
7817 #: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:632
7822 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:634
7824 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7829 #: ../src/guestfs-actions.pod:966 ../fish/guestfish-actions.pod:637
7834 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:639
7835 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7839 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:641
7844 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:643
7845 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7849 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:645
7854 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:647
7855 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7859 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:649
7864 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:651
7865 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7869 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:653
7874 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:655
7875 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7879 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:657
7884 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:659
7885 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7889 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:663
7890 msgid "The checksum is returned as a printable string."
7894 #: ../src/guestfs-actions.pod:994
7895 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7899 #: ../src/guestfs-actions.pod:996
7900 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7904 #: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1309
7905 #: ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:3425
7906 #: ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3515
7907 #: ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:7205
7908 msgid "(Added in 1.0.2)"
7912 #: ../src/guestfs-actions.pod:1003
7913 msgid "guestfs_checksum_device"
7917 #: ../src/guestfs-actions.pod:1005
7921 " guestfs_checksum_device (guestfs_h *g,\n"
7922 " const char *csumtype,\n"
7923 " const char *device);\n"
7928 #: ../src/guestfs-actions.pod:1010
7930 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7931 "device named C<device>. For the types of checksums supported see the "
7932 "C<guestfs_checksum> command."
7936 #: ../src/guestfs-actions.pod:1017 ../src/guestfs-actions.pod:5156
7937 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5328
7938 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5522
7939 #: ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7128
7940 #: ../src/guestfs-actions.pod:7528
7941 msgid "(Added in 1.3.2)"
7945 #: ../src/guestfs-actions.pod:1019
7946 msgid "guestfs_checksums_out"
7950 #: ../src/guestfs-actions.pod:1021
7954 " guestfs_checksums_out (guestfs_h *g,\n"
7955 " const char *csumtype,\n"
7956 " const char *directory,\n"
7957 " const char *sumsfile);\n"
7962 #: ../src/guestfs-actions.pod:1027 ../fish/guestfish-actions.pod:681
7964 "This command computes the checksums of all regular files in C<directory> and "
7965 "then emits a list of those checksums to the local output file C<sumsfile>."
7969 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:685
7971 "This can be used for verifying the integrity of a virtual machine. However "
7972 "to be properly secure you should pay attention to the output of the checksum "
7973 "command (it uses the ones from GNU coreutils). In particular when the "
7974 "filename is not printable, coreutils uses a special backslash syntax. For "
7975 "more information, see the GNU coreutils info file."
7979 #: ../src/guestfs-actions.pod:1041
7980 msgid "(Added in 1.3.7)"
7984 #: ../src/guestfs-actions.pod:1043
7985 msgid "guestfs_chmod"
7989 #: ../src/guestfs-actions.pod:1045
7993 " guestfs_chmod (guestfs_h *g,\n"
7995 " const char *path);\n"
8000 #: ../src/guestfs-actions.pod:1050 ../fish/guestfish-actions.pod:699
8002 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8007 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:702
8009 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8010 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8015 #: ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:4573
8016 #: ../src/guestfs-actions.pod:4782 ../src/guestfs-actions.pod:4801
8017 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:706
8018 #: ../fish/guestfish-actions.pod:3054 ../fish/guestfish-actions.pod:3193
8019 #: ../fish/guestfish-actions.pod:3203 ../fish/guestfish-actions.pod:3213
8020 msgid "The mode actually set is affected by the umask."
8024 #: ../src/guestfs-actions.pod:1063
8025 msgid "guestfs_chown"
8029 #: ../src/guestfs-actions.pod:1065
8033 " guestfs_chown (guestfs_h *g,\n"
8036 " const char *path);\n"
8041 #: ../src/guestfs-actions.pod:1071 ../fish/guestfish-actions.pod:712
8042 msgid "Change the file owner to C<owner> and group to C<group>."
8046 #: ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:3644
8047 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2489
8049 "Only numeric uid and gid are supported. If you want to use names, you will "
8050 "need to locate and parse the password file yourself (Augeas support makes "
8051 "this relatively easy)."
8055 #: ../src/guestfs-actions.pod:1081
8056 msgid "guestfs_command"
8060 #: ../src/guestfs-actions.pod:1083
8064 " guestfs_command (guestfs_h *g,\n"
8065 " char *const *arguments);\n"
8070 #: ../src/guestfs-actions.pod:1087 ../fish/guestfish-actions.pod:722
8072 "This call runs a command from the guest filesystem. The filesystem must be "
8073 "mounted, and must contain a compatible operating system (ie. something "
8074 "Linux, with the same or compatible processor architecture)."
8078 #: ../src/guestfs-actions.pod:1092
8080 "The single parameter is an argv-style list of arguments. The first element "
8081 "is the name of the program to run. Subsequent elements are parameters. The "
8082 "list must be non-empty (ie. must contain a program name). Note that the "
8083 "command runs directly, and is I<not> invoked via the shell (see "
8088 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:734
8089 msgid "The return value is anything printed to I<stdout> by the command."
8093 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:737
8095 "If the command returns a non-zero exit status, then this function returns an "
8096 "error message. The error message string is the content of I<stderr> from "
8101 #: ../src/guestfs-actions.pod:1106 ../fish/guestfish-actions.pod:741
8103 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8104 "bin>. If you require a program from another location, you should provide "
8105 "the full path in the first parameter."
8109 #: ../src/guestfs-actions.pod:1111 ../fish/guestfish-actions.pod:746
8111 "Shared libraries and data files required by the program must be available on "
8112 "filesystems which are mounted in the correct places. It is the caller's "
8113 "responsibility to ensure all filesystems that are needed are mounted at the "
8118 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1143
8119 #: ../src/guestfs-actions.pod:1608
8120 msgid "(Added in 0.9.1)"
8124 #: ../src/guestfs-actions.pod:1125
8125 msgid "guestfs_command_lines"
8129 #: ../src/guestfs-actions.pod:1127
8133 " guestfs_command_lines (guestfs_h *g,\n"
8134 " char *const *arguments);\n"
8139 #: ../src/guestfs-actions.pod:1131
8141 "This is the same as C<guestfs_command>, but splits the result into a list of "
8146 #: ../src/guestfs-actions.pod:1134
8147 msgid "See also: C<guestfs_sh_lines>"
8151 #: ../src/guestfs-actions.pod:1145
8152 msgid "guestfs_config"
8156 #: ../src/guestfs-actions.pod:1147
8160 " guestfs_config (guestfs_h *g,\n"
8161 " const char *qemuparam,\n"
8162 " const char *qemuvalue);\n"
8167 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
8169 "This can be used to add arbitrary qemu command line parameters of the form "
8170 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8171 "setting some parameters which would interfere with parameters that we use."
8175 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:776
8176 msgid "The first character of C<param> string must be a C<-> (dash)."
8180 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:778
8181 msgid "C<value> can be NULL."
8185 #: ../src/guestfs-actions.pod:1165
8186 msgid "guestfs_copy_size"
8190 #: ../src/guestfs-actions.pod:1167
8194 " guestfs_copy_size (guestfs_h *g,\n"
8195 " const char *src,\n"
8196 " const char *dest,\n"
8202 #: ../src/guestfs-actions.pod:1173 ../fish/guestfish-actions.pod:784
8204 "This command copies exactly C<size> bytes from one source device or file "
8205 "C<src> to another destination device or file C<dest>."
8209 #: ../src/guestfs-actions.pod:1176 ../fish/guestfish-actions.pod:787
8211 "Note this will fail if the source is too short or if the destination is not "
8216 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1304
8217 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1380
8218 #: ../src/guestfs-actions.pod:1757 ../src/guestfs-actions.pod:1779
8219 #: ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:7200
8220 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7715
8221 #: ../src/guestfs-actions.pod:7734
8223 "This long-running command can generate progress notification messages so "
8224 "that the caller can display a progress bar or indicator. To receive these "
8225 "messages, the caller must register a progress event callback. See L<guestfs"
8226 "(3)/GUESTFS_EVENT_PROGRESS>."
8230 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:4349
8231 #: ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:7435
8232 #: ../src/guestfs-actions.pod:7455 ../src/guestfs-actions.pod:7541
8233 msgid "(Added in 1.0.87)"
8237 #: ../src/guestfs-actions.pod:1188
8242 #: ../src/guestfs-actions.pod:1190
8246 " guestfs_cp (guestfs_h *g,\n"
8247 " const char *src,\n"
8248 " const char *dest);\n"
8253 #: ../src/guestfs-actions.pod:1195 ../fish/guestfish-actions.pod:794
8255 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8256 "destination filename or destination directory."
8260 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
8261 #: ../src/guestfs-actions.pod:1286 ../src/guestfs-actions.pod:1360
8262 #: ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:5103
8263 #: ../src/guestfs-actions.pod:5572
8264 msgid "(Added in 1.0.18)"
8268 #: ../src/guestfs-actions.pod:1202
8269 msgid "guestfs_cp_a"
8273 #: ../src/guestfs-actions.pod:1204
8277 " guestfs_cp_a (guestfs_h *g,\n"
8278 " const char *src,\n"
8279 " const char *dest);\n"
8284 #: ../src/guestfs-actions.pod:1209 ../fish/guestfish-actions.pod:801
8286 "This copies a file or directory from C<src> to C<dest> recursively using the "
8291 #: ../src/guestfs-actions.pod:1216
8296 #: ../src/guestfs-actions.pod:1218
8300 " guestfs_dd (guestfs_h *g,\n"
8301 " const char *src,\n"
8302 " const char *dest);\n"
8307 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:808
8309 "This command copies from one source device or file C<src> to another "
8310 "destination device or file C<dest>. Normally you would use this to copy to "
8311 "or from a device or partition, for example to duplicate a filesystem."
8315 #: ../src/guestfs-actions.pod:1228
8317 "If the destination is a device, it must be as large or larger than the "
8318 "source file or device, otherwise the copy will fail. This command cannot do "
8319 "partial copies (see C<guestfs_copy_size>)."
8323 #: ../src/guestfs-actions.pod:1236
8328 #: ../src/guestfs-actions.pod:1238
8332 " guestfs_df (guestfs_h *g);\n"
8337 #: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:821
8338 msgid "This command runs the C<df> command to report disk space used."
8342 #: ../src/guestfs-actions.pod:1243 ../src/guestfs-actions.pod:1260
8344 "This command is mostly useful for interactive sessions. It is I<not> "
8345 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8350 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
8351 #: ../src/guestfs-actions.pod:1385 ../src/guestfs-actions.pod:2348
8352 #: ../src/guestfs-actions.pod:2372 ../src/guestfs-actions.pod:2440
8353 #: ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:5003
8354 #: ../src/guestfs-actions.pod:6938 ../src/guestfs-actions.pod:6962
8355 #: ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7594
8356 #: ../src/guestfs-actions.pod:7607
8357 msgid "(Added in 1.0.54)"
8361 #: ../src/guestfs-actions.pod:1252
8362 msgid "guestfs_df_h"
8366 #: ../src/guestfs-actions.pod:1254
8370 " guestfs_df_h (guestfs_h *g);\n"
8375 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:831
8377 "This command runs the C<df -h> command to report disk space used in human-"
8382 #: ../src/guestfs-actions.pod:1269
8383 msgid "guestfs_dmesg"
8387 #: ../src/guestfs-actions.pod:1271
8391 " guestfs_dmesg (guestfs_h *g);\n"
8396 #: ../src/guestfs-actions.pod:1274 ../fish/guestfish-actions.pod:842
8398 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8399 "This is sometimes useful for extended debugging of problems."
8403 #: ../src/guestfs-actions.pod:1278
8405 "Another way to get the same information is to enable verbose messages with "
8406 "C<guestfs_set_verbose> or by setting the environment variable "
8407 "C<LIBGUESTFS_DEBUG=1> before running the program."
8411 #: ../src/guestfs-actions.pod:1288
8412 msgid "guestfs_download"
8416 #: ../src/guestfs-actions.pod:1290
8420 " guestfs_download (guestfs_h *g,\n"
8421 " const char *remotefilename,\n"
8422 " const char *filename);\n"
8427 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1320
8428 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
8430 "Download file C<remotefilename> and save it as C<filename> on the local "
8435 #: ../src/guestfs-actions.pod:1298 ../src/guestfs-actions.pod:7194
8436 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4776
8437 msgid "C<filename> can also be a named pipe."
8441 #: ../src/guestfs-actions.pod:1300
8442 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8446 #: ../src/guestfs-actions.pod:1311
8447 msgid "guestfs_download_offset"
8451 #: ../src/guestfs-actions.pod:1313
8455 " guestfs_download_offset (guestfs_h *g,\n"
8456 " const char *remotefilename,\n"
8457 " const char *filename,\n"
8458 " int64_t offset,\n"
8464 #: ../src/guestfs-actions.pod:1323 ../fish/guestfish-actions.pod:871
8466 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8467 "region must be within the file or device)."
8471 #: ../src/guestfs-actions.pod:1326
8473 "Note that there is no limit on the amount of data that can be downloaded "
8474 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8475 "full amount unless an error occurs."
8479 #: ../src/guestfs-actions.pod:1331
8480 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8484 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:7239
8485 msgid "(Added in 1.5.17)"
8489 #: ../src/guestfs-actions.pod:1342
8490 msgid "guestfs_drop_caches"
8494 #: ../src/guestfs-actions.pod:1344
8498 " guestfs_drop_caches (guestfs_h *g,\n"
8499 " int whattodrop);\n"
8504 #: ../src/guestfs-actions.pod:1348 ../fish/guestfish-actions.pod:887
8506 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8507 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8508 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8512 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:892
8513 msgid "Setting C<whattodrop> to 3 should drop everything."
8517 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:894
8519 "This automatically calls L<sync(2)> before the operation, so that the "
8520 "maximum guest memory is freed."
8524 #: ../src/guestfs-actions.pod:1362
8529 #: ../src/guestfs-actions.pod:1364
8533 " guestfs_du (guestfs_h *g,\n"
8534 " const char *path);\n"
8539 #: ../src/guestfs-actions.pod:1368 ../fish/guestfish-actions.pod:901
8541 "This command runs the C<du -s> command to estimate file space usage for "
8546 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:904
8548 "C<path> can be a file or a directory. If C<path> is a directory then the "
8549 "estimate includes the contents of the directory and all subdirectories "
8554 #: ../src/guestfs-actions.pod:1375 ../fish/guestfish-actions.pod:908
8556 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8560 #: ../src/guestfs-actions.pod:1387
8561 msgid "guestfs_e2fsck_f"
8565 #: ../src/guestfs-actions.pod:1389
8569 " guestfs_e2fsck_f (guestfs_h *g,\n"
8570 " const char *device);\n"
8575 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:915
8577 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8578 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8583 #: ../src/guestfs-actions.pod:1397
8585 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8586 "Normally you should use C<guestfs_fsck>."
8590 #: ../src/guestfs-actions.pod:1402
8591 msgid "(Added in 1.0.29)"
8595 #: ../src/guestfs-actions.pod:1404
8596 msgid "guestfs_echo_daemon"
8600 #: ../src/guestfs-actions.pod:1406
8604 " guestfs_echo_daemon (guestfs_h *g,\n"
8605 " char *const *words);\n"
8610 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:926
8612 "This command concatenates the list of C<words> passed with single spaces "
8613 "between them and returns the resulting string."
8617 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:929
8618 msgid "You can use this command to test the connection through to the daemon."
8622 #: ../src/guestfs-actions.pod:1415
8623 msgid "See also C<guestfs_ping_daemon>."
8627 #: ../src/guestfs-actions.pod:1420 ../src/guestfs-actions.pod:2156
8628 #: ../src/guestfs-actions.pod:6410
8629 msgid "(Added in 1.0.69)"
8633 #: ../src/guestfs-actions.pod:1422
8634 msgid "guestfs_egrep"
8638 #: ../src/guestfs-actions.pod:1424
8642 " guestfs_egrep (guestfs_h *g,\n"
8643 " const char *regex,\n"
8644 " const char *path);\n"
8649 #: ../src/guestfs-actions.pod:1429 ../fish/guestfish-actions.pod:937
8651 "This calls the external C<egrep> program and returns the matching lines."
8655 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458
8656 #: ../src/guestfs-actions.pod:1515 ../src/guestfs-actions.pod:1561
8657 #: ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:2286
8658 #: ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2461
8659 #: ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2489
8660 #: ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:2557
8661 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:3839
8662 #: ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:3866
8663 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4881
8664 #: ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5955
8665 #: ../src/guestfs-actions.pod:6806 ../src/guestfs-actions.pod:6818
8666 #: ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:6844
8667 #: ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:6879
8668 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905
8669 #: ../src/guestfs-actions.pod:7677 ../src/guestfs-actions.pod:7696
8670 #: ../src/guestfs-actions.pod:7782 ../src/guestfs-actions.pod:7801
8671 #: ../src/guestfs-actions.pod:7847 ../src/guestfs-actions.pod:7866
8672 msgid "(Added in 1.0.66)"
8676 #: ../src/guestfs-actions.pod:1441
8677 msgid "guestfs_egrepi"
8681 #: ../src/guestfs-actions.pod:1443
8685 " guestfs_egrepi (guestfs_h *g,\n"
8686 " const char *regex,\n"
8687 " const char *path);\n"
8692 #: ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:947
8694 "This calls the external C<egrep -i> program and returns the matching lines."
8698 #: ../src/guestfs-actions.pod:1460
8699 msgid "guestfs_equal"
8703 #: ../src/guestfs-actions.pod:1462
8707 " guestfs_equal (guestfs_h *g,\n"
8708 " const char *file1,\n"
8709 " const char *file2);\n"
8714 #: ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:957
8716 "This compares the two files C<file1> and C<file2> and returns true if their "
8717 "content is exactly equal, or false otherwise."
8721 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:960
8722 msgid "The external L<cmp(1)> program is used for the comparison."
8726 #: ../src/guestfs-actions.pod:1476
8727 msgid "guestfs_exists"
8731 #: ../src/guestfs-actions.pod:1478
8735 " guestfs_exists (guestfs_h *g,\n"
8736 " const char *path);\n"
8741 #: ../src/guestfs-actions.pod:1482 ../fish/guestfish-actions.pod:966
8743 "This returns C<true> if and only if there is a file, directory (or anything) "
8744 "with the given C<path> name."
8748 #: ../src/guestfs-actions.pod:1485
8749 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8753 #: ../src/guestfs-actions.pod:1491
8754 msgid "guestfs_fallocate"
8758 #: ../src/guestfs-actions.pod:1493
8762 " guestfs_fallocate (guestfs_h *g,\n"
8763 " const char *path,\n"
8769 #: ../src/guestfs-actions.pod:1498 ../src/guestfs-actions.pod:1524
8770 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8772 "This command preallocates a file (containing zero bytes) named C<path> of "
8773 "size C<len> bytes. If the file exists already, it is overwritten."
8777 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:979
8779 "Do not confuse this with the guestfish-specific C<alloc> command which "
8780 "allocates a file in the host and attaches it as a device."
8784 #: ../src/guestfs-actions.pod:1508 ../fish/guestfish-actions.pod:983
8786 "This function is deprecated. In new code, use the C<fallocate64> call "
8791 #: ../src/guestfs-actions.pod:1517
8792 msgid "guestfs_fallocate64"
8796 #: ../src/guestfs-actions.pod:1519
8800 " guestfs_fallocate64 (guestfs_h *g,\n"
8801 " const char *path,\n"
8807 #: ../src/guestfs-actions.pod:1528
8809 "Note that this call allocates disk blocks for the file. To create a sparse "
8810 "file use C<guestfs_truncate_size> instead."
8814 #: ../src/guestfs-actions.pod:1531
8816 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8817 "oversight it only allowed 30 bit lengths to be specified, effectively "
8818 "limiting the maximum size of files created through that call to 1GB."
8822 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1006
8824 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8825 "commands which create a file in the host and attach it as a device."
8829 #: ../src/guestfs-actions.pod:1542
8830 msgid "(Added in 1.3.17)"
8834 #: ../src/guestfs-actions.pod:1544
8835 msgid "guestfs_fgrep"
8839 #: ../src/guestfs-actions.pod:1546
8843 " guestfs_fgrep (guestfs_h *g,\n"
8844 " const char *pattern,\n"
8845 " const char *path);\n"
8850 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1014
8852 "This calls the external C<fgrep> program and returns the matching lines."
8856 #: ../src/guestfs-actions.pod:1563
8857 msgid "guestfs_fgrepi"
8861 #: ../src/guestfs-actions.pod:1565
8865 " guestfs_fgrepi (guestfs_h *g,\n"
8866 " const char *pattern,\n"
8867 " const char *path);\n"
8872 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1024
8874 "This calls the external C<fgrep -i> program and returns the matching lines."
8878 #: ../src/guestfs-actions.pod:1582
8879 msgid "guestfs_file"
8883 #: ../src/guestfs-actions.pod:1584
8887 " guestfs_file (guestfs_h *g,\n"
8888 " const char *path);\n"
8893 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1034
8895 "This call uses the standard L<file(1)> command to determine the type or "
8896 "contents of the file."
8900 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1037
8902 "This call will also transparently look inside various types of compressed "
8907 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1040
8909 "The exact command which runs is C<file -zb path>. Note in particular that "
8910 "the filename is not prepended to the output (the I<-b> option)."
8914 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1044
8916 "The output depends on the output of the underlying L<file(1)> command and it "
8917 "can change in future in ways beyond our control. In other words, the output "
8918 "is not guaranteed by the ABI."
8922 #: ../src/guestfs-actions.pod:1602
8924 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8925 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8929 #: ../src/guestfs-actions.pod:1610
8930 msgid "guestfs_file_architecture"
8934 #: ../src/guestfs-actions.pod:1612
8938 " guestfs_file_architecture (guestfs_h *g,\n"
8939 " const char *filename);\n"
8944 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1055
8946 "This detects the architecture of the binary C<filename>, and returns it if "
8951 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1058
8952 msgid "Currently defined architectures are:"
8956 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1062
8961 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1064
8963 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8964 "irrespective of the precise processor requirements of the binary."
8968 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1067
8973 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1069
8974 msgid "64 bit x86-64."
8978 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1071
8983 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1073
8984 msgid "32 bit SPARC."
8988 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1075
8993 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1077
8994 msgid "64 bit SPARC V9 and above."
8998 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1079
9003 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1081
9004 msgid "Intel Itanium."
9005 msgstr "Intel Itanium."
9008 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1083
9013 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1085
9014 msgid "32 bit Power PC."
9018 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1087
9023 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1089
9024 msgid "64 bit Power PC."
9028 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1093
9029 msgid "Libguestfs may return other architecture strings in future."
9033 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1095
9034 msgid "The function works on at least the following types of files:"
9038 #: ../src/guestfs-actions.pod:1662 ../fish/guestfish-actions.pod:1101
9039 msgid "many types of Un*x and Linux binary"
9043 #: ../src/guestfs-actions.pod:1666 ../fish/guestfish-actions.pod:1105
9044 msgid "many types of Un*x and Linux shared library"
9048 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1109
9049 msgid "Windows Win32 and Win64 binaries"
9053 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1113
9054 msgid "Windows Win32 and Win64 DLLs"
9058 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1115
9059 msgid "Win32 binaries and DLLs return C<i386>."
9063 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1117
9064 msgid "Win64 binaries and DLLs return C<x86_64>."
9068 #: ../src/guestfs-actions.pod:1682 ../fish/guestfish-actions.pod:1121
9069 msgid "Linux kernel modules"
9073 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1125
9074 msgid "Linux new-style initrd images"
9078 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1129
9079 msgid "some non-x86 Linux vmlinuz kernels"
9083 #: ../src/guestfs-actions.pod:1694 ../fish/guestfish-actions.pod:1133
9084 msgid "What it can't do currently:"
9088 #: ../src/guestfs-actions.pod:1700 ../fish/guestfish-actions.pod:1139
9089 msgid "static libraries (libfoo.a)"
9093 #: ../src/guestfs-actions.pod:1704 ../fish/guestfish-actions.pod:1143
9094 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9098 #: ../src/guestfs-actions.pod:1708 ../fish/guestfish-actions.pod:1147
9099 msgid "x86 Linux vmlinuz kernels"
9103 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1149
9105 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9106 "compressed code, and are horribly hard to unpack. If you want to find the "
9107 "architecture of a kernel, use the architecture of the associated initrd or "
9108 "kernel module(s) instead."
9112 #: ../src/guestfs-actions.pod:1720 ../src/guestfs-actions.pod:1883
9113 #: ../src/guestfs-actions.pod:1900 ../src/guestfs-actions.pod:2590
9114 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2746
9115 #: ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:2951
9116 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3066
9117 #: ../src/guestfs-actions.pod:3159 ../src/guestfs-actions.pod:3396
9118 #: ../src/guestfs-actions.pod:3528
9119 msgid "(Added in 1.5.3)"
9123 #: ../src/guestfs-actions.pod:1722
9124 msgid "guestfs_filesize"
9128 #: ../src/guestfs-actions.pod:1724
9132 " guestfs_filesize (guestfs_h *g,\n"
9133 " const char *file);\n"
9138 #: ../src/guestfs-actions.pod:1728 ../fish/guestfish-actions.pod:1160
9139 msgid "This command returns the size of C<file> in bytes."
9143 #: ../src/guestfs-actions.pod:1730
9145 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9146 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9147 "devices, use C<guestfs_blockdev_getsize64>."
9151 #: ../src/guestfs-actions.pod:1736
9152 msgid "(Added in 1.0.82)"
9156 #: ../src/guestfs-actions.pod:1738
9157 msgid "guestfs_fill"
9161 #: ../src/guestfs-actions.pod:1740
9165 " guestfs_fill (guestfs_h *g,\n"
9168 " const char *path);\n"
9173 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1170
9175 "This command creates a new file called C<path>. The initial content of the "
9176 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9181 #: ../src/guestfs-actions.pod:1750
9183 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9184 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9185 "bytes use C<guestfs_fill_pattern>."
9189 #: ../src/guestfs-actions.pod:1762
9190 msgid "(Added in 1.0.79)"
9194 #: ../src/guestfs-actions.pod:1764
9195 msgid "guestfs_fill_pattern"
9199 #: ../src/guestfs-actions.pod:1766
9203 " guestfs_fill_pattern (guestfs_h *g,\n"
9204 " const char *pattern,\n"
9206 " const char *path);\n"
9211 #: ../src/guestfs-actions.pod:1772
9213 "This function is like C<guestfs_fill> except that it creates a new file of "
9214 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9215 "pattern is truncated if necessary to ensure the length of the file is "
9216 "exactly C<len> bytes."
9220 #: ../src/guestfs-actions.pod:1784
9221 msgid "(Added in 1.3.12)"
9225 #: ../src/guestfs-actions.pod:1786
9226 msgid "guestfs_find"
9230 #: ../src/guestfs-actions.pod:1788
9234 " guestfs_find (guestfs_h *g,\n"
9235 " const char *directory);\n"
9240 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1192
9242 "This command lists out all files and directories, recursively, starting at "
9243 "C<directory>. It is essentially equivalent to running the shell command "
9244 "C<find directory -print> but some post-processing happens on the output, "
9249 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1197
9251 "This returns a list of strings I<without any prefix>. Thus if the directory "
9256 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1200
9266 #: ../src/guestfs-actions.pod:1804
9268 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9272 #: ../src/guestfs-actions.pod:1807 ../fish/guestfish-actions.pod:1207
9283 #: ../src/guestfs-actions.pod:1812 ../fish/guestfish-actions.pod:1212
9284 msgid "If C<directory> is not a directory, then this command returns an error."
9288 #: ../src/guestfs-actions.pod:1815 ../fish/guestfish-actions.pod:1215
9289 msgid "The returned list is sorted."
9293 #: ../src/guestfs-actions.pod:1817
9294 msgid "See also C<guestfs_find0>."
9298 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:4286
9299 #: ../src/guestfs-actions.pod:5990
9300 msgid "(Added in 1.0.27)"
9304 #: ../src/guestfs-actions.pod:1828
9305 msgid "guestfs_find0"
9309 #: ../src/guestfs-actions.pod:1830
9313 " guestfs_find0 (guestfs_h *g,\n"
9314 " const char *directory,\n"
9315 " const char *files);\n"
9320 #: ../src/guestfs-actions.pod:1835 ../fish/guestfish-actions.pod:1226
9322 "This command lists out all files and directories, recursively, starting at "
9323 "C<directory>, placing the resulting list in the external file called "
9328 #: ../src/guestfs-actions.pod:1839
9330 "This command works the same way as C<guestfs_find> with the following "
9335 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1237
9336 msgid "The resulting list is written to an external file."
9340 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1241
9342 "Items (filenames) in the result are separated by C<\\0> characters. See "
9343 "L<find(1)> option I<-print0>."
9347 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1246
9348 msgid "This command is not limited in the number of names that it can return."
9352 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1251
9353 msgid "The result list is not sorted."
9357 #: ../src/guestfs-actions.pod:1866
9358 msgid "(Added in 1.0.74)"
9362 #: ../src/guestfs-actions.pod:1868
9363 msgid "guestfs_findfs_label"
9367 #: ../src/guestfs-actions.pod:1870
9371 " guestfs_findfs_label (guestfs_h *g,\n"
9372 " const char *label);\n"
9377 #: ../src/guestfs-actions.pod:1874 ../fish/guestfish-actions.pod:1261
9379 "This command searches the filesystems and returns the one which has the "
9380 "given label. An error is returned if no such filesystem can be found."
9384 #: ../src/guestfs-actions.pod:1878
9385 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9389 #: ../src/guestfs-actions.pod:1885
9390 msgid "guestfs_findfs_uuid"
9394 #: ../src/guestfs-actions.pod:1887
9398 " guestfs_findfs_uuid (guestfs_h *g,\n"
9399 " const char *uuid);\n"
9404 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1271
9406 "This command searches the filesystems and returns the one which has the "
9407 "given UUID. An error is returned if no such filesystem can be found."
9411 #: ../src/guestfs-actions.pod:1895
9412 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9416 #: ../src/guestfs-actions.pod:1902
9417 msgid "guestfs_fsck"
9421 #: ../src/guestfs-actions.pod:1904
9425 " guestfs_fsck (guestfs_h *g,\n"
9426 " const char *fstype,\n"
9427 " const char *device);\n"
9432 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1281
9434 "This runs the filesystem checker (fsck) on C<device> which should have "
9435 "filesystem type C<fstype>."
9439 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1284
9441 "The returned integer is the status. See L<fsck(8)> for the list of status "
9442 "codes from C<fsck>."
9446 #: ../src/guestfs-actions.pod:1921 ../fish/guestfish-actions.pod:1293
9447 msgid "Multiple status codes can be summed together."
9451 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1297
9453 "A non-zero return code can mean \"success\", for example if errors have been "
9454 "corrected on the filesystem."
9458 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1302
9459 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9463 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1307
9465 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9469 #: ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:7720
9470 msgid "(Added in 1.0.16)"
9474 #: ../src/guestfs-actions.pod:1941
9475 msgid "guestfs_get_append"
9479 #: ../src/guestfs-actions.pod:1943
9483 " guestfs_get_append (guestfs_h *g);\n"
9488 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1313
9490 "Return the additional kernel options which are added to the guest kernel "
9495 #: ../src/guestfs-actions.pod:1949 ../fish/guestfish-actions.pod:1316
9496 msgid "If C<NULL> then no options are added."
9500 #: ../src/guestfs-actions.pod:1951
9502 "This function returns a string which may be NULL. There is no way to return "
9503 "an error from this function. The string is owned by the guest handle and "
9504 "must I<not> be freed."
9508 #: ../src/guestfs-actions.pod:1955 ../src/guestfs-actions.pod:5668
9509 #: ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6573
9510 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6608
9511 #: ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:7386
9512 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7763
9513 msgid "(Added in 1.0.26)"
9517 #: ../src/guestfs-actions.pod:1957
9518 msgid "guestfs_get_attach_method"
9522 #: ../src/guestfs-actions.pod:1959
9526 " guestfs_get_attach_method (guestfs_h *g);\n"
9531 #: ../src/guestfs-actions.pod:1962
9532 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9536 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:6180
9537 msgid "(Added in 1.9.8)"
9541 #: ../src/guestfs-actions.pod:1969
9542 msgid "guestfs_get_autosync"
9546 #: ../src/guestfs-actions.pod:1971
9550 " guestfs_get_autosync (guestfs_h *g);\n"
9555 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1328
9556 msgid "Get the autosync flag."
9560 #: ../src/guestfs-actions.pod:1980
9561 msgid "guestfs_get_direct"
9565 #: ../src/guestfs-actions.pod:1982
9569 " guestfs_get_direct (guestfs_h *g);\n"
9574 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1334
9575 msgid "Return the direct appliance mode flag."
9579 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:6221
9580 msgid "(Added in 1.0.72)"
9584 #: ../src/guestfs-actions.pod:1991
9585 msgid "guestfs_get_e2label"
9589 #: ../src/guestfs-actions.pod:1993
9593 " guestfs_get_e2label (guestfs_h *g,\n"
9594 " const char *device);\n"
9599 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1340
9601 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9605 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1343
9607 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9611 #: ../src/guestfs-actions.pod:2010 ../src/guestfs-actions.pod:2031
9612 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6258
9613 msgid "(Added in 1.0.15)"
9617 #: ../src/guestfs-actions.pod:2012
9618 msgid "guestfs_get_e2uuid"
9622 #: ../src/guestfs-actions.pod:2014
9626 " guestfs_get_e2uuid (guestfs_h *g,\n"
9627 " const char *device);\n"
9632 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1354
9634 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9638 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1357
9640 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9644 #: ../src/guestfs-actions.pod:2033
9645 msgid "guestfs_get_memsize"
9649 #: ../src/guestfs-actions.pod:2035
9653 " guestfs_get_memsize (guestfs_h *g);\n"
9658 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1368
9660 "This gets the memory size in megabytes allocated to the qemu subprocess."
9664 #: ../src/guestfs-actions.pod:2041
9666 "If C<guestfs_set_memsize> was not called on this handle, and if "
9667 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9668 "value for memsize."
9672 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:2126
9673 #: ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6381
9674 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1426
9675 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4238
9677 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9681 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:4577
9682 #: ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4805
9683 #: ../src/guestfs-actions.pod:4824 ../src/guestfs-actions.pod:4836
9684 #: ../src/guestfs-actions.pod:4853 ../src/guestfs-actions.pod:4866
9685 #: ../src/guestfs-actions.pod:5893 ../src/guestfs-actions.pod:6279
9686 #: ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:7155
9687 msgid "(Added in 1.0.55)"
9691 #: ../src/guestfs-actions.pod:2052
9692 msgid "guestfs_get_network"
9696 #: ../src/guestfs-actions.pod:2054
9700 " guestfs_get_network (guestfs_h *g);\n"
9705 #: ../src/guestfs-actions.pod:2057 ../fish/guestfish-actions.pod:1382
9706 msgid "This returns the enable network flag."
9710 #: ../src/guestfs-actions.pod:2061 ../src/guestfs-actions.pod:6298
9711 msgid "(Added in 1.5.4)"
9715 #: ../src/guestfs-actions.pod:2063
9716 msgid "guestfs_get_path"
9720 #: ../src/guestfs-actions.pod:2065
9724 " guestfs_get_path (guestfs_h *g);\n"
9729 #: ../src/guestfs-actions.pod:2068 ../fish/guestfish-actions.pod:1388
9730 msgid "Return the current search path."
9734 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1390
9736 "This is always non-NULL. If it wasn't set already, then this will return "
9741 #: ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:2102
9743 "This function returns a string, or NULL on error. The string is owned by "
9744 "the guest handle and must I<not> be freed."
9748 #: ../src/guestfs-actions.pod:2078
9749 msgid "guestfs_get_pid"
9753 #: ../src/guestfs-actions.pod:2080
9757 " guestfs_get_pid (guestfs_h *g);\n"
9762 #: ../src/guestfs-actions.pod:2083 ../fish/guestfish-actions.pod:1399
9764 "Return the process ID of the qemu subprocess. If there is no qemu "
9765 "subprocess, then this will return an error."
9769 #: ../src/guestfs-actions.pod:2086 ../fish/guestfish-actions.pod:1402
9770 msgid "This is an internal call used for debugging and testing."
9774 #: ../src/guestfs-actions.pod:2090
9775 msgid "(Added in 1.0.56)"
9779 #: ../src/guestfs-actions.pod:2092
9780 msgid "guestfs_get_qemu"
9784 #: ../src/guestfs-actions.pod:2094
9788 " guestfs_get_qemu (guestfs_h *g);\n"
9793 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
9794 msgid "Return the current qemu binary."
9798 #: ../src/guestfs-actions.pod:2099 ../fish/guestfish-actions.pod:1410
9800 "This is always non-NULL. If it wasn't set already, then this will return "
9801 "the default qemu binary name."
9805 #: ../src/guestfs-actions.pod:2105 ../src/guestfs-actions.pod:6343
9806 msgid "(Added in 1.0.6)"
9810 #: ../src/guestfs-actions.pod:2107
9811 msgid "guestfs_get_recovery_proc"
9815 #: ../src/guestfs-actions.pod:2109
9819 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9824 #: ../src/guestfs-actions.pod:2112 ../fish/guestfish-actions.pod:1417
9825 msgid "Return the recovery process enabled flag."
9829 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:3650
9830 #: ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4384
9831 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:5598
9832 #: ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6367
9833 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078
9834 #: ../src/guestfs-actions.pod:7270
9835 msgid "(Added in 1.0.77)"
9839 #: ../src/guestfs-actions.pod:2118
9840 msgid "guestfs_get_selinux"
9844 #: ../src/guestfs-actions.pod:2120
9848 " guestfs_get_selinux (guestfs_h *g);\n"
9853 #: ../src/guestfs-actions.pod:2123
9855 "This returns the current setting of the selinux flag which is passed to the "
9856 "appliance at boot time. See C<guestfs_set_selinux>."
9860 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:2194
9861 #: ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6444
9862 msgid "(Added in 1.0.67)"
9866 #: ../src/guestfs-actions.pod:2133
9867 msgid "guestfs_get_state"
9871 #: ../src/guestfs-actions.pod:2135
9875 " guestfs_get_state (guestfs_h *g);\n"
9880 #: ../src/guestfs-actions.pod:2138 ../fish/guestfish-actions.pod:1433
9882 "This returns the current state as an opaque integer. This is only useful "
9883 "for printing debug and internal error messages."
9887 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3421
9888 #: ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:3511
9889 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:1436
9890 #: ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2374
9891 #: ../fish/guestfish-actions.pod:2412 ../fish/guestfish-actions.pod:2428
9892 msgid "For more information on states, see L<guestfs(3)>."
9896 #: ../src/guestfs-actions.pod:2147
9897 msgid "guestfs_get_trace"
9901 #: ../src/guestfs-actions.pod:2149
9905 " guestfs_get_trace (guestfs_h *g);\n"
9910 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1442
9911 msgid "Return the command trace flag."
9915 #: ../src/guestfs-actions.pod:2158
9916 msgid "guestfs_get_umask"
9920 #: ../src/guestfs-actions.pod:2160
9924 " guestfs_get_umask (guestfs_h *g);\n"
9929 #: ../src/guestfs-actions.pod:2163
9931 "Return the current umask. By default the umask is C<022> unless it has been "
9932 "set by calling C<guestfs_umask>."
9936 #: ../src/guestfs-actions.pod:2170
9937 msgid "guestfs_get_verbose"
9941 #: ../src/guestfs-actions.pod:2172
9945 " guestfs_get_verbose (guestfs_h *g);\n"
9950 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1455
9951 msgid "This returns the verbose messages flag."
9955 #: ../src/guestfs-actions.pod:2181
9956 msgid "guestfs_getcon"
9960 #: ../src/guestfs-actions.pod:2183
9964 " guestfs_getcon (guestfs_h *g);\n"
9969 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
9970 msgid "This gets the SELinux security context of the daemon."
9974 #: ../src/guestfs-actions.pod:2188
9976 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9980 #: ../src/guestfs-actions.pod:2196
9981 msgid "guestfs_getxattr"
9985 #: ../src/guestfs-actions.pod:2198
9989 " guestfs_getxattr (guestfs_h *g,\n"
9990 " const char *path,\n"
9991 " const char *name,\n"
9992 " size_t *size_r);\n"
9997 #: ../src/guestfs-actions.pod:2204
9999 "Get a single extended attribute from file C<path> named C<name>. This call "
10000 "follows symlinks. If you want to lookup an extended attribute for the "
10001 "symlink itself, use C<guestfs_lgetxattr>."
10005 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:3664
10007 "Normally it is better to get all extended attributes from a file in one go "
10008 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10009 "implementations are buggy and do not provide a way to list out attributes. "
10010 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10011 "extended attributes you want in advance and call this function."
10015 #: ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:3671
10016 #: ../fish/guestfish-actions.pod:1481 ../fish/guestfish-actions.pod:2508
10018 "Extended attribute values are blobs of binary data. If there is no extended "
10019 "attribute named C<name>, this returns an error."
10023 #: ../src/guestfs-actions.pod:2218
10024 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10028 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2411
10029 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:3676
10030 #: ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5617
10031 #: ../src/guestfs-actions.pod:5798
10033 "This function returns a buffer, or NULL on error. The size of the returned "
10034 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10039 #: ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:3680
10040 msgid "(Added in 1.7.24)"
10044 #: ../src/guestfs-actions.pod:2226
10045 msgid "guestfs_getxattrs"
10049 #: ../src/guestfs-actions.pod:2228
10052 " struct guestfs_xattr_list *\n"
10053 " guestfs_getxattrs (guestfs_h *g,\n"
10054 " const char *path);\n"
10059 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1490
10061 "This call lists the extended attributes of the file or directory C<path>."
10065 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1493
10067 "At the system call level, this is a combination of the L<listxattr(2)> and "
10068 "L<getxattr(2)> calls."
10072 #: ../src/guestfs-actions.pod:2238
10073 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10077 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:3692
10078 #: ../src/guestfs-actions.pod:4380
10080 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10081 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10085 #: ../src/guestfs-actions.pod:2244 ../src/guestfs-actions.pod:3696
10086 #: ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3931
10087 #: ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6463
10088 #: ../src/guestfs-actions.pod:7828
10089 msgid "(Added in 1.0.59)"
10093 #: ../src/guestfs-actions.pod:2246
10094 msgid "guestfs_glob_expand"
10098 #: ../src/guestfs-actions.pod:2248
10102 " guestfs_glob_expand (guestfs_h *g,\n"
10103 " const char *pattern);\n"
10108 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1502
10110 "This command searches for all the pathnames matching C<pattern> according to "
10111 "the wildcard expansion rules used by the shell."
10115 #: ../src/guestfs-actions.pod:2256 ../fish/guestfish-actions.pod:1506
10117 "If no paths match, then this returns an empty list (note: not an error)."
10121 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1509
10123 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10124 "GLOB_BRACE>. See that manual page for more details."
10128 #: ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:6656
10129 #: ../src/guestfs-actions.pod:6673
10130 msgid "(Added in 1.0.50)"
10134 #: ../src/guestfs-actions.pod:2269
10135 msgid "guestfs_grep"
10139 #: ../src/guestfs-actions.pod:2271
10143 " guestfs_grep (guestfs_h *g,\n"
10144 " const char *regex,\n"
10145 " const char *path);\n"
10150 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1517
10151 msgid "This calls the external C<grep> program and returns the matching lines."
10155 #: ../src/guestfs-actions.pod:2288
10156 msgid "guestfs_grepi"
10160 #: ../src/guestfs-actions.pod:2290
10164 " guestfs_grepi (guestfs_h *g,\n"
10165 " const char *regex,\n"
10166 " const char *path);\n"
10171 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1527
10173 "This calls the external C<grep -i> program and returns the matching lines."
10177 #: ../src/guestfs-actions.pod:2307
10178 msgid "guestfs_grub_install"
10182 #: ../src/guestfs-actions.pod:2309
10186 " guestfs_grub_install (guestfs_h *g,\n"
10187 " const char *root,\n"
10188 " const char *device);\n"
10193 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1537
10195 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10196 "the root directory being C<root>."
10200 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1540
10202 "Note: If grub-install reports the error \"No suitable drive was found in the "
10203 "generated device map.\" it may be that you need to create a C</boot/grub/"
10204 "device.map> file first that contains the mapping between grub device names "
10205 "and Linux device names. It is usually sufficient to create a file "
10210 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1547
10213 " (hd0) /dev/vda\n"
10218 #: ../src/guestfs-actions.pod:2326 ../fish/guestfish-actions.pod:1549
10219 msgid "replacing C</dev/vda> with the name of the installation device."
10223 #: ../src/guestfs-actions.pod:2330
10224 msgid "(Added in 1.0.17)"
10228 #: ../src/guestfs-actions.pod:2332
10229 msgid "guestfs_head"
10233 #: ../src/guestfs-actions.pod:2334
10237 " guestfs_head (guestfs_h *g,\n"
10238 " const char *path);\n"
10243 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1555
10245 "This command returns up to the first 10 lines of a file as a list of strings."
10249 #: ../src/guestfs-actions.pod:2350
10250 msgid "guestfs_head_n"
10254 #: ../src/guestfs-actions.pod:2352
10258 " guestfs_head_n (guestfs_h *g,\n"
10260 " const char *path);\n"
10265 #: ../src/guestfs-actions.pod:2357 ../fish/guestfish-actions.pod:1565
10267 "If the parameter C<nrlines> is a positive number, this returns the first "
10268 "C<nrlines> lines of the file C<path>."
10272 #: ../src/guestfs-actions.pod:2360 ../fish/guestfish-actions.pod:1568
10274 "If the parameter C<nrlines> is a negative number, this returns lines from "
10275 "the file C<path>, excluding the last C<nrlines> lines."
10279 #: ../src/guestfs-actions.pod:2363 ../src/guestfs-actions.pod:6953
10280 #: ../fish/guestfish-actions.pod:1571 ../fish/guestfish-actions.pod:4616
10281 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10285 #: ../src/guestfs-actions.pod:2374
10286 msgid "guestfs_hexdump"
10290 #: ../src/guestfs-actions.pod:2376
10294 " guestfs_hexdump (guestfs_h *g,\n"
10295 " const char *path);\n"
10300 #: ../src/guestfs-actions.pod:2380 ../fish/guestfish-actions.pod:1580
10302 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10303 "readable, canonical hex dump of the file."
10307 #: ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:6737
10308 #: ../src/guestfs-actions.pod:6792
10309 msgid "(Added in 1.0.22)"
10313 #: ../src/guestfs-actions.pod:2391
10314 msgid "guestfs_initrd_cat"
10318 #: ../src/guestfs-actions.pod:2393
10322 " guestfs_initrd_cat (guestfs_h *g,\n"
10323 " const char *initrdpath,\n"
10324 " const char *filename,\n"
10325 " size_t *size_r);\n"
10330 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1590
10332 "This command unpacks the file C<filename> from the initrd file called "
10333 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10338 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1594
10340 "For example, in guestfish you could use the following command to examine the "
10341 "boot script (usually called C</init>) contained in a Linux initrd or "
10346 #: ../src/guestfs-actions.pod:2407 ../fish/guestfish-actions.pod:1598
10349 " initrd-cat /boot/initrd-<version>.img init\n"
10354 #: ../src/guestfs-actions.pod:2409
10355 msgid "See also C<guestfs_initrd_list>."
10359 #: ../src/guestfs-actions.pod:2420
10360 msgid "guestfs_initrd_list"
10364 #: ../src/guestfs-actions.pod:2422
10368 " guestfs_initrd_list (guestfs_h *g,\n"
10369 " const char *path);\n"
10374 #: ../src/guestfs-actions.pod:2426 ../fish/guestfish-actions.pod:1609
10375 msgid "This command lists out files contained in an initrd."
10379 #: ../src/guestfs-actions.pod:2428 ../fish/guestfish-actions.pod:1611
10381 "The files are listed without any initial C</> character. The files are "
10382 "listed in the order they appear (not necessarily alphabetical). Directory "
10383 "names are listed as separate items."
10387 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1615
10389 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10390 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10395 #: ../src/guestfs-actions.pod:2442
10396 msgid "guestfs_inotify_add_watch"
10400 #: ../src/guestfs-actions.pod:2444
10404 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10405 " const char *path,\n"
10411 #: ../src/guestfs-actions.pod:2449 ../fish/guestfish-actions.pod:1623
10412 msgid "Watch C<path> for the events listed in C<mask>."
10416 #: ../src/guestfs-actions.pod:2451 ../fish/guestfish-actions.pod:1625
10418 "Note that if C<path> is a directory then events within that directory are "
10419 "watched, but this does I<not> happen recursively (in subdirectories)."
10423 #: ../src/guestfs-actions.pod:2455 ../fish/guestfish-actions.pod:1629
10425 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10426 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10430 #: ../src/guestfs-actions.pod:2463
10431 msgid "guestfs_inotify_close"
10435 #: ../src/guestfs-actions.pod:2465
10439 " guestfs_inotify_close (guestfs_h *g);\n"
10444 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1637
10446 "This closes the inotify handle which was previously opened by inotify_init. "
10447 "It removes all watches, throws away any pending events, and deallocates all "
10452 #: ../src/guestfs-actions.pod:2476
10453 msgid "guestfs_inotify_files"
10457 #: ../src/guestfs-actions.pod:2478
10461 " guestfs_inotify_files (guestfs_h *g);\n"
10466 #: ../src/guestfs-actions.pod:2481
10468 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10469 "returns a list of pathnames of objects that were touched. The returned "
10470 "pathnames are sorted and deduplicated."
10474 #: ../src/guestfs-actions.pod:2491
10475 msgid "guestfs_inotify_init"
10479 #: ../src/guestfs-actions.pod:2493
10483 " guestfs_inotify_init (guestfs_h *g,\n"
10484 " int maxevents);\n"
10489 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1653
10491 "This command creates a new inotify handle. The inotify subsystem can be "
10492 "used to notify events which happen to objects in the guest filesystem."
10496 #: ../src/guestfs-actions.pod:2501
10498 "C<maxevents> is the maximum number of events which will be queued up between "
10499 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10500 "passed as C<0>, then the kernel (or previously set) default is used. For "
10501 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10502 "throws away events, but records the fact that it threw them away by setting "
10503 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10504 "C<guestfs_inotify_read>)."
10508 #: ../src/guestfs-actions.pod:2511
10510 "Before any events are generated, you have to add some watches to the "
10511 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10512 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10516 #: ../src/guestfs-actions.pod:2517
10518 "Queued up events should be read periodically by calling "
10519 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10520 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10521 "often enough then you risk the internal queue overflowing."
10525 #: ../src/guestfs-actions.pod:2524
10527 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10528 "This also removes any watches automatically."
10532 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1684
10534 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10535 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10536 "that there is one global inotify handle per libguestfs instance."
10540 #: ../src/guestfs-actions.pod:2537
10541 msgid "guestfs_inotify_read"
10545 #: ../src/guestfs-actions.pod:2539
10548 " struct guestfs_inotify_event_list *\n"
10549 " guestfs_inotify_read (guestfs_h *g);\n"
10554 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1693
10556 "Return the complete queue of events that have happened since the previous "
10561 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1696
10562 msgid "If no events have happened, this returns an empty list."
10566 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1698
10568 "I<Note>: In order to make sure that all events have been read, you must call "
10569 "this function repeatedly until it returns an empty list. The reason is that "
10570 "the call will read events up to the maximum appliance-to-host message size "
10571 "and leave remaining events in the queue."
10575 #: ../src/guestfs-actions.pod:2553
10577 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10578 "there was an error. I<The caller must call "
10579 "C<guestfs_free_inotify_event_list> after use>."
10583 #: ../src/guestfs-actions.pod:2559
10584 msgid "guestfs_inotify_rm_watch"
10588 #: ../src/guestfs-actions.pod:2561
10592 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10598 #: ../src/guestfs-actions.pod:2565
10600 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10604 #: ../src/guestfs-actions.pod:2572
10605 msgid "guestfs_inspect_get_arch"
10609 #: ../src/guestfs-actions.pod:2574
10613 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10614 " const char *root);\n"
10619 #: ../src/guestfs-actions.pod:2578
10621 "This returns the architecture of the inspected operating system. The "
10622 "possible return values are listed under C<guestfs_file_architecture>."
10626 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1719
10628 "If the architecture could not be determined, then the string C<unknown> is "
10633 #: ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2675
10634 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2798
10635 #: ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:3012
10636 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3061
10637 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3154
10638 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3194
10639 #: ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3227
10640 #: ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3347
10641 #: ../src/guestfs-actions.pod:3388 ../fish/guestfish-actions.pod:1722
10642 #: ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1884
10643 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1980
10644 #: ../fish/guestfish-actions.pod:2041 ../fish/guestfish-actions.pod:2062
10645 #: ../fish/guestfish-actions.pod:2076 ../fish/guestfish-actions.pod:2116
10646 #: ../fish/guestfish-actions.pod:2148 ../fish/guestfish-actions.pod:2161
10647 #: ../fish/guestfish-actions.pod:2174 ../fish/guestfish-actions.pod:2184
10648 #: ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2206
10649 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2336
10650 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10654 #: ../src/guestfs-actions.pod:2592
10655 msgid "guestfs_inspect_get_distro"
10659 #: ../src/guestfs-actions.pod:2594
10663 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10664 " const char *root);\n"
10669 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1728
10671 "This returns the distro (distribution) of the inspected operating system."
10675 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1731
10676 msgid "Currently defined distros are:"
10680 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1735
10681 msgid "\"archlinux\""
10682 msgstr "\"archlinux\""
10685 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1737
10686 msgid "Arch Linux."
10687 msgstr "Arch Linux."
10690 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1739
10692 #| msgid "\"gentoo\""
10694 msgstr "\"gentoo\""
10697 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1741
10702 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1743
10704 msgstr "\"debian\""
10707 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1745
10712 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1747
10714 msgstr "\"fedora\""
10717 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1749
10722 #: ../src/guestfs-actions.pod:2621 ../fish/guestfish-actions.pod:1751
10724 msgstr "\"gentoo\""
10727 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1753
10732 #: ../src/guestfs-actions.pod:2625 ../fish/guestfish-actions.pod:1755
10733 msgid "\"linuxmint\""
10734 msgstr "\"linuxmint\""
10737 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1757
10738 msgid "Linux Mint."
10739 msgstr "Linux Mint."
10742 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1759
10743 msgid "\"mandriva\""
10744 msgstr "\"mandriva\""
10747 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1761
10752 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1763
10757 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1765
10762 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1767
10764 msgstr "\"pardus\""
10767 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1769
10772 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1771
10773 msgid "\"redhat-based\""
10774 msgstr "\"redhat-based\""
10777 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1773
10778 msgid "Some Red Hat-derived distro."
10779 msgstr "Дистрибутив, що походить від Red Hat."
10782 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1775
10787 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1777
10789 #| msgid "Red Hat Enterprise Linux and some derivatives."
10790 msgid "Red Hat Enterprise Linux."
10791 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10794 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1779
10795 msgid "\"scientificlinux\""
10799 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1781
10800 msgid "Scientific Linux."
10804 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1783
10805 msgid "\"slackware\""
10809 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1785
10814 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1787
10816 msgstr "\"ubuntu\""
10819 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1789
10824 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2770
10825 #: ../src/guestfs-actions.pod:3145 ../fish/guestfish-actions.pod:1791
10826 #: ../fish/guestfish-actions.pod:1875 ../fish/guestfish-actions.pod:2139
10827 msgid "\"unknown\""
10828 msgstr "\"unknown\""
10831 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1793
10832 msgid "The distro could not be determined."
10833 msgstr "Дистрибутив, тип якого не вдалося визначити."
10836 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:3137
10837 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:2131
10838 msgid "\"windows\""
10839 msgstr "\"windows\""
10842 #: ../src/guestfs-actions.pod:2667 ../fish/guestfish-actions.pod:1797
10844 "Windows does not have distributions. This string is returned if the OS type "
10849 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2776
10850 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1802
10851 #: ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
10853 "Future versions of libguestfs may return other strings here. The caller "
10854 "should be prepared to handle any string."
10858 #: ../src/guestfs-actions.pod:2682
10859 msgid "guestfs_inspect_get_drive_mappings"
10863 #: ../src/guestfs-actions.pod:2684
10867 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10868 " const char *root);\n"
10873 #: ../src/guestfs-actions.pod:2688 ../fish/guestfish-actions.pod:1811
10875 "This call is useful for Windows which uses a primitive system of assigning "
10876 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10877 "Windows Registry to find out how disks/partitions are mapped to drive "
10878 "letters, and returns a hash table as in the example below:"
10882 #: ../src/guestfs-actions.pod:2694 ../fish/guestfish-actions.pod:1817
10885 " C => /dev/vda2\n"
10886 " E => /dev/vdb1\n"
10887 " F => /dev/vdc1\n"
10892 #: ../src/guestfs-actions.pod:2698 ../fish/guestfish-actions.pod:1821
10894 "Note that keys are drive letters. For Windows, the key is case insensitive "
10895 "and just contains the drive letter, without the customary colon separator "
10900 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1825
10902 "In future we may support other operating systems that also used drive "
10903 "letters, but the keys for those might not be case insensitive and might be "
10904 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10909 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1830
10911 "For Windows guests, currently only hard drive mappings are returned. "
10912 "Removable disks (eg. DVD-ROMs) are ignored."
10916 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1833
10918 "For guests that do not use drive mappings, or if the drive mappings could "
10919 "not be determined, this returns an empty hash table."
10923 #: ../src/guestfs-actions.pod:2713
10925 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10926 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10930 #: ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2985
10931 #: ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:5065
10932 #: ../src/guestfs-actions.pod:7094
10934 "This function returns a NULL-terminated array of strings, or NULL if there "
10935 "was an error. The array of strings will always have length C<2n+1>, where "
10936 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10937 "caller must free the strings and the array after use>."
10941 #: ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:3179
10942 msgid "(Added in 1.9.17)"
10946 #: ../src/guestfs-actions.pod:2725
10947 msgid "guestfs_inspect_get_filesystems"
10951 #: ../src/guestfs-actions.pod:2727
10955 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10956 " const char *root);\n"
10961 #: ../src/guestfs-actions.pod:2731 ../fish/guestfish-actions.pod:1844
10963 "This returns a list of all the filesystems that we think are associated with "
10964 "this operating system. This includes the root filesystem, other ordinary "
10965 "filesystems, and non-mounted devices like swap partitions."
10969 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1849
10971 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10972 "to be shared between operating systems."
10976 #: ../src/guestfs-actions.pod:2739
10978 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10979 "C<guestfs_inspect_get_mountpoints>."
10983 #: ../src/guestfs-actions.pod:2748
10984 msgid "guestfs_inspect_get_format"
10988 #: ../src/guestfs-actions.pod:2750
10992 " guestfs_inspect_get_format (guestfs_h *g,\n"
10993 " const char *root);\n"
10998 #: ../src/guestfs-actions.pod:2754 ../fish/guestfish-actions.pod:1859
11000 "This returns the format of the inspected operating system. You can use it "
11001 "to detect install images, live CDs and similar."
11005 #: ../src/guestfs-actions.pod:2757 ../fish/guestfish-actions.pod:1862
11006 msgid "Currently defined formats are:"
11010 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1866
11011 msgid "\"installed\""
11012 msgstr "\"installed\""
11015 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1868
11016 msgid "This is an installed operating system."
11017 msgstr "Це встановлена операційна система."
11020 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1870
11021 msgid "\"installer\""
11025 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1872
11027 "The disk image being inspected is not an installed operating system, but a "
11028 "I<bootable> install disk, live CD, or similar."
11032 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1877
11033 msgid "The format of this disk image is not known."
11037 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:3215
11038 #: ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3249
11039 #: ../src/guestfs-actions.pod:6009
11040 msgid "(Added in 1.9.4)"
11044 #: ../src/guestfs-actions.pod:2786
11045 msgid "guestfs_inspect_get_hostname"
11049 #: ../src/guestfs-actions.pod:2788
11053 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11054 " const char *root);\n"
11059 #: ../src/guestfs-actions.pod:2792 ../fish/guestfish-actions.pod:1890
11061 "This function returns the hostname of the operating system as found by "
11062 "inspection of the guest's configuration files."
11066 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1893
11068 "If the hostname could not be determined, then the string C<unknown> is "
11073 #: ../src/guestfs-actions.pod:2803
11074 msgid "(Added in 1.7.9)"
11078 #: ../src/guestfs-actions.pod:2805
11079 msgid "guestfs_inspect_get_icon"
11083 #: ../src/guestfs-actions.pod:2807
11087 " guestfs_inspect_get_icon (guestfs_h *g,\n"
11088 " const char *root,\n"
11089 " size_t *size_r,\n"
11095 #: ../src/guestfs-actions.pod:2818
11098 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
11099 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
11104 #: ../src/guestfs-actions.pod:2821 ../fish/guestfish-actions.pod:1902
11106 "This function returns an icon corresponding to the inspected operating "
11107 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
11108 "to PNG if necessary)."
11112 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1906
11114 "If it was not possible to get an icon this function returns a zero-length "
11115 "(non-NULL) buffer. I<Callers must check for this case>."
11119 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1909
11121 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11122 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11123 "this file will be returned. You can disable favicons by passing the "
11124 "optional C<favicon> boolean as false (default is true)."
11128 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1915
11130 "If finding the favicon fails, then we look in other places in the guest for "
11135 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1918
11137 "If the optional C<highquality> boolean is true then only high quality icons "
11138 "are returned, which means only icons of high resolution with an alpha "
11139 "channel. The default (false) is to return any icon we can, even if it is of "
11140 "substandard quality."
11144 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1929
11146 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11147 "before you call this, since it needs to read information from the guest "
11148 "filesystem during the call."
11152 #: ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1935
11154 "B<Security:> The icon data comes from the untrusted guest, and should be "
11155 "treated with caution. PNG files have been known to contain exploits. "
11156 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11157 "trying to process or display the icon."
11161 #: ../src/guestfs-actions.pod:2862 ../fish/guestfish-actions.pod:1943
11163 "The PNG image returned can be any size. It might not be square. Libguestfs "
11164 "tries to return the largest, highest quality icon available. The "
11165 "application must scale the icon to the required size."
11169 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1950
11171 "Extracting icons from Windows guests requires the external C<wrestool> "
11172 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11173 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11174 "installed separately."
11178 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1957
11180 "Operating system icons are usually trademarks. Seek legal advice before "
11181 "using trademarks in applications."
11185 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:3710
11186 #: ../src/guestfs-actions.pod:4964
11187 msgid "(Added in 1.11.12)"
11191 #: ../src/guestfs-actions.pod:2887
11192 msgid "guestfs_inspect_get_icon_va"
11196 #: ../src/guestfs-actions.pod:2889
11200 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11201 " const char *root,\n"
11202 " size_t *size_r,\n"
11203 " va_list args);\n"
11208 #: ../src/guestfs-actions.pod:2895
11209 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11213 #: ../src/guestfs-actions.pod:2899
11214 msgid "guestfs_inspect_get_icon_argv"
11218 #: ../src/guestfs-actions.pod:2901
11222 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11223 " const char *root,\n"
11224 " size_t *size_r,\n"
11225 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11230 #: ../src/guestfs-actions.pod:2907
11231 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11235 #: ../src/guestfs-actions.pod:2911
11236 msgid "guestfs_inspect_get_major_version"
11240 #: ../src/guestfs-actions.pod:2913
11244 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11245 " const char *root);\n"
11250 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:1968
11252 "This returns the major version number of the inspected operating system."
11256 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:1971
11258 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11259 "popular public names used by the operating system. Notably the operating "
11260 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11261 "1). You can find out the real versions corresponding to releases of Windows "
11262 "by consulting Wikipedia or MSDN."
11266 #: ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:2944
11267 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1989
11268 msgid "If the version could not be determined, then C<0> is returned."
11272 #: ../src/guestfs-actions.pod:2935
11273 msgid "guestfs_inspect_get_minor_version"
11277 #: ../src/guestfs-actions.pod:2937
11281 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11282 " const char *root);\n"
11287 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:1986
11289 "This returns the minor version number of the inspected operating system."
11293 #: ../src/guestfs-actions.pod:2946
11295 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11296 "C<guestfs_inspect_get_major_version>."
11300 #: ../src/guestfs-actions.pod:2953
11301 msgid "guestfs_inspect_get_mountpoints"
11305 #: ../src/guestfs-actions.pod:2955
11309 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11310 " const char *root);\n"
11315 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:1998
11317 "This returns a hash of where we think the filesystems associated with this "
11318 "operating system should be mounted. Callers should note that this is at "
11319 "best an educated guess made by reading configuration files such as C</etc/"
11320 "fstab>. I<In particular note> that this may return filesystems which are "
11321 "non-existent or not mountable and callers should be prepared to handle or "
11322 "ignore failures if they try to mount them."
11326 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2007
11328 "Each element in the returned hashtable has a key which is the path of the "
11329 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11330 "mounted there (eg. C</dev/sda1>)."
11334 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2012
11336 "Non-mounted devices such as swap devices are I<not> returned in this list."
11340 #: ../src/guestfs-actions.pod:2976
11342 "For operating systems like Windows which still use drive letters, this call "
11343 "will only return an entry for the first drive \"mounted on\" C</>. For "
11344 "information about the mapping of drive letters to partitions, see "
11345 "C<guestfs_inspect_get_drive_mappings>."
11349 #: ../src/guestfs-actions.pod:2982
11351 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11352 "C<guestfs_inspect_get_filesystems>."
11356 #: ../src/guestfs-actions.pod:2993
11357 msgid "guestfs_inspect_get_package_format"
11361 #: ../src/guestfs-actions.pod:2995
11365 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11366 " const char *root);\n"
11371 #: ../src/guestfs-actions.pod:2999
11373 "This function and C<guestfs_inspect_get_package_management> return the "
11374 "package format and package management tool used by the inspected operating "
11375 "system. For example for Fedora these functions would return C<rpm> (package "
11376 "format) and C<yum> (package management)."
11380 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2034
11382 "This returns the string C<unknown> if we could not determine the package "
11383 "format I<or> if the operating system does not have a real packaging system "
11388 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2038
11390 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11391 "Future versions of libguestfs may return other strings."
11395 #: ../src/guestfs-actions.pod:3017 ../src/guestfs-actions.pod:3045
11396 msgid "(Added in 1.7.5)"
11400 #: ../src/guestfs-actions.pod:3019
11401 msgid "guestfs_inspect_get_package_management"
11405 #: ../src/guestfs-actions.pod:3021
11409 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11410 " const char *root);\n"
11415 #: ../src/guestfs-actions.pod:3025
11417 "C<guestfs_inspect_get_package_format> and this function return the package "
11418 "format and package management tool used by the inspected operating system. "
11419 "For example for Fedora these functions would return C<rpm> (package format) "
11420 "and C<yum> (package management)."
11424 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2053
11426 "This returns the string C<unknown> if we could not determine the package "
11427 "management tool I<or> if the operating system does not have a real packaging "
11428 "system (eg. Windows)."
11432 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2057
11434 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11435 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11436 "libguestfs may return other strings."
11440 #: ../src/guestfs-actions.pod:3047
11441 msgid "guestfs_inspect_get_product_name"
11445 #: ../src/guestfs-actions.pod:3049
11449 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11450 " const char *root);\n"
11455 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2068
11457 "This returns the product name of the inspected operating system. The "
11458 "product name is generally some freeform string which can be displayed to the "
11459 "user, but should not be parsed by programs."
11463 #: ../src/guestfs-actions.pod:3058 ../fish/guestfish-actions.pod:2073
11465 "If the product name could not be determined, then the string C<unknown> is "
11470 #: ../src/guestfs-actions.pod:3068
11471 msgid "guestfs_inspect_get_product_variant"
11475 #: ../src/guestfs-actions.pod:3070
11479 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11480 " const char *root);\n"
11485 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2082
11487 #| msgid "This is an installed operating system."
11488 msgid "This returns the product variant of the inspected operating system."
11489 msgstr "Це встановлена операційна система."
11492 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2085
11494 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11495 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11496 "is usually a string such as C<Client> or C<Server> (other values are "
11497 "possible). This can be used to distinguish consumer and enterprise versions "
11498 "of Windows that have the same version number (for example, Windows 7 and "
11499 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11500 "the latter is C<Server>)."
11504 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2094
11506 "For enterprise Linux guests, in future we intend this to return the product "
11507 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11508 "implemented at present."
11512 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2098
11514 "If the product variant could not be determined, then the string C<unknown> "
11519 #: ../src/guestfs-actions.pod:3093
11521 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11522 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11526 #: ../src/guestfs-actions.pod:3100
11527 msgid "(Added in 1.9.13)"
11531 #: ../src/guestfs-actions.pod:3102
11532 msgid "guestfs_inspect_get_roots"
11536 #: ../src/guestfs-actions.pod:3104
11540 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11545 #: ../src/guestfs-actions.pod:3107
11547 "This function is a convenient way to get the list of root devices, as "
11548 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11549 "the whole inspection process."
11553 #: ../src/guestfs-actions.pod:3111
11555 "This returns an empty list if either no root devices were found or the "
11556 "caller has not called C<guestfs_inspect_os>."
11560 #: ../src/guestfs-actions.pod:3120
11561 msgid "(Added in 1.7.3)"
11565 #: ../src/guestfs-actions.pod:3122
11566 msgid "guestfs_inspect_get_type"
11570 #: ../src/guestfs-actions.pod:3124
11574 " guestfs_inspect_get_type (guestfs_h *g,\n"
11575 " const char *root);\n"
11580 #: ../src/guestfs-actions.pod:3128 ../fish/guestfish-actions.pod:2122
11582 "This returns the type of the inspected operating system. Currently defined "
11587 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2127
11592 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2129
11593 msgid "Any Linux-based operating system."
11597 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2133
11598 msgid "Any Microsoft Windows operating system."
11602 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2135
11603 msgid "\"freebsd\""
11604 msgstr "\"freebsd\""
11607 #: ../src/guestfs-actions.pod:3143 ../fish/guestfish-actions.pod:2137
11612 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2141
11613 msgid "The operating system type could not be determined."
11617 #: ../src/guestfs-actions.pod:3161
11618 msgid "guestfs_inspect_get_windows_current_control_set"
11622 #: ../src/guestfs-actions.pod:3163
11626 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11627 " const char *root);\n"
11632 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2154
11634 "This returns the Windows CurrentControlSet of the inspected guest. The "
11635 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11639 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2157
11641 "This call assumes that the guest is Windows and that the Registry could be "
11642 "examined by inspection. If this is not the case then an error is returned."
11646 #: ../src/guestfs-actions.pod:3181
11647 msgid "guestfs_inspect_get_windows_systemroot"
11651 #: ../src/guestfs-actions.pod:3183
11655 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11656 " const char *root);\n"
11661 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2167
11663 "This returns the Windows systemroot of the inspected guest. The systemroot "
11664 "is a directory path such as C</WINDOWS>."
11668 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2170
11670 "This call assumes that the guest is Windows and that the systemroot could be "
11671 "determined by inspection. If this is not the case then an error is returned."
11675 #: ../src/guestfs-actions.pod:3199
11676 msgid "(Added in 1.5.25)"
11680 #: ../src/guestfs-actions.pod:3201
11681 msgid "guestfs_inspect_is_live"
11685 #: ../src/guestfs-actions.pod:3203
11689 " guestfs_inspect_is_live (guestfs_h *g,\n"
11690 " const char *root);\n"
11695 #: ../src/guestfs-actions.pod:3207
11697 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11698 "disk), then this returns true if a live image was detected on the disk."
11702 #: ../src/guestfs-actions.pod:3217
11703 msgid "guestfs_inspect_is_multipart"
11707 #: ../src/guestfs-actions.pod:3219
11711 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11712 " const char *root);\n"
11717 #: ../src/guestfs-actions.pod:3223
11719 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11720 "disk), then this returns true if the disk is part of a set."
11724 #: ../src/guestfs-actions.pod:3233
11725 msgid "guestfs_inspect_is_netinst"
11729 #: ../src/guestfs-actions.pod:3235
11733 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11734 " const char *root);\n"
11739 #: ../src/guestfs-actions.pod:3239
11741 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11742 "disk), then this returns true if the disk is a network installer, ie. not a "
11743 "self-contained install CD but one which is likely to require network access "
11744 "to complete the install."
11748 #: ../src/guestfs-actions.pod:3251
11749 msgid "guestfs_inspect_list_applications"
11753 #: ../src/guestfs-actions.pod:3253
11756 " struct guestfs_application_list *\n"
11757 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11758 " const char *root);\n"
11763 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2212
11764 msgid "Return the list of applications installed in the operating system."
11768 #: ../src/guestfs-actions.pod:3259
11770 "I<Note:> This call works differently from other parts of the inspection "
11771 "API. You have to call C<guestfs_inspect_os>, then "
11772 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11773 "this. Listing applications is a significantly more difficult operation "
11774 "which requires access to the full filesystem. Also note that unlike the "
11775 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11776 "the libguestfs handle, this call actually reads parts of the mounted "
11777 "filesystems during the call."
11781 #: ../src/guestfs-actions.pod:3269 ../fish/guestfish-actions.pod:2224
11783 "This returns an empty list if the inspection code was not able to determine "
11784 "the list of applications."
11788 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2227
11789 msgid "The application structure contains the following fields:"
11793 #: ../src/guestfs-actions.pod:3276 ../fish/guestfish-actions.pod:2231
11794 msgid "C<app_name>"
11795 msgstr "C<app_name>"
11798 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2233
11800 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11801 "guests, this is the package name."
11805 #: ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:2236
11806 msgid "C<app_display_name>"
11807 msgstr "C<app_display_name>"
11810 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2238
11812 "The display name of the application, sometimes localized to the install "
11813 "language of the guest operating system."
11817 #: ../src/guestfs-actions.pod:3286 ../fish/guestfish-actions.pod:2241
11819 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11820 "to display something can use C<app_name> instead."
11824 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2244
11825 msgid "C<app_epoch>"
11826 msgstr "C<app_epoch>"
11829 #: ../src/guestfs-actions.pod:3291 ../fish/guestfish-actions.pod:2246
11831 "For package managers which use epochs, this contains the epoch of the "
11832 "package (an integer). If unavailable, this is returned as C<0>."
11836 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2249
11837 msgid "C<app_version>"
11838 msgstr "C<app_version>"
11841 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2251
11843 "The version string of the application or package. If unavailable this is "
11844 "returned as an empty string C<\"\">."
11848 #: ../src/guestfs-actions.pod:3299 ../fish/guestfish-actions.pod:2254
11849 msgid "C<app_release>"
11850 msgstr "C<app_release>"
11853 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2256
11855 "The release string of the application or package, for package managers that "
11856 "use this. If unavailable this is returned as an empty string C<\"\">."
11860 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2260
11861 msgid "C<app_install_path>"
11862 msgstr "C<app_install_path>"
11865 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2262
11867 "The installation path of the application (on operating systems such as "
11868 "Windows which use installation paths). This path is in the format used by "
11869 "the guest operating system, it is not a libguestfs path."
11873 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2267
11874 msgid "If unavailable this is returned as an empty string C<\"\">."
11878 #: ../src/guestfs-actions.pod:3314 ../fish/guestfish-actions.pod:2269
11879 msgid "C<app_trans_path>"
11880 msgstr "C<app_trans_path>"
11883 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2271
11885 "The install path translated into a libguestfs path. If unavailable this is "
11886 "returned as an empty string C<\"\">."
11890 #: ../src/guestfs-actions.pod:3319 ../fish/guestfish-actions.pod:2274
11891 msgid "C<app_publisher>"
11892 msgstr "C<app_publisher>"
11895 #: ../src/guestfs-actions.pod:3321 ../fish/guestfish-actions.pod:2276
11897 "The name of the publisher of the application, for package managers that use "
11898 "this. If unavailable this is returned as an empty string C<\"\">."
11902 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2280
11904 msgstr "C<app_url>"
11907 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2282
11909 "The URL (eg. upstream URL) of the application. If unavailable this is "
11910 "returned as an empty string C<\"\">."
11914 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2285
11915 msgid "C<app_source_package>"
11919 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2287
11921 "For packaging systems which support this, the name of the source package. "
11922 "If unavailable this is returned as an empty string C<\"\">."
11926 #: ../src/guestfs-actions.pod:3335 ../fish/guestfish-actions.pod:2290
11927 msgid "C<app_summary>"
11931 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2292
11933 "A short (usually one line) description of the application or package. If "
11934 "unavailable this is returned as an empty string C<\"\">."
11938 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2295
11939 msgid "C<app_description>"
11943 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2297
11945 "A longer description of the application or package. If unavailable this is "
11946 "returned as an empty string C<\"\">."
11950 #: ../src/guestfs-actions.pod:3349
11952 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11953 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11958 #: ../src/guestfs-actions.pod:3353
11959 msgid "(Added in 1.7.8)"
11963 #: ../src/guestfs-actions.pod:3355
11964 msgid "guestfs_inspect_os"
11968 #: ../src/guestfs-actions.pod:3357
11972 " guestfs_inspect_os (guestfs_h *g);\n"
11977 #: ../src/guestfs-actions.pod:3360 ../fish/guestfish-actions.pod:2308
11979 "This function uses other libguestfs functions and certain heuristics to "
11980 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11981 "for operating systems."
11985 #: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2312
11986 msgid "The list returned is empty if no operating systems were found."
11990 #: ../src/guestfs-actions.pod:3366 ../fish/guestfish-actions.pod:2314
11992 "If one operating system was found, then this returns a list with a single "
11993 "element, which is the name of the root filesystem of this operating system. "
11994 "It is also possible for this function to return a list containing more than "
11995 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11996 "element being the root filesystem of one of the operating systems."
12000 #: ../src/guestfs-actions.pod:3373
12002 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12003 "functions in order to query further information about each operating system, "
12004 "such as the name and version."
12008 #: ../src/guestfs-actions.pod:3378
12010 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12011 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12012 "the contents. This should be called with no disks currently mounted. The "
12013 "function may also use Augeas, so any existing Augeas handle will be closed."
12017 #: ../src/guestfs-actions.pod:3384 ../fish/guestfish-actions.pod:2332
12019 "This function cannot decrypt encrypted disks. The caller must do that first "
12020 "(supplying the necessary keys) if the disk is encrypted."
12024 #: ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3721
12025 #: ../src/guestfs-actions.pod:3803
12026 msgid "See also C<guestfs_list_filesystems>."
12030 #: ../src/guestfs-actions.pod:3398
12031 msgid "guestfs_is_blockdev"
12035 #: ../src/guestfs-actions.pod:3400
12039 " guestfs_is_blockdev (guestfs_h *g,\n"
12040 " const char *path);\n"
12045 #: ../src/guestfs-actions.pod:3404 ../fish/guestfish-actions.pod:2344
12047 "This returns C<true> if and only if there is a block device with the given "
12052 #: ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3436
12053 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3481
12054 #: ../src/guestfs-actions.pod:3497 ../src/guestfs-actions.pod:3553
12055 #: ../src/guestfs-actions.pod:3568
12056 msgid "See also C<guestfs_stat>."
12060 #: ../src/guestfs-actions.pod:3411 ../src/guestfs-actions.pod:3440
12061 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3557
12062 #: ../src/guestfs-actions.pod:3572
12063 msgid "(Added in 1.5.10)"
12067 #: ../src/guestfs-actions.pod:3413
12068 msgid "guestfs_is_busy"
12072 #: ../src/guestfs-actions.pod:3415
12076 " guestfs_is_busy (guestfs_h *g);\n"
12081 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2353
12083 "This returns true iff this handle is busy processing a command (in the "
12088 #: ../src/guestfs-actions.pod:3427
12089 msgid "guestfs_is_chardev"
12093 #: ../src/guestfs-actions.pod:3429
12097 " guestfs_is_chardev (guestfs_h *g,\n"
12098 " const char *path);\n"
12103 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2362
12105 "This returns C<true> if and only if there is a character device with the "
12106 "given C<path> name."
12110 #: ../src/guestfs-actions.pod:3442
12111 msgid "guestfs_is_config"
12115 #: ../src/guestfs-actions.pod:3444
12119 " guestfs_is_config (guestfs_h *g);\n"
12124 #: ../src/guestfs-actions.pod:3447 ../fish/guestfish-actions.pod:2371
12126 "This returns true iff this handle is being configured (in the C<CONFIG> "
12131 #: ../src/guestfs-actions.pod:3456
12132 msgid "guestfs_is_dir"
12136 #: ../src/guestfs-actions.pod:3458
12140 " guestfs_is_dir (guestfs_h *g,\n"
12141 " const char *path);\n"
12146 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2380
12148 "This returns C<true> if and only if there is a directory with the given "
12149 "C<path> name. Note that it returns false for other objects like files."
12153 #: ../src/guestfs-actions.pod:3472
12154 msgid "guestfs_is_fifo"
12158 #: ../src/guestfs-actions.pod:3474
12162 " guestfs_is_fifo (guestfs_h *g,\n"
12163 " const char *path);\n"
12168 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2390
12170 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12171 "given C<path> name."
12175 #: ../src/guestfs-actions.pod:3487
12176 msgid "guestfs_is_file"
12180 #: ../src/guestfs-actions.pod:3489
12184 " guestfs_is_file (guestfs_h *g,\n"
12185 " const char *path);\n"
12190 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2399
12192 "This returns C<true> if and only if there is a regular file with the given "
12193 "C<path> name. Note that it returns false for other objects like directories."
12197 #: ../src/guestfs-actions.pod:3503
12198 msgid "guestfs_is_launching"
12202 #: ../src/guestfs-actions.pod:3505
12206 " guestfs_is_launching (guestfs_h *g);\n"
12211 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2409
12213 "This returns true iff this handle is launching the subprocess (in the "
12214 "C<LAUNCHING> state)."
12218 #: ../src/guestfs-actions.pod:3517
12219 msgid "guestfs_is_lv"
12223 #: ../src/guestfs-actions.pod:3519
12227 " guestfs_is_lv (guestfs_h *g,\n"
12228 " const char *device);\n"
12233 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2418
12235 "This command tests whether C<device> is a logical volume, and returns true "
12236 "iff this is the case."
12240 #: ../src/guestfs-actions.pod:3530
12241 msgid "guestfs_is_ready"
12245 #: ../src/guestfs-actions.pod:3532
12249 " guestfs_is_ready (guestfs_h *g);\n"
12254 #: ../src/guestfs-actions.pod:3535 ../fish/guestfish-actions.pod:2425
12256 "This returns true iff this handle is ready to accept commands (in the "
12261 #: ../src/guestfs-actions.pod:3544
12262 msgid "guestfs_is_socket"
12266 #: ../src/guestfs-actions.pod:3546
12270 " guestfs_is_socket (guestfs_h *g,\n"
12271 " const char *path);\n"
12276 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2434
12278 "This returns C<true> if and only if there is a Unix domain socket with the "
12279 "given C<path> name."
12283 #: ../src/guestfs-actions.pod:3559
12284 msgid "guestfs_is_symlink"
12288 #: ../src/guestfs-actions.pod:3561
12292 " guestfs_is_symlink (guestfs_h *g,\n"
12293 " const char *path);\n"
12298 #: ../src/guestfs-actions.pod:3565 ../fish/guestfish-actions.pod:2443
12300 "This returns C<true> if and only if there is a symbolic link with the given "
12305 #: ../src/guestfs-actions.pod:3574
12306 msgid "guestfs_is_zero"
12310 #: ../src/guestfs-actions.pod:3576
12314 " guestfs_is_zero (guestfs_h *g,\n"
12315 " const char *path);\n"
12320 #: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2452
12322 "This returns true iff the file exists and the file is empty or it contains "
12327 #: ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3599
12328 msgid "(Added in 1.11.8)"
12332 #: ../src/guestfs-actions.pod:3587
12333 msgid "guestfs_is_zero_device"
12337 #: ../src/guestfs-actions.pod:3589
12341 " guestfs_is_zero_device (guestfs_h *g,\n"
12342 " const char *device);\n"
12347 #: ../src/guestfs-actions.pod:3593 ../fish/guestfish-actions.pod:2459
12348 msgid "This returns true iff the device exists and contains all zero bytes."
12352 #: ../src/guestfs-actions.pod:3595 ../fish/guestfish-actions.pod:2461
12353 msgid "Note that for large devices this can take a long time to run."
12357 #: ../src/guestfs-actions.pod:3601
12358 msgid "guestfs_kill_subprocess"
12362 #: ../src/guestfs-actions.pod:3603
12366 " guestfs_kill_subprocess (guestfs_h *g);\n"
12371 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
12372 msgid "This kills the qemu subprocess. You should never need to call this."
12376 #: ../src/guestfs-actions.pod:3612
12377 msgid "guestfs_launch"
12381 #: ../src/guestfs-actions.pod:3614
12385 " guestfs_launch (guestfs_h *g);\n"
12390 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2475
12392 "Internally libguestfs is implemented by running a virtual machine using "
12397 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2478
12399 "You should call this after configuring the handle (eg. adding drives) but "
12400 "before performing any actions."
12404 #: ../src/guestfs-actions.pod:3632
12405 msgid "guestfs_lchown"
12409 #: ../src/guestfs-actions.pod:3634
12413 " guestfs_lchown (guestfs_h *g,\n"
12416 " const char *path);\n"
12421 #: ../src/guestfs-actions.pod:3640
12423 "Change the file owner to C<owner> and group to C<group>. This is like "
12424 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12425 "changed, not the target."
12429 #: ../src/guestfs-actions.pod:3652
12430 msgid "guestfs_lgetxattr"
12434 #: ../src/guestfs-actions.pod:3654
12438 " guestfs_lgetxattr (guestfs_h *g,\n"
12439 " const char *path,\n"
12440 " const char *name,\n"
12441 " size_t *size_r);\n"
12446 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2497
12448 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12449 "is a symlink, then this call returns an extended attribute from the symlink."
12453 #: ../src/guestfs-actions.pod:3674
12454 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12458 #: ../src/guestfs-actions.pod:3682
12459 msgid "guestfs_lgetxattrs"
12463 #: ../src/guestfs-actions.pod:3684
12466 " struct guestfs_xattr_list *\n"
12467 " guestfs_lgetxattrs (guestfs_h *g,\n"
12468 " const char *path);\n"
12473 #: ../src/guestfs-actions.pod:3688
12475 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12476 "then it returns the extended attributes of the link itself."
12480 #: ../src/guestfs-actions.pod:3698
12481 msgid "guestfs_list_9p"
12485 #: ../src/guestfs-actions.pod:3700
12489 " guestfs_list_9p (guestfs_h *g);\n"
12494 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2525
12496 "List all 9p filesystems attached to the guest. A list of mount tags is "
12501 #: ../src/guestfs-actions.pod:3712
12502 msgid "guestfs_list_devices"
12506 #: ../src/guestfs-actions.pod:3714
12510 " guestfs_list_devices (guestfs_h *g);\n"
12515 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2532
12516 msgid "List all the block devices."
12520 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2534
12521 msgid "The full block device names are returned, eg. C</dev/sda>."
12525 #: ../src/guestfs-actions.pod:3729
12526 msgid "guestfs_list_dm_devices"
12530 #: ../src/guestfs-actions.pod:3731
12534 " guestfs_list_dm_devices (guestfs_h *g);\n"
12539 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2542
12540 msgid "List all device mapper devices."
12544 #: ../src/guestfs-actions.pod:3736
12546 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12547 "previous call to C<guestfs_luks_open>."
12551 #: ../src/guestfs-actions.pod:3739
12553 "Device mapper devices which correspond to logical volumes are I<not> "
12554 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12559 #: ../src/guestfs-actions.pod:3747 ../src/guestfs-actions.pod:5203
12560 msgid "(Added in 1.11.15)"
12564 #: ../src/guestfs-actions.pod:3749
12565 msgid "guestfs_list_filesystems"
12569 #: ../src/guestfs-actions.pod:3751
12573 " guestfs_list_filesystems (guestfs_h *g);\n"
12578 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2555
12580 "This inspection command looks for filesystems on partitions, block devices "
12581 "and logical volumes, returning a list of devices containing filesystems and "
12586 #: ../src/guestfs-actions.pod:3758 ../fish/guestfish-actions.pod:2559
12588 "The return value is a hash, where the keys are the devices containing "
12589 "filesystems, and the values are the filesystem types. For example:"
12593 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2563
12596 " \"/dev/sda1\" => \"ntfs\"\n"
12597 " \"/dev/sda2\" => \"ext2\"\n"
12598 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12599 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12604 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2568
12606 "The value can have the special value \"unknown\", meaning the content of the "
12607 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12611 #: ../src/guestfs-actions.pod:3771
12613 "This command runs other libguestfs commands, which might include "
12614 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12615 "soon after launch and only when nothing is mounted."
12619 #: ../src/guestfs-actions.pod:3775
12621 "Not all of the filesystems returned will be mountable. In particular, swap "
12622 "partitions are returned in the list. Also this command does not check that "
12623 "each filesystem found is valid and mountable, and some filesystems might be "
12624 "mountable but require special options. Filesystems may not all belong to a "
12625 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12629 #: ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:5558
12630 msgid "(Added in 1.5.15)"
12634 #: ../src/guestfs-actions.pod:3791
12635 msgid "guestfs_list_partitions"
12639 #: ../src/guestfs-actions.pod:3793
12643 " guestfs_list_partitions (guestfs_h *g);\n"
12648 #: ../src/guestfs-actions.pod:3796 ../fish/guestfish-actions.pod:2588
12649 msgid "List all the partitions detected on all block devices."
12653 #: ../src/guestfs-actions.pod:3798 ../fish/guestfish-actions.pod:2590
12654 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12658 #: ../src/guestfs-actions.pod:3800
12660 "This does not return logical volumes. For that you will need to call "
12665 #: ../src/guestfs-actions.pod:3811
12670 #: ../src/guestfs-actions.pod:3813
12674 " guestfs_ll (guestfs_h *g,\n"
12675 " const char *directory);\n"
12680 #: ../src/guestfs-actions.pod:3817 ../fish/guestfish-actions.pod:2601
12682 "List the files in C<directory> (relative to the root directory, there is no "
12683 "cwd) in the format of 'ls -la'."
12687 #: ../src/guestfs-actions.pod:3820 ../fish/guestfish-actions.pod:2604
12689 "This command is mostly useful for interactive sessions. It is I<not> "
12690 "intended that you try to parse the output string."
12694 #: ../src/guestfs-actions.pod:3828
12699 #: ../src/guestfs-actions.pod:3830
12703 " guestfs_ln (guestfs_h *g,\n"
12704 " const char *target,\n"
12705 " const char *linkname);\n"
12710 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2611
12711 msgid "This command creates a hard link using the C<ln> command."
12715 #: ../src/guestfs-actions.pod:3841
12716 msgid "guestfs_ln_f"
12720 #: ../src/guestfs-actions.pod:3843
12724 " guestfs_ln_f (guestfs_h *g,\n"
12725 " const char *target,\n"
12726 " const char *linkname);\n"
12731 #: ../src/guestfs-actions.pod:3848 ../fish/guestfish-actions.pod:2617
12733 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12734 "option removes the link (C<linkname>) if it exists already."
12738 #: ../src/guestfs-actions.pod:3855
12739 msgid "guestfs_ln_s"
12743 #: ../src/guestfs-actions.pod:3857
12747 " guestfs_ln_s (guestfs_h *g,\n"
12748 " const char *target,\n"
12749 " const char *linkname);\n"
12754 #: ../src/guestfs-actions.pod:3862 ../fish/guestfish-actions.pod:2624
12755 msgid "This command creates a symbolic link using the C<ln -s> command."
12759 #: ../src/guestfs-actions.pod:3868
12760 msgid "guestfs_ln_sf"
12764 #: ../src/guestfs-actions.pod:3870
12768 " guestfs_ln_sf (guestfs_h *g,\n"
12769 " const char *target,\n"
12770 " const char *linkname);\n"
12775 #: ../src/guestfs-actions.pod:3875 ../fish/guestfish-actions.pod:2630
12777 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12778 "option removes the link (C<linkname>) if it exists already."
12782 #: ../src/guestfs-actions.pod:3882
12783 msgid "guestfs_lremovexattr"
12787 #: ../src/guestfs-actions.pod:3884
12791 " guestfs_lremovexattr (guestfs_h *g,\n"
12792 " const char *xattr,\n"
12793 " const char *path);\n"
12798 #: ../src/guestfs-actions.pod:3889
12800 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12801 "link, then it removes an extended attribute of the link itself."
12805 #: ../src/guestfs-actions.pod:3897
12810 #: ../src/guestfs-actions.pod:3899
12814 " guestfs_ls (guestfs_h *g,\n"
12815 " const char *directory);\n"
12820 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2645
12822 "List the files in C<directory> (relative to the root directory, there is no "
12823 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12827 #: ../src/guestfs-actions.pod:3907
12829 "This command is mostly useful for interactive sessions. Programs should "
12830 "probably use C<guestfs_readdir> instead."
12834 #: ../src/guestfs-actions.pod:3916
12835 msgid "guestfs_lsetxattr"
12839 #: ../src/guestfs-actions.pod:3918
12843 " guestfs_lsetxattr (guestfs_h *g,\n"
12844 " const char *xattr,\n"
12845 " const char *val,\n"
12847 " const char *path);\n"
12852 #: ../src/guestfs-actions.pod:3925
12854 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12855 "then it sets an extended attribute of the link itself."
12859 #: ../src/guestfs-actions.pod:3933
12860 msgid "guestfs_lstat"
12864 #: ../src/guestfs-actions.pod:3935
12867 " struct guestfs_stat *\n"
12868 " guestfs_lstat (guestfs_h *g,\n"
12869 " const char *path);\n"
12874 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:6693
12875 #: ../fish/guestfish-actions.pod:2664 ../fish/guestfish-actions.pod:4451
12876 msgid "Returns file information for the given C<path>."
12880 #: ../src/guestfs-actions.pod:3941
12882 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12883 "link, then the link is stat-ed, not the file it refers to."
12887 #: ../src/guestfs-actions.pod:3945 ../fish/guestfish-actions.pod:2670
12888 msgid "This is the same as the C<lstat(2)> system call."
12892 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:6697
12894 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12895 "error. I<The caller must call C<guestfs_free_stat> after use>."
12899 #: ../src/guestfs-actions.pod:3951 ../src/guestfs-actions.pod:6701
12900 #: ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:7100
12901 msgid "(Added in 0.9.2)"
12905 #: ../src/guestfs-actions.pod:3953
12906 msgid "guestfs_lstatlist"
12910 #: ../src/guestfs-actions.pod:3955
12913 " struct guestfs_stat_list *\n"
12914 " guestfs_lstatlist (guestfs_h *g,\n"
12915 " const char *path,\n"
12916 " char *const *names);\n"
12921 #: ../src/guestfs-actions.pod:3960
12923 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12924 "files, where all files are in the directory C<path>. C<names> is the list "
12925 "of files from this directory."
12929 #: ../src/guestfs-actions.pod:3964 ../fish/guestfish-actions.pod:2680
12931 "On return you get a list of stat structs, with a one-to-one correspondence "
12932 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12933 "then the C<ino> field of that structure is set to C<-1>."
12937 #: ../src/guestfs-actions.pod:3969
12939 "This call is intended for programs that want to efficiently list a directory "
12940 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12941 "for a similarly efficient call for getting extended attributes. Very long "
12942 "directory listings might cause the protocol message size to be exceeded, "
12943 "causing this call to fail. The caller must split up such requests into "
12944 "smaller groups of names."
12948 #: ../src/guestfs-actions.pod:3977
12950 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12951 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12955 #: ../src/guestfs-actions.pod:3983
12956 msgid "guestfs_luks_add_key"
12960 #: ../src/guestfs-actions.pod:3985
12964 " guestfs_luks_add_key (guestfs_h *g,\n"
12965 " const char *device,\n"
12966 " const char *key,\n"
12967 " const char *newkey,\n"
12973 #: ../src/guestfs-actions.pod:3992 ../fish/guestfish-actions.pod:2697
12975 "This command adds a new key on LUKS device C<device>. C<key> is any "
12976 "existing key, and is used to access the device. C<newkey> is the new key to "
12977 "add. C<keyslot> is the key slot that will be replaced."
12981 #: ../src/guestfs-actions.pod:3997
12983 "Note that if C<keyslot> already contains a key, then this command will "
12984 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12988 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4043
12989 #: ../src/guestfs-actions.pod:4066 ../src/guestfs-actions.pod:4086
12990 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4140
12992 "This function takes a key or passphrase parameter which could contain "
12993 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12998 #: ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4047
12999 #: ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4090
13000 msgid "(Added in 1.5.2)"
13004 #: ../src/guestfs-actions.pod:4009
13005 msgid "guestfs_luks_close"
13009 #: ../src/guestfs-actions.pod:4011
13013 " guestfs_luks_close (guestfs_h *g,\n"
13014 " const char *device);\n"
13019 #: ../src/guestfs-actions.pod:4015
13021 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13022 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13023 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13024 "underlying block device."
13028 #: ../src/guestfs-actions.pod:4023 ../src/guestfs-actions.pod:4125
13029 #: ../src/guestfs-actions.pod:4144 ../src/guestfs-actions.pod:4194
13030 #: ../src/guestfs-actions.pod:4242
13031 msgid "(Added in 1.5.1)"
13035 #: ../src/guestfs-actions.pod:4025
13036 msgid "guestfs_luks_format"
13040 #: ../src/guestfs-actions.pod:4027
13044 " guestfs_luks_format (guestfs_h *g,\n"
13045 " const char *device,\n"
13046 " const char *key,\n"
13052 #: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:2723
13054 "This command erases existing data on C<device> and formats the device as a "
13055 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13056 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13060 #: ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:4063
13061 #: ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5309
13062 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6500
13063 #: ../src/guestfs-actions.pod:6530 ../src/guestfs-actions.pod:6563
13064 #: ../src/guestfs-actions.pod:7739 ../fish/guestfish-actions.pod:2731
13065 #: ../fish/guestfish-actions.pod:2744 ../fish/guestfish-actions.pod:2831
13066 #: ../fish/guestfish-actions.pod:3492 ../fish/guestfish-actions.pod:4012
13067 #: ../fish/guestfish-actions.pod:4322 ../fish/guestfish-actions.pod:4345
13068 #: ../fish/guestfish-actions.pod:4367 ../fish/guestfish-actions.pod:5091
13070 "B<This command is dangerous. Without careful use you can easily destroy all "
13075 #: ../src/guestfs-actions.pod:4049
13076 msgid "guestfs_luks_format_cipher"
13080 #: ../src/guestfs-actions.pod:4051
13084 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13085 " const char *device,\n"
13086 " const char *key,\n"
13088 " const char *cipher);\n"
13093 #: ../src/guestfs-actions.pod:4058
13095 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13096 "set the C<cipher> used."
13100 #: ../src/guestfs-actions.pod:4072
13101 msgid "guestfs_luks_kill_slot"
13105 #: ../src/guestfs-actions.pod:4074
13109 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13110 " const char *device,\n"
13111 " const char *key,\n"
13117 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:2751
13119 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13120 "device C<device>. C<key> must be one of the I<other> keys."
13124 #: ../src/guestfs-actions.pod:4092
13125 msgid "guestfs_luks_open"
13129 #: ../src/guestfs-actions.pod:4094
13133 " guestfs_luks_open (guestfs_h *g,\n"
13134 " const char *device,\n"
13135 " const char *key,\n"
13136 " const char *mapname);\n"
13141 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2762
13143 "This command opens a block device which has been encrypted according to the "
13144 "Linux Unified Key Setup (LUKS) standard."
13148 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2765
13149 msgid "C<device> is the encrypted block device or partition."
13153 #: ../src/guestfs-actions.pod:4105 ../fish/guestfish-actions.pod:2767
13155 "The caller must supply one of the keys associated with the LUKS block "
13156 "device, in the C<key> parameter."
13160 #: ../src/guestfs-actions.pod:4108 ../fish/guestfish-actions.pod:2770
13162 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13163 "writes to this block device are decrypted from and encrypted to the "
13164 "underlying C<device> respectively."
13168 #: ../src/guestfs-actions.pod:4112
13170 "If this block device contains LVM volume groups, then calling "
13171 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13176 #: ../src/guestfs-actions.pod:4116
13177 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
13181 #: ../src/guestfs-actions.pod:4127
13182 msgid "guestfs_luks_open_ro"
13186 #: ../src/guestfs-actions.pod:4129
13190 " guestfs_luks_open_ro (guestfs_h *g,\n"
13191 " const char *device,\n"
13192 " const char *key,\n"
13193 " const char *mapname);\n"
13198 #: ../src/guestfs-actions.pod:4135
13200 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13205 #: ../src/guestfs-actions.pod:4146
13206 msgid "guestfs_lvcreate"
13210 #: ../src/guestfs-actions.pod:4148
13214 " guestfs_lvcreate (guestfs_h *g,\n"
13215 " const char *logvol,\n"
13216 " const char *volgroup,\n"
13222 #: ../src/guestfs-actions.pod:4154 ../fish/guestfish-actions.pod:2798
13224 "This creates an LVM logical volume called C<logvol> on the volume group "
13225 "C<volgroup>, with C<size> megabytes."
13229 #: ../src/guestfs-actions.pod:4161
13230 msgid "guestfs_lvm_canonical_lv_name"
13234 #: ../src/guestfs-actions.pod:4163
13238 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13239 " const char *lvname);\n"
13244 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2805
13246 "This converts alternative naming schemes for LVs that you might find to the "
13247 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13252 #: ../src/guestfs-actions.pod:4171 ../fish/guestfish-actions.pod:2809
13254 "This command returns an error if the C<lvname> parameter does not refer to a "
13259 #: ../src/guestfs-actions.pod:4174
13260 msgid "See also C<guestfs_is_lv>."
13264 #: ../src/guestfs-actions.pod:4179
13265 msgid "(Added in 1.5.24)"
13269 #: ../src/guestfs-actions.pod:4181
13270 msgid "guestfs_lvm_clear_filter"
13274 #: ../src/guestfs-actions.pod:4183
13278 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13283 #: ../src/guestfs-actions.pod:4186
13285 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13286 "see every block device."
13290 #: ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4231
13291 #: ../fish/guestfish-actions.pod:2821 ../fish/guestfish-actions.pod:2852
13293 "This command also clears the LVM cache and performs a volume group scan."
13297 #: ../src/guestfs-actions.pod:4196
13298 msgid "guestfs_lvm_remove_all"
13302 #: ../src/guestfs-actions.pod:4198
13306 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13311 #: ../src/guestfs-actions.pod:4201 ../fish/guestfish-actions.pod:2828
13313 "This command removes all LVM logical volumes, volume groups and physical "
13318 #: ../src/guestfs-actions.pod:4211
13319 msgid "guestfs_lvm_set_filter"
13323 #: ../src/guestfs-actions.pod:4213
13327 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13328 " char *const *devices);\n"
13333 #: ../src/guestfs-actions.pod:4217 ../fish/guestfish-actions.pod:2838
13335 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13336 "block devices in the list C<devices>, and will ignore all other attached "
13341 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2842
13343 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13344 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13345 "there are two types of duplication possible: either cloned PVs/VGs which "
13346 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13347 "same name. In normal operation you cannot create this situation, but you "
13348 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13349 "inside the LVM metadata."
13353 #: ../src/guestfs-actions.pod:4234 ../fish/guestfish-actions.pod:2855
13354 msgid "You can filter whole block devices or individual partitions."
13358 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:2857
13360 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13361 "filesystem), even if you are not filtering out that VG."
13365 #: ../src/guestfs-actions.pod:4244
13366 msgid "guestfs_lvremove"
13370 #: ../src/guestfs-actions.pod:4246
13374 " guestfs_lvremove (guestfs_h *g,\n"
13375 " const char *device);\n"
13380 #: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:2865
13382 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13383 "LV, such as C</dev/VG/LV>."
13387 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2868
13389 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13394 #: ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:5655
13395 #: ../src/guestfs-actions.pod:7470
13396 msgid "(Added in 1.0.13)"
13400 #: ../src/guestfs-actions.pod:4260
13401 msgid "guestfs_lvrename"
13405 #: ../src/guestfs-actions.pod:4262
13409 " guestfs_lvrename (guestfs_h *g,\n"
13410 " const char *logvol,\n"
13411 " const char *newlogvol);\n"
13416 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2875
13417 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13421 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:7483
13422 msgid "(Added in 1.0.83)"
13426 #: ../src/guestfs-actions.pod:4273
13427 msgid "guestfs_lvresize"
13431 #: ../src/guestfs-actions.pod:4275
13435 " guestfs_lvresize (guestfs_h *g,\n"
13436 " const char *device,\n"
13442 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2881
13444 "This resizes (expands or shrinks) an existing LVM logical volume to "
13445 "C<mbytes>. When reducing, data in the reduced part is lost."
13449 #: ../src/guestfs-actions.pod:4288
13450 msgid "guestfs_lvresize_free"
13454 #: ../src/guestfs-actions.pod:4290
13458 " guestfs_lvresize_free (guestfs_h *g,\n"
13459 " const char *lv,\n"
13465 #: ../src/guestfs-actions.pod:4295 ../fish/guestfish-actions.pod:2889
13467 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13468 "remaining free space in the volume group. Commonly you would call this with "
13469 "pc = 100 which expands the logical volume as much as possible, using all "
13470 "remaining free space in the volume group."
13474 #: ../src/guestfs-actions.pod:4303
13475 msgid "(Added in 1.3.3)"
13479 #: ../src/guestfs-actions.pod:4305
13480 msgid "guestfs_lvs"
13484 #: ../src/guestfs-actions.pod:4307
13488 " guestfs_lvs (guestfs_h *g);\n"
13493 #: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:2899
13495 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13500 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2902
13502 "This returns a list of the logical volume device names (eg. C</dev/"
13503 "VolGroup00/LogVol00>)."
13507 #: ../src/guestfs-actions.pod:4316
13508 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13512 #: ../src/guestfs-actions.pod:4324
13513 msgid "guestfs_lvs_full"
13517 #: ../src/guestfs-actions.pod:4326
13520 " struct guestfs_lvm_lv_list *\n"
13521 " guestfs_lvs_full (guestfs_h *g);\n"
13526 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2911
13528 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13529 "(8)> command. The \"full\" version includes all fields."
13533 #: ../src/guestfs-actions.pod:4332
13535 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13536 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13540 #: ../src/guestfs-actions.pod:4338
13541 msgid "guestfs_lvuuid"
13545 #: ../src/guestfs-actions.pod:4340
13549 " guestfs_lvuuid (guestfs_h *g,\n"
13550 " const char *device);\n"
13555 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2918
13556 msgid "This command returns the UUID of the LVM LV C<device>."
13560 #: ../src/guestfs-actions.pod:4351
13561 msgid "guestfs_lxattrlist"
13565 #: ../src/guestfs-actions.pod:4353
13568 " struct guestfs_xattr_list *\n"
13569 " guestfs_lxattrlist (guestfs_h *g,\n"
13570 " const char *path,\n"
13571 " char *const *names);\n"
13576 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2924
13578 "This call allows you to get the extended attributes of multiple files, where "
13579 "all files are in the directory C<path>. C<names> is the list of files from "
13584 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2928
13586 "On return you get a flat list of xattr structs which must be interpreted "
13587 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13588 "C<attrval> in this struct is zero-length to indicate there was an error "
13589 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13590 "number (the number of following attributes for this file, which could be C<"
13591 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13592 "for the first named file. This repeats for the second and subsequent files."
13596 #: ../src/guestfs-actions.pod:4372
13598 "This call is intended for programs that want to efficiently list a directory "
13599 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13600 "a similarly efficient call for getting standard stats. Very long directory "
13601 "listings might cause the protocol message size to be exceeded, causing this "
13602 "call to fail. The caller must split up such requests into smaller groups of "
13607 #: ../src/guestfs-actions.pod:4386
13608 msgid "guestfs_mkdir"
13612 #: ../src/guestfs-actions.pod:4388
13616 " guestfs_mkdir (guestfs_h *g,\n"
13617 " const char *path);\n"
13622 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2950
13623 msgid "Create a directory named C<path>."
13627 #: ../src/guestfs-actions.pod:4398
13628 msgid "guestfs_mkdir_mode"
13632 #: ../src/guestfs-actions.pod:4400
13636 " guestfs_mkdir_mode (guestfs_h *g,\n"
13637 " const char *path,\n"
13643 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2956
13645 "This command creates a directory, setting the initial permissions of the "
13646 "directory to C<mode>."
13650 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:2959
13652 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13653 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13658 #: ../src/guestfs-actions.pod:4412
13659 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13663 #: ../src/guestfs-actions.pod:4418
13664 msgid "guestfs_mkdir_p"
13668 #: ../src/guestfs-actions.pod:4420
13672 " guestfs_mkdir_p (guestfs_h *g,\n"
13673 " const char *path);\n"
13678 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2969
13680 "Create a directory named C<path>, creating any parent directories as "
13681 "necessary. This is like the C<mkdir -p> shell command."
13685 #: ../src/guestfs-actions.pod:4431
13686 msgid "guestfs_mkdtemp"
13690 #: ../src/guestfs-actions.pod:4433
13694 " guestfs_mkdtemp (guestfs_h *g,\n"
13695 " const char *template);\n"
13700 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:2976
13702 "This command creates a temporary directory. The C<template> parameter "
13703 "should be a full pathname for the temporary directory name with the final "
13704 "six characters being \"XXXXXX\"."
13708 #: ../src/guestfs-actions.pod:4442 ../fish/guestfish-actions.pod:2981
13710 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13711 "being suitable for Windows filesystems."
13715 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2984
13716 msgid "The name of the temporary directory that was created is returned."
13720 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2987
13721 msgid "The temporary directory is created with mode 0700 and is owned by root."
13725 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:2990
13727 "The caller is responsible for deleting the temporary directory and its "
13728 "contents after use."
13732 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2993
13733 msgid "See also: L<mkdtemp(3)>"
13737 #: ../src/guestfs-actions.pod:4461
13738 msgid "guestfs_mke2fs_J"
13742 #: ../src/guestfs-actions.pod:4463
13746 " guestfs_mke2fs_J (guestfs_h *g,\n"
13747 " const char *fstype,\n"
13748 " int blocksize,\n"
13749 " const char *device,\n"
13750 " const char *journal);\n"
13755 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2999
13757 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13758 "C<journal>. It is equivalent to the command:"
13762 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3003
13765 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13770 #: ../src/guestfs-actions.pod:4476
13771 msgid "See also C<guestfs_mke2journal>."
13775 #: ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:4498
13776 #: ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4532
13777 #: ../src/guestfs-actions.pod:4546 ../src/guestfs-actions.pod:4560
13778 #: ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:4896
13779 msgid "(Added in 1.0.68)"
13783 #: ../src/guestfs-actions.pod:4482
13784 msgid "guestfs_mke2fs_JL"
13788 #: ../src/guestfs-actions.pod:4484
13792 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13793 " const char *fstype,\n"
13794 " int blocksize,\n"
13795 " const char *device,\n"
13796 " const char *label);\n"
13801 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3011
13803 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13804 "the journal labeled C<label>."
13808 #: ../src/guestfs-actions.pod:4494
13809 msgid "See also C<guestfs_mke2journal_L>."
13813 #: ../src/guestfs-actions.pod:4500
13814 msgid "guestfs_mke2fs_JU"
13818 #: ../src/guestfs-actions.pod:4502
13822 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13823 " const char *fstype,\n"
13824 " int blocksize,\n"
13825 " const char *device,\n"
13826 " const char *uuid);\n"
13831 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3020
13833 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13834 "the journal with UUID C<uuid>."
13838 #: ../src/guestfs-actions.pod:4512
13839 msgid "See also C<guestfs_mke2journal_U>."
13843 #: ../src/guestfs-actions.pod:4518
13844 msgid "guestfs_mke2journal"
13848 #: ../src/guestfs-actions.pod:4520
13852 " guestfs_mke2journal (guestfs_h *g,\n"
13853 " int blocksize,\n"
13854 " const char *device);\n"
13859 #: ../src/guestfs-actions.pod:4525 ../fish/guestfish-actions.pod:3029
13861 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13866 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3032
13869 " mke2fs -O journal_dev -b blocksize device\n"
13874 #: ../src/guestfs-actions.pod:4534
13875 msgid "guestfs_mke2journal_L"
13879 #: ../src/guestfs-actions.pod:4536
13883 " guestfs_mke2journal_L (guestfs_h *g,\n"
13884 " int blocksize,\n"
13885 " const char *label,\n"
13886 " const char *device);\n"
13891 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3038
13892 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13896 #: ../src/guestfs-actions.pod:4548
13897 msgid "guestfs_mke2journal_U"
13901 #: ../src/guestfs-actions.pod:4550
13905 " guestfs_mke2journal_U (guestfs_h *g,\n"
13906 " int blocksize,\n"
13907 " const char *uuid,\n"
13908 " const char *device);\n"
13913 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3044
13914 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13918 #: ../src/guestfs-actions.pod:4562
13919 msgid "guestfs_mkfifo"
13923 #: ../src/guestfs-actions.pod:4564
13927 " guestfs_mkfifo (guestfs_h *g,\n"
13929 " const char *path);\n"
13934 #: ../src/guestfs-actions.pod:4569
13936 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13937 "is just a convenient wrapper around C<guestfs_mknod>."
13941 #: ../src/guestfs-actions.pod:4579
13942 msgid "guestfs_mkfs"
13946 #: ../src/guestfs-actions.pod:4581
13950 " guestfs_mkfs (guestfs_h *g,\n"
13951 " const char *fstype,\n"
13952 " const char *device);\n"
13957 #: ../src/guestfs-actions.pod:4586 ../fish/guestfish-actions.pod:3060
13959 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13960 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13964 #: ../src/guestfs-actions.pod:4594
13965 msgid "guestfs_mkfs_b"
13969 #: ../src/guestfs-actions.pod:4596
13973 " guestfs_mkfs_b (guestfs_h *g,\n"
13974 " const char *fstype,\n"
13975 " int blocksize,\n"
13976 " const char *device);\n"
13981 #: ../src/guestfs-actions.pod:4602
13983 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13984 "block size of the resulting filesystem. Supported block sizes depend on the "
13985 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13989 #: ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4652
13990 #: ../fish/guestfish-actions.pod:3073 ../fish/guestfish-actions.pod:3100
13992 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13997 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3076
13999 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14003 #: ../src/guestfs-actions.pod:4621
14004 msgid "guestfs_mkfs_opts"
14008 #: ../src/guestfs-actions.pod:4623
14012 " guestfs_mkfs_opts (guestfs_h *g,\n"
14013 " const char *fstype,\n"
14014 " const char *device,\n"
14020 #: ../src/guestfs-actions.pod:4634
14023 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14024 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14025 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
14026 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
14031 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3087
14033 "This function creates a filesystem on C<device>. The filesystem type is "
14034 "C<fstype>, for example C<ext3>."
14038 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3094
14039 msgid "C<blocksize>"
14043 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3096
14045 "The filesystem block size. Supported block sizes depend on the filesystem "
14046 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14051 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3103
14052 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14056 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3105
14057 msgid "C<features>"
14061 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3107
14062 msgid "This passes the I<-O> parameter to the external mkfs program."
14066 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3109
14068 "For certain filesystem types, this allows extra filesystem features to be "
14069 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14073 #: ../src/guestfs-actions.pod:4665 ../fish/guestfish-actions.pod:3113
14075 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14080 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3116
14082 #| msgid "C<inspector>"
14084 msgstr "C<inspector>"
14087 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3118
14089 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
14090 "sets the inode size (only for ext2/3/4 filesystems at present)."
14094 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3121
14096 #| msgid "C<inspector>"
14097 msgid "C<sectorsize>"
14098 msgstr "C<inspector>"
14101 #: ../src/guestfs-actions.pod:4675 ../fish/guestfish-actions.pod:3123
14103 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
14104 "sets sector size for ufs filesystem."
14108 #: ../src/guestfs-actions.pod:4682
14109 msgid "(Added in 1.7.19)"
14113 #: ../src/guestfs-actions.pod:4684
14114 msgid "guestfs_mkfs_opts_va"
14118 #: ../src/guestfs-actions.pod:4686
14122 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14123 " const char *fstype,\n"
14124 " const char *device,\n"
14125 " va_list args);\n"
14130 #: ../src/guestfs-actions.pod:4692
14131 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14135 #: ../src/guestfs-actions.pod:4696
14136 msgid "guestfs_mkfs_opts_argv"
14140 #: ../src/guestfs-actions.pod:4698
14144 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14145 " const char *fstype,\n"
14146 " const char *device,\n"
14147 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14152 #: ../src/guestfs-actions.pod:4704
14153 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14157 #: ../src/guestfs-actions.pod:4708
14158 msgid "guestfs_mkmountpoint"
14162 #: ../src/guestfs-actions.pod:4710
14166 " guestfs_mkmountpoint (guestfs_h *g,\n"
14167 " const char *exemptpath);\n"
14172 #: ../src/guestfs-actions.pod:4714
14174 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14175 "that can be used to create extra mountpoints before mounting the first "
14180 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3138
14182 "These calls are I<only> necessary in some very limited circumstances, mainly "
14183 "the case where you want to mount a mix of unrelated and/or read-only "
14184 "filesystems together."
14188 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3142
14190 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14191 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14192 "inside that. You can unpack this as follows in guestfish:"
14196 #: ../src/guestfs-actions.pod:4727 ../fish/guestfish-actions.pod:3147
14199 " add-ro Fedora-11-i686-Live.iso\n"
14201 " mkmountpoint /cd\n"
14202 " mkmountpoint /sqsh\n"
14203 " mkmountpoint /ext3fs\n"
14204 " mount /dev/sda /cd\n"
14205 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14206 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14211 #: ../src/guestfs-actions.pod:4736 ../fish/guestfish-actions.pod:3156
14212 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14216 #: ../src/guestfs-actions.pod:4738
14218 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14219 "may get unexpected errors if you try to mix these calls. It is safest to "
14220 "manually unmount filesystems and remove mountpoints after use."
14224 #: ../src/guestfs-actions.pod:4742
14226 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14227 "first, so for this to work for manual mountpoints, you must ensure that the "
14228 "innermost mountpoints have the longest pathnames, as in the example code "
14233 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3167
14235 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14239 #: ../src/guestfs-actions.pod:4749
14241 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14242 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14243 "can also trigger these issues."
14247 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:5071
14248 #: ../src/guestfs-actions.pod:6075
14249 msgid "(Added in 1.0.62)"
14253 #: ../src/guestfs-actions.pod:4757
14254 msgid "guestfs_mknod"
14258 #: ../src/guestfs-actions.pod:4759
14262 " guestfs_mknod (guestfs_h *g,\n"
14266 " const char *path);\n"
14271 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3177
14273 "This call creates block or character special devices, or named pipes (FIFOs)."
14277 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3180
14279 "The C<mode> parameter should be the mode, using the standard constants. "
14280 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14281 "used when creating block and character special devices."
14285 #: ../src/guestfs-actions.pod:4774
14287 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14288 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14289 "regular file). These constants are available in the standard Linux header "
14290 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14291 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14292 "the appropriate constant for you."
14296 #: ../src/guestfs-actions.pod:4788
14297 msgid "guestfs_mknod_b"
14301 #: ../src/guestfs-actions.pod:4790
14305 " guestfs_mknod_b (guestfs_h *g,\n"
14309 " const char *path);\n"
14314 #: ../src/guestfs-actions.pod:4797
14316 "This call creates a block device node called C<path> with mode C<mode> and "
14317 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14318 "wrapper around C<guestfs_mknod>."
14322 #: ../src/guestfs-actions.pod:4807
14323 msgid "guestfs_mknod_c"
14327 #: ../src/guestfs-actions.pod:4809
14331 " guestfs_mknod_c (guestfs_h *g,\n"
14335 " const char *path);\n"
14340 #: ../src/guestfs-actions.pod:4816
14342 "This call creates a char device node called C<path> with mode C<mode> and "
14343 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14344 "wrapper around C<guestfs_mknod>."
14348 #: ../src/guestfs-actions.pod:4826
14349 msgid "guestfs_mkswap"
14353 #: ../src/guestfs-actions.pod:4828
14357 " guestfs_mkswap (guestfs_h *g,\n"
14358 " const char *device);\n"
14363 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3219
14364 msgid "Create a swap partition on C<device>."
14368 #: ../src/guestfs-actions.pod:4838
14369 msgid "guestfs_mkswap_L"
14373 #: ../src/guestfs-actions.pod:4840
14377 " guestfs_mkswap_L (guestfs_h *g,\n"
14378 " const char *label,\n"
14379 " const char *device);\n"
14384 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3225
14385 msgid "Create a swap partition on C<device> with label C<label>."
14389 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3227
14391 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14392 "sda>), just to a partition. This appears to be a limitation of the kernel "
14397 #: ../src/guestfs-actions.pod:4855
14398 msgid "guestfs_mkswap_U"
14402 #: ../src/guestfs-actions.pod:4857
14406 " guestfs_mkswap_U (guestfs_h *g,\n"
14407 " const char *uuid,\n"
14408 " const char *device);\n"
14413 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3235
14414 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14418 #: ../src/guestfs-actions.pod:4868
14419 msgid "guestfs_mkswap_file"
14423 #: ../src/guestfs-actions.pod:4870
14427 " guestfs_mkswap_file (guestfs_h *g,\n"
14428 " const char *path);\n"
14433 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3241
14434 msgid "Create a swap file."
14438 #: ../src/guestfs-actions.pod:4876
14440 "This command just writes a swap file signature to an existing file. To "
14441 "create the file itself, use something like C<guestfs_fallocate>."
14445 #: ../src/guestfs-actions.pod:4883
14446 msgid "guestfs_modprobe"
14450 #: ../src/guestfs-actions.pod:4885
14454 " guestfs_modprobe (guestfs_h *g,\n"
14455 " const char *modulename);\n"
14460 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3250
14461 msgid "This loads a kernel module in the appliance."
14465 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3252
14467 "The kernel module must have been whitelisted when libguestfs was built (see "
14468 "C<appliance/kmod.whitelist.in> in the source)."
14472 #: ../src/guestfs-actions.pod:4898
14473 msgid "guestfs_mount"
14477 #: ../src/guestfs-actions.pod:4900
14481 " guestfs_mount (guestfs_h *g,\n"
14482 " const char *device,\n"
14483 " const char *mountpoint);\n"
14488 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3259
14490 "Mount a guest disk at a position in the filesystem. Block devices are named "
14491 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14492 "those block devices contain partitions, they will have the usual names (eg. "
14493 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14497 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3265
14499 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14500 "mounted on C</> before others can be mounted. Other filesystems can only be "
14501 "mounted on directories which already exist."
14505 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3270
14507 "The mounted filesystem is writable, if we have sufficient permissions on the "
14508 "underlying device."
14512 #: ../src/guestfs-actions.pod:4919
14514 "B<Important note:> When you use this call, the filesystem options C<sync> "
14515 "and C<noatime> are set implicitly. This was originally done because we "
14516 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14517 "very large negative performance impact and negligible effect on "
14518 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14519 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14520 "(use an empty string for the first parameter if you don't want any options)."
14524 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3283
14526 "This function is deprecated. In new code, use the C<mount_options> call "
14531 #: ../src/guestfs-actions.pod:4940
14532 msgid "guestfs_mount_9p"
14536 #: ../src/guestfs-actions.pod:4942
14540 " guestfs_mount_9p (guestfs_h *g,\n"
14541 " const char *mounttag,\n"
14542 " const char *mountpoint,\n"
14548 #: ../src/guestfs-actions.pod:4953
14551 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14556 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3294
14558 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14563 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3297
14565 "If required, C<trans=virtio> will be automatically added to the options. "
14566 "Any other options required can be passed in the optional C<options> "
14571 #: ../src/guestfs-actions.pod:4966
14572 msgid "guestfs_mount_9p_va"
14576 #: ../src/guestfs-actions.pod:4968
14580 " guestfs_mount_9p_va (guestfs_h *g,\n"
14581 " const char *mounttag,\n"
14582 " const char *mountpoint,\n"
14583 " va_list args);\n"
14588 #: ../src/guestfs-actions.pod:4974
14589 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14593 #: ../src/guestfs-actions.pod:4978
14594 msgid "guestfs_mount_9p_argv"
14598 #: ../src/guestfs-actions.pod:4980
14602 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14603 " const char *mounttag,\n"
14604 " const char *mountpoint,\n"
14605 " const struct guestfs_mount_9p_argv *optargs);\n"
14610 #: ../src/guestfs-actions.pod:4986
14611 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14615 #: ../src/guestfs-actions.pod:4990
14616 msgid "guestfs_mount_loop"
14620 #: ../src/guestfs-actions.pod:4992
14624 " guestfs_mount_loop (guestfs_h *g,\n"
14625 " const char *file,\n"
14626 " const char *mountpoint);\n"
14631 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3307
14633 "This command lets you mount C<file> (a filesystem image in a file) on a "
14634 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14639 #: ../src/guestfs-actions.pod:5005
14640 msgid "guestfs_mount_options"
14644 #: ../src/guestfs-actions.pod:5007
14648 " guestfs_mount_options (guestfs_h *g,\n"
14649 " const char *options,\n"
14650 " const char *device,\n"
14651 " const char *mountpoint);\n"
14656 #: ../src/guestfs-actions.pod:5013
14658 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14659 "the mount options as for the L<mount(8)> I<-o> flag."
14663 #: ../src/guestfs-actions.pod:5017 ../fish/guestfish-actions.pod:3319
14665 "If the C<options> parameter is an empty string, then no options are passed "
14666 "(all options default to whatever the filesystem uses)."
14670 #: ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5037
14671 #: ../src/guestfs-actions.pod:5054
14672 msgid "(Added in 1.0.10)"
14676 #: ../src/guestfs-actions.pod:5025
14677 msgid "guestfs_mount_ro"
14681 #: ../src/guestfs-actions.pod:5027
14685 " guestfs_mount_ro (guestfs_h *g,\n"
14686 " const char *device,\n"
14687 " const char *mountpoint);\n"
14692 #: ../src/guestfs-actions.pod:5032
14694 "This is the same as the C<guestfs_mount> command, but it mounts the "
14695 "filesystem with the read-only (I<-o ro>) flag."
14699 #: ../src/guestfs-actions.pod:5039
14700 msgid "guestfs_mount_vfs"
14704 #: ../src/guestfs-actions.pod:5041
14708 " guestfs_mount_vfs (guestfs_h *g,\n"
14709 " const char *options,\n"
14710 " const char *vfstype,\n"
14711 " const char *device,\n"
14712 " const char *mountpoint);\n"
14717 #: ../src/guestfs-actions.pod:5048
14719 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14720 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14725 #: ../src/guestfs-actions.pod:5056
14726 msgid "guestfs_mountpoints"
14730 #: ../src/guestfs-actions.pod:5058
14734 " guestfs_mountpoints (guestfs_h *g);\n"
14739 #: ../src/guestfs-actions.pod:5061
14741 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14742 "devices. This one returns a hash table (map) of device name to directory "
14743 "where the device is mounted."
14747 #: ../src/guestfs-actions.pod:5073
14748 msgid "guestfs_mounts"
14752 #: ../src/guestfs-actions.pod:5075
14756 " guestfs_mounts (guestfs_h *g);\n"
14761 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3350
14763 "This returns the list of currently mounted filesystems. It returns the list "
14764 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14768 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3353
14769 msgid "Some internal mounts are not shown."
14773 #: ../src/guestfs-actions.pod:5083
14774 msgid "See also: C<guestfs_mountpoints>"
14778 #: ../src/guestfs-actions.pod:5091
14783 #: ../src/guestfs-actions.pod:5093
14787 " guestfs_mv (guestfs_h *g,\n"
14788 " const char *src,\n"
14789 " const char *dest);\n"
14794 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3361
14796 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14797 "destination filename or destination directory."
14801 #: ../src/guestfs-actions.pod:5105
14802 msgid "guestfs_ntfs_3g_probe"
14806 #: ../src/guestfs-actions.pod:5107
14810 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14812 " const char *device);\n"
14817 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3368
14819 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14820 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14821 "write, and some cannot be mounted at all)."
14825 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3372
14827 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14828 "can be mounted read-write. Set it to false if you want to test if the "
14829 "volume can be mounted read-only."
14833 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3376
14835 "The return value is an integer which C<0> if the operation would succeed, or "
14836 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14840 #: ../src/guestfs-actions.pod:5126
14841 msgid "(Added in 1.0.43)"
14845 #: ../src/guestfs-actions.pod:5128
14846 msgid "guestfs_ntfsresize"
14850 #: ../src/guestfs-actions.pod:5130
14854 " guestfs_ntfsresize (guestfs_h *g,\n"
14855 " const char *device);\n"
14860 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5173
14861 #: ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3408
14863 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14864 "size of the underlying device."
14868 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3387
14870 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14871 "consistency check (for safety). You have to boot into Windows to perform "
14872 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14873 "resize filesystems which have been marked in this way. So in effect it is "
14874 "not possible to call ntfsresize multiple times on a single filesystem "
14875 "without booting into Windows between each resize."
14879 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5199
14880 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3434
14882 #| msgid "See L<guestfish(1)>."
14883 msgid "See also L<ntfsresize(8)>."
14884 msgstr "Див. L<guestfish(1)>."
14887 #: ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5239
14888 #: ../fish/guestfish-actions.pod:3397 ../fish/guestfish-actions.pod:3445
14890 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14895 #: ../src/guestfs-actions.pod:5158
14896 msgid "guestfs_ntfsresize_opts"
14900 #: ../src/guestfs-actions.pod:5160
14904 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
14905 " const char *device,\n"
14911 #: ../src/guestfs-actions.pod:5170
14914 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
14915 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
14920 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3417
14922 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14923 "resized to fit the container (eg. partition)."
14927 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3420
14929 #| msgid "C<format>"
14934 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3422
14936 "If this option is true, then force the resize of the filesystem even if the "
14937 "filesystem is marked as requiring a consistency check."
14941 #: ../src/guestfs-actions.pod:5190
14943 "After the resize operation, the filesystem is always marked as requiring a "
14944 "consistency check (for safety). You have to boot into Windows to perform "
14945 "this check and clear this condition. If you I<don't> set the C<force> "
14946 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
14947 "times on a single filesystem without booting into Windows between each "
14952 #: ../src/guestfs-actions.pod:5205
14953 msgid "guestfs_ntfsresize_opts_va"
14957 #: ../src/guestfs-actions.pod:5207
14961 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
14962 " const char *device,\n"
14963 " va_list args);\n"
14968 #: ../src/guestfs-actions.pod:5212
14969 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
14973 #: ../src/guestfs-actions.pod:5216
14974 msgid "guestfs_ntfsresize_opts_argv"
14978 #: ../src/guestfs-actions.pod:5218
14982 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
14983 " const char *device,\n"
14984 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
14989 #: ../src/guestfs-actions.pod:5223
14990 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
14994 #: ../src/guestfs-actions.pod:5227
14995 msgid "guestfs_ntfsresize_size"
14999 #: ../src/guestfs-actions.pod:5229
15003 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15004 " const char *device,\n"
15005 " int64_t size);\n"
15010 #: ../src/guestfs-actions.pod:5234
15012 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15013 "to specify the new size (in bytes) explicitly."
15017 #: ../src/guestfs-actions.pod:5246 ../src/guestfs-actions.pod:5682
15018 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6023
15019 #: ../src/guestfs-actions.pod:7625
15020 msgid "(Added in 1.3.14)"
15024 #: ../src/guestfs-actions.pod:5248
15025 msgid "guestfs_part_add"
15029 #: ../src/guestfs-actions.pod:5250
15033 " guestfs_part_add (guestfs_h *g,\n"
15034 " const char *device,\n"
15035 " const char *prlogex,\n"
15036 " int64_t startsect,\n"
15037 " int64_t endsect);\n"
15042 #: ../src/guestfs-actions.pod:5257
15044 "This command adds a partition to C<device>. If there is no partition table "
15045 "on the device, call C<guestfs_part_init> first."
15049 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3459
15051 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15052 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15053 "C<logical>) and C<e> (or C<extended>) partition types."
15057 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3464
15059 "C<startsect> and C<endsect> are the start and end of the partition in "
15060 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15061 "from the end of the disk (C<-1> is the last sector)."
15065 #: ../src/guestfs-actions.pod:5269
15067 "Creating a partition which covers the whole disk is not so easy. Use "
15068 "C<guestfs_part_disk> to do that."
15072 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5312
15073 #: ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5443
15074 #: ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5500
15075 #: ../src/guestfs-actions.pod:5540
15076 msgid "(Added in 1.0.78)"
15080 #: ../src/guestfs-actions.pod:5276
15081 msgid "guestfs_part_del"
15085 #: ../src/guestfs-actions.pod:5278
15089 " guestfs_part_del (guestfs_h *g,\n"
15090 " const char *device,\n"
15096 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3475
15097 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15101 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3477
15103 "Note that in the case of MBR partitioning, deleting an extended partition "
15104 "also deletes any logical partitions it contains."
15108 #: ../src/guestfs-actions.pod:5293
15109 msgid "guestfs_part_disk"
15113 #: ../src/guestfs-actions.pod:5295
15117 " guestfs_part_disk (guestfs_h *g,\n"
15118 " const char *device,\n"
15119 " const char *parttype);\n"
15124 #: ../src/guestfs-actions.pod:5300
15126 "This command is simply a combination of C<guestfs_part_init> followed by "
15127 "C<guestfs_part_add> to create a single primary partition covering the whole "
15132 #: ../src/guestfs-actions.pod:5304
15134 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15135 "possible values are described in C<guestfs_part_init>."
15139 #: ../src/guestfs-actions.pod:5314
15140 msgid "guestfs_part_get_bootable"
15144 #: ../src/guestfs-actions.pod:5316
15148 " guestfs_part_get_bootable (guestfs_h *g,\n"
15149 " const char *device,\n"
15155 #: ../src/guestfs-actions.pod:5321 ../fish/guestfish-actions.pod:3499
15157 "This command returns true if the partition C<partnum> on C<device> has the "
15158 "bootable flag set."
15162 #: ../src/guestfs-actions.pod:5324
15163 msgid "See also C<guestfs_part_set_bootable>."
15167 #: ../src/guestfs-actions.pod:5330
15168 msgid "guestfs_part_get_mbr_id"
15172 #: ../src/guestfs-actions.pod:5332
15176 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15177 " const char *device,\n"
15183 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3508
15185 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15186 "partition C<partnum>."
15190 #: ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:5516
15192 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15193 "undefined results for other partition table types (see "
15194 "C<guestfs_part_get_parttype>)."
15198 #: ../src/guestfs-actions.pod:5348
15199 msgid "guestfs_part_get_parttype"
15203 #: ../src/guestfs-actions.pod:5350
15207 " guestfs_part_get_parttype (guestfs_h *g,\n"
15208 " const char *device);\n"
15213 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3519
15215 "This command examines the partition table on C<device> and returns the "
15216 "partition table type (format) being used."
15220 #: ../src/guestfs-actions.pod:5357
15222 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15223 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15224 "possible, although unusual. See C<guestfs_part_init> for a full list."
15228 #: ../src/guestfs-actions.pod:5367
15229 msgid "guestfs_part_init"
15233 #: ../src/guestfs-actions.pod:5369
15237 " guestfs_part_init (guestfs_h *g,\n"
15238 " const char *device,\n"
15239 " const char *parttype);\n"
15244 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3531
15246 "This creates an empty partition table on C<device> of one of the partition "
15247 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15248 "(for large disks)."
15252 #: ../src/guestfs-actions.pod:5378
15254 "Initially there are no partitions. Following this, you should call "
15255 "C<guestfs_part_add> for each partition required."
15259 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3538
15260 msgid "Possible values for C<parttype> are:"
15264 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3542
15265 msgid "B<efi> | B<gpt>"
15269 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3544
15270 msgid "Intel EFI / GPT partition table."
15274 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3546
15276 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15277 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15278 "the C<mbr> format."
15282 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3550
15283 msgid "B<mbr> | B<msdos>"
15287 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3552
15289 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15290 "Windows. This partition type will B<only> work for device sizes up to 2 "
15291 "TB. For large disks we recommend using C<gpt>."
15295 #: ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3559
15297 "Other partition table types that may work but are not supported include:"
15301 #: ../src/guestfs-actions.pod:5407 ../fish/guestfish-actions.pod:3564
15306 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3566
15307 msgid "AIX disk labels."
15311 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3568
15312 msgid "B<amiga> | B<rdb>"
15316 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3570
15317 msgid "Amiga \"Rigid Disk Block\" format."
15321 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3572
15326 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3574
15327 msgid "BSD disk labels."
15331 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3576
15336 #: ../src/guestfs-actions.pod:5421 ../fish/guestfish-actions.pod:3578
15337 msgid "DASD, used on IBM mainframes."
15341 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3580
15346 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3582
15347 msgid "MIPS/SGI volumes."
15351 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3584
15356 #: ../src/guestfs-actions.pod:5429 ../fish/guestfish-actions.pod:3586
15357 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15361 #: ../src/guestfs-actions.pod:5431 ../fish/guestfish-actions.pod:3588
15366 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3590
15367 msgid "NEC PC-98 format, common in Japan apparently."
15371 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3592
15376 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3594
15377 msgid "Sun disk labels."
15381 #: ../src/guestfs-actions.pod:5445
15382 msgid "guestfs_part_list"
15386 #: ../src/guestfs-actions.pod:5447
15389 " struct guestfs_partition_list *\n"
15390 " guestfs_part_list (guestfs_h *g,\n"
15391 " const char *device);\n"
15396 #: ../src/guestfs-actions.pod:5451 ../fish/guestfish-actions.pod:3602
15398 "This command parses the partition table on C<device> and returns the list of "
15399 "partitions found."
15403 #: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:3605
15404 msgid "The fields in the returned structure are:"
15408 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3609
15409 msgid "B<part_num>"
15413 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3611
15414 msgid "Partition number, counting from 1."
15418 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3613
15419 msgid "B<part_start>"
15423 #: ../src/guestfs-actions.pod:5464
15425 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15426 "the device's sector size, see C<guestfs_blockdev_getss>."
15430 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3618
15431 msgid "B<part_end>"
15435 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3620
15436 msgid "End of the partition in bytes."
15440 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3622
15441 msgid "B<part_size>"
15445 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3624
15446 msgid "Size of the partition in bytes."
15450 #: ../src/guestfs-actions.pod:5477
15452 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15453 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15458 #: ../src/guestfs-actions.pod:5483
15459 msgid "guestfs_part_set_bootable"
15463 #: ../src/guestfs-actions.pod:5485
15467 " guestfs_part_set_bootable (guestfs_h *g,\n"
15468 " const char *device,\n"
15470 " int bootable);\n"
15475 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3632
15477 "This sets the bootable flag on partition numbered C<partnum> on device "
15478 "C<device>. Note that partitions are numbered from 1."
15482 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3635
15484 "The bootable flag is used by some operating systems (notably Windows) to "
15485 "determine which partition to boot from. It is by no means universally "
15490 #: ../src/guestfs-actions.pod:5502
15491 msgid "guestfs_part_set_mbr_id"
15495 #: ../src/guestfs-actions.pod:5504
15499 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15500 " const char *device,\n"
15507 #: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3643
15509 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15510 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15511 "documentation are in fact hexadecimal numbers, but usually documented "
15512 "without any leading \"0x\" which might be confusing."
15516 #: ../src/guestfs-actions.pod:5524
15517 msgid "guestfs_part_set_name"
15521 #: ../src/guestfs-actions.pod:5526
15525 " guestfs_part_set_name (guestfs_h *g,\n"
15526 " const char *device,\n"
15528 " const char *name);\n"
15533 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3657
15535 "This sets the partition name on partition numbered C<partnum> on device "
15536 "C<device>. Note that partitions are numbered from 1."
15540 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3660
15542 "The partition name can only be set on certain types of partition table. "
15543 "This works on C<gpt> but not on C<mbr> partitions."
15547 #: ../src/guestfs-actions.pod:5542
15548 msgid "guestfs_part_to_dev"
15552 #: ../src/guestfs-actions.pod:5544
15556 " guestfs_part_to_dev (guestfs_h *g,\n"
15557 " const char *partition);\n"
15562 #: ../src/guestfs-actions.pod:5548 ../fish/guestfish-actions.pod:3667
15564 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15565 "partition number, returning the device name (eg. \"/dev/sdb\")."
15569 #: ../src/guestfs-actions.pod:5552
15571 "The named partition must exist, for example as a string returned from "
15572 "C<guestfs_list_partitions>."
15576 #: ../src/guestfs-actions.pod:5560
15577 msgid "guestfs_ping_daemon"
15581 #: ../src/guestfs-actions.pod:5562
15585 " guestfs_ping_daemon (guestfs_h *g);\n"
15590 #: ../src/guestfs-actions.pod:5565 ../fish/guestfish-actions.pod:3678
15592 "This is a test probe into the guestfs daemon running inside the qemu "
15593 "subprocess. Calling this function checks that the daemon responds to the "
15594 "ping message, without affecting the daemon or attached block device(s) in "
15599 #: ../src/guestfs-actions.pod:5574
15600 msgid "guestfs_pread"
15604 #: ../src/guestfs-actions.pod:5576
15608 " guestfs_pread (guestfs_h *g,\n"
15609 " const char *path,\n"
15611 " int64_t offset,\n"
15612 " size_t *size_r);\n"
15617 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3687
15619 "This command lets you read part of a file. It reads C<count> bytes of the "
15620 "file, starting at C<offset>, from file C<path>."
15624 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:5612
15625 #: ../fish/guestfish-actions.pod:3690 ../fish/guestfish-actions.pod:3705
15627 "This may read fewer bytes than requested. For further details see the "
15628 "L<pread(2)> system call."
15632 #: ../src/guestfs-actions.pod:5589
15633 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15637 #: ../src/guestfs-actions.pod:5600
15638 msgid "guestfs_pread_device"
15642 #: ../src/guestfs-actions.pod:5602
15646 " guestfs_pread_device (guestfs_h *g,\n"
15647 " const char *device,\n"
15649 " int64_t offset,\n"
15650 " size_t *size_r);\n"
15655 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3702
15657 "This command lets you read part of a file. It reads C<count> bytes of "
15658 "C<device>, starting at C<offset>."
15662 #: ../src/guestfs-actions.pod:5615
15663 msgid "See also C<guestfs_pread>."
15667 #: ../src/guestfs-actions.pod:5624
15668 msgid "(Added in 1.5.21)"
15672 #: ../src/guestfs-actions.pod:5626
15673 msgid "guestfs_pvcreate"
15677 #: ../src/guestfs-actions.pod:5628
15681 " guestfs_pvcreate (guestfs_h *g,\n"
15682 " const char *device);\n"
15687 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3717
15689 "This creates an LVM physical volume on the named C<device>, where C<device> "
15690 "should usually be a partition name such as C</dev/sda1>."
15694 #: ../src/guestfs-actions.pod:5640
15695 msgid "guestfs_pvremove"
15699 #: ../src/guestfs-actions.pod:5642
15703 " guestfs_pvremove (guestfs_h *g,\n"
15704 " const char *device);\n"
15709 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3725
15711 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15716 #: ../src/guestfs-actions.pod:5649 ../fish/guestfish-actions.pod:3728
15718 "The implementation uses the C<pvremove> command which refuses to wipe "
15719 "physical volumes that contain any volume groups, so you have to remove those "
15724 #: ../src/guestfs-actions.pod:5657
15725 msgid "guestfs_pvresize"
15729 #: ../src/guestfs-actions.pod:5659
15733 " guestfs_pvresize (guestfs_h *g,\n"
15734 " const char *device);\n"
15739 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3736
15741 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15742 "the new size of the underlying device."
15746 #: ../src/guestfs-actions.pod:5670
15747 msgid "guestfs_pvresize_size"
15751 #: ../src/guestfs-actions.pod:5672
15755 " guestfs_pvresize_size (guestfs_h *g,\n"
15756 " const char *device,\n"
15757 " int64_t size);\n"
15762 #: ../src/guestfs-actions.pod:5677
15764 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15765 "specify the new size (in bytes) explicitly."
15769 #: ../src/guestfs-actions.pod:5684
15770 msgid "guestfs_pvs"
15774 #: ../src/guestfs-actions.pod:5686
15778 " guestfs_pvs (guestfs_h *g);\n"
15783 #: ../src/guestfs-actions.pod:5689 ../fish/guestfish-actions.pod:3750
15785 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15790 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3753
15792 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15797 #: ../src/guestfs-actions.pod:5695
15798 msgid "See also C<guestfs_pvs_full>."
15802 #: ../src/guestfs-actions.pod:5703
15803 msgid "guestfs_pvs_full"
15807 #: ../src/guestfs-actions.pod:5705
15810 " struct guestfs_lvm_pv_list *\n"
15811 " guestfs_pvs_full (guestfs_h *g);\n"
15816 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3762
15818 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15819 "(8)> command. The \"full\" version includes all fields."
15823 #: ../src/guestfs-actions.pod:5711
15825 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15826 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15830 #: ../src/guestfs-actions.pod:5717
15831 msgid "guestfs_pvuuid"
15835 #: ../src/guestfs-actions.pod:5719
15839 " guestfs_pvuuid (guestfs_h *g,\n"
15840 " const char *device);\n"
15845 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3769
15846 msgid "This command returns the UUID of the LVM PV C<device>."
15850 #: ../src/guestfs-actions.pod:5730
15851 msgid "guestfs_pwrite"
15855 #: ../src/guestfs-actions.pod:5732
15859 " guestfs_pwrite (guestfs_h *g,\n"
15860 " const char *path,\n"
15861 " const char *content,\n"
15862 " size_t content_size,\n"
15863 " int64_t offset);\n"
15868 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3775
15870 "This command writes to part of a file. It writes the data buffer C<content> "
15871 "to the file C<path> starting at offset C<offset>."
15875 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3778
15877 "This command implements the L<pwrite(2)> system call, and like that system "
15878 "call it may not write the full data requested. The return value is the "
15879 "number of bytes that were actually written to the file. This could even be "
15880 "0, although short writes are unlikely for regular files in ordinary "
15885 #: ../src/guestfs-actions.pod:5748
15886 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15890 #: ../src/guestfs-actions.pod:5757
15891 msgid "guestfs_pwrite_device"
15895 #: ../src/guestfs-actions.pod:5759
15899 " guestfs_pwrite_device (guestfs_h *g,\n"
15900 " const char *device,\n"
15901 " const char *content,\n"
15902 " size_t content_size,\n"
15903 " int64_t offset);\n"
15908 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3793
15910 "This command writes to part of a device. It writes the data buffer "
15911 "C<content> to C<device> starting at offset C<offset>."
15915 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3796
15917 "This command implements the L<pwrite(2)> system call, and like that system "
15918 "call it may not write the full data requested (although short writes to disk "
15919 "devices and partitions are probably impossible with standard Linux kernels)."
15923 #: ../src/guestfs-actions.pod:5774
15924 msgid "See also C<guestfs_pwrite>."
15928 #: ../src/guestfs-actions.pod:5781
15929 msgid "(Added in 1.5.20)"
15933 #: ../src/guestfs-actions.pod:5783
15934 msgid "guestfs_read_file"
15938 #: ../src/guestfs-actions.pod:5785
15942 " guestfs_read_file (guestfs_h *g,\n"
15943 " const char *path,\n"
15944 " size_t *size_r);\n"
15949 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3810
15950 msgid "This calls returns the contents of the file C<path> as a buffer."
15954 #: ../src/guestfs-actions.pod:5793
15956 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15957 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15958 "function is limited in the total size of file that can be handled."
15962 #: ../src/guestfs-actions.pod:5805
15963 msgid "(Added in 1.0.63)"
15967 #: ../src/guestfs-actions.pod:5807
15968 msgid "guestfs_read_lines"
15972 #: ../src/guestfs-actions.pod:5809
15976 " guestfs_read_lines (guestfs_h *g,\n"
15977 " const char *path);\n"
15982 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3827
15984 "The file contents are returned as a list of lines. Trailing C<LF> and "
15985 "C<CRLF> character sequences are I<not> returned."
15989 #: ../src/guestfs-actions.pod:5818
15991 "Note that this function cannot correctly handle binary files (specifically, "
15992 "files containing C<\\0> character which is treated as end of line). For "
15993 "those you need to use the C<guestfs_read_file> function which has a more "
15994 "complex interface."
15998 #: ../src/guestfs-actions.pod:5829
15999 msgid "guestfs_readdir"
16003 #: ../src/guestfs-actions.pod:5831
16006 " struct guestfs_dirent_list *\n"
16007 " guestfs_readdir (guestfs_h *g,\n"
16008 " const char *dir);\n"
16013 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3839
16014 msgid "This returns the list of directory entries in directory C<dir>."
16018 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3841
16020 "All entries in the directory are returned, including C<.> and C<..>. The "
16021 "entries are I<not> sorted, but returned in the same order as the underlying "
16026 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3845
16028 "Also this call returns basic file type information about each file. The "
16029 "C<ftyp> field will contain one of the following characters:"
16033 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3850
16038 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3852
16039 msgid "Block special"
16043 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3854
16048 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3856
16049 msgid "Char special"
16053 #: ../src/guestfs-actions.pod:5854 ../fish/guestfish-actions.pod:3858
16058 #: ../src/guestfs-actions.pod:5856 ../fish/guestfish-actions.pod:3860
16063 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3862
16068 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3864
16069 msgid "FIFO (named pipe)"
16073 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3866
16078 #: ../src/guestfs-actions.pod:5864 ../fish/guestfish-actions.pod:3868
16079 msgid "Symbolic link"
16083 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3870
16088 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3872
16089 msgid "Regular file"
16093 #: ../src/guestfs-actions.pod:5870 ../fish/guestfish-actions.pod:3874
16098 #: ../src/guestfs-actions.pod:5872 ../fish/guestfish-actions.pod:3876
16103 #: ../src/guestfs-actions.pod:5874 ../fish/guestfish-actions.pod:3878
16108 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3880
16109 msgid "Unknown file type"
16113 #: ../src/guestfs-actions.pod:5878 ../fish/guestfish-actions.pod:3882
16118 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3884
16120 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16124 #: ../src/guestfs-actions.pod:5885
16126 "This function is primarily intended for use by programs. To get a simple "
16127 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16128 "consumption, use C<guestfs_ll>."
16132 #: ../src/guestfs-actions.pod:5889
16134 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16135 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16139 #: ../src/guestfs-actions.pod:5895
16140 msgid "guestfs_readlink"
16144 #: ../src/guestfs-actions.pod:5897
16148 " guestfs_readlink (guestfs_h *g,\n"
16149 " const char *path);\n"
16154 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3897
16155 msgid "This command reads the target of a symbolic link."
16159 #: ../src/guestfs-actions.pod:5908
16160 msgid "guestfs_readlinklist"
16164 #: ../src/guestfs-actions.pod:5910
16168 " guestfs_readlinklist (guestfs_h *g,\n"
16169 " const char *path,\n"
16170 " char *const *names);\n"
16175 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3903
16177 "This call allows you to do a C<readlink> operation on multiple files, where "
16178 "all files are in the directory C<path>. C<names> is the list of files from "
16183 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3907
16185 "On return you get a list of strings, with a one-to-one correspondence to the "
16186 "C<names> list. Each string is the value of the symbolic link."
16190 #: ../src/guestfs-actions.pod:5923 ../fish/guestfish-actions.pod:3911
16192 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16193 "result string is the empty string C<\"\">. However the whole operation is "
16194 "completed even if there were C<readlink(2)> errors, and so you can call this "
16195 "function with names where you don't know if they are symbolic links already "
16196 "(albeit slightly less efficient)."
16200 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3918
16202 "This call is intended for programs that want to efficiently list a directory "
16203 "contents without making many round-trips. Very long directory listings "
16204 "might cause the protocol message size to be exceeded, causing this call to "
16205 "fail. The caller must split up such requests into smaller groups of names."
16209 #: ../src/guestfs-actions.pod:5943
16210 msgid "guestfs_realpath"
16214 #: ../src/guestfs-actions.pod:5945
16218 " guestfs_realpath (guestfs_h *g,\n"
16219 " const char *path);\n"
16224 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:3929
16226 "Return the canonicalized absolute pathname of C<path>. The returned path "
16227 "has no C<.>, C<..> or symbolic link path elements."
16231 #: ../src/guestfs-actions.pod:5957
16232 msgid "guestfs_removexattr"
16236 #: ../src/guestfs-actions.pod:5959
16240 " guestfs_removexattr (guestfs_h *g,\n"
16241 " const char *xattr,\n"
16242 " const char *path);\n"
16247 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:3936
16249 "This call removes the extended attribute named C<xattr> of the file C<path>."
16253 #: ../src/guestfs-actions.pod:5967
16254 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16258 #: ../src/guestfs-actions.pod:5973
16259 msgid "guestfs_resize2fs"
16263 #: ../src/guestfs-actions.pod:5975
16267 " guestfs_resize2fs (guestfs_h *g,\n"
16268 " const char *device);\n"
16273 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:3945
16275 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16276 "underlying device."
16280 #: ../src/guestfs-actions.pod:5982
16282 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16283 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16284 "sometimes gives an error about this and sometimes not. In any case, it is "
16285 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16289 #: ../src/guestfs-actions.pod:5992
16290 msgid "guestfs_resize2fs_M"
16294 #: ../src/guestfs-actions.pod:5994
16298 " guestfs_resize2fs_M (guestfs_h *g,\n"
16299 " const char *device);\n"
16304 #: ../src/guestfs-actions.pod:5998
16306 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16307 "resized to its minimum size. This works like the I<-M> option to the "
16308 "C<resize2fs> command."
16312 #: ../src/guestfs-actions.pod:6002
16314 "To get the resulting size of the filesystem you should call "
16315 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16316 "These two numbers, multiplied together, give the resulting size of the "
16317 "minimal filesystem in bytes."
16321 #: ../src/guestfs-actions.pod:6011
16322 msgid "guestfs_resize2fs_size"
16326 #: ../src/guestfs-actions.pod:6013
16330 " guestfs_resize2fs_size (guestfs_h *g,\n"
16331 " const char *device,\n"
16332 " int64_t size);\n"
16337 #: ../src/guestfs-actions.pod:6018
16339 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16340 "to specify the new size (in bytes) explicitly."
16344 #: ../src/guestfs-actions.pod:6025
16349 #: ../src/guestfs-actions.pod:6027
16353 " guestfs_rm (guestfs_h *g,\n"
16354 " const char *path);\n"
16359 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:3978
16360 msgid "Remove the single file C<path>."
16364 #: ../src/guestfs-actions.pod:6037
16365 msgid "guestfs_rm_rf"
16369 #: ../src/guestfs-actions.pod:6039
16373 " guestfs_rm_rf (guestfs_h *g,\n"
16374 " const char *path);\n"
16379 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:3984
16381 "Remove the file or directory C<path>, recursively removing the contents if "
16382 "its a directory. This is like the C<rm -rf> shell command."
16386 #: ../src/guestfs-actions.pod:6051
16387 msgid "guestfs_rmdir"
16391 #: ../src/guestfs-actions.pod:6053
16395 " guestfs_rmdir (guestfs_h *g,\n"
16396 " const char *path);\n"
16401 #: ../src/guestfs-actions.pod:6057 ../fish/guestfish-actions.pod:3992
16402 msgid "Remove the single directory C<path>."
16406 #: ../src/guestfs-actions.pod:6063
16407 msgid "guestfs_rmmountpoint"
16411 #: ../src/guestfs-actions.pod:6065
16415 " guestfs_rmmountpoint (guestfs_h *g,\n"
16416 " const char *exemptpath);\n"
16421 #: ../src/guestfs-actions.pod:6069
16423 "This calls removes a mountpoint that was previously created with "
16424 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16428 #: ../src/guestfs-actions.pod:6077
16429 msgid "guestfs_scrub_device"
16433 #: ../src/guestfs-actions.pod:6079
16437 " guestfs_scrub_device (guestfs_h *g,\n"
16438 " const char *device);\n"
16443 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4006
16445 "This command writes patterns over C<device> to make data retrieval more "
16450 #: ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6107
16451 #: ../src/guestfs-actions.pod:6126 ../fish/guestfish-actions.pod:4009
16452 #: ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4037
16454 "It is an interface to the L<scrub(1)> program. See that manual page for "
16459 #: ../src/guestfs-actions.pod:6094 ../src/guestfs-actions.pod:6112
16460 #: ../src/guestfs-actions.pod:6131
16461 msgid "(Added in 1.0.52)"
16465 #: ../src/guestfs-actions.pod:6096
16466 msgid "guestfs_scrub_file"
16470 #: ../src/guestfs-actions.pod:6098
16474 " guestfs_scrub_file (guestfs_h *g,\n"
16475 " const char *file);\n"
16480 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4019
16482 "This command writes patterns over a file to make data retrieval more "
16487 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4022
16488 msgid "The file is I<removed> after scrubbing."
16492 #: ../src/guestfs-actions.pod:6114
16493 msgid "guestfs_scrub_freespace"
16497 #: ../src/guestfs-actions.pod:6116
16501 " guestfs_scrub_freespace (guestfs_h *g,\n"
16502 " const char *dir);\n"
16507 #: ../src/guestfs-actions.pod:6120
16509 "This command creates the directory C<dir> and then fills it with files until "
16510 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16511 "and deletes them. The intention is to scrub any free space on the partition "
16512 "containing C<dir>."
16516 #: ../src/guestfs-actions.pod:6133
16517 msgid "guestfs_set_append"
16521 #: ../src/guestfs-actions.pod:6135
16525 " guestfs_set_append (guestfs_h *g,\n"
16526 " const char *append);\n"
16531 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4046
16533 "This function is used to add additional options to the guest kernel command "
16538 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4049
16540 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16541 "environment variable."
16545 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4052
16547 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16548 "(libguestfs always adds a few of its own)."
16552 #: ../src/guestfs-actions.pod:6152
16553 msgid "guestfs_set_attach_method"
16557 #: ../src/guestfs-actions.pod:6154
16561 " guestfs_set_attach_method (guestfs_h *g,\n"
16562 " const char *attachmethod);\n"
16567 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4061
16569 "Set the method that libguestfs uses to connect to the back end guestfsd "
16570 "daemon. Possible methods are:"
16574 #: ../src/guestfs-actions.pod:6165 ../fish/guestfish-actions.pod:4068
16576 "Launch an appliance and connect to it. This is the ordinary method and the "
16581 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4071
16582 msgid "C<unix:I<path>>"
16586 #: ../src/guestfs-actions.pod:6170 ../fish/guestfish-actions.pod:4073
16587 msgid "Connect to the Unix domain socket I<path>."
16591 #: ../src/guestfs-actions.pod:6172 ../fish/guestfish-actions.pod:4075
16593 "This method lets you connect to an existing daemon or (using virtio-serial) "
16594 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16595 "RUNNING DAEMONS>."
16599 #: ../src/guestfs-actions.pod:6182
16600 msgid "guestfs_set_autosync"
16604 #: ../src/guestfs-actions.pod:6184
16608 " guestfs_set_autosync (guestfs_h *g,\n"
16609 " int autosync);\n"
16614 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4087
16616 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16617 "effort attempt to make filesystems consistent and synchronized when the "
16618 "handle is closed (also if the program exits without closing handles)."
16622 #: ../src/guestfs-actions.pod:6193 ../fish/guestfish-actions.pod:4092
16624 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16625 "disabled by default)."
16629 #: ../src/guestfs-actions.pod:6200
16630 msgid "guestfs_set_direct"
16634 #: ../src/guestfs-actions.pod:6202
16638 " guestfs_set_direct (guestfs_h *g,\n"
16644 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4101
16646 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16647 "passed directly through to the appliance once it is launched."
16651 #: ../src/guestfs-actions.pod:6210
16653 "One consequence of this is that log messages aren't caught by the library "
16654 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16659 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4109
16660 msgid "You probably don't want to use this unless you know what you are doing."
16664 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4112
16665 msgid "The default is disabled."
16669 #: ../src/guestfs-actions.pod:6223
16670 msgid "guestfs_set_e2label"
16674 #: ../src/guestfs-actions.pod:6225
16678 " guestfs_set_e2label (guestfs_h *g,\n"
16679 " const char *device,\n"
16680 " const char *label);\n"
16685 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4118
16687 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16688 "C<label>. Filesystem labels are limited to 16 characters."
16692 #: ../src/guestfs-actions.pod:6234
16694 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16695 "the existing label on a filesystem."
16699 #: ../src/guestfs-actions.pod:6241
16700 msgid "guestfs_set_e2uuid"
16704 #: ../src/guestfs-actions.pod:6243
16708 " guestfs_set_e2uuid (guestfs_h *g,\n"
16709 " const char *device,\n"
16710 " const char *uuid);\n"
16715 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4129
16717 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16718 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16719 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16723 #: ../src/guestfs-actions.pod:6253
16725 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16726 "the existing UUID of a filesystem."
16730 #: ../src/guestfs-actions.pod:6260
16731 msgid "guestfs_set_memsize"
16735 #: ../src/guestfs-actions.pod:6262
16739 " guestfs_set_memsize (guestfs_h *g,\n"
16745 #: ../src/guestfs-actions.pod:6266
16747 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16748 "This only has any effect if called before C<guestfs_launch>."
16752 #: ../src/guestfs-actions.pod:6270 ../fish/guestfish-actions.pod:4147
16754 "You can also change this by setting the environment variable "
16755 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16759 #: ../src/guestfs-actions.pod:6281
16760 msgid "guestfs_set_network"
16764 #: ../src/guestfs-actions.pod:6283
16768 " guestfs_set_network (guestfs_h *g,\n"
16774 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4160
16776 "If C<network> is true, then the network is enabled in the libguestfs "
16777 "appliance. The default is false."
16781 #: ../src/guestfs-actions.pod:6290 ../fish/guestfish-actions.pod:4163
16783 "This affects whether commands are able to access the network (see L<guestfs"
16784 "(3)/RUNNING COMMANDS>)."
16788 #: ../src/guestfs-actions.pod:6293
16790 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16795 #: ../src/guestfs-actions.pod:6300
16796 msgid "guestfs_set_path"
16800 #: ../src/guestfs-actions.pod:6302
16804 " guestfs_set_path (guestfs_h *g,\n"
16805 " const char *searchpath);\n"
16810 #: ../src/guestfs-actions.pod:6306 ../fish/guestfish-actions.pod:4175
16811 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16815 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4177
16817 "The default is C<$libdir/guestfs> unless overridden by setting "
16818 "C<LIBGUESTFS_PATH> environment variable."
16822 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4180
16823 msgid "Setting C<path> to C<NULL> restores the default path."
16827 #: ../src/guestfs-actions.pod:6317
16828 msgid "guestfs_set_qemu"
16832 #: ../src/guestfs-actions.pod:6319
16836 " guestfs_set_qemu (guestfs_h *g,\n"
16837 " const char *qemu);\n"
16842 #: ../src/guestfs-actions.pod:6323 ../fish/guestfish-actions.pod:4188
16843 msgid "Set the qemu binary that we will use."
16847 #: ../src/guestfs-actions.pod:6325 ../fish/guestfish-actions.pod:4190
16849 "The default is chosen when the library was compiled by the configure script."
16853 #: ../src/guestfs-actions.pod:6328 ../fish/guestfish-actions.pod:4193
16855 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16860 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4196
16861 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16865 #: ../src/guestfs-actions.pod:6333 ../fish/guestfish-actions.pod:4198
16867 "Note that you should call this function as early as possible after creating "
16868 "the handle. This is because some pre-launch operations depend on testing "
16869 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16870 "don't retest features, and so you might see inconsistent results. Using the "
16871 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16872 "the qemu binary at the same time as the handle is created."
16876 #: ../src/guestfs-actions.pod:6345
16877 msgid "guestfs_set_recovery_proc"
16881 #: ../src/guestfs-actions.pod:6347
16885 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16886 " int recoveryproc);\n"
16891 #: ../src/guestfs-actions.pod:6351
16893 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16894 "not create a recovery process. The purpose of the recovery process is to "
16895 "stop runaway qemu processes in the case where the main program aborts "
16900 #: ../src/guestfs-actions.pod:6356
16902 "This only has any effect if called before C<guestfs_launch>, and the default "
16907 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4220
16909 "About the only time when you would want to disable this is if the main "
16910 "process will fork itself into the background (\"daemonize\" itself). In "
16911 "this case the recovery process thinks that the main program has disappeared "
16912 "and so kills qemu, which is not very helpful."
16916 #: ../src/guestfs-actions.pod:6369
16917 msgid "guestfs_set_selinux"
16921 #: ../src/guestfs-actions.pod:6371
16925 " guestfs_set_selinux (guestfs_h *g,\n"
16931 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4232
16933 "This sets the selinux flag that is passed to the appliance at boot time. "
16934 "The default is C<selinux=0> (disabled)."
16938 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4235
16940 "Note that if SELinux is enabled, it is always in Permissive mode "
16941 "(C<enforcing=0>)."
16945 #: ../src/guestfs-actions.pod:6388
16946 msgid "guestfs_set_trace"
16950 #: ../src/guestfs-actions.pod:6390
16954 " guestfs_set_trace (guestfs_h *g,\n"
16960 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4247
16962 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16963 "return values are traced."
16967 #: ../src/guestfs-actions.pod:6397 ../fish/guestfish-actions.pod:4250
16969 "If you want to trace C API calls into libguestfs (and other libraries) then "
16970 "possibly a better way is to use the external ltrace(1) command."
16974 #: ../src/guestfs-actions.pod:6401 ../fish/guestfish-actions.pod:4254
16976 "Command traces are disabled unless the environment variable "
16977 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16981 #: ../src/guestfs-actions.pod:6404
16983 "Trace messages are normally sent to C<stderr>, unless you register a "
16984 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16988 #: ../src/guestfs-actions.pod:6412
16989 msgid "guestfs_set_verbose"
16993 #: ../src/guestfs-actions.pod:6414
16997 " guestfs_set_verbose (guestfs_h *g,\n"
17003 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4267
17004 msgid "If C<verbose> is true, this turns on verbose messages."
17008 #: ../src/guestfs-actions.pod:6420 ../fish/guestfish-actions.pod:4269
17010 "Verbose messages are disabled unless the environment variable "
17011 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17015 #: ../src/guestfs-actions.pod:6423
17017 "Verbose messages are normally sent to C<stderr>, unless you register a "
17018 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17022 #: ../src/guestfs-actions.pod:6431
17023 msgid "guestfs_setcon"
17027 #: ../src/guestfs-actions.pod:6433
17031 " guestfs_setcon (guestfs_h *g,\n"
17032 " const char *context);\n"
17037 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4280
17039 "This sets the SELinux security context of the daemon to the string "
17044 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4283
17045 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17049 #: ../src/guestfs-actions.pod:6446
17050 msgid "guestfs_setxattr"
17054 #: ../src/guestfs-actions.pod:6448
17058 " guestfs_setxattr (guestfs_h *g,\n"
17059 " const char *xattr,\n"
17060 " const char *val,\n"
17062 " const char *path);\n"
17067 #: ../src/guestfs-actions.pod:6455 ../fish/guestfish-actions.pod:4289
17069 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17070 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17074 #: ../src/guestfs-actions.pod:6459
17075 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17079 #: ../src/guestfs-actions.pod:6465
17080 msgid "guestfs_sfdisk"
17084 #: ../src/guestfs-actions.pod:6467
17088 " guestfs_sfdisk (guestfs_h *g,\n"
17089 " const char *device,\n"
17093 " char *const *lines);\n"
17098 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4299
17100 "This is a direct interface to the L<sfdisk(8)> program for creating "
17101 "partitions on block devices."
17105 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4302
17106 msgid "C<device> should be a block device, for example C</dev/sda>."
17110 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4304
17112 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17113 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17114 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17115 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17116 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17117 "the kernel) cannot work out the right geometry and you will need to tell it."
17121 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4312
17123 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17124 "refer to the L<sfdisk(8)> manpage."
17128 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4315
17130 "To create a single partition occupying the whole disk, you would pass "
17131 "C<lines> as a single element list, when the single element being the string "
17136 #: ../src/guestfs-actions.pod:6495
17138 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17142 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6533
17143 #: ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4325
17144 #: ../fish/guestfish-actions.pod:4348 ../fish/guestfish-actions.pod:4370
17146 "This function is deprecated. In new code, use the C<part_add> call instead."
17150 #: ../src/guestfs-actions.pod:6512
17151 msgid "guestfs_sfdiskM"
17155 #: ../src/guestfs-actions.pod:6514
17159 " guestfs_sfdiskM (guestfs_h *g,\n"
17160 " const char *device,\n"
17161 " char *const *lines);\n"
17166 #: ../src/guestfs-actions.pod:6519
17168 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17169 "partition sizes are specified in megabytes only (rounded to the nearest "
17170 "cylinder) and you don't need to specify the cyls, heads and sectors "
17171 "parameters which were rarely if ever used anyway."
17175 #: ../src/guestfs-actions.pod:6525
17177 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17178 "C<guestfs_part_disk>"
17182 #: ../src/guestfs-actions.pod:6542
17183 msgid "guestfs_sfdisk_N"
17187 #: ../src/guestfs-actions.pod:6544
17191 " guestfs_sfdisk_N (guestfs_h *g,\n"
17192 " const char *device,\n"
17197 " const char *line);\n"
17202 #: ../src/guestfs-actions.pod:6553 ../fish/guestfish-actions.pod:4359
17204 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17205 "(note: C<n> counts from 1)."
17209 #: ../src/guestfs-actions.pod:6556
17211 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17212 "for the cyls/heads/sectors parameters."
17216 #: ../src/guestfs-actions.pod:6559
17217 msgid "See also: C<guestfs_part_add>"
17221 #: ../src/guestfs-actions.pod:6575
17222 msgid "guestfs_sfdisk_disk_geometry"
17226 #: ../src/guestfs-actions.pod:6577
17230 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17231 " const char *device);\n"
17236 #: ../src/guestfs-actions.pod:6581
17238 "This displays the disk geometry of C<device> read from the partition table. "
17239 "Especially in the case where the underlying block device has been resized, "
17240 "this can be different from the kernel's idea of the geometry (see "
17241 "C<guestfs_sfdisk_kernel_geometry>)."
17245 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6602
17246 #: ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:4395
17247 msgid "The result is in human-readable format, and not designed to be parsed."
17251 #: ../src/guestfs-actions.pod:6594
17252 msgid "guestfs_sfdisk_kernel_geometry"
17256 #: ../src/guestfs-actions.pod:6596
17260 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17261 " const char *device);\n"
17266 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4393
17267 msgid "This displays the kernel's idea of the geometry of C<device>."
17271 #: ../src/guestfs-actions.pod:6610
17272 msgid "guestfs_sfdisk_l"
17276 #: ../src/guestfs-actions.pod:6612
17280 " guestfs_sfdisk_l (guestfs_h *g,\n"
17281 " const char *device);\n"
17286 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4402
17288 "This displays the partition table on C<device>, in the human-readable output "
17289 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17293 #: ../src/guestfs-actions.pod:6620
17294 msgid "See also: C<guestfs_part_list>"
17298 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4408
17300 "This function is deprecated. In new code, use the C<part_list> call instead."
17304 #: ../src/guestfs-actions.pod:6634
17309 #: ../src/guestfs-actions.pod:6636
17313 " guestfs_sh (guestfs_h *g,\n"
17314 " const char *command);\n"
17319 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4419
17321 "This call runs a command from the guest filesystem via the guest's C</bin/"
17326 #: ../src/guestfs-actions.pod:6643
17327 msgid "This is like C<guestfs_command>, but passes the command to:"
17331 #: ../src/guestfs-actions.pod:6645 ../fish/guestfish-actions.pod:4424
17334 " /bin/sh -c \"command\"\n"
17339 #: ../src/guestfs-actions.pod:6647 ../fish/guestfish-actions.pod:4426
17341 "Depending on the guest's shell, this usually results in wildcards being "
17342 "expanded, shell expressions being interpolated and so on."
17346 #: ../src/guestfs-actions.pod:6651
17347 msgid "All the provisos about C<guestfs_command> apply to this call."
17351 #: ../src/guestfs-actions.pod:6658
17352 msgid "guestfs_sh_lines"
17356 #: ../src/guestfs-actions.pod:6660
17360 " guestfs_sh_lines (guestfs_h *g,\n"
17361 " const char *command);\n"
17366 #: ../src/guestfs-actions.pod:6664
17368 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17373 #: ../src/guestfs-actions.pod:6667
17374 msgid "See also: C<guestfs_command_lines>"
17378 #: ../src/guestfs-actions.pod:6675
17379 msgid "guestfs_sleep"
17383 #: ../src/guestfs-actions.pod:6677
17387 " guestfs_sleep (guestfs_h *g,\n"
17393 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4445
17394 msgid "Sleep for C<secs> seconds."
17398 #: ../src/guestfs-actions.pod:6685
17399 msgid "(Added in 1.0.41)"
17403 #: ../src/guestfs-actions.pod:6687 ../src/guestfs-structs.pod:109
17404 msgid "guestfs_stat"
17408 #: ../src/guestfs-actions.pod:6689
17411 " struct guestfs_stat *\n"
17412 " guestfs_stat (guestfs_h *g,\n"
17413 " const char *path);\n"
17418 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4453
17419 msgid "This is the same as the C<stat(2)> system call."
17423 #: ../src/guestfs-actions.pod:6703 ../src/guestfs-structs.pod:135
17424 msgid "guestfs_statvfs"
17428 #: ../src/guestfs-actions.pod:6705
17431 " struct guestfs_statvfs *\n"
17432 " guestfs_statvfs (guestfs_h *g,\n"
17433 " const char *path);\n"
17438 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4459
17440 "Returns file system statistics for any mounted file system. C<path> should "
17441 "be a file or directory in the mounted file system (typically it is the mount "
17442 "point itself, but it doesn't need to be)."
17446 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4463
17447 msgid "This is the same as the C<statvfs(2)> system call."
17451 #: ../src/guestfs-actions.pod:6715
17453 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17454 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17458 #: ../src/guestfs-actions.pod:6721
17459 msgid "guestfs_strings"
17463 #: ../src/guestfs-actions.pod:6723
17467 " guestfs_strings (guestfs_h *g,\n"
17468 " const char *path);\n"
17473 #: ../src/guestfs-actions.pod:6727 ../fish/guestfish-actions.pod:4469
17475 "This runs the L<strings(1)> command on a file and returns the list of "
17476 "printable strings found."
17480 #: ../src/guestfs-actions.pod:6739
17481 msgid "guestfs_strings_e"
17485 #: ../src/guestfs-actions.pod:6741
17489 " guestfs_strings_e (guestfs_h *g,\n"
17490 " const char *encoding,\n"
17491 " const char *path);\n"
17496 #: ../src/guestfs-actions.pod:6746
17498 "This is like the C<guestfs_strings> command, but allows you to specify the "
17499 "encoding of strings that are looked for in the source file C<path>."
17503 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4483
17504 msgid "Allowed encodings are:"
17508 #: ../src/guestfs-actions.pod:6754 ../fish/guestfish-actions.pod:4487
17513 #: ../src/guestfs-actions.pod:6756
17515 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17516 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17520 #: ../src/guestfs-actions.pod:6759 ../fish/guestfish-actions.pod:4492
17525 #: ../src/guestfs-actions.pod:6761 ../fish/guestfish-actions.pod:4494
17526 msgid "Single 8-bit-byte characters."
17530 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4496
17535 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4498
17536 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17540 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4501
17541 msgid "l (lower case letter L)"
17545 #: ../src/guestfs-actions.pod:6770 ../fish/guestfish-actions.pod:4503
17547 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17548 "examining binaries in Windows guests."
17552 #: ../src/guestfs-actions.pod:6773 ../fish/guestfish-actions.pod:4506
17557 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4508
17558 msgid "32-bit big endian such as UCS-4BE."
17562 #: ../src/guestfs-actions.pod:6777 ../fish/guestfish-actions.pod:4510
17567 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4512
17568 msgid "32-bit little endian such as UCS-4LE."
17572 #: ../src/guestfs-actions.pod:6783 ../fish/guestfish-actions.pod:4516
17573 msgid "The returned strings are transcoded to UTF-8."
17577 #: ../src/guestfs-actions.pod:6794
17578 msgid "guestfs_swapoff_device"
17582 #: ../src/guestfs-actions.pod:6796
17586 " guestfs_swapoff_device (guestfs_h *g,\n"
17587 " const char *device);\n"
17592 #: ../src/guestfs-actions.pod:6800
17594 "This command disables the libguestfs appliance swap device or partition "
17595 "named C<device>. See C<guestfs_swapon_device>."
17599 #: ../src/guestfs-actions.pod:6808
17600 msgid "guestfs_swapoff_file"
17604 #: ../src/guestfs-actions.pod:6810
17608 " guestfs_swapoff_file (guestfs_h *g,\n"
17609 " const char *file);\n"
17614 #: ../src/guestfs-actions.pod:6814 ../fish/guestfish-actions.pod:4533
17615 msgid "This command disables the libguestfs appliance swap on file."
17619 #: ../src/guestfs-actions.pod:6820
17620 msgid "guestfs_swapoff_label"
17624 #: ../src/guestfs-actions.pod:6822
17628 " guestfs_swapoff_label (guestfs_h *g,\n"
17629 " const char *label);\n"
17634 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4539
17636 "This command disables the libguestfs appliance swap on labeled swap "
17641 #: ../src/guestfs-actions.pod:6833
17642 msgid "guestfs_swapoff_uuid"
17646 #: ../src/guestfs-actions.pod:6835
17650 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17651 " const char *uuid);\n"
17656 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4546
17658 "This command disables the libguestfs appliance swap partition with the given "
17663 #: ../src/guestfs-actions.pod:6846
17664 msgid "guestfs_swapon_device"
17668 #: ../src/guestfs-actions.pod:6848
17672 " guestfs_swapon_device (guestfs_h *g,\n"
17673 " const char *device);\n"
17678 #: ../src/guestfs-actions.pod:6852
17680 "This command enables the libguestfs appliance to use the swap device or "
17681 "partition named C<device>. The increased memory is made available for all "
17682 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17686 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4558
17688 "Note that you should not swap to existing guest swap partitions unless you "
17689 "know what you are doing. They may contain hibernation information, or other "
17690 "information that the guest doesn't want you to trash. You also risk leaking "
17691 "information about the host to the guest this way. Instead, attach a new "
17692 "host device to the guest and swap on that."
17696 #: ../src/guestfs-actions.pod:6868
17697 msgid "guestfs_swapon_file"
17701 #: ../src/guestfs-actions.pod:6870
17705 " guestfs_swapon_file (guestfs_h *g,\n"
17706 " const char *file);\n"
17711 #: ../src/guestfs-actions.pod:6874
17713 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17718 #: ../src/guestfs-actions.pod:6881
17719 msgid "guestfs_swapon_label"
17723 #: ../src/guestfs-actions.pod:6883
17727 " guestfs_swapon_label (guestfs_h *g,\n"
17728 " const char *label);\n"
17733 #: ../src/guestfs-actions.pod:6887
17735 "This command enables swap to a labeled swap partition. See "
17736 "C<guestfs_swapon_device> for other notes."
17740 #: ../src/guestfs-actions.pod:6894
17741 msgid "guestfs_swapon_uuid"
17745 #: ../src/guestfs-actions.pod:6896
17749 " guestfs_swapon_uuid (guestfs_h *g,\n"
17750 " const char *uuid);\n"
17755 #: ../src/guestfs-actions.pod:6900
17757 "This command enables swap to a swap partition with the given UUID. See "
17758 "C<guestfs_swapon_device> for other notes."
17762 #: ../src/guestfs-actions.pod:6907
17763 msgid "guestfs_sync"
17767 #: ../src/guestfs-actions.pod:6909
17771 " guestfs_sync (guestfs_h *g);\n"
17776 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4590
17778 "This syncs the disk, so that any writes are flushed through to the "
17779 "underlying disk image."
17783 #: ../src/guestfs-actions.pod:6915 ../fish/guestfish-actions.pod:4593
17785 "You should always call this if you have modified a disk image, before "
17786 "closing the handle."
17790 #: ../src/guestfs-actions.pod:6922
17791 msgid "guestfs_tail"
17795 #: ../src/guestfs-actions.pod:6924
17799 " guestfs_tail (guestfs_h *g,\n"
17800 " const char *path);\n"
17805 #: ../src/guestfs-actions.pod:6928 ../fish/guestfish-actions.pod:4600
17807 "This command returns up to the last 10 lines of a file as a list of strings."
17811 #: ../src/guestfs-actions.pod:6940
17812 msgid "guestfs_tail_n"
17816 #: ../src/guestfs-actions.pod:6942
17820 " guestfs_tail_n (guestfs_h *g,\n"
17822 " const char *path);\n"
17827 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4610
17829 "If the parameter C<nrlines> is a positive number, this returns the last "
17830 "C<nrlines> lines of the file C<path>."
17834 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4613
17836 "If the parameter C<nrlines> is a negative number, this returns lines from "
17837 "the file C<path>, starting with the C<-nrlines>th line."
17841 #: ../src/guestfs-actions.pod:6964
17842 msgid "guestfs_tar_in"
17846 #: ../src/guestfs-actions.pod:6966
17850 " guestfs_tar_in (guestfs_h *g,\n"
17851 " const char *tarfile,\n"
17852 " const char *directory);\n"
17857 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4625
17859 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17860 "tar file) into C<directory>."
17864 #: ../src/guestfs-actions.pod:6974
17866 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17870 #: ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:6996
17871 #: ../src/guestfs-actions.pod:7012 ../src/guestfs-actions.pod:7028
17872 msgid "(Added in 1.0.3)"
17876 #: ../src/guestfs-actions.pod:6981
17877 msgid "guestfs_tar_out"
17881 #: ../src/guestfs-actions.pod:6983
17885 " guestfs_tar_out (guestfs_h *g,\n"
17886 " const char *directory,\n"
17887 " const char *tarfile);\n"
17892 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4637
17894 "This command packs the contents of C<directory> and downloads it to local "
17899 #: ../src/guestfs-actions.pod:6991
17901 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17902 "C<guestfs_txz_out>."
17906 #: ../src/guestfs-actions.pod:6998
17907 msgid "guestfs_tgz_in"
17911 #: ../src/guestfs-actions.pod:7000
17915 " guestfs_tgz_in (guestfs_h *g,\n"
17916 " const char *tarball,\n"
17917 " const char *directory);\n"
17922 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4649
17924 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17925 "tar file) into C<directory>."
17929 #: ../src/guestfs-actions.pod:7008
17930 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17934 #: ../src/guestfs-actions.pod:7014
17935 msgid "guestfs_tgz_out"
17939 #: ../src/guestfs-actions.pod:7016
17943 " guestfs_tgz_out (guestfs_h *g,\n"
17944 " const char *directory,\n"
17945 " const char *tarball);\n"
17950 #: ../src/guestfs-actions.pod:7021 ../fish/guestfish-actions.pod:4660
17952 "This command packs the contents of C<directory> and downloads it to local "
17957 #: ../src/guestfs-actions.pod:7024
17958 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17962 #: ../src/guestfs-actions.pod:7030
17963 msgid "guestfs_touch"
17967 #: ../src/guestfs-actions.pod:7032
17971 " guestfs_touch (guestfs_h *g,\n"
17972 " const char *path);\n"
17977 #: ../src/guestfs-actions.pod:7036 ../fish/guestfish-actions.pod:4671
17979 "Touch acts like the L<touch(1)> command. It can be used to update the "
17980 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17985 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4675
17987 "This command only works on regular files, and will fail on other file types "
17988 "such as directories, symbolic links, block special etc."
17992 #: ../src/guestfs-actions.pod:7047
17993 msgid "guestfs_truncate"
17997 #: ../src/guestfs-actions.pod:7049
18001 " guestfs_truncate (guestfs_h *g,\n"
18002 " const char *path);\n"
18007 #: ../src/guestfs-actions.pod:7053 ../fish/guestfish-actions.pod:4682
18009 "This command truncates C<path> to a zero-length file. The file must exist "
18014 #: ../src/guestfs-actions.pod:7060
18015 msgid "guestfs_truncate_size"
18019 #: ../src/guestfs-actions.pod:7062
18023 " guestfs_truncate_size (guestfs_h *g,\n"
18024 " const char *path,\n"
18025 " int64_t size);\n"
18030 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4689
18032 "This command truncates C<path> to size C<size> bytes. The file must exist "
18037 #: ../src/guestfs-actions.pod:7070
18039 "If the current file size is less than C<size> then the file is extended to "
18040 "the required size with zero bytes. This creates a sparse file (ie. disk "
18041 "blocks are not allocated for the file until you write to it). To create a "
18042 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18046 #: ../src/guestfs-actions.pod:7080
18047 msgid "guestfs_tune2fs_l"
18051 #: ../src/guestfs-actions.pod:7082
18055 " guestfs_tune2fs_l (guestfs_h *g,\n"
18056 " const char *device);\n"
18061 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4702
18063 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18068 #: ../src/guestfs-actions.pod:7089 ../fish/guestfish-actions.pod:4705
18070 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18071 "for more details. The list of fields returned isn't clearly defined, and "
18072 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18073 "and the filesystem itself."
18077 #: ../src/guestfs-actions.pod:7102
18078 msgid "guestfs_txz_in"
18082 #: ../src/guestfs-actions.pod:7104
18086 " guestfs_txz_in (guestfs_h *g,\n"
18087 " const char *tarball,\n"
18088 " const char *directory);\n"
18093 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4714
18095 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18096 "tar file) into C<directory>."
18100 #: ../src/guestfs-actions.pod:7116
18101 msgid "guestfs_txz_out"
18105 #: ../src/guestfs-actions.pod:7118
18109 " guestfs_txz_out (guestfs_h *g,\n"
18110 " const char *directory,\n"
18111 " const char *tarball);\n"
18116 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4723
18118 "This command packs the contents of C<directory> and downloads it to local "
18119 "file C<tarball> (as an xz compressed tar archive)."
18123 #: ../src/guestfs-actions.pod:7130
18124 msgid "guestfs_umask"
18128 #: ../src/guestfs-actions.pod:7132
18132 " guestfs_umask (guestfs_h *g,\n"
18138 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4732
18140 "This function sets the mask used for creating new files and device nodes to "
18145 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4735
18147 "Typical umask values would be C<022> which creates new files with "
18148 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18149 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18153 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4740
18155 "The default umask is C<022>. This is important because it means that "
18156 "directories and device nodes will be created with C<0644> or C<0755> mode "
18157 "even if you specify C<0777>."
18161 #: ../src/guestfs-actions.pod:7148
18163 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18164 "C<guestfs_mkdir>."
18168 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4747
18169 msgid "This call returns the previous umask."
18173 #: ../src/guestfs-actions.pod:7157
18174 msgid "guestfs_umount"
18178 #: ../src/guestfs-actions.pod:7159
18182 " guestfs_umount (guestfs_h *g,\n"
18183 " const char *pathordevice);\n"
18188 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4755
18190 "This unmounts the given filesystem. The filesystem may be specified either "
18191 "by its mountpoint (path) or the device which contains the filesystem."
18195 #: ../src/guestfs-actions.pod:7171
18196 msgid "guestfs_umount_all"
18200 #: ../src/guestfs-actions.pod:7173
18204 " guestfs_umount_all (guestfs_h *g);\n"
18209 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4765
18210 msgid "This unmounts all mounted filesystems."
18214 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4767
18215 msgid "Some internal mounts are not unmounted by this call."
18219 #: ../src/guestfs-actions.pod:7184
18220 msgid "guestfs_upload"
18224 #: ../src/guestfs-actions.pod:7186
18228 " guestfs_upload (guestfs_h *g,\n"
18229 " const char *filename,\n"
18230 " const char *remotefilename);\n"
18235 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7215
18236 #: ../fish/guestfish-actions.pod:4773 ../fish/guestfish-actions.pod:4786
18237 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18241 #: ../src/guestfs-actions.pod:7196
18242 msgid "See also C<guestfs_download>."
18246 #: ../src/guestfs-actions.pod:7207
18247 msgid "guestfs_upload_offset"
18251 #: ../src/guestfs-actions.pod:7209
18255 " guestfs_upload_offset (guestfs_h *g,\n"
18256 " const char *filename,\n"
18257 " const char *remotefilename,\n"
18258 " int64_t offset);\n"
18263 #: ../src/guestfs-actions.pod:7218 ../fish/guestfish-actions.pod:4789
18265 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18266 "The intention is to overwrite parts of existing files or devices, although "
18267 "if a non-existant file is specified then it is created with a \"hole\" "
18268 "before C<offset>. The size of the data written is implicit in the size of "
18269 "the source C<filename>."
18273 #: ../src/guestfs-actions.pod:7225
18275 "Note that there is no limit on the amount of data that can be uploaded with "
18276 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18277 "full amount unless an error occurs."
18281 #: ../src/guestfs-actions.pod:7230
18282 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18286 #: ../src/guestfs-actions.pod:7241
18287 msgid "guestfs_utimens"
18291 #: ../src/guestfs-actions.pod:7243
18295 " guestfs_utimens (guestfs_h *g,\n"
18296 " const char *path,\n"
18297 " int64_t atsecs,\n"
18298 " int64_t atnsecs,\n"
18299 " int64_t mtsecs,\n"
18300 " int64_t mtnsecs);\n"
18305 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4809
18306 msgid "This command sets the timestamps of a file with nanosecond precision."
18310 #: ../src/guestfs-actions.pod:7254 ../fish/guestfish-actions.pod:4812
18312 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18317 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4815
18319 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18320 "nanoseconds from the epoch."
18324 #: ../src/guestfs-actions.pod:7260 ../fish/guestfish-actions.pod:4818
18326 "If the C<*nsecs> field contains the special value C<-1> then the "
18327 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18328 "ignored in this case)."
18332 #: ../src/guestfs-actions.pod:7264 ../fish/guestfish-actions.pod:4822
18334 "If the C<*nsecs> field contains the special value C<-2> then the "
18335 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18340 #: ../src/guestfs-actions.pod:7272 ../src/guestfs-structs.pod:175
18341 msgid "guestfs_version"
18345 #: ../src/guestfs-actions.pod:7274
18348 " struct guestfs_version *\n"
18349 " guestfs_version (guestfs_h *g);\n"
18354 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4830
18356 "Return the libguestfs version number that the program is linked against."
18360 #: ../src/guestfs-actions.pod:7280 ../fish/guestfish-actions.pod:4833
18362 "Note that because of dynamic linking this is not necessarily the version of "
18363 "libguestfs that you compiled against. You can compile the program, and then "
18364 "at runtime dynamically link against a completely different C<libguestfs.so> "
18369 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4838
18371 "This call was added in version C<1.0.58>. In previous versions of "
18372 "libguestfs there was no way to get the version number. From C code you can "
18373 "use dynamic linker functions to find out if this symbol exists (if it "
18374 "doesn't, then it's an earlier version)."
18378 #: ../src/guestfs-actions.pod:7291 ../fish/guestfish-actions.pod:4844
18380 "The call returns a structure with four elements. The first three (C<major>, "
18381 "C<minor> and C<release>) are numbers and correspond to the usual version "
18382 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18383 "but may be used for distro-specific information."
18387 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4850
18389 "To construct the original version string: C<$major.$minor.$release$extra>"
18393 #: ../src/guestfs-actions.pod:7300 ../fish/guestfish-actions.pod:4853
18394 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18398 #: ../src/guestfs-actions.pod:7302
18400 "I<Note:> Don't use this call to test for availability of features. In "
18401 "enterprise distributions we backport features from later versions into "
18402 "earlier versions, making this an unreliable way to test for features. Use "
18403 "C<guestfs_available> instead."
18407 #: ../src/guestfs-actions.pod:7308
18409 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18410 "error. I<The caller must call C<guestfs_free_version> after use>."
18414 #: ../src/guestfs-actions.pod:7312
18415 msgid "(Added in 1.0.58)"
18419 #: ../src/guestfs-actions.pod:7314
18420 msgid "guestfs_vfs_label"
18424 #: ../src/guestfs-actions.pod:7316
18428 " guestfs_vfs_label (guestfs_h *g,\n"
18429 " const char *device);\n"
18434 #: ../src/guestfs-actions.pod:7320 ../fish/guestfish-actions.pod:4865
18435 msgid "This returns the filesystem label of the filesystem on C<device>."
18439 #: ../src/guestfs-actions.pod:7323 ../fish/guestfish-actions.pod:4868
18440 msgid "If the filesystem is unlabeled, this returns the empty string."
18444 #: ../src/guestfs-actions.pod:7325
18445 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18449 #: ../src/guestfs-actions.pod:7330 ../src/guestfs-actions.pod:7367
18450 msgid "(Added in 1.3.18)"
18454 #: ../src/guestfs-actions.pod:7332
18455 msgid "guestfs_vfs_type"
18459 #: ../src/guestfs-actions.pod:7334
18463 " guestfs_vfs_type (guestfs_h *g,\n"
18464 " const char *device);\n"
18469 #: ../src/guestfs-actions.pod:7338 ../fish/guestfish-actions.pod:4876
18471 "This command gets the filesystem type corresponding to the filesystem on "
18476 #: ../src/guestfs-actions.pod:7341 ../fish/guestfish-actions.pod:4879
18478 "For most filesystems, the result is the name of the Linux VFS module which "
18479 "would be used to mount this filesystem if you mounted it without specifying "
18480 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18484 #: ../src/guestfs-actions.pod:7351
18485 msgid "guestfs_vfs_uuid"
18489 #: ../src/guestfs-actions.pod:7353
18493 " guestfs_vfs_uuid (guestfs_h *g,\n"
18494 " const char *device);\n"
18499 #: ../src/guestfs-actions.pod:7357 ../fish/guestfish-actions.pod:4888
18500 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18504 #: ../src/guestfs-actions.pod:7360 ../fish/guestfish-actions.pod:4891
18505 msgid "If the filesystem does not have a UUID, this returns the empty string."
18509 #: ../src/guestfs-actions.pod:7362
18510 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18514 #: ../src/guestfs-actions.pod:7369
18515 msgid "guestfs_vg_activate"
18519 #: ../src/guestfs-actions.pod:7371
18523 " guestfs_vg_activate (guestfs_h *g,\n"
18525 " char *const *volgroups);\n"
18530 #: ../src/guestfs-actions.pod:7376 ../fish/guestfish-actions.pod:4899
18532 "This command activates or (if C<activate> is false) deactivates all logical "
18533 "volumes in the listed volume groups C<volgroups>."
18537 #: ../src/guestfs-actions.pod:7379 ../fish/guestfish-actions.pod:4902
18538 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18542 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4904
18544 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18545 "activated or deactivated."
18549 #: ../src/guestfs-actions.pod:7388
18550 msgid "guestfs_vg_activate_all"
18554 #: ../src/guestfs-actions.pod:7390
18558 " guestfs_vg_activate_all (guestfs_h *g,\n"
18559 " int activate);\n"
18564 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4911
18566 "This command activates or (if C<activate> is false) deactivates all logical "
18567 "volumes in all volume groups."
18571 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:4914
18572 msgid "This command is the same as running C<vgchange -a y|n>"
18576 #: ../src/guestfs-actions.pod:7403
18577 msgid "guestfs_vgcreate"
18581 #: ../src/guestfs-actions.pod:7405
18585 " guestfs_vgcreate (guestfs_h *g,\n"
18586 " const char *volgroup,\n"
18587 " char *const *physvols);\n"
18592 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4920
18594 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18595 "of physical volumes C<physvols>."
18599 #: ../src/guestfs-actions.pod:7417
18600 msgid "guestfs_vglvuuids"
18604 #: ../src/guestfs-actions.pod:7419
18608 " guestfs_vglvuuids (guestfs_h *g,\n"
18609 " const char *vgname);\n"
18614 #: ../src/guestfs-actions.pod:7423 ../fish/guestfish-actions.pod:4927
18616 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18617 "volumes created in this volume group."
18621 #: ../src/guestfs-actions.pod:7426
18623 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18624 "associate logical volumes and volume groups."
18628 #: ../src/guestfs-actions.pod:7429
18629 msgid "See also C<guestfs_vgpvuuids>."
18633 #: ../src/guestfs-actions.pod:7437
18634 msgid "guestfs_vgpvuuids"
18638 #: ../src/guestfs-actions.pod:7439
18642 " guestfs_vgpvuuids (guestfs_h *g,\n"
18643 " const char *vgname);\n"
18648 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4939
18650 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18651 "volumes that this volume group resides on."
18655 #: ../src/guestfs-actions.pod:7446
18657 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18658 "associate physical volumes and volume groups."
18662 #: ../src/guestfs-actions.pod:7449
18663 msgid "See also C<guestfs_vglvuuids>."
18667 #: ../src/guestfs-actions.pod:7457
18668 msgid "guestfs_vgremove"
18672 #: ../src/guestfs-actions.pod:7459
18676 " guestfs_vgremove (guestfs_h *g,\n"
18677 " const char *vgname);\n"
18682 #: ../src/guestfs-actions.pod:7463 ../fish/guestfish-actions.pod:4951
18683 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18687 #: ../src/guestfs-actions.pod:7465 ../fish/guestfish-actions.pod:4953
18689 "This also forcibly removes all logical volumes in the volume group (if any)."
18693 #: ../src/guestfs-actions.pod:7472
18694 msgid "guestfs_vgrename"
18698 #: ../src/guestfs-actions.pod:7474
18702 " guestfs_vgrename (guestfs_h *g,\n"
18703 " const char *volgroup,\n"
18704 " const char *newvolgroup);\n"
18709 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4960
18710 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18714 #: ../src/guestfs-actions.pod:7485
18715 msgid "guestfs_vgs"
18719 #: ../src/guestfs-actions.pod:7487
18723 " guestfs_vgs (guestfs_h *g);\n"
18728 #: ../src/guestfs-actions.pod:7490 ../fish/guestfish-actions.pod:4966
18730 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18735 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4969
18737 "This returns a list of just the volume group names that were detected (eg. "
18742 #: ../src/guestfs-actions.pod:7496
18743 msgid "See also C<guestfs_vgs_full>."
18747 #: ../src/guestfs-actions.pod:7504
18748 msgid "guestfs_vgs_full"
18752 #: ../src/guestfs-actions.pod:7506
18755 " struct guestfs_lvm_vg_list *\n"
18756 " guestfs_vgs_full (guestfs_h *g);\n"
18761 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:4978
18763 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18764 "> command. The \"full\" version includes all fields."
18768 #: ../src/guestfs-actions.pod:7512
18770 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18771 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18775 #: ../src/guestfs-actions.pod:7518
18776 msgid "guestfs_vgscan"
18780 #: ../src/guestfs-actions.pod:7520
18784 " guestfs_vgscan (guestfs_h *g);\n"
18789 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:4985
18791 "This rescans all block devices and rebuilds the list of LVM physical "
18792 "volumes, volume groups and logical volumes."
18796 #: ../src/guestfs-actions.pod:7530
18797 msgid "guestfs_vguuid"
18801 #: ../src/guestfs-actions.pod:7532
18805 " guestfs_vguuid (guestfs_h *g,\n"
18806 " const char *vgname);\n"
18811 #: ../src/guestfs-actions.pod:7536 ../fish/guestfish-actions.pod:4992
18812 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18816 #: ../src/guestfs-actions.pod:7543
18817 msgid "guestfs_wait_ready"
18821 #: ../src/guestfs-actions.pod:7545
18825 " guestfs_wait_ready (guestfs_h *g);\n"
18830 #: ../src/guestfs-actions.pod:7548
18831 msgid "This function is a no op."
18835 #: ../src/guestfs-actions.pod:7550
18837 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18838 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18839 "is no longer necessary because C<guestfs_launch> now does the waiting."
18843 #: ../src/guestfs-actions.pod:7555
18845 "If you see any calls to this function in code then you can just remove them, "
18846 "unless you want to retain compatibility with older versions of the API."
18850 #: ../src/guestfs-actions.pod:7561
18852 "This function is deprecated. In new code, use the C<launch> call instead."
18856 #: ../src/guestfs-actions.pod:7570
18857 msgid "guestfs_wc_c"
18861 #: ../src/guestfs-actions.pod:7572
18865 " guestfs_wc_c (guestfs_h *g,\n"
18866 " const char *path);\n"
18871 #: ../src/guestfs-actions.pod:7576 ../fish/guestfish-actions.pod:4998
18873 "This command counts the characters in a file, using the C<wc -c> external "
18878 #: ../src/guestfs-actions.pod:7583
18879 msgid "guestfs_wc_l"
18883 #: ../src/guestfs-actions.pod:7585
18887 " guestfs_wc_l (guestfs_h *g,\n"
18888 " const char *path);\n"
18893 #: ../src/guestfs-actions.pod:7589 ../fish/guestfish-actions.pod:5005
18895 "This command counts the lines in a file, using the C<wc -l> external command."
18899 #: ../src/guestfs-actions.pod:7596
18900 msgid "guestfs_wc_w"
18904 #: ../src/guestfs-actions.pod:7598
18908 " guestfs_wc_w (guestfs_h *g,\n"
18909 " const char *path);\n"
18914 #: ../src/guestfs-actions.pod:7602 ../fish/guestfish-actions.pod:5012
18916 "This command counts the words in a file, using the C<wc -w> external command."
18920 #: ../src/guestfs-actions.pod:7609
18921 msgid "guestfs_write"
18925 #: ../src/guestfs-actions.pod:7611
18929 " guestfs_write (guestfs_h *g,\n"
18930 " const char *path,\n"
18931 " const char *content,\n"
18932 " size_t content_size);\n"
18937 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5019
18939 "This call creates a file called C<path>. The content of the file is the "
18940 "string C<content> (which can contain any 8 bit data)."
18944 #: ../src/guestfs-actions.pod:7627
18945 msgid "guestfs_write_file"
18949 #: ../src/guestfs-actions.pod:7629
18953 " guestfs_write_file (guestfs_h *g,\n"
18954 " const char *path,\n"
18955 " const char *content,\n"
18961 #: ../src/guestfs-actions.pod:7635 ../fish/guestfish-actions.pod:5029
18963 "This call creates a file called C<path>. The contents of the file is the "
18964 "string C<content> (which can contain any 8 bit data), with length C<size>."
18968 #: ../src/guestfs-actions.pod:7639 ../fish/guestfish-actions.pod:5033
18970 "As a special case, if C<size> is C<0> then the length is calculated using "
18971 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18975 #: ../src/guestfs-actions.pod:7643 ../fish/guestfish-actions.pod:5037
18977 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18978 "I<not> work, even if the length is specified."
18982 #: ../src/guestfs-actions.pod:7651 ../fish/guestfish-actions.pod:5043
18984 "This function is deprecated. In new code, use the C<write> call instead."
18988 #: ../src/guestfs-actions.pod:7660
18989 msgid "guestfs_zegrep"
18993 #: ../src/guestfs-actions.pod:7662
18997 " guestfs_zegrep (guestfs_h *g,\n"
18998 " const char *regex,\n"
18999 " const char *path);\n"
19004 #: ../src/guestfs-actions.pod:7667 ../fish/guestfish-actions.pod:5054
19006 "This calls the external C<zegrep> program and returns the matching lines."
19010 #: ../src/guestfs-actions.pod:7679
19011 msgid "guestfs_zegrepi"
19015 #: ../src/guestfs-actions.pod:7681
19019 " guestfs_zegrepi (guestfs_h *g,\n"
19020 " const char *regex,\n"
19021 " const char *path);\n"
19026 #: ../src/guestfs-actions.pod:7686 ../fish/guestfish-actions.pod:5064
19028 "This calls the external C<zegrep -i> program and returns the matching lines."
19032 #: ../src/guestfs-actions.pod:7698
19033 msgid "guestfs_zero"
19037 #: ../src/guestfs-actions.pod:7700
19041 " guestfs_zero (guestfs_h *g,\n"
19042 " const char *device);\n"
19047 #: ../src/guestfs-actions.pod:7704 ../fish/guestfish-actions.pod:5074
19048 msgid "This command writes zeroes over the first few blocks of C<device>."
19052 #: ../src/guestfs-actions.pod:7706 ../fish/guestfish-actions.pod:5076
19054 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19055 "securely wipe the device). It should be sufficient to remove any partition "
19056 "tables, filesystem superblocks and so on."
19060 #: ../src/guestfs-actions.pod:7710
19062 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
19063 "C<guestfs_is_zero_device>"
19067 #: ../src/guestfs-actions.pod:7722
19068 msgid "guestfs_zero_device"
19072 #: ../src/guestfs-actions.pod:7724
19076 " guestfs_zero_device (guestfs_h *g,\n"
19077 " const char *device);\n"
19082 #: ../src/guestfs-actions.pod:7728
19084 "This command writes zeroes over the entire C<device>. Compare with "
19085 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19089 #: ../src/guestfs-actions.pod:7742
19090 msgid "(Added in 1.3.1)"
19094 #: ../src/guestfs-actions.pod:7744
19095 msgid "guestfs_zerofree"
19099 #: ../src/guestfs-actions.pod:7746
19103 " guestfs_zerofree (guestfs_h *g,\n"
19104 " const char *device);\n"
19109 #: ../src/guestfs-actions.pod:7750 ../fish/guestfish-actions.pod:5098
19111 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19112 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19113 "possible to compress the filesystem more effectively."
19117 #: ../src/guestfs-actions.pod:7755 ../fish/guestfish-actions.pod:5103
19118 msgid "You should B<not> run this program if the filesystem is mounted."
19122 #: ../src/guestfs-actions.pod:7758 ../fish/guestfish-actions.pod:5106
19124 "It is possible that using this program can damage the filesystem or data on "
19129 #: ../src/guestfs-actions.pod:7765
19130 msgid "guestfs_zfgrep"
19134 #: ../src/guestfs-actions.pod:7767
19138 " guestfs_zfgrep (guestfs_h *g,\n"
19139 " const char *pattern,\n"
19140 " const char *path);\n"
19145 #: ../src/guestfs-actions.pod:7772 ../fish/guestfish-actions.pod:5113
19147 "This calls the external C<zfgrep> program and returns the matching lines."
19151 #: ../src/guestfs-actions.pod:7784
19152 msgid "guestfs_zfgrepi"
19156 #: ../src/guestfs-actions.pod:7786
19160 " guestfs_zfgrepi (guestfs_h *g,\n"
19161 " const char *pattern,\n"
19162 " const char *path);\n"
19167 #: ../src/guestfs-actions.pod:7791 ../fish/guestfish-actions.pod:5123
19169 "This calls the external C<zfgrep -i> program and returns the matching lines."
19173 #: ../src/guestfs-actions.pod:7803
19174 msgid "guestfs_zfile"
19178 #: ../src/guestfs-actions.pod:7805
19182 " guestfs_zfile (guestfs_h *g,\n"
19183 " const char *meth,\n"
19184 " const char *path);\n"
19189 #: ../src/guestfs-actions.pod:7810 ../fish/guestfish-actions.pod:5133
19191 "This command runs C<file> after first decompressing C<path> using C<method>."
19195 #: ../src/guestfs-actions.pod:7813 ../fish/guestfish-actions.pod:5136
19196 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19200 #: ../src/guestfs-actions.pod:7815
19202 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19207 #: ../src/guestfs-actions.pod:7821 ../fish/guestfish-actions.pod:5141
19209 "This function is deprecated. In new code, use the C<file> call instead."
19213 #: ../src/guestfs-actions.pod:7830
19214 msgid "guestfs_zgrep"
19218 #: ../src/guestfs-actions.pod:7832
19222 " guestfs_zgrep (guestfs_h *g,\n"
19223 " const char *regex,\n"
19224 " const char *path);\n"
19229 #: ../src/guestfs-actions.pod:7837 ../fish/guestfish-actions.pod:5152
19231 "This calls the external C<zgrep> program and returns the matching lines."
19235 #: ../src/guestfs-actions.pod:7849
19236 msgid "guestfs_zgrepi"
19240 #: ../src/guestfs-actions.pod:7851
19244 " guestfs_zgrepi (guestfs_h *g,\n"
19245 " const char *regex,\n"
19246 " const char *path);\n"
19251 #: ../src/guestfs-actions.pod:7856 ../fish/guestfish-actions.pod:5162
19253 "This calls the external C<zgrep -i> program and returns the matching lines."
19257 #: ../src/guestfs-availability.pod:3
19262 #: ../src/guestfs-availability.pod:5
19264 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19265 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19266 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19267 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19268 "L</guestfs_aug_save> L</guestfs_aug_set>"
19272 #: ../src/guestfs-availability.pod:21
19277 #: ../src/guestfs-availability.pod:23
19278 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
19282 #: ../src/guestfs-availability.pod:26
19287 #: ../src/guestfs-availability.pod:28
19289 "The following functions: L</guestfs_inotify_add_watch> L</"
19290 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19291 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19295 #: ../src/guestfs-availability.pod:36
19296 msgid "B<linuxfsuuid>"
19300 #: ../src/guestfs-availability.pod:38
19302 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19303 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19307 #: ../src/guestfs-availability.pod:45
19308 msgid "B<linuxmodules>"
19312 #: ../src/guestfs-availability.pod:47
19313 msgid "The following functions: L</guestfs_modprobe>"
19317 #: ../src/guestfs-availability.pod:50
19318 msgid "B<linuxxattrs>"
19322 #: ../src/guestfs-availability.pod:52
19324 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19325 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19326 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19327 "guestfs_setxattr>"
19331 #: ../src/guestfs-availability.pod:63
19336 #: ../src/guestfs-availability.pod:65
19338 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19339 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19340 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19344 #: ../src/guestfs-availability.pod:74
19349 #: ../src/guestfs-availability.pod:76
19351 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19352 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19353 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19354 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19355 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19356 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19357 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19361 #: ../src/guestfs-availability.pod:99
19366 #: ../src/guestfs-availability.pod:101
19368 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19369 "guestfs_mknod_b> L</guestfs_mknod_c>"
19373 #: ../src/guestfs-availability.pod:107
19378 #: ../src/guestfs-availability.pod:109
19379 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19383 #: ../src/guestfs-availability.pod:112
19384 msgid "B<ntfsprogs>"
19388 #: ../src/guestfs-availability.pod:114
19390 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
19391 "L</guestfs_ntfsresize_size>"
19395 #: ../src/guestfs-availability.pod:119
19396 msgid "B<realpath>"
19400 #: ../src/guestfs-availability.pod:121
19401 msgid "The following functions: L</guestfs_realpath>"
19405 #: ../src/guestfs-availability.pod:124
19410 #: ../src/guestfs-availability.pod:126
19412 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19413 "guestfs_scrub_freespace>"
19417 #: ../src/guestfs-availability.pod:131
19422 #: ../src/guestfs-availability.pod:133
19423 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19427 #: ../src/guestfs-availability.pod:137
19432 #: ../src/guestfs-availability.pod:139
19433 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19437 #: ../src/guestfs-availability.pod:143
19438 msgid "B<zerofree>"
19442 #: ../src/guestfs-availability.pod:145
19443 msgid "The following functions: L</guestfs_zerofree>"
19447 #: ../src/guestfs-structs.pod:1
19448 msgid "guestfs_int_bool"
19452 #: ../src/guestfs-structs.pod:3
19455 " struct guestfs_int_bool {\n"
19463 #: ../src/guestfs-structs.pod:8
19466 " struct guestfs_int_bool_list {\n"
19467 " uint32_t len; /* Number of elements in list. */\n"
19468 " struct guestfs_int_bool *val; /* Elements. */\n"
19474 #: ../src/guestfs-structs.pod:13
19477 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19478 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19483 #: ../src/guestfs-structs.pod:16
19484 msgid "guestfs_lvm_pv"
19488 #: ../src/guestfs-structs.pod:18
19491 " struct guestfs_lvm_pv {\n"
19492 " char *pv_name;\n"
19493 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19494 " char pv_uuid[32];\n"
19496 " uint64_t pv_size;\n"
19497 " uint64_t dev_size;\n"
19498 " uint64_t pv_free;\n"
19499 " uint64_t pv_used;\n"
19500 " char *pv_attr;\n"
19501 " int64_t pv_pe_count;\n"
19502 " int64_t pv_pe_alloc_count;\n"
19503 " char *pv_tags;\n"
19504 " uint64_t pe_start;\n"
19505 " int64_t pv_mda_count;\n"
19506 " uint64_t pv_mda_free;\n"
19512 #: ../src/guestfs-structs.pod:36
19515 " struct guestfs_lvm_pv_list {\n"
19516 " uint32_t len; /* Number of elements in list. */\n"
19517 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19523 #: ../src/guestfs-structs.pod:41
19526 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19527 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19532 #: ../src/guestfs-structs.pod:44
19533 msgid "guestfs_lvm_vg"
19537 #: ../src/guestfs-structs.pod:46
19540 " struct guestfs_lvm_vg {\n"
19541 " char *vg_name;\n"
19542 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19543 " char vg_uuid[32];\n"
19545 " char *vg_attr;\n"
19546 " uint64_t vg_size;\n"
19547 " uint64_t vg_free;\n"
19548 " char *vg_sysid;\n"
19549 " uint64_t vg_extent_size;\n"
19550 " int64_t vg_extent_count;\n"
19551 " int64_t vg_free_count;\n"
19552 " int64_t max_lv;\n"
19553 " int64_t max_pv;\n"
19554 " int64_t pv_count;\n"
19555 " int64_t lv_count;\n"
19556 " int64_t snap_count;\n"
19557 " int64_t vg_seqno;\n"
19558 " char *vg_tags;\n"
19559 " int64_t vg_mda_count;\n"
19560 " uint64_t vg_mda_free;\n"
19566 #: ../src/guestfs-structs.pod:69
19569 " struct guestfs_lvm_vg_list {\n"
19570 " uint32_t len; /* Number of elements in list. */\n"
19571 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19577 #: ../src/guestfs-structs.pod:74
19580 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19581 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19586 #: ../src/guestfs-structs.pod:77
19587 msgid "guestfs_lvm_lv"
19591 #: ../src/guestfs-structs.pod:79
19594 " struct guestfs_lvm_lv {\n"
19595 " char *lv_name;\n"
19596 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19597 " char lv_uuid[32];\n"
19598 " char *lv_attr;\n"
19599 " int64_t lv_major;\n"
19600 " int64_t lv_minor;\n"
19601 " int64_t lv_kernel_major;\n"
19602 " int64_t lv_kernel_minor;\n"
19603 " uint64_t lv_size;\n"
19604 " int64_t seg_count;\n"
19606 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19607 " float snap_percent;\n"
19608 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19609 " float copy_percent;\n"
19610 " char *move_pv;\n"
19611 " char *lv_tags;\n"
19612 " char *mirror_log;\n"
19613 " char *modules;\n"
19619 #: ../src/guestfs-structs.pod:101
19622 " struct guestfs_lvm_lv_list {\n"
19623 " uint32_t len; /* Number of elements in list. */\n"
19624 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19630 #: ../src/guestfs-structs.pod:106
19633 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19634 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19639 #: ../src/guestfs-structs.pod:111
19642 " struct guestfs_stat {\n"
19646 " int64_t nlink;\n"
19651 " int64_t blksize;\n"
19652 " int64_t blocks;\n"
19653 " int64_t atime;\n"
19654 " int64_t mtime;\n"
19655 " int64_t ctime;\n"
19661 #: ../src/guestfs-structs.pod:127
19664 " struct guestfs_stat_list {\n"
19665 " uint32_t len; /* Number of elements in list. */\n"
19666 " struct guestfs_stat *val; /* Elements. */\n"
19672 #: ../src/guestfs-structs.pod:132
19675 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19676 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19681 #: ../src/guestfs-structs.pod:137
19684 " struct guestfs_statvfs {\n"
19685 " int64_t bsize;\n"
19686 " int64_t frsize;\n"
19687 " int64_t blocks;\n"
19688 " int64_t bfree;\n"
19689 " int64_t bavail;\n"
19690 " int64_t files;\n"
19691 " int64_t ffree;\n"
19692 " int64_t favail;\n"
19695 " int64_t namemax;\n"
19701 #: ../src/guestfs-structs.pod:151
19704 " struct guestfs_statvfs_list {\n"
19705 " uint32_t len; /* Number of elements in list. */\n"
19706 " struct guestfs_statvfs *val; /* Elements. */\n"
19712 #: ../src/guestfs-structs.pod:156
19715 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19716 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19721 #: ../src/guestfs-structs.pod:159
19722 msgid "guestfs_dirent"
19726 #: ../src/guestfs-structs.pod:161
19729 " struct guestfs_dirent {\n"
19738 #: ../src/guestfs-structs.pod:167
19741 " struct guestfs_dirent_list {\n"
19742 " uint32_t len; /* Number of elements in list. */\n"
19743 " struct guestfs_dirent *val; /* Elements. */\n"
19749 #: ../src/guestfs-structs.pod:172
19752 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19753 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19758 #: ../src/guestfs-structs.pod:177
19761 " struct guestfs_version {\n"
19762 " int64_t major;\n"
19763 " int64_t minor;\n"
19764 " int64_t release;\n"
19771 #: ../src/guestfs-structs.pod:184
19774 " struct guestfs_version_list {\n"
19775 " uint32_t len; /* Number of elements in list. */\n"
19776 " struct guestfs_version *val; /* Elements. */\n"
19782 #: ../src/guestfs-structs.pod:189
19785 " void guestfs_free_version (struct guestfs_free_version *);\n"
19786 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19791 #: ../src/guestfs-structs.pod:192
19792 msgid "guestfs_xattr"
19796 #: ../src/guestfs-structs.pod:194
19799 " struct guestfs_xattr {\n"
19800 " char *attrname;\n"
19801 " /* The next two fields describe a byte array. */\n"
19802 " uint32_t attrval_len;\n"
19803 " char *attrval;\n"
19809 #: ../src/guestfs-structs.pod:201
19812 " struct guestfs_xattr_list {\n"
19813 " uint32_t len; /* Number of elements in list. */\n"
19814 " struct guestfs_xattr *val; /* Elements. */\n"
19820 #: ../src/guestfs-structs.pod:206
19823 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19824 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19829 #: ../src/guestfs-structs.pod:209
19830 msgid "guestfs_inotify_event"
19834 #: ../src/guestfs-structs.pod:211
19837 " struct guestfs_inotify_event {\n"
19838 " int64_t in_wd;\n"
19839 " uint32_t in_mask;\n"
19840 " uint32_t in_cookie;\n"
19841 " char *in_name;\n"
19847 #: ../src/guestfs-structs.pod:218
19850 " struct guestfs_inotify_event_list {\n"
19851 " uint32_t len; /* Number of elements in list. */\n"
19852 " struct guestfs_inotify_event *val; /* Elements. */\n"
19858 #: ../src/guestfs-structs.pod:223
19861 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19862 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19867 #: ../src/guestfs-structs.pod:226
19868 msgid "guestfs_partition"
19872 #: ../src/guestfs-structs.pod:228
19875 " struct guestfs_partition {\n"
19876 " int32_t part_num;\n"
19877 " uint64_t part_start;\n"
19878 " uint64_t part_end;\n"
19879 " uint64_t part_size;\n"
19885 #: ../src/guestfs-structs.pod:235
19888 " struct guestfs_partition_list {\n"
19889 " uint32_t len; /* Number of elements in list. */\n"
19890 " struct guestfs_partition *val; /* Elements. */\n"
19896 #: ../src/guestfs-structs.pod:240
19899 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19900 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19905 #: ../src/guestfs-structs.pod:243
19906 msgid "guestfs_application"
19910 #: ../src/guestfs-structs.pod:245
19913 " struct guestfs_application {\n"
19914 " char *app_name;\n"
19915 " char *app_display_name;\n"
19916 " int32_t app_epoch;\n"
19917 " char *app_version;\n"
19918 " char *app_release;\n"
19919 " char *app_install_path;\n"
19920 " char *app_trans_path;\n"
19921 " char *app_publisher;\n"
19922 " char *app_url;\n"
19923 " char *app_source_package;\n"
19924 " char *app_summary;\n"
19925 " char *app_description;\n"
19931 #: ../src/guestfs-structs.pod:260
19934 " struct guestfs_application_list {\n"
19935 " uint32_t len; /* Number of elements in list. */\n"
19936 " struct guestfs_application *val; /* Elements. */\n"
19942 #: ../src/guestfs-structs.pod:265
19945 " void guestfs_free_application (struct guestfs_free_application *);\n"
19946 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19951 #: ../fish/guestfish.pod:5
19952 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19956 #: ../fish/guestfish.pod:9
19959 " guestfish [--options] [commands]\n"
19964 #: ../fish/guestfish.pod:11
19972 #: ../fish/guestfish.pod:13
19975 " guestfish [--ro|--rw] -a disk.img\n"
19980 #: ../fish/guestfish.pod:15
19983 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19988 #: ../fish/guestfish.pod:17
19991 " guestfish -d libvirt-domain\n"
19996 #: ../fish/guestfish.pod:19
19999 " guestfish [--ro|--rw] -a disk.img -i\n"
20004 #: ../fish/guestfish.pod:21
20007 " guestfish -d libvirt-domain -i\n"
20012 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
20013 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
20018 #: ../fish/guestfish.pod:25
20020 "Using guestfish in read/write mode on live virtual machines can be "
20021 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20022 "option to use guestfish safely if the disk image or virtual machine might be "
20027 #: ../fish/guestfish.pod:32
20029 "Guestfish is a shell and command-line tool for examining and modifying "
20030 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20031 "functionality of the guestfs API, see L<guestfs(3)>."
20035 #: ../fish/guestfish.pod:36
20037 "Guestfish gives you structured access to the libguestfs API, from shell "
20038 "scripts or the command line or interactively. If you want to rescue a "
20039 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20044 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
20045 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
20050 #: ../fish/guestfish.pod:43
20051 msgid "As an interactive shell"
20055 #: ../fish/guestfish.pod:45
20063 #: ../fish/guestfish.pod:47
20066 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20067 " editing virtual machine filesystems.\n"
20072 #: ../fish/guestfish.pod:50
20075 " Type: 'help' for a list of commands\n"
20076 " 'man' to read the manual\n"
20077 " 'quit' to quit the shell\n"
20082 #: ../fish/guestfish.pod:54
20085 " ><fs> add-ro disk.img\n"
20087 " ><fs> list-filesystems\n"
20088 " /dev/sda1: ext4\n"
20089 " /dev/vg_guest/lv_root: ext4\n"
20090 " /dev/vg_guest/lv_swap: swap\n"
20091 " ><fs> mount /dev/vg_guest/lv_root /\n"
20092 " ><fs> cat /etc/fstab\n"
20094 " # Created by anaconda\n"
20101 #: ../fish/guestfish.pod:67
20102 msgid "From shell scripts"
20106 #: ../fish/guestfish.pod:69
20107 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20111 #: ../fish/guestfish.pod:71
20114 " guestfish <<_EOF_\n"
20117 " mount /dev/vg_guest/lv_root /\n"
20118 " write /etc/motd \"Welcome, new users\"\n"
20124 #: ../fish/guestfish.pod:78
20125 msgid "List the LVM logical volumes in a disk image:"
20129 #: ../fish/guestfish.pod:80
20132 " guestfish -a disk.img --ro <<_EOF_\n"
20140 #: ../fish/guestfish.pod:85
20141 msgid "List all the filesystems in a disk image:"
20145 #: ../fish/guestfish.pod:87
20148 " guestfish -a disk.img --ro <<_EOF_\n"
20150 " list-filesystems\n"
20156 #: ../fish/guestfish.pod:92
20157 msgid "On one command line"
20161 #: ../fish/guestfish.pod:94
20162 msgid "Update C</etc/resolv.conf> in a guest:"
20166 #: ../fish/guestfish.pod:96
20170 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20171 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20176 #: ../fish/guestfish.pod:100
20177 msgid "Edit C</boot/grub/grub.conf> interactively:"
20181 #: ../fish/guestfish.pod:102
20184 " guestfish --rw --add disk.img \\\n"
20185 " --mount /dev/vg_guest/lv_root \\\n"
20186 " --mount /dev/sda1:/boot \\\n"
20187 " edit /boot/grub/grub.conf\n"
20192 #: ../fish/guestfish.pod:107
20193 msgid "Mount disks automatically"
20197 #: ../fish/guestfish.pod:109
20199 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20203 #: ../fish/guestfish.pod:112
20206 " guestfish --ro -a disk.img -i cat /etc/group\n"
20211 #: ../fish/guestfish.pod:114
20214 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20219 #: ../fish/guestfish.pod:116
20220 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20224 #: ../fish/guestfish.pod:118
20227 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20232 #: ../fish/guestfish.pod:120
20233 msgid "As a script interpreter"
20237 #: ../fish/guestfish.pod:122
20238 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20242 #: ../fish/guestfish.pod:124
20245 " #!/usr/bin/guestfish -f\n"
20246 " sparse test1.img 100M\n"
20248 " part-disk /dev/sda mbr\n"
20249 " mkfs ext2 /dev/sda1\n"
20254 #: ../fish/guestfish.pod:130
20255 msgid "Start with a prepared disk"
20259 #: ../fish/guestfish.pod:132
20261 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20262 "single ext2-formatted partition:"
20266 #: ../fish/guestfish.pod:135
20269 " guestfish -N fs\n"
20274 #: ../fish/guestfish.pod:137
20275 msgid "To list what is available do:"
20279 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
20282 " guestfish -N help | less\n"
20287 #: ../fish/guestfish.pod:141
20288 msgid "Remote control"
20292 #: ../fish/guestfish.pod:143
20295 " eval \"`guestfish --listen`\"\n"
20296 " guestfish --remote add-ro disk.img\n"
20297 " guestfish --remote run\n"
20298 " guestfish --remote lvs\n"
20303 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20304 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
20305 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
20306 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20311 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
20312 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
20313 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
20314 #: ../tools/virt-list-partitions.pl:62
20319 #: ../fish/guestfish.pod:154
20320 msgid "Displays general help on options."
20324 #: ../fish/guestfish.pod:156
20329 #: ../fish/guestfish.pod:158
20330 msgid "B<--cmd-help>"
20334 #: ../fish/guestfish.pod:160
20335 msgid "Lists all available guestfish commands."
20339 #: ../fish/guestfish.pod:162
20344 #: ../fish/guestfish.pod:164
20345 msgid "B<--cmd-help cmd>"
20349 #: ../fish/guestfish.pod:166
20350 msgid "Displays detailed help on a single command C<cmd>."
20354 #: ../fish/guestfish.pod:168
20355 msgid "B<-a image>"
20359 #: ../fish/guestfish.pod:170
20360 msgid "B<--add image>"
20364 #: ../fish/guestfish.pod:172
20365 msgid "Add a block device or virtual machine image to the shell."
20369 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20371 "The format of the disk image is auto-detected. To override this and force a "
20372 "particular format use the I<--format=..> option."
20376 #: ../fish/guestfish.pod:177
20378 "Using this flag is mostly equivalent to using the C<add> command, with "
20379 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20380 "the I<--format=...> flag was given."
20384 #: ../fish/guestfish.pod:181
20389 #: ../fish/guestfish.pod:183
20390 msgid "B<--connect URI>"
20394 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20396 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20397 "URI to use. The default is to use the default libvirt connection."
20401 #: ../fish/guestfish.pod:189
20406 #: ../fish/guestfish.pod:191
20408 "If using the I<--listen> option and a csh-like shell, use this option. See "
20409 "section L</REMOTE CONTROL AND CSH> below."
20413 #: ../fish/guestfish.pod:194
20414 msgid "B<-d libvirt-domain>"
20418 #: ../fish/guestfish.pod:196
20419 msgid "B<--domain libvirt-domain>"
20423 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20425 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20426 "used, then any libvirt domain can be used. However in write mode, only "
20427 "libvirt domains which are shut down can be named here."
20431 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20432 msgid "Domain UUIDs can be used instead of names."
20436 #: ../fish/guestfish.pod:204
20438 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20439 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20440 "if the I<--format:...> flag was given."
20444 #: ../fish/guestfish.pod:208
20449 #: ../fish/guestfish.pod:210
20450 msgid "B<--no-dest-paths>"
20454 #: ../fish/guestfish.pod:212
20456 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20457 "to hit the tab key to complete paths on the guest filesystem, but this "
20458 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20459 "allow this feature to be disabled."
20463 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20464 msgid "B<--echo-keys>"
20468 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20470 "When prompting for keys and passphrases, guestfish normally turns echoing "
20471 "off so you cannot see what you are typing. If you are not worried about "
20472 "Tempest attacks and there is no one else in the room you can specify this "
20473 "flag to see what you are typing."
20477 #: ../fish/guestfish.pod:224
20482 #: ../fish/guestfish.pod:226
20483 msgid "B<--file file>"
20487 #: ../fish/guestfish.pod:228
20488 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20492 #: ../fish/guestfish.pod:231
20495 " #!/usr/bin/guestfish -f\n"
20500 #: ../fish/guestfish.pod:233
20501 msgid "B<--format=raw|qcow2|..>"
20505 #: ../fish/guestfish.pod:235
20506 msgid "B<--format>"
20510 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20512 "The default for the I<-a> option is to auto-detect the format of the disk "
20513 "image. Using this forces the disk format for I<-a> options which follow on "
20514 "the command line. Using I<--format> with no argument switches back to auto-"
20515 "detection for subsequent I<-a> options."
20519 #: ../fish/guestfish.pod:244
20522 " guestfish --format=raw -a disk.img\n"
20527 #: ../fish/guestfish.pod:246
20528 msgid "forces raw format (no auto-detection) for C<disk.img>."
20532 #: ../fish/guestfish.pod:248
20535 " guestfish --format=raw -a disk.img --format -a another.img\n"
20540 #: ../fish/guestfish.pod:250
20542 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20543 "detection for C<another.img>."
20547 #: ../fish/guestfish.pod:253
20549 "If you have untrusted raw-format guest disk images, you should use this "
20550 "option to specify the disk format. This avoids a possible security problem "
20551 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20555 #: ../fish/guestfish.pod:258
20560 #: ../fish/guestfish.pod:260
20561 msgid "B<--inspector>"
20565 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20567 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20568 "system and mount filesystems as they would be mounted on the real virtual "
20573 #: ../fish/guestfish.pod:266
20574 msgid "Typical usage is either:"
20578 #: ../fish/guestfish.pod:268
20581 " guestfish -d myguest -i\n"
20586 #: ../fish/guestfish.pod:270
20587 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20591 #: ../fish/guestfish.pod:272
20594 " guestfish --ro -d myguest -i\n"
20599 #: ../fish/guestfish.pod:274
20600 msgid "(for active domains, readonly), or specify the block device directly:"
20604 #: ../fish/guestfish.pod:276
20607 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20612 #: ../fish/guestfish.pod:278
20614 "Note that the command line syntax changed slightly over older versions of "
20615 "guestfish. You can still use the old syntax:"
20619 #: ../fish/guestfish.pod:281
20622 " guestfish [--ro] -i disk.img\n"
20627 #: ../fish/guestfish.pod:283
20630 " guestfish [--ro] -i libvirt-domain\n"
20635 #: ../fish/guestfish.pod:285
20637 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20638 "then using other commands to mount the filesystems that were found."
20642 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20643 msgid "B<--keys-from-stdin>"
20647 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20649 "Read key or passphrase parameters from stdin. The default is to try to read "
20650 "passphrases from the user by opening C</dev/tty>."
20654 #: ../fish/guestfish.pod:294
20655 msgid "B<--listen>"
20659 #: ../fish/guestfish.pod:296
20661 "Fork into the background and listen for remote commands. See section L</"
20662 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20666 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20671 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20673 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20674 "ATTACHING TO RUNNING DAEMONS>)."
20678 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20679 msgid "B<-m dev[:mountpoint[:options]]>"
20683 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20684 msgid "B<--mount dev[:mountpoint[:options]]>"
20688 #: ../fish/guestfish.pod:308
20689 msgid "Mount the named partition or logical volume on the given mountpoint."
20693 #: ../fish/guestfish.pod:310
20694 msgid "If the mountpoint is omitted, it defaults to C</>."
20698 #: ../fish/guestfish.pod:312
20699 msgid "You have to mount something on C</> before most commands will work."
20703 #: ../fish/guestfish.pod:314
20705 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20710 #: ../fish/guestfish.pod:317
20712 "If you don't know what filesystems a disk image contains, you can either run "
20713 "guestfish without this option, then list the partitions, filesystems and LVs "
20714 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20715 "commands), or you can use the L<virt-filesystems(1)> program."
20719 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20721 "The third (and rarely used) part of the mount parameter is the list of mount "
20722 "options used to mount the underlying filesystem. If this is not given, then "
20723 "the mount options are either the empty string or C<ro> (the latter if the "
20724 "I<--ro> flag is used). By specifying the mount options, you override this "
20725 "default choice. Probably the only time you would use this is to enable ACLs "
20726 "and/or extended attributes if the filesystem can support them:"
20730 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20733 " -m /dev/sda1:/:acl,user_xattr\n"
20738 #: ../fish/guestfish.pod:333
20739 msgid "Using this flag is equivalent to using the C<mount-options> command."
20743 #: ../fish/guestfish.pod:335
20748 #: ../fish/guestfish.pod:337
20749 msgid "B<--no-sync>"
20753 #: ../fish/guestfish.pod:339
20755 "Disable autosync. This is enabled by default. See the discussion of "
20756 "autosync in the L<guestfs(3)> manpage."
20760 #: ../fish/guestfish.pod:342
20765 #: ../fish/guestfish.pod:344
20766 msgid "B<--new type>"
20770 #: ../fish/guestfish.pod:346
20775 #: ../fish/guestfish.pod:348
20777 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20778 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20779 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20784 #: ../fish/guestfish.pod:353
20785 msgid "B<--progress-bars>"
20789 #: ../fish/guestfish.pod:355
20790 msgid "Enable progress bars, even when guestfish is used non-interactively."
20794 #: ../fish/guestfish.pod:357
20796 "Progress bars are enabled by default when guestfish is used as an "
20797 "interactive shell."
20801 #: ../fish/guestfish.pod:360
20802 msgid "B<--no-progress-bars>"
20806 #: ../fish/guestfish.pod:362
20807 msgid "Disable progress bars."
20811 #: ../fish/guestfish.pod:364
20812 msgid "B<--remote[=pid]>"
20816 #: ../fish/guestfish.pod:366
20818 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20819 "CONTROL GUESTFISH OVER A SOCKET> below."
20823 #: ../fish/guestfish.pod:369
20828 #: ../fish/guestfish.pod:371
20833 #: ../fish/guestfish.pod:373
20835 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20836 "mounts are done read-only."
20840 #: ../fish/guestfish.pod:376
20842 "The option must always be used if the disk image or virtual machine might be "
20843 "running, and is generally recommended in cases where you don't need write "
20844 "access to the disk."
20848 #: ../fish/guestfish.pod:380
20850 "Note that prepared disk images created with I<-N> are not affected by this "
20851 "option. Also commands like C<add> are not affected - you have to specify "
20852 "the C<readonly:true> option explicitly if you need it."
20856 #: ../fish/guestfish.pod:384
20857 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20861 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
20862 msgid "B<--selinux>"
20866 #: ../fish/guestfish.pod:388
20867 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20871 #: ../fish/guestfish.pod:390
20876 #: ../fish/guestfish.pod:392
20877 msgid "B<--verbose>"
20881 #: ../fish/guestfish.pod:394
20883 "Enable very verbose messages. This is particularly useful if you find a bug."
20887 #: ../fish/guestfish.pod:397
20892 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
20893 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
20894 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
20895 msgid "B<--version>"
20899 #: ../fish/guestfish.pod:401
20900 msgid "Display the guestfish / libguestfs version number and exit."
20904 #: ../fish/guestfish.pod:403
20909 #: ../fish/guestfish.pod:405
20914 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20916 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20917 "mounts are done read-write."
20921 #: ../fish/guestfish.pod:410
20922 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20926 #: ../fish/guestfish.pod:412
20931 #: ../fish/guestfish.pod:414
20932 msgid "Echo each command before executing it."
20936 #: ../fish/guestfish.pod:418
20937 msgid "COMMANDS ON COMMAND LINE"
20941 #: ../fish/guestfish.pod:420
20943 "Any additional (non-option) arguments are treated as commands to execute."
20947 #: ../fish/guestfish.pod:423
20949 "Commands to execute should be separated by a colon (C<:>), where the colon "
20950 "is a separate parameter. Thus:"
20954 #: ../fish/guestfish.pod:426
20957 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20962 #: ../fish/guestfish.pod:428
20964 "If there are no additional arguments, then we enter a shell, either an "
20965 "interactive shell with a prompt (if the input is a terminal) or a non-"
20966 "interactive shell."
20970 #: ../fish/guestfish.pod:432
20972 "In either command line mode or non-interactive shell, the first command that "
20973 "gives an error causes the whole shell to exit. In interactive mode (with a "
20974 "prompt) if a command fails, you can continue to enter commands."
20978 #: ../fish/guestfish.pod:437
20979 msgid "USING launch (OR run)"
20983 #: ../fish/guestfish.pod:439
20985 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20986 "then launch it, then mount any disks you need, and finally issue actions/"
20987 "commands. So the general order of the day is:"
20991 #: ../fish/guestfish.pod:447
20992 msgid "add or -a/--add"
20996 #: ../fish/guestfish.pod:451
20997 msgid "launch (aka run)"
21001 #: ../fish/guestfish.pod:455
21002 msgid "mount or -m/--mount"
21006 #: ../fish/guestfish.pod:459
21007 msgid "any other commands"
21011 #: ../fish/guestfish.pod:463
21013 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21014 "guest before mounting or performing any other commands."
21018 #: ../fish/guestfish.pod:466
21020 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21021 "I<--new> options were given then C<run> is done automatically, simply "
21022 "because guestfish can't perform the action you asked for without doing this."
21026 #: ../fish/guestfish.pod:471
21027 msgid "OPENING DISKS FOR READ AND WRITE"
21031 #: ../fish/guestfish.pod:473
21033 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
21034 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
21035 "I<-i> and I<-m> open disk images read-only or for writing."
21039 #: ../fish/guestfish.pod:478
21041 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
21042 "opening disk images supplied on the command line for write. To open a disk "
21043 "image read-only you have to do I<-a image --ro>."
21047 #: ../fish/guestfish.pod:482
21049 "This matters: If you accidentally open a live VM disk image writable then "
21050 "you will cause irreversible disk corruption."
21054 #: ../fish/guestfish.pod:485
21056 "By libguestfs 1.12 we intend to change the default the other way. Disk "
21057 "images will be opened read-only. You will have to either specify "
21058 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
21059 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
21060 "access for disk images specified by those other command line options."
21064 #: ../fish/guestfish.pod:492
21066 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
21067 "which does nothing (it is already the default). However it is highly "
21068 "recommended that you use this option to indicate that you need write access, "
21069 "and prepare your scripts for the day when this option will be required for "
21074 #: ../fish/guestfish.pod:498
21076 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21077 "other libguestfs program apart from guestfish and guestmount."
21081 #: ../fish/guestfish.pod:501
21086 #: ../fish/guestfish.pod:503
21088 "You can quote ordinary parameters using either single or double quotes. For "
21093 #: ../fish/guestfish.pod:506
21096 " add \"file with a space.img\"\n"
21101 #: ../fish/guestfish.pod:508
21104 " rm '/file name'\n"
21109 #: ../fish/guestfish.pod:510
21117 #: ../fish/guestfish.pod:512
21119 "A few commands require a list of strings to be passed. For these, use a "
21120 "whitespace-separated list, enclosed in quotes. Strings containing "
21121 "whitespace to be passed through must be enclosed in single quotes. A "
21122 "literal single quote must be escaped with a backslash."
21126 #: ../fish/guestfish.pod:517
21129 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21130 " command \"/bin/echo 'foo bar'\"\n"
21131 " command \"/bin/echo \\'foo\\'\"\n"
21136 #: ../fish/guestfish.pod:521
21137 msgid "OPTIONAL ARGUMENTS"
21141 #: ../fish/guestfish.pod:523
21143 "Some commands take optional arguments. These arguments appear in this "
21144 "documentation as C<[argname:..]>. You can use them as in these examples:"
21148 #: ../fish/guestfish.pod:527
21151 " add-drive-opts filename\n"
21156 #: ../fish/guestfish.pod:529
21159 " add-drive-opts filename readonly:true\n"
21164 #: ../fish/guestfish.pod:531
21167 " add-drive-opts filename format:qcow2 readonly:false\n"
21172 #: ../fish/guestfish.pod:533
21174 "Each optional argument can appear at most once. All optional arguments must "
21175 "appear after the required ones."
21179 #: ../fish/guestfish.pod:536
21184 #: ../fish/guestfish.pod:538
21186 "This section applies to all commands which can take integers as parameters."
21190 #: ../fish/guestfish.pod:541
21191 msgid "SIZE SUFFIX"
21195 #: ../fish/guestfish.pod:543
21197 "When the command takes a parameter measured in bytes, you can use one of the "
21198 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21202 #: ../fish/guestfish.pod:549
21203 msgid "B<k> or B<K> or B<KiB>"
21207 #: ../fish/guestfish.pod:551
21208 msgid "The size in kilobytes (multiplied by 1024)."
21212 #: ../fish/guestfish.pod:553
21217 #: ../fish/guestfish.pod:555
21218 msgid "The size in SI 1000 byte units."
21222 #: ../fish/guestfish.pod:557
21223 msgid "B<M> or B<MiB>"
21227 #: ../fish/guestfish.pod:559
21228 msgid "The size in megabytes (multiplied by 1048576)."
21232 #: ../fish/guestfish.pod:561
21237 #: ../fish/guestfish.pod:563
21238 msgid "The size in SI 1000000 byte units."
21242 #: ../fish/guestfish.pod:565
21243 msgid "B<G> or B<GiB>"
21247 #: ../fish/guestfish.pod:567
21248 msgid "The size in gigabytes (multiplied by 2**30)."
21252 #: ../fish/guestfish.pod:569
21257 #: ../fish/guestfish.pod:571
21258 msgid "The size in SI 10**9 byte units."
21262 #: ../fish/guestfish.pod:573
21263 msgid "B<T> or B<TiB>"
21267 #: ../fish/guestfish.pod:575
21268 msgid "The size in terabytes (multiplied by 2**40)."
21272 #: ../fish/guestfish.pod:577
21277 #: ../fish/guestfish.pod:579
21278 msgid "The size in SI 10**12 byte units."
21282 #: ../fish/guestfish.pod:581
21283 msgid "B<P> or B<PiB>"
21287 #: ../fish/guestfish.pod:583
21288 msgid "The size in petabytes (multiplied by 2**50)."
21292 #: ../fish/guestfish.pod:585
21297 #: ../fish/guestfish.pod:587
21298 msgid "The size in SI 10**15 byte units."
21302 #: ../fish/guestfish.pod:589
21303 msgid "B<E> or B<EiB>"
21307 #: ../fish/guestfish.pod:591
21308 msgid "The size in exabytes (multiplied by 2**60)."
21312 #: ../fish/guestfish.pod:593
21317 #: ../fish/guestfish.pod:595
21318 msgid "The size in SI 10**18 byte units."
21322 #: ../fish/guestfish.pod:597
21323 msgid "B<Z> or B<ZiB>"
21327 #: ../fish/guestfish.pod:599
21328 msgid "The size in zettabytes (multiplied by 2**70)."
21332 #: ../fish/guestfish.pod:601
21337 #: ../fish/guestfish.pod:603
21338 msgid "The size in SI 10**21 byte units."
21342 #: ../fish/guestfish.pod:605
21343 msgid "B<Y> or B<YiB>"
21347 #: ../fish/guestfish.pod:607
21348 msgid "The size in yottabytes (multiplied by 2**80)."
21352 #: ../fish/guestfish.pod:609
21357 #: ../fish/guestfish.pod:611
21358 msgid "The size in SI 10**24 byte units."
21362 #: ../fish/guestfish.pod:617
21365 " truncate-size /file 1G\n"
21370 #: ../fish/guestfish.pod:619
21371 msgid "would truncate the file to 1 gigabyte."
21375 #: ../fish/guestfish.pod:621
21377 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21378 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21379 "suffix will probably not do what you expect."
21383 #: ../fish/guestfish.pod:625
21384 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21388 #: ../fish/guestfish.pod:627
21390 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21391 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21395 #: ../fish/guestfish.pod:630
21398 " 1234 decimal number 1234\n"
21399 " 02322 octal number, equivalent to decimal 1234\n"
21400 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21405 #: ../fish/guestfish.pod:634
21407 "When using the C<chmod> command, you almost always want to specify an octal "
21408 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21409 "L<chmod(1)> program):"
21413 #: ../fish/guestfish.pod:638
21416 " chmod 0777 /public # OK\n"
21417 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21422 #: ../fish/guestfish.pod:641
21424 "Commands that return numbers usually print them in decimal, but some "
21425 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21426 "octal, preceeded by C<0>)."
21430 #: ../fish/guestfish.pod:645
21431 msgid "WILDCARDS AND GLOBBING"
21435 #: ../fish/guestfish.pod:647
21437 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21438 "(globbing) by default. So for example the following will not do what you "
21443 #: ../fish/guestfish.pod:651
21451 #: ../fish/guestfish.pod:653
21453 "Assuming you don't have a directory called literally C</home/*> then the "
21454 "above command will return an error."
21458 #: ../fish/guestfish.pod:656
21459 msgid "To perform wildcard expansion, use the C<glob> command."
21463 #: ../fish/guestfish.pod:658
21466 " glob rm-rf /home/*\n"
21471 #: ../fish/guestfish.pod:660
21473 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21474 "many times), equivalent to:"
21478 #: ../fish/guestfish.pod:663
21481 " rm-rf /home/jim\n"
21482 " rm-rf /home/joe\n"
21483 " rm-rf /home/mary\n"
21488 #: ../fish/guestfish.pod:667
21489 msgid "C<glob> only works on simple guest paths and not on device names."
21493 #: ../fish/guestfish.pod:669
21495 "If you have several parameters, each containing a wildcard, then glob will "
21496 "perform a Cartesian product."
21500 #: ../fish/guestfish.pod:672
21505 #: ../fish/guestfish.pod:674
21507 "Any line which starts with a I<#> character is treated as a comment and "
21508 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21509 "a command. For example:"
21513 #: ../fish/guestfish.pod:678
21516 " # this is a comment\n"
21517 " # this is a comment\n"
21518 " foo # NOT a comment\n"
21523 #: ../fish/guestfish.pod:682
21524 msgid "Blank lines are also ignored."
21528 #: ../fish/guestfish.pod:684
21529 msgid "RUNNING COMMANDS LOCALLY"
21533 #: ../fish/guestfish.pod:686
21535 "Any line which starts with a I<!> character is treated as a command sent to "
21536 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21540 #: ../fish/guestfish.pod:690
21544 " tgz-out /remote local/remote-data.tar.gz\n"
21549 #: ../fish/guestfish.pod:693
21551 "will create a directory C<local> on the host, and then export the contents "
21552 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21553 "(See C<tgz-out>)."
21557 #: ../fish/guestfish.pod:697
21559 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21560 "effect, due to the way that subprocesses work in Unix."
21564 #: ../fish/guestfish.pod:700
21565 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21569 #: ../fish/guestfish.pod:702
21571 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21572 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21573 "and executed as guestfish commands."
21577 #: ../fish/guestfish.pod:706
21579 "Thus you can use shell script to construct arbitrary guestfish commands "
21580 "which are then parsed by guestfish."
21584 #: ../fish/guestfish.pod:709
21586 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21587 "through C</foo.100>) using guestfish commands alone. However this is simple "
21588 "if we use a shell script to create the guestfish commands for us:"
21592 #: ../fish/guestfish.pod:714
21595 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21600 #: ../fish/guestfish.pod:716
21601 msgid "or with names like C</foo.001>:"
21605 #: ../fish/guestfish.pod:718
21608 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21613 #: ../fish/guestfish.pod:720
21615 "When using guestfish interactively it can be helpful to just run the shell "
21616 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21617 "ordinary I<!> local command), see what guestfish commands it would run, and "
21618 "when you are happy with those prepend the C<E<lt>> character to run the "
21619 "guestfish commands for real."
21623 #: ../fish/guestfish.pod:726
21628 #: ../fish/guestfish.pod:728
21630 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21631 "command (a guestfish command) to the second command (any host command). For "
21636 #: ../fish/guestfish.pod:732
21639 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21644 #: ../fish/guestfish.pod:734
21646 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21647 "program). The above command would list all accounts in the guest filesystem "
21648 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21652 #: ../fish/guestfish.pod:739
21655 " hexdump /bin/ls | head\n"
21656 " list-devices | tail -1\n"
21657 " tgz-out / - | tar ztf -\n"
21662 #: ../fish/guestfish.pod:743
21664 "The space before the pipe symbol is required, any space after the pipe "
21665 "symbol is optional. Everything after the pipe symbol is just passed "
21666 "straight to the host shell, so it can contain redirections, globs and "
21667 "anything else that makes sense on the host side."
21671 #: ../fish/guestfish.pod:748
21673 "To use a literal argument which begins with a pipe symbol, you have to quote "
21678 #: ../fish/guestfish.pod:751
21686 #: ../fish/guestfish.pod:753
21687 msgid "HOME DIRECTORIES"
21691 #: ../fish/guestfish.pod:755
21693 "If a parameter starts with the character C<~> then the tilde may be expanded "
21694 "as a home directory path (either C<~> for the current user's home directory, "
21695 "or C<~user> for another user)."
21699 #: ../fish/guestfish.pod:759
21701 "Note that home directory expansion happens for users known I<on the host>, "
21702 "not in the guest filesystem."
21706 #: ../fish/guestfish.pod:762
21708 "To use a literal argument which begins with a tilde, you have to quote it, "
21713 #: ../fish/guestfish.pod:765
21721 #: ../fish/guestfish.pod:769
21723 "Libguestfs has some support for Linux guests encrypted according to the "
21724 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21725 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21726 "LUKS is supported."
21730 #: ../fish/guestfish.pod:774
21731 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21735 #: ../fish/guestfish.pod:776
21738 " ><fs> vfs-type /dev/sda2\n"
21744 #: ../fish/guestfish.pod:779
21746 "Then open those devices using L</luks-open>. This creates a device-mapper "
21747 "device called C</dev/mapper/luksdev>."
21751 #: ../fish/guestfish.pod:782
21754 " ><fs> luks-open /dev/sda2 luksdev\n"
21755 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21760 #: ../fish/guestfish.pod:785
21762 "Finally you have to tell LVM to scan for volume groups on the newly created "
21767 #: ../fish/guestfish.pod:788
21771 " vg-activate-all true\n"
21776 #: ../fish/guestfish.pod:791
21777 msgid "The logical volume(s) can now be mounted in the usual way."
21781 #: ../fish/guestfish.pod:793
21783 "Before closing a LUKS device you must unmount any logical volumes on it and "
21784 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21785 "one. Then you can close the mapper device:"
21789 #: ../fish/guestfish.pod:797
21792 " vg-activate false /dev/VG\n"
21793 " luks-close /dev/mapper/luksdev\n"
21798 #: ../fish/guestfish.pod:800
21799 msgid "WINDOWS PATHS"
21803 #: ../fish/guestfish.pod:802
21805 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21806 "letters and paths (with some limitations). The following commands are "
21811 #: ../fish/guestfish.pod:806
21814 " file /WINDOWS/system32/config/system.LOG\n"
21819 #: ../fish/guestfish.pod:808
21822 " file win:\\windows\\system32\\config\\system.log\n"
21827 #: ../fish/guestfish.pod:810
21830 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21835 #: ../fish/guestfish.pod:812
21837 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21838 "where the drive is mounted, prepending that to the path, changing all "
21839 "backslash characters to forward slash, then resolving the result using L</"
21840 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21841 "the parameter might be rewritten like this:"
21845 #: ../fish/guestfish.pod:818
21848 " win:e:\\foo\\bar => /e/FOO/bar\n"
21853 #: ../fish/guestfish.pod:820
21854 msgid "This only works in argument positions that expect a path."
21858 #: ../fish/guestfish.pod:822
21859 msgid "UPLOADING AND DOWNLOADING FILES"
21863 #: ../fish/guestfish.pod:824
21865 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21866 "others which upload from or download to a local file, you can use the "
21867 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21871 #: ../fish/guestfish.pod:828
21879 #: ../fish/guestfish.pod:830
21881 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21885 #: ../fish/guestfish.pod:833
21888 " tar-out /etc - | tar tf -\n"
21893 #: ../fish/guestfish.pod:835
21895 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21896 "command (see L</PIPES>)."
21900 #: ../fish/guestfish.pod:838
21902 "When using C<-> to read from stdin, the input is read up to the end of "
21903 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21904 "some arbitrary end marker:"
21908 #: ../fish/guestfish.pod:842
21911 " upload -<<END /foo\n"
21920 #: ../fish/guestfish.pod:848
21922 "Any string of characters can be used instead of C<END>. The end marker must "
21923 "appear on a line of its own, without any preceeding or following characters "
21924 "(not even spaces)."
21928 #: ../fish/guestfish.pod:852
21930 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21931 "upload local files (so-called \"FileIn\" parameters in the generator)."
21935 #: ../fish/guestfish.pod:855
21936 msgid "EXIT ON ERROR BEHAVIOUR"
21940 #: ../fish/guestfish.pod:857
21942 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21943 "taking commands from a human over a tty), and will exit on the first error "
21944 "in non-interactive mode (scripts, commands given on the command line)."
21948 #: ../fish/guestfish.pod:862
21950 "If you prefix a command with a I<-> character, then that command will not "
21951 "cause guestfish to exit, even if that (one) command returns an error."
21955 #: ../fish/guestfish.pod:866
21956 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21960 #: ../fish/guestfish.pod:868
21962 "Guestfish can be remote-controlled over a socket. This is useful "
21963 "particularly in shell scripts where you want to make several different "
21964 "changes to a filesystem, but you don't want the overhead of starting up a "
21965 "guestfish process each time."
21969 #: ../fish/guestfish.pod:873
21970 msgid "Start a guestfish server process using:"
21974 #: ../fish/guestfish.pod:875
21977 " eval \"`guestfish --listen`\"\n"
21982 #: ../fish/guestfish.pod:877
21983 msgid "and then send it commands by doing:"
21987 #: ../fish/guestfish.pod:879
21990 " guestfish --remote cmd [...]\n"
21995 #: ../fish/guestfish.pod:881
21996 msgid "To cause the server to exit, send it the exit command:"
22000 #: ../fish/guestfish.pod:883
22003 " guestfish --remote exit\n"
22008 #: ../fish/guestfish.pod:885
22010 "Note that the server will normally exit if there is an error in a command. "
22011 "You can change this in the usual way. See section L</EXIT ON ERROR "
22016 #: ../fish/guestfish.pod:889
22017 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22021 #: ../fish/guestfish.pod:891
22023 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22024 "is how the I<--remote> option knows where to send the commands. You can "
22025 "have several guestfish listener processes running using:"
22029 #: ../fish/guestfish.pod:895
22032 " eval \"`guestfish --listen`\"\n"
22033 " pid1=$GUESTFISH_PID\n"
22034 " eval \"`guestfish --listen`\"\n"
22035 " pid2=$GUESTFISH_PID\n"
22037 " guestfish --remote=$pid1 cmd\n"
22038 " guestfish --remote=$pid2 cmd\n"
22043 #: ../fish/guestfish.pod:903
22044 msgid "REMOTE CONTROL AND CSH"
22048 #: ../fish/guestfish.pod:905
22050 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22055 #: ../fish/guestfish.pod:908
22058 " eval \"`guestfish --listen --csh`\"\n"
22063 #: ../fish/guestfish.pod:910
22064 msgid "REMOTE CONTROL DETAILS"
22068 #: ../fish/guestfish.pod:912
22070 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22071 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22072 "and C<$PID> is the process ID of the server."
22076 #: ../fish/guestfish.pod:916
22077 msgid "Guestfish client and server versions must match exactly."
22081 #: ../fish/guestfish.pod:918
22082 msgid "PREPARED DISK IMAGES"
22086 #: ../fish/guestfish.pod:920
22088 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22089 "preformatted disk images that guestfish can make for you to save typing. "
22090 "This is particularly useful for testing purposes. This option is used "
22091 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22092 "can be mixed with I<-a>)."
22096 #: ../fish/guestfish.pod:926
22098 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22099 "the second and so on. Existing files in the current directory are "
22104 #: ../fish/guestfish.pod:930
22106 "The type briefly describes how the disk should be sized, partitioned, how "
22107 "filesystem(s) should be created, and how content should be added. "
22108 "Optionally the type can be followed by extra parameters, separated by C<:> "
22109 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22110 "allocated disk, containing a single partition, with the partition formatted "
22111 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22116 #: ../fish/guestfish.pod:938
22117 msgid "To list the available types and any extra parameters they take, run:"
22121 #: ../fish/guestfish.pod:942
22123 "Note that the prepared filesystem is not mounted. You would usually have to "
22124 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22128 #: ../fish/guestfish.pod:946
22130 "If any I<-N> or I<--new> options are given, the guest is automatically "
22135 #: ../fish/guestfish.pod:951
22136 msgid "Create a 100MB disk with an ext4-formatted partition:"
22140 #: ../fish/guestfish.pod:953
22143 " guestfish -N fs:ext4\n"
22148 #: ../fish/guestfish.pod:955
22149 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22153 #: ../fish/guestfish.pod:957
22156 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22161 #: ../fish/guestfish.pod:959
22162 msgid "Create a blank 200MB disk:"
22166 #: ../fish/guestfish.pod:961
22169 " guestfish -N disk:200M\n"
22174 #: ../fish/guestfish.pod:963
22175 msgid "PROGRESS BARS"
22179 #: ../fish/guestfish.pod:965
22181 "Some (not all) long-running commands send progress notification messages as "
22182 "they are running. Guestfish turns these messages into progress bars."
22186 #: ../fish/guestfish.pod:969
22188 "When a command that supports progress bars takes longer than two seconds to "
22189 "run, and if progress bars are enabled, then you will see one appearing below "
22194 #: ../fish/guestfish.pod:973
22197 " ><fs> copy-size /large-file /another-file 2048M\n"
22198 " / 10% [#####-----------------------------------------] 00:30\n"
22203 #: ../fish/guestfish.pod:976
22205 "The spinner on the left hand side moves round once for every progress "
22206 "notification received from the backend. This is a (reasonably) golden "
22207 "assurance that the command is \"doing something\" even if the progress bar "
22208 "is not moving, because the command is able to send the progress "
22209 "notifications. When the bar reaches 100% and the command finishes, the "
22210 "spinner disappears."
22214 #: ../fish/guestfish.pod:983
22216 "Progress bars are enabled by default when guestfish is used interactively. "
22217 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22218 "and you can disable them completely using I<--no-progress-bars>."
22222 #: ../fish/guestfish.pod:988
22223 msgid "GUESTFISH COMMANDS"
22227 #: ../fish/guestfish.pod:990
22229 "The commands in this section are guestfish convenience commands, in other "
22230 "words, they are not part of the L<guestfs(3)> API."
22234 #: ../fish/guestfish.pod:993
22239 #: ../fish/guestfish.pod:995
22248 #: ../fish/guestfish.pod:998
22249 msgid "Without any parameter, this provides general help."
22253 #: ../fish/guestfish.pod:1000
22254 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22258 #: ../fish/guestfish.pod:1002
22259 msgid "quit | exit"
22263 #: ../fish/guestfish.pod:1004
22264 msgid "This exits guestfish. You can also use C<^D> key."
22268 #: ../fish/guestfish.pod:1006
22269 msgid "@FISH_COMMANDS@"
22273 #: ../fish/guestfish.pod:1008
22278 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
22283 #: ../fish/guestfish.pod:1014
22285 "guestfish returns 0 if the commands completed without error, or 1 if there "
22290 #: ../fish/guestfish.pod:1021
22295 #: ../fish/guestfish.pod:1023
22297 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22302 #: ../fish/guestfish.pod:1026
22303 msgid "GUESTFISH_DISPLAY_IMAGE"
22307 #: ../fish/guestfish.pod:1028
22309 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22310 "If not set, it uses L<display(1)>."
22314 #: ../fish/guestfish.pod:1031
22315 msgid "GUESTFISH_PID"
22319 #: ../fish/guestfish.pod:1033
22321 "Used with the I<--remote> option to specify the remote guestfish process to "
22322 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22326 #: ../fish/guestfish.pod:1037
22331 #: ../fish/guestfish.pod:1039
22333 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22334 "not specified, the external L<hexedit(1)> program is used."
22338 #: ../fish/guestfish.pod:1043
22343 #: ../fish/guestfish.pod:1045
22345 "If compiled with GNU readline support, various files in the home directory "
22346 "can be used. See L</FILES>."
22350 #: ../fish/guestfish.pod:1054
22352 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22353 "effect as using the B<-v> option."
22357 #: ../fish/guestfish.pod:1066
22359 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22360 "the discussion of paths in L<guestfs(3)>."
22364 #: ../fish/guestfish.pod:1077
22365 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22369 #: ../fish/guestfish.pod:1079
22374 #: ../fish/guestfish.pod:1081
22376 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22381 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
22386 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
22387 msgid "$HOME/.libguestfs-tools.rc"
22391 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
22392 msgid "/etc/libguestfs-tools.conf"
22396 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
22398 "This configuration file controls the default read-only or read-write mode "
22399 "(I<--ro> or I<--rw>)."
22403 #: ../fish/guestfish.pod:1108
22404 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22408 #: ../fish/guestfish.pod:1110
22409 msgid "$HOME/.guestfish"
22413 #: ../fish/guestfish.pod:1112
22415 "If compiled with GNU readline support, then the command history is saved in "
22420 #: ../fish/guestfish.pod:1115
22421 msgid "$HOME/.inputrc"
22425 #: ../fish/guestfish.pod:1117
22426 msgid "/etc/inputrc"
22430 #: ../fish/guestfish.pod:1119
22432 "If compiled with GNU readline support, then these files can be used to "
22433 "configure readline. For further information, please see L<readline(3)/"
22434 "INITIALIZATION FILE>."
22438 #: ../fish/guestfish.pod:1123
22439 msgid "To write rules which only apply to guestfish, use:"
22443 #: ../fish/guestfish.pod:1125
22453 #: ../fish/guestfish.pod:1129
22455 "Variables that you can set in inputrc that change the behaviour of guestfish "
22456 "in useful ways include:"
22460 #: ../fish/guestfish.pod:1134
22461 msgid "completion-ignore-case (default: on)"
22465 #: ../fish/guestfish.pod:1136
22467 "By default, guestfish will ignore case when tab-completing paths on the "
22472 #: ../fish/guestfish.pod:1139
22475 " set completion-ignore-case off\n"
22480 #: ../fish/guestfish.pod:1141
22481 msgid "to make guestfish case sensitive."
22485 #: ../fish/guestfish.pod:1145
22490 #: ../fish/guestfish.pod:1147
22491 msgid "test2.img (etc)"
22495 #: ../fish/guestfish.pod:1149
22497 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22498 "will be created in the file C<test1.img> in the current directory. The "
22499 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22500 "the same name will be overwritten."
22504 #: ../fish/guestfish.pod:1158
22506 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
22507 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
22508 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
22509 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
22510 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
22511 ">, L<display(1)>, L<hexedit(1)>."
22515 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
22516 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22517 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22518 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22520 "This program is free software; you can redistribute it and/or modify it "
22521 "under the terms of the GNU General Public License as published by the Free "
22522 "Software Foundation; either version 2 of the License, or (at your option) "
22523 "any later version."
22527 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
22528 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22529 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22530 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22532 "This program is distributed in the hope that it will be useful, but WITHOUT "
22533 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22534 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22539 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
22540 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22541 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22542 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22544 "You should have received a copy of the GNU General Public License along with "
22545 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
22546 "Ave, Cambridge, MA 02139, USA."
22550 #: ../fish/guestfish-actions.pod:1
22555 #: ../fish/guestfish-actions.pod:3
22558 " add-cdrom filename\n"
22563 #: ../fish/guestfish-actions.pod:15
22565 "This call checks for the existence of C<filename>. This stops you from "
22566 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22567 "and C<http:> URLs. To specify those, use the general L</config> call "
22572 #: ../fish/guestfish-actions.pod:22
22574 "If you just want to add an ISO file (often you use this as an efficient way "
22575 "to transfer large files into the guest), then you should probably use L</add-"
22576 "drive-ro> instead."
22580 #: ../fish/guestfish-actions.pod:35
22585 #: ../fish/guestfish-actions.pod:37
22590 #: ../fish/guestfish-actions.pod:39
22593 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22598 #: ../fish/guestfish-actions.pod:41
22600 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22601 "It works by connecting to libvirt, requesting the domain and domain XML from "
22602 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22606 #: ../fish/guestfish-actions.pod:76
22608 "The other optional parameters are passed directly through to L</add-drive-"
22613 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22614 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1962
22615 #: ../fish/guestfish-actions.pod:3128 ../fish/guestfish-actions.pod:3301
22616 #: ../fish/guestfish-actions.pod:3436
22618 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22622 #: ../fish/guestfish-actions.pod:81
22627 #: ../fish/guestfish-actions.pod:83
22630 " add-drive filename\n"
22635 #: ../fish/guestfish-actions.pod:85
22637 "This function is the equivalent of calling L</add-drive-opts> with no "
22638 "optional parameters, so the disk is added writable, with the format being "
22639 "detected automatically."
22643 #: ../fish/guestfish-actions.pod:89
22645 "Automatic detection of the format opens you up to a potential security hole "
22646 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22647 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22648 "you should think about replacing calls to this function with calls to L</add-"
22649 "drive-opts>, and specifying the format."
22653 #: ../fish/guestfish-actions.pod:96
22654 msgid "add-drive-opts"
22658 #: ../fish/guestfish-actions.pod:98
22663 #: ../fish/guestfish-actions.pod:100
22666 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22671 #: ../fish/guestfish-actions.pod:127
22673 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22674 "add-drive-ro>) then the format is automatically detected. Possible formats "
22675 "include C<raw> and C<qcow2>."
22679 #: ../fish/guestfish-actions.pod:138
22681 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22682 "add-drive-with-if> call (q.v.)"
22686 #: ../fish/guestfish-actions.pod:145
22687 msgid "add-drive-ro"
22691 #: ../fish/guestfish-actions.pod:147
22696 #: ../fish/guestfish-actions.pod:149
22699 " add-drive-ro filename\n"
22704 #: ../fish/guestfish-actions.pod:151
22706 "This function is the equivalent of calling L</add-drive-opts> with the "
22707 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22708 "is added read-only, with the format being detected automatically."
22712 #: ../fish/guestfish-actions.pod:156
22713 msgid "add-drive-ro-with-if"
22717 #: ../fish/guestfish-actions.pod:158
22720 " add-drive-ro-with-if filename iface\n"
22725 #: ../fish/guestfish-actions.pod:160
22727 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22728 "interface emulation to use at run time."
22732 #: ../fish/guestfish-actions.pod:170
22733 msgid "add-drive-with-if"
22737 #: ../fish/guestfish-actions.pod:172
22740 " add-drive-with-if filename iface\n"
22745 #: ../fish/guestfish-actions.pod:174
22747 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22748 "interface emulation to use at run time."
22752 #: ../fish/guestfish-actions.pod:184
22757 #: ../fish/guestfish-actions.pod:186
22760 " aug-clear augpath\n"
22765 #: ../fish/guestfish-actions.pod:191
22770 #: ../fish/guestfish-actions.pod:193
22778 #: ../fish/guestfish-actions.pod:195
22780 "Close the current Augeas handle and free up any resources used by it. After "
22781 "calling this, you have to call L</aug-init> again before you can use any "
22782 "other Augeas functions."
22786 #: ../fish/guestfish-actions.pod:200
22787 msgid "aug-defnode"
22791 #: ../fish/guestfish-actions.pod:202
22794 " aug-defnode name expr val\n"
22799 #: ../fish/guestfish-actions.pod:207
22801 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22802 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22803 "containing that single node."
22807 #: ../fish/guestfish-actions.pod:215
22812 #: ../fish/guestfish-actions.pod:217
22815 " aug-defvar name expr\n"
22820 #: ../fish/guestfish-actions.pod:226
22825 #: ../fish/guestfish-actions.pod:228
22828 " aug-get augpath\n"
22833 #: ../fish/guestfish-actions.pod:233
22838 #: ../fish/guestfish-actions.pod:235
22841 " aug-init root flags\n"
22846 #: ../fish/guestfish-actions.pod:241
22847 msgid "You must call this before using any other L</aug-*> commands."
22851 #: ../fish/guestfish-actions.pod:276
22852 msgid "Do not load the tree in L</aug-init>."
22856 #: ../fish/guestfish-actions.pod:280
22857 msgid "To close the handle, you can call L</aug-close>."
22861 #: ../fish/guestfish-actions.pod:284
22866 #: ../fish/guestfish-actions.pod:286
22869 " aug-insert augpath label true|false\n"
22874 #: ../fish/guestfish-actions.pod:296
22879 #: ../fish/guestfish-actions.pod:298
22887 #: ../fish/guestfish-actions.pod:305
22892 #: ../fish/guestfish-actions.pod:307
22895 " aug-ls augpath\n"
22900 #: ../fish/guestfish-actions.pod:309
22902 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22903 "resulting nodes into alphabetical order."
22907 #: ../fish/guestfish-actions.pod:312
22912 #: ../fish/guestfish-actions.pod:314
22915 " aug-match augpath\n"
22920 #: ../fish/guestfish-actions.pod:320
22925 #: ../fish/guestfish-actions.pod:322
22928 " aug-mv src dest\n"
22933 #: ../fish/guestfish-actions.pod:327
22938 #: ../fish/guestfish-actions.pod:329
22941 " aug-rm augpath\n"
22946 #: ../fish/guestfish-actions.pod:335
22951 #: ../fish/guestfish-actions.pod:337
22959 #: ../fish/guestfish-actions.pod:341
22961 "The flags which were passed to L</aug-init> affect exactly how files are "
22966 #: ../fish/guestfish-actions.pod:344
22971 #: ../fish/guestfish-actions.pod:346
22974 " aug-set augpath val\n"
22979 #: ../fish/guestfish-actions.pod:350
22981 "In the Augeas API, it is possible to clear a node by setting the value to "
22982 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22983 "this call. Instead you must use the L</aug-clear> call."
22987 #: ../fish/guestfish-actions.pod:355
22992 #: ../fish/guestfish-actions.pod:357
22995 " available 'groups ...'\n"
23000 #: ../fish/guestfish-actions.pod:363
23002 "The libguestfs groups, and the functions that those groups correspond to, "
23003 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23004 "runtime by calling L</available-all-groups>."
23008 #: ../fish/guestfish-actions.pod:387
23009 msgid "You must call L</launch> before calling this function."
23013 #: ../fish/guestfish-actions.pod:409
23015 "This call was added in version C<1.0.80>. In previous versions of "
23016 "libguestfs all you could do would be to speculatively execute a command to "
23017 "find out if the daemon implemented it. See also L</version>."
23021 #: ../fish/guestfish-actions.pod:416
23022 msgid "available-all-groups"
23026 #: ../fish/guestfish-actions.pod:418
23029 " available-all-groups\n"
23034 #: ../fish/guestfish-actions.pod:420
23036 "This command returns a list of all optional groups that this daemon knows "
23037 "about. Note this returns both supported and unsupported groups. To find "
23038 "out which ones the daemon can actually support you have to call L</"
23039 "available> on each member of the returned list."
23043 #: ../fish/guestfish-actions.pod:426
23044 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23048 #: ../fish/guestfish-actions.pod:428
23053 #: ../fish/guestfish-actions.pod:430
23056 " base64-in (base64file|-) filename\n"
23061 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
23062 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
23063 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
23064 #: ../fish/guestfish-actions.pod:4631 ../fish/guestfish-actions.pod:4643
23065 #: ../fish/guestfish-actions.pod:4654 ../fish/guestfish-actions.pod:4665
23066 #: ../fish/guestfish-actions.pod:4717 ../fish/guestfish-actions.pod:4726
23067 #: ../fish/guestfish-actions.pod:4780 ../fish/guestfish-actions.pod:4803
23068 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23072 #: ../fish/guestfish-actions.pod:437
23077 #: ../fish/guestfish-actions.pod:439
23080 " base64-out filename (base64file|-)\n"
23085 #: ../fish/guestfish-actions.pod:446
23086 msgid "blockdev-flushbufs"
23090 #: ../fish/guestfish-actions.pod:448
23093 " blockdev-flushbufs device\n"
23098 #: ../fish/guestfish-actions.pod:455
23099 msgid "blockdev-getbsz"
23103 #: ../fish/guestfish-actions.pod:457
23106 " blockdev-getbsz device\n"
23111 #: ../fish/guestfish-actions.pod:466
23112 msgid "blockdev-getro"
23116 #: ../fish/guestfish-actions.pod:468
23119 " blockdev-getro device\n"
23124 #: ../fish/guestfish-actions.pod:475
23125 msgid "blockdev-getsize64"
23129 #: ../fish/guestfish-actions.pod:477
23132 " blockdev-getsize64 device\n"
23137 #: ../fish/guestfish-actions.pod:481
23138 msgid "See also L</blockdev-getsz>."
23142 #: ../fish/guestfish-actions.pod:485
23143 msgid "blockdev-getss"
23147 #: ../fish/guestfish-actions.pod:487
23150 " blockdev-getss device\n"
23155 #: ../fish/guestfish-actions.pod:492
23157 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23161 #: ../fish/guestfish-actions.pod:497
23162 msgid "blockdev-getsz"
23166 #: ../fish/guestfish-actions.pod:499
23169 " blockdev-getsz device\n"
23174 #: ../fish/guestfish-actions.pod:504
23176 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23177 "blockdev-getsize64> for the more useful I<size in bytes>."
23181 #: ../fish/guestfish-actions.pod:510
23182 msgid "blockdev-rereadpt"
23186 #: ../fish/guestfish-actions.pod:512
23189 " blockdev-rereadpt device\n"
23194 #: ../fish/guestfish-actions.pod:518
23195 msgid "blockdev-setbsz"
23199 #: ../fish/guestfish-actions.pod:520
23202 " blockdev-setbsz device blocksize\n"
23207 #: ../fish/guestfish-actions.pod:529
23208 msgid "blockdev-setro"
23212 #: ../fish/guestfish-actions.pod:531
23215 " blockdev-setro device\n"
23220 #: ../fish/guestfish-actions.pod:537
23221 msgid "blockdev-setrw"
23225 #: ../fish/guestfish-actions.pod:539
23228 " blockdev-setrw device\n"
23233 #: ../fish/guestfish-actions.pod:545
23234 msgid "btrfs-filesystem-resize"
23238 #: ../fish/guestfish-actions.pod:547
23241 " btrfs-filesystem-resize mountpoint [size:..]\n"
23246 #: ../fish/guestfish-actions.pod:570
23247 msgid "case-sensitive-path"
23251 #: ../fish/guestfish-actions.pod:572
23254 " case-sensitive-path path\n"
23259 #: ../fish/guestfish-actions.pod:596
23261 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23262 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23263 "the directories were originally created under Windows)."
23267 #: ../fish/guestfish-actions.pod:604
23268 msgid "See also L</realpath>."
23272 #: ../fish/guestfish-actions.pod:606
23277 #: ../fish/guestfish-actions.pod:608
23285 #: ../fish/guestfish-actions.pod:612
23287 "Note that this function cannot correctly handle binary files (specifically, "
23288 "files containing C<\\0> character which is treated as end of string). For "
23289 "those you need to use the L</read-file> or L</download> functions which have "
23290 "a more complex interface."
23294 #: ../fish/guestfish-actions.pod:620
23299 #: ../fish/guestfish-actions.pod:622
23302 " checksum csumtype path\n"
23307 #: ../fish/guestfish-actions.pod:665
23308 msgid "To get the checksum for a device, use L</checksum-device>."
23312 #: ../fish/guestfish-actions.pod:667
23313 msgid "To get the checksums for many files, use L</checksums-out>."
23317 #: ../fish/guestfish-actions.pod:669
23318 msgid "checksum-device"
23322 #: ../fish/guestfish-actions.pod:671
23325 " checksum-device csumtype device\n"
23330 #: ../fish/guestfish-actions.pod:673
23332 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23333 "device named C<device>. For the types of checksums supported see the L</"
23334 "checksum> command."
23338 #: ../fish/guestfish-actions.pod:677
23339 msgid "checksums-out"
23343 #: ../fish/guestfish-actions.pod:679
23346 " checksums-out csumtype directory (sumsfile|-)\n"
23351 #: ../fish/guestfish-actions.pod:695
23356 #: ../fish/guestfish-actions.pod:697
23359 " chmod mode path\n"
23364 #: ../fish/guestfish-actions.pod:708
23369 #: ../fish/guestfish-actions.pod:710
23372 " chown owner group path\n"
23377 #: ../fish/guestfish-actions.pod:718
23382 #: ../fish/guestfish-actions.pod:720
23385 " command 'arguments ...'\n"
23390 #: ../fish/guestfish-actions.pod:727
23392 "The single parameter is an argv-style list of arguments. The first element "
23393 "is the name of the program to run. Subsequent elements are parameters. The "
23394 "list must be non-empty (ie. must contain a program name). Note that the "
23395 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23399 #: ../fish/guestfish-actions.pod:755
23400 msgid "command-lines"
23404 #: ../fish/guestfish-actions.pod:757
23407 " command-lines 'arguments ...'\n"
23412 #: ../fish/guestfish-actions.pod:759
23414 "This is the same as L</command>, but splits the result into a list of lines."
23418 #: ../fish/guestfish-actions.pod:762
23419 msgid "See also: L</sh-lines>"
23423 #: ../fish/guestfish-actions.pod:767
23428 #: ../fish/guestfish-actions.pod:769
23431 " config qemuparam qemuvalue\n"
23436 #: ../fish/guestfish-actions.pod:780
23441 #: ../fish/guestfish-actions.pod:782
23444 " copy-size src dest size\n"
23449 #: ../fish/guestfish-actions.pod:790
23454 #: ../fish/guestfish-actions.pod:792
23462 #: ../fish/guestfish-actions.pod:797
23467 #: ../fish/guestfish-actions.pod:799
23475 #: ../fish/guestfish-actions.pod:804
23480 #: ../fish/guestfish-actions.pod:806
23488 #: ../fish/guestfish-actions.pod:813
23490 "If the destination is a device, it must be as large or larger than the "
23491 "source file or device, otherwise the copy will fail. This command cannot do "
23492 "partial copies (see L</copy-size>)."
23496 #: ../fish/guestfish-actions.pod:817
23501 #: ../fish/guestfish-actions.pod:819
23509 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
23511 "This command is mostly useful for interactive sessions. It is I<not> "
23512 "intended that you try to parse the output string. Use L</statvfs> from "
23517 #: ../fish/guestfish-actions.pod:827
23522 #: ../fish/guestfish-actions.pod:829
23530 #: ../fish/guestfish-actions.pod:838
23535 #: ../fish/guestfish-actions.pod:840
23543 #: ../fish/guestfish-actions.pod:846
23545 "Another way to get the same information is to enable verbose messages with "
23546 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23547 "before running the program."
23551 #: ../fish/guestfish-actions.pod:851
23556 #: ../fish/guestfish-actions.pod:853
23559 " download remotefilename (filename|-)\n"
23564 #: ../fish/guestfish-actions.pod:860
23565 msgid "See also L</upload>, L</cat>."
23569 #: ../fish/guestfish-actions.pod:864
23570 msgid "download-offset"
23574 #: ../fish/guestfish-actions.pod:866
23577 " download-offset remotefilename (filename|-) offset size\n"
23582 #: ../fish/guestfish-actions.pod:874
23584 "Note that there is no limit on the amount of data that can be downloaded "
23585 "with this call, unlike with L</pread>, and this call always reads the full "
23586 "amount unless an error occurs."
23590 #: ../fish/guestfish-actions.pod:879
23591 msgid "See also L</download>, L</pread>."
23595 #: ../fish/guestfish-actions.pod:883
23596 msgid "drop-caches"
23600 #: ../fish/guestfish-actions.pod:885
23603 " drop-caches whattodrop\n"
23608 #: ../fish/guestfish-actions.pod:897
23613 #: ../fish/guestfish-actions.pod:899
23621 #: ../fish/guestfish-actions.pod:911
23626 #: ../fish/guestfish-actions.pod:913
23629 " e2fsck-f device\n"
23634 #: ../fish/guestfish-actions.pod:919
23636 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23637 "should use L</fsck>."
23641 #: ../fish/guestfish-actions.pod:922
23642 msgid "echo-daemon"
23646 #: ../fish/guestfish-actions.pod:924
23649 " echo-daemon 'words ...'\n"
23654 #: ../fish/guestfish-actions.pod:931
23655 msgid "See also L</ping-daemon>."
23659 #: ../fish/guestfish-actions.pod:933
23664 #: ../fish/guestfish-actions.pod:935
23667 " egrep regex path\n"
23672 #: ../fish/guestfish-actions.pod:943
23677 #: ../fish/guestfish-actions.pod:945
23680 " egrepi regex path\n"
23685 #: ../fish/guestfish-actions.pod:953
23690 #: ../fish/guestfish-actions.pod:955
23693 " equal file1 file2\n"
23698 #: ../fish/guestfish-actions.pod:962
23703 #: ../fish/guestfish-actions.pod:964
23711 #: ../fish/guestfish-actions.pod:969
23712 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23716 #: ../fish/guestfish-actions.pod:971
23721 #: ../fish/guestfish-actions.pod:973
23724 " fallocate path len\n"
23729 #: ../fish/guestfish-actions.pod:990
23730 msgid "fallocate64"
23734 #: ../fish/guestfish-actions.pod:992
23737 " fallocate64 path len\n"
23742 #: ../fish/guestfish-actions.pod:998
23744 "Note that this call allocates disk blocks for the file. To create a sparse "
23745 "file use L</truncate-size> instead."
23749 #: ../fish/guestfish-actions.pod:1001
23751 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23752 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23753 "maximum size of files created through that call to 1GB."
23757 #: ../fish/guestfish-actions.pod:1010
23762 #: ../fish/guestfish-actions.pod:1012
23765 " fgrep pattern path\n"
23770 #: ../fish/guestfish-actions.pod:1020
23775 #: ../fish/guestfish-actions.pod:1022
23778 " fgrepi pattern path\n"
23783 #: ../fish/guestfish-actions.pod:1030
23788 #: ../fish/guestfish-actions.pod:1032
23796 #: ../fish/guestfish-actions.pod:1048
23798 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23799 "(etc), L</is-zero>."
23803 #: ../fish/guestfish-actions.pod:1051
23804 msgid "file-architecture"
23808 #: ../fish/guestfish-actions.pod:1053
23811 " file-architecture filename\n"
23816 #: ../fish/guestfish-actions.pod:1156
23821 #: ../fish/guestfish-actions.pod:1158
23829 #: ../fish/guestfish-actions.pod:1162
23831 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23832 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23836 #: ../fish/guestfish-actions.pod:1166
23841 #: ../fish/guestfish-actions.pod:1168
23844 " fill c len path\n"
23849 #: ../fish/guestfish-actions.pod:1174
23851 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23852 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23853 "L</fill-pattern>."
23857 #: ../fish/guestfish-actions.pod:1179
23858 msgid "fill-pattern"
23862 #: ../fish/guestfish-actions.pod:1181
23865 " fill-pattern pattern len path\n"
23870 #: ../fish/guestfish-actions.pod:1183
23872 "This function is like L</fill> except that it creates a new file of length "
23873 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23874 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23879 #: ../fish/guestfish-actions.pod:1188
23884 #: ../fish/guestfish-actions.pod:1190
23887 " find directory\n"
23892 #: ../fish/guestfish-actions.pod:1204
23893 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23897 #: ../fish/guestfish-actions.pod:1217
23898 msgid "See also L</find0>."
23902 #: ../fish/guestfish-actions.pod:1222
23907 #: ../fish/guestfish-actions.pod:1224
23910 " find0 directory (files|-)\n"
23915 #: ../fish/guestfish-actions.pod:1230
23917 "This command works the same way as L</find> with the following exceptions:"
23921 #: ../fish/guestfish-actions.pod:1257
23922 msgid "findfs-label"
23926 #: ../fish/guestfish-actions.pod:1259
23929 " findfs-label label\n"
23934 #: ../fish/guestfish-actions.pod:1265
23935 msgid "To find the label of a filesystem, use L</vfs-label>."
23939 #: ../fish/guestfish-actions.pod:1267
23940 msgid "findfs-uuid"
23944 #: ../fish/guestfish-actions.pod:1269
23947 " findfs-uuid uuid\n"
23952 #: ../fish/guestfish-actions.pod:1275
23953 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23957 #: ../fish/guestfish-actions.pod:1277
23962 #: ../fish/guestfish-actions.pod:1279
23965 " fsck fstype device\n"
23970 #: ../fish/guestfish-actions.pod:1309
23975 #: ../fish/guestfish-actions.pod:1311
23983 #: ../fish/guestfish-actions.pod:1318
23984 msgid "get-attach-method"
23988 #: ../fish/guestfish-actions.pod:1320
23991 " get-attach-method\n"
23996 #: ../fish/guestfish-actions.pod:1322
23997 msgid "Return the current attach method. See L</set-attach-method>."
24001 #: ../fish/guestfish-actions.pod:1324
24002 msgid "get-autosync"
24006 #: ../fish/guestfish-actions.pod:1326
24014 #: ../fish/guestfish-actions.pod:1330
24019 #: ../fish/guestfish-actions.pod:1332
24027 #: ../fish/guestfish-actions.pod:1336
24028 msgid "get-e2label"
24032 #: ../fish/guestfish-actions.pod:1338
24035 " get-e2label device\n"
24040 #: ../fish/guestfish-actions.pod:1350
24045 #: ../fish/guestfish-actions.pod:1352
24048 " get-e2uuid device\n"
24053 #: ../fish/guestfish-actions.pod:1364
24054 msgid "get-memsize"
24058 #: ../fish/guestfish-actions.pod:1366
24066 #: ../fish/guestfish-actions.pod:1371
24068 "If L</set-memsize> was not called on this handle, and if "
24069 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24070 "value for memsize."
24074 #: ../fish/guestfish-actions.pod:1378
24075 msgid "get-network"
24079 #: ../fish/guestfish-actions.pod:1380
24087 #: ../fish/guestfish-actions.pod:1384
24092 #: ../fish/guestfish-actions.pod:1386
24100 #: ../fish/guestfish-actions.pod:1393
24105 #: ../fish/guestfish-actions.pod:1395
24110 #: ../fish/guestfish-actions.pod:1397
24118 #: ../fish/guestfish-actions.pod:1404
24123 #: ../fish/guestfish-actions.pod:1406
24131 #: ../fish/guestfish-actions.pod:1413
24132 msgid "get-recovery-proc"
24136 #: ../fish/guestfish-actions.pod:1415
24139 " get-recovery-proc\n"
24144 #: ../fish/guestfish-actions.pod:1419
24145 msgid "get-selinux"
24149 #: ../fish/guestfish-actions.pod:1421
24157 #: ../fish/guestfish-actions.pod:1423
24159 "This returns the current setting of the selinux flag which is passed to the "
24160 "appliance at boot time. See L</set-selinux>."
24164 #: ../fish/guestfish-actions.pod:1429
24169 #: ../fish/guestfish-actions.pod:1431
24177 #: ../fish/guestfish-actions.pod:1438
24182 #: ../fish/guestfish-actions.pod:1440
24190 #: ../fish/guestfish-actions.pod:1444
24195 #: ../fish/guestfish-actions.pod:1446
24203 #: ../fish/guestfish-actions.pod:1448
24205 "Return the current umask. By default the umask is C<022> unless it has been "
24206 "set by calling L</umask>."
24210 #: ../fish/guestfish-actions.pod:1451
24211 msgid "get-verbose"
24215 #: ../fish/guestfish-actions.pod:1453
24223 #: ../fish/guestfish-actions.pod:1457
24228 #: ../fish/guestfish-actions.pod:1459
24236 #: ../fish/guestfish-actions.pod:1463
24237 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24241 #: ../fish/guestfish-actions.pod:1466
24246 #: ../fish/guestfish-actions.pod:1468
24249 " getxattr path name\n"
24254 #: ../fish/guestfish-actions.pod:1470
24256 "Get a single extended attribute from file C<path> named C<name>. This call "
24257 "follows symlinks. If you want to lookup an extended attribute for the "
24258 "symlink itself, use L</lgetxattr>."
24262 #: ../fish/guestfish-actions.pod:1474 ../fish/guestfish-actions.pod:2501
24264 "Normally it is better to get all extended attributes from a file in one go "
24265 "by calling L</getxattrs>. However some Linux filesystem implementations are "
24266 "buggy and do not provide a way to list out attributes. For these "
24267 "filesystems (notably ntfs-3g) you have to know the names of the extended "
24268 "attributes you want in advance and call this function."
24272 #: ../fish/guestfish-actions.pod:1484
24273 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
24277 #: ../fish/guestfish-actions.pod:1486
24282 #: ../fish/guestfish-actions.pod:1488
24285 " getxattrs path\n"
24290 #: ../fish/guestfish-actions.pod:1496
24291 msgid "See also: L</lgetxattrs>, L<attr(5)>."
24295 #: ../fish/guestfish-actions.pod:1498
24296 msgid "glob-expand"
24300 #: ../fish/guestfish-actions.pod:1500
24303 " glob-expand pattern\n"
24308 #: ../fish/guestfish-actions.pod:1513
24313 #: ../fish/guestfish-actions.pod:1515
24316 " grep regex path\n"
24321 #: ../fish/guestfish-actions.pod:1523
24326 #: ../fish/guestfish-actions.pod:1525
24329 " grepi regex path\n"
24334 #: ../fish/guestfish-actions.pod:1533
24335 msgid "grub-install"
24339 #: ../fish/guestfish-actions.pod:1535
24342 " grub-install root device\n"
24347 #: ../fish/guestfish-actions.pod:1551
24352 #: ../fish/guestfish-actions.pod:1553
24360 #: ../fish/guestfish-actions.pod:1561
24365 #: ../fish/guestfish-actions.pod:1563
24368 " head-n nrlines path\n"
24373 #: ../fish/guestfish-actions.pod:1576
24378 #: ../fish/guestfish-actions.pod:1578
24386 #: ../fish/guestfish-actions.pod:1586
24391 #: ../fish/guestfish-actions.pod:1588
24394 " initrd-cat initrdpath filename\n"
24399 #: ../fish/guestfish-actions.pod:1600
24400 msgid "See also L</initrd-list>."
24404 #: ../fish/guestfish-actions.pod:1605
24405 msgid "initrd-list"
24409 #: ../fish/guestfish-actions.pod:1607
24412 " initrd-list path\n"
24417 #: ../fish/guestfish-actions.pod:1619
24418 msgid "inotify-add-watch"
24422 #: ../fish/guestfish-actions.pod:1621
24425 " inotify-add-watch path mask\n"
24430 #: ../fish/guestfish-actions.pod:1633
24431 msgid "inotify-close"
24435 #: ../fish/guestfish-actions.pod:1635
24443 #: ../fish/guestfish-actions.pod:1641
24444 msgid "inotify-files"
24448 #: ../fish/guestfish-actions.pod:1643
24456 #: ../fish/guestfish-actions.pod:1645
24458 "This function is a helpful wrapper around L</inotify-read> which just "
24459 "returns a list of pathnames of objects that were touched. The returned "
24460 "pathnames are sorted and deduplicated."
24464 #: ../fish/guestfish-actions.pod:1649
24465 msgid "inotify-init"
24469 #: ../fish/guestfish-actions.pod:1651
24472 " inotify-init maxevents\n"
24477 #: ../fish/guestfish-actions.pod:1657
24479 "C<maxevents> is the maximum number of events which will be queued up between "
24480 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
24481 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
24482 "default was 16384 events. Beyond this limit, the kernel throws away events, "
24483 "but records the fact that it threw them away by setting a flag "
24484 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24488 #: ../fish/guestfish-actions.pod:1667
24490 "Before any events are generated, you have to add some watches to the "
24491 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
24492 "L</inotify-watch-all>."
24496 #: ../fish/guestfish-actions.pod:1673
24498 "Queued up events should be read periodically by calling L</inotify-read> (or "
24499 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
24500 "If you don't read the events out often enough then you risk the internal "
24501 "queue overflowing."
24505 #: ../fish/guestfish-actions.pod:1680
24507 "The handle should be closed after use by calling L</inotify-close>. This "
24508 "also removes any watches automatically."
24512 #: ../fish/guestfish-actions.pod:1689
24513 msgid "inotify-read"
24517 #: ../fish/guestfish-actions.pod:1691
24525 #: ../fish/guestfish-actions.pod:1704
24526 msgid "inotify-rm-watch"
24530 #: ../fish/guestfish-actions.pod:1706
24533 " inotify-rm-watch wd\n"
24538 #: ../fish/guestfish-actions.pod:1708
24539 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24543 #: ../fish/guestfish-actions.pod:1711
24544 msgid "inspect-get-arch"
24548 #: ../fish/guestfish-actions.pod:1713
24551 " inspect-get-arch root\n"
24556 #: ../fish/guestfish-actions.pod:1715
24558 "This returns the architecture of the inspected operating system. The "
24559 "possible return values are listed under L</file-architecture>."
24563 #: ../fish/guestfish-actions.pod:1724
24564 msgid "inspect-get-distro"
24568 #: ../fish/guestfish-actions.pod:1726
24571 " inspect-get-distro root\n"
24576 #: ../fish/guestfish-actions.pod:1807
24577 msgid "inspect-get-drive-mappings"
24581 #: ../fish/guestfish-actions.pod:1809
24584 " inspect-get-drive-mappings root\n"
24589 #: ../fish/guestfish-actions.pod:1836
24591 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24592 "get-mountpoints>, L</inspect-get-filesystems>."
24596 #: ../fish/guestfish-actions.pod:1840
24597 msgid "inspect-get-filesystems"
24601 #: ../fish/guestfish-actions.pod:1842
24604 " inspect-get-filesystems root\n"
24609 #: ../fish/guestfish-actions.pod:1852
24611 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24612 "get-mountpoints>."
24616 #: ../fish/guestfish-actions.pod:1855
24617 msgid "inspect-get-format"
24621 #: ../fish/guestfish-actions.pod:1857
24624 " inspect-get-format root\n"
24629 #: ../fish/guestfish-actions.pod:1886
24630 msgid "inspect-get-hostname"
24634 #: ../fish/guestfish-actions.pod:1888
24637 " inspect-get-hostname root\n"
24642 #: ../fish/guestfish-actions.pod:1898
24643 msgid "inspect-get-icon"
24647 #: ../fish/guestfish-actions.pod:1900
24650 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24655 #: ../fish/guestfish-actions.pod:1964
24656 msgid "inspect-get-major-version"
24660 #: ../fish/guestfish-actions.pod:1966
24663 " inspect-get-major-version root\n"
24668 #: ../fish/guestfish-actions.pod:1982
24669 msgid "inspect-get-minor-version"
24673 #: ../fish/guestfish-actions.pod:1984
24676 " inspect-get-minor-version root\n"
24681 #: ../fish/guestfish-actions.pod:1991
24683 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24684 "get-major-version>."
24688 #: ../fish/guestfish-actions.pod:1994
24689 msgid "inspect-get-mountpoints"
24693 #: ../fish/guestfish-actions.pod:1996
24696 " inspect-get-mountpoints root\n"
24701 #: ../fish/guestfish-actions.pod:2015
24703 "For operating systems like Windows which still use drive letters, this call "
24704 "will only return an entry for the first drive \"mounted on\" C</>. For "
24705 "information about the mapping of drive letters to partitions, see L</inspect-"
24706 "get-drive-mappings>."
24710 #: ../fish/guestfish-actions.pod:2021
24712 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24713 "get-filesystems>."
24717 #: ../fish/guestfish-actions.pod:2024
24718 msgid "inspect-get-package-format"
24722 #: ../fish/guestfish-actions.pod:2026
24725 " inspect-get-package-format root\n"
24730 #: ../fish/guestfish-actions.pod:2028
24732 "This function and L</inspect-get-package-management> return the package "
24733 "format and package management tool used by the inspected operating system. "
24734 "For example for Fedora these functions would return C<rpm> (package format) "
24735 "and C<yum> (package management)."
24739 #: ../fish/guestfish-actions.pod:2043
24740 msgid "inspect-get-package-management"
24744 #: ../fish/guestfish-actions.pod:2045
24747 " inspect-get-package-management root\n"
24752 #: ../fish/guestfish-actions.pod:2047
24754 "L</inspect-get-package-format> and this function return the package format "
24755 "and package management tool used by the inspected operating system. For "
24756 "example for Fedora these functions would return C<rpm> (package format) and "
24757 "C<yum> (package management)."
24761 #: ../fish/guestfish-actions.pod:2064
24762 msgid "inspect-get-product-name"
24766 #: ../fish/guestfish-actions.pod:2066
24769 " inspect-get-product-name root\n"
24774 #: ../fish/guestfish-actions.pod:2078
24775 msgid "inspect-get-product-variant"
24779 #: ../fish/guestfish-actions.pod:2080
24782 " inspect-get-product-variant root\n"
24787 #: ../fish/guestfish-actions.pod:2101
24789 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24790 "get-product-name>, L</inspect-get-major-version>."
24794 #: ../fish/guestfish-actions.pod:2105
24795 msgid "inspect-get-roots"
24799 #: ../fish/guestfish-actions.pod:2107
24802 " inspect-get-roots\n"
24807 #: ../fish/guestfish-actions.pod:2109
24809 "This function is a convenient way to get the list of root devices, as "
24810 "returned from a previous call to L</inspect-os>, but without redoing the "
24811 "whole inspection process."
24815 #: ../fish/guestfish-actions.pod:2113
24817 "This returns an empty list if either no root devices were found or the "
24818 "caller has not called L</inspect-os>."
24822 #: ../fish/guestfish-actions.pod:2118
24823 msgid "inspect-get-type"
24827 #: ../fish/guestfish-actions.pod:2120
24830 " inspect-get-type root\n"
24835 #: ../fish/guestfish-actions.pod:2150
24836 msgid "inspect-get-windows-current-control-set"
24840 #: ../fish/guestfish-actions.pod:2152
24843 " inspect-get-windows-current-control-set root\n"
24848 #: ../fish/guestfish-actions.pod:2163
24849 msgid "inspect-get-windows-systemroot"
24853 #: ../fish/guestfish-actions.pod:2165
24856 " inspect-get-windows-systemroot root\n"
24861 #: ../fish/guestfish-actions.pod:2176
24862 msgid "inspect-is-live"
24866 #: ../fish/guestfish-actions.pod:2178
24869 " inspect-is-live root\n"
24874 #: ../fish/guestfish-actions.pod:2180
24876 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24877 "then this returns true if a live image was detected on the disk."
24881 #: ../fish/guestfish-actions.pod:2186
24882 msgid "inspect-is-multipart"
24886 #: ../fish/guestfish-actions.pod:2188
24889 " inspect-is-multipart root\n"
24894 #: ../fish/guestfish-actions.pod:2190
24896 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24897 "then this returns true if the disk is part of a set."
24901 #: ../fish/guestfish-actions.pod:2196
24902 msgid "inspect-is-netinst"
24906 #: ../fish/guestfish-actions.pod:2198
24909 " inspect-is-netinst root\n"
24914 #: ../fish/guestfish-actions.pod:2200
24916 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24917 "then this returns true if the disk is a network installer, ie. not a self-"
24918 "contained install CD but one which is likely to require network access to "
24919 "complete the install."
24923 #: ../fish/guestfish-actions.pod:2208
24924 msgid "inspect-list-applications"
24928 #: ../fish/guestfish-actions.pod:2210
24931 " inspect-list-applications root\n"
24936 #: ../fish/guestfish-actions.pod:2214
24938 "I<Note:> This call works differently from other parts of the inspection "
24939 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24940 "then mount up the disks, before calling this. Listing applications is a "
24941 "significantly more difficult operation which requires access to the full "
24942 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24943 "are just returning data cached in the libguestfs handle, this call actually "
24944 "reads parts of the mounted filesystems during the call."
24948 #: ../fish/guestfish-actions.pod:2304
24953 #: ../fish/guestfish-actions.pod:2306
24961 #: ../fish/guestfish-actions.pod:2321
24963 "You can pass the root string(s) returned to other L</inspect-get-*> "
24964 "functions in order to query further information about each operating system, "
24965 "such as the name and version."
24969 #: ../fish/guestfish-actions.pod:2326
24971 "This function uses other libguestfs features such as L</mount-ro> and L</"
24972 "umount-all> in order to mount and unmount filesystems and look at the "
24973 "contents. This should be called with no disks currently mounted. The "
24974 "function may also use Augeas, so any existing Augeas handle will be closed."
24978 #: ../fish/guestfish-actions.pod:2338 ../fish/guestfish-actions.pod:2536
24979 #: ../fish/guestfish-actions.pod:2595
24980 msgid "See also L</list-filesystems>."
24984 #: ../fish/guestfish-actions.pod:2340
24985 msgid "is-blockdev"
24989 #: ../fish/guestfish-actions.pod:2342
24992 " is-blockdev path\n"
24997 #: ../fish/guestfish-actions.pod:2347 ../fish/guestfish-actions.pod:2365
24998 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2393
24999 #: ../fish/guestfish-actions.pod:2403 ../fish/guestfish-actions.pod:2437
25000 #: ../fish/guestfish-actions.pod:2446
25001 msgid "See also L</stat>."
25005 #: ../fish/guestfish-actions.pod:2349
25010 #: ../fish/guestfish-actions.pod:2351
25018 #: ../fish/guestfish-actions.pod:2358
25023 #: ../fish/guestfish-actions.pod:2360
25026 " is-chardev path\n"
25031 #: ../fish/guestfish-actions.pod:2367
25036 #: ../fish/guestfish-actions.pod:2369
25044 #: ../fish/guestfish-actions.pod:2376
25049 #: ../fish/guestfish-actions.pod:2378
25057 #: ../fish/guestfish-actions.pod:2386
25062 #: ../fish/guestfish-actions.pod:2388
25070 #: ../fish/guestfish-actions.pod:2395
25075 #: ../fish/guestfish-actions.pod:2397
25083 #: ../fish/guestfish-actions.pod:2405
25084 msgid "is-launching"
25088 #: ../fish/guestfish-actions.pod:2407
25096 #: ../fish/guestfish-actions.pod:2414
25101 #: ../fish/guestfish-actions.pod:2416
25109 #: ../fish/guestfish-actions.pod:2421
25114 #: ../fish/guestfish-actions.pod:2423
25122 #: ../fish/guestfish-actions.pod:2430
25127 #: ../fish/guestfish-actions.pod:2432
25130 " is-socket path\n"
25135 #: ../fish/guestfish-actions.pod:2439
25140 #: ../fish/guestfish-actions.pod:2441
25143 " is-symlink path\n"
25148 #: ../fish/guestfish-actions.pod:2448
25153 #: ../fish/guestfish-actions.pod:2450
25161 #: ../fish/guestfish-actions.pod:2455
25162 msgid "is-zero-device"
25166 #: ../fish/guestfish-actions.pod:2457
25169 " is-zero-device device\n"
25174 #: ../fish/guestfish-actions.pod:2463
25175 msgid "kill-subprocess"
25179 #: ../fish/guestfish-actions.pod:2465
25182 " kill-subprocess\n"
25187 #: ../fish/guestfish-actions.pod:2469
25192 #: ../fish/guestfish-actions.pod:2471
25197 #: ../fish/guestfish-actions.pod:2473
25205 #: ../fish/guestfish-actions.pod:2481
25210 #: ../fish/guestfish-actions.pod:2483
25213 " lchown owner group path\n"
25218 #: ../fish/guestfish-actions.pod:2485
25220 "Change the file owner to C<owner> and group to C<group>. This is like L</"
25221 "chown> but if C<path> is a symlink then the link itself is changed, not the "
25226 #: ../fish/guestfish-actions.pod:2493
25231 #: ../fish/guestfish-actions.pod:2495
25234 " lgetxattr path name\n"
25239 #: ../fish/guestfish-actions.pod:2511
25240 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25244 #: ../fish/guestfish-actions.pod:2513
25249 #: ../fish/guestfish-actions.pod:2515
25252 " lgetxattrs path\n"
25257 #: ../fish/guestfish-actions.pod:2517
25259 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25260 "it returns the extended attributes of the link itself."
25264 #: ../fish/guestfish-actions.pod:2521
25269 #: ../fish/guestfish-actions.pod:2523
25277 #: ../fish/guestfish-actions.pod:2528
25278 msgid "list-devices"
25282 #: ../fish/guestfish-actions.pod:2530
25290 #: ../fish/guestfish-actions.pod:2538
25291 msgid "list-dm-devices"
25295 #: ../fish/guestfish-actions.pod:2540
25298 " list-dm-devices\n"
25303 #: ../fish/guestfish-actions.pod:2544
25305 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25306 "previous call to L</luks-open>."
25310 #: ../fish/guestfish-actions.pod:2547
25312 "Device mapper devices which correspond to logical volumes are I<not> "
25313 "returned in this list. Call L</lvs> if you want to list logical volumes."
25317 #: ../fish/guestfish-actions.pod:2551
25318 msgid "list-filesystems"
25322 #: ../fish/guestfish-actions.pod:2553
25325 " list-filesystems\n"
25330 #: ../fish/guestfish-actions.pod:2572
25332 "This command runs other libguestfs commands, which might include L</mount> "
25333 "and L</umount>, and therefore you should use this soon after launch and only "
25334 "when nothing is mounted."
25338 #: ../fish/guestfish-actions.pod:2576
25340 "Not all of the filesystems returned will be mountable. In particular, swap "
25341 "partitions are returned in the list. Also this command does not check that "
25342 "each filesystem found is valid and mountable, and some filesystems might be "
25343 "mountable but require special options. Filesystems may not all belong to a "
25344 "single logical operating system (use L</inspect-os> to look for OSes)."
25348 #: ../fish/guestfish-actions.pod:2584
25349 msgid "list-partitions"
25353 #: ../fish/guestfish-actions.pod:2586
25356 " list-partitions\n"
25361 #: ../fish/guestfish-actions.pod:2592
25363 "This does not return logical volumes. For that you will need to call L</"
25368 #: ../fish/guestfish-actions.pod:2597
25373 #: ../fish/guestfish-actions.pod:2599
25381 #: ../fish/guestfish-actions.pod:2607
25386 #: ../fish/guestfish-actions.pod:2609
25389 " ln target linkname\n"
25394 #: ../fish/guestfish-actions.pod:2613
25399 #: ../fish/guestfish-actions.pod:2615
25402 " ln-f target linkname\n"
25407 #: ../fish/guestfish-actions.pod:2620
25412 #: ../fish/guestfish-actions.pod:2622
25415 " ln-s target linkname\n"
25420 #: ../fish/guestfish-actions.pod:2626
25425 #: ../fish/guestfish-actions.pod:2628
25428 " ln-sf target linkname\n"
25433 #: ../fish/guestfish-actions.pod:2633
25434 msgid "lremovexattr"
25438 #: ../fish/guestfish-actions.pod:2635
25441 " lremovexattr xattr path\n"
25446 #: ../fish/guestfish-actions.pod:2637
25448 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
25449 "it removes an extended attribute of the link itself."
25453 #: ../fish/guestfish-actions.pod:2641
25458 #: ../fish/guestfish-actions.pod:2643
25466 #: ../fish/guestfish-actions.pod:2649
25468 "This command is mostly useful for interactive sessions. Programs should "
25469 "probably use L</readdir> instead."
25473 #: ../fish/guestfish-actions.pod:2652
25478 #: ../fish/guestfish-actions.pod:2654
25481 " lsetxattr xattr val vallen path\n"
25486 #: ../fish/guestfish-actions.pod:2656
25488 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
25489 "sets an extended attribute of the link itself."
25493 #: ../fish/guestfish-actions.pod:2660
25498 #: ../fish/guestfish-actions.pod:2662
25506 #: ../fish/guestfish-actions.pod:2666
25508 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
25509 "the link is stat-ed, not the file it refers to."
25513 #: ../fish/guestfish-actions.pod:2672
25518 #: ../fish/guestfish-actions.pod:2674
25521 " lstatlist path 'names ...'\n"
25526 #: ../fish/guestfish-actions.pod:2676
25528 "This call allows you to perform the L</lstat> operation on multiple files, "
25529 "where all files are in the directory C<path>. C<names> is the list of files "
25530 "from this directory."
25534 #: ../fish/guestfish-actions.pod:2685
25536 "This call is intended for programs that want to efficiently list a directory "
25537 "contents without making many round-trips. See also L</lxattrlist> for a "
25538 "similarly efficient call for getting extended attributes. Very long "
25539 "directory listings might cause the protocol message size to be exceeded, "
25540 "causing this call to fail. The caller must split up such requests into "
25541 "smaller groups of names."
25545 #: ../fish/guestfish-actions.pod:2693
25546 msgid "luks-add-key"
25550 #: ../fish/guestfish-actions.pod:2695
25553 " luks-add-key device keyslot\n"
25558 #: ../fish/guestfish-actions.pod:2702
25560 "Note that if C<keyslot> already contains a key, then this command will "
25561 "fail. You have to use L</luks-kill-slot> first to remove that key."
25565 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2728
25566 #: ../fish/guestfish-actions.pod:2741 ../fish/guestfish-actions.pod:2755
25567 #: ../fish/guestfish-actions.pod:2781 ../fish/guestfish-actions.pod:2791
25569 "This command has one or more key or passphrase parameters. Guestfish will "
25570 "prompt for these separately."
25574 #: ../fish/guestfish-actions.pod:2709
25579 #: ../fish/guestfish-actions.pod:2711
25582 " luks-close device\n"
25587 #: ../fish/guestfish-actions.pod:2713
25589 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
25590 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
25591 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
25596 #: ../fish/guestfish-actions.pod:2719
25597 msgid "luks-format"
25601 #: ../fish/guestfish-actions.pod:2721
25604 " luks-format device keyslot\n"
25609 #: ../fish/guestfish-actions.pod:2734
25610 msgid "luks-format-cipher"
25614 #: ../fish/guestfish-actions.pod:2736
25617 " luks-format-cipher device keyslot cipher\n"
25622 #: ../fish/guestfish-actions.pod:2738
25624 "This command is the same as L</luks-format> but it also allows you to set "
25625 "the C<cipher> used."
25629 #: ../fish/guestfish-actions.pod:2747
25630 msgid "luks-kill-slot"
25634 #: ../fish/guestfish-actions.pod:2749
25637 " luks-kill-slot device keyslot\n"
25642 #: ../fish/guestfish-actions.pod:2758
25647 #: ../fish/guestfish-actions.pod:2760
25650 " luks-open device mapname\n"
25655 #: ../fish/guestfish-actions.pod:2774
25657 "If this block device contains LVM volume groups, then calling L</vgscan> "
25658 "followed by L</vg-activate-all> will make them visible."
25662 #: ../fish/guestfish-actions.pod:2778
25663 msgid "Use L</list-dm-devices> to list all device mapper devices."
25667 #: ../fish/guestfish-actions.pod:2784
25668 msgid "luks-open-ro"
25672 #: ../fish/guestfish-actions.pod:2786
25675 " luks-open-ro device mapname\n"
25680 #: ../fish/guestfish-actions.pod:2788
25682 "This is the same as L</luks-open> except that a read-only mapping is created."
25686 #: ../fish/guestfish-actions.pod:2794
25691 #: ../fish/guestfish-actions.pod:2796
25694 " lvcreate logvol volgroup mbytes\n"
25699 #: ../fish/guestfish-actions.pod:2801
25700 msgid "lvm-canonical-lv-name"
25704 #: ../fish/guestfish-actions.pod:2803
25707 " lvm-canonical-lv-name lvname\n"
25712 #: ../fish/guestfish-actions.pod:2812
25713 msgid "See also L</is-lv>."
25717 #: ../fish/guestfish-actions.pod:2814
25718 msgid "lvm-clear-filter"
25722 #: ../fish/guestfish-actions.pod:2816
25725 " lvm-clear-filter\n"
25730 #: ../fish/guestfish-actions.pod:2818
25732 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25737 #: ../fish/guestfish-actions.pod:2824
25738 msgid "lvm-remove-all"
25742 #: ../fish/guestfish-actions.pod:2826
25745 " lvm-remove-all\n"
25750 #: ../fish/guestfish-actions.pod:2834
25751 msgid "lvm-set-filter"
25755 #: ../fish/guestfish-actions.pod:2836
25758 " lvm-set-filter 'devices ...'\n"
25763 #: ../fish/guestfish-actions.pod:2861
25768 #: ../fish/guestfish-actions.pod:2863
25771 " lvremove device\n"
25776 #: ../fish/guestfish-actions.pod:2871
25781 #: ../fish/guestfish-actions.pod:2873
25784 " lvrename logvol newlogvol\n"
25789 #: ../fish/guestfish-actions.pod:2877
25794 #: ../fish/guestfish-actions.pod:2879
25797 " lvresize device mbytes\n"
25802 #: ../fish/guestfish-actions.pod:2885
25803 msgid "lvresize-free"
25807 #: ../fish/guestfish-actions.pod:2887
25810 " lvresize-free lv percent\n"
25815 #: ../fish/guestfish-actions.pod:2895
25820 #: ../fish/guestfish-actions.pod:2897
25828 #: ../fish/guestfish-actions.pod:2905
25829 msgid "See also L</lvs-full>, L</list-filesystems>."
25833 #: ../fish/guestfish-actions.pod:2907
25838 #: ../fish/guestfish-actions.pod:2909
25846 #: ../fish/guestfish-actions.pod:2914
25851 #: ../fish/guestfish-actions.pod:2916
25859 #: ../fish/guestfish-actions.pod:2920
25864 #: ../fish/guestfish-actions.pod:2922
25867 " lxattrlist path 'names ...'\n"
25872 #: ../fish/guestfish-actions.pod:2938
25874 "This call is intended for programs that want to efficiently list a directory "
25875 "contents without making many round-trips. See also L</lstatlist> for a "
25876 "similarly efficient call for getting standard stats. Very long directory "
25877 "listings might cause the protocol message size to be exceeded, causing this "
25878 "call to fail. The caller must split up such requests into smaller groups of "
25883 #: ../fish/guestfish-actions.pod:2946
25888 #: ../fish/guestfish-actions.pod:2948
25896 #: ../fish/guestfish-actions.pod:2952
25901 #: ../fish/guestfish-actions.pod:2954
25904 " mkdir-mode path mode\n"
25909 #: ../fish/guestfish-actions.pod:2963
25910 msgid "See also L</mkdir>, L</umask>"
25914 #: ../fish/guestfish-actions.pod:2965
25919 #: ../fish/guestfish-actions.pod:2967
25927 #: ../fish/guestfish-actions.pod:2972
25932 #: ../fish/guestfish-actions.pod:2974
25935 " mkdtemp template\n"
25940 #: ../fish/guestfish-actions.pod:2995
25945 #: ../fish/guestfish-actions.pod:2997
25948 " mke2fs-J fstype blocksize device journal\n"
25953 #: ../fish/guestfish-actions.pod:3005
25954 msgid "See also L</mke2journal>."
25958 #: ../fish/guestfish-actions.pod:3007
25963 #: ../fish/guestfish-actions.pod:3009
25966 " mke2fs-JL fstype blocksize device label\n"
25971 #: ../fish/guestfish-actions.pod:3014
25972 msgid "See also L</mke2journal-L>."
25976 #: ../fish/guestfish-actions.pod:3016
25981 #: ../fish/guestfish-actions.pod:3018
25984 " mke2fs-JU fstype blocksize device uuid\n"
25989 #: ../fish/guestfish-actions.pod:3023
25990 msgid "See also L</mke2journal-U>."
25994 #: ../fish/guestfish-actions.pod:3025
25995 msgid "mke2journal"
25999 #: ../fish/guestfish-actions.pod:3027
26002 " mke2journal blocksize device\n"
26007 #: ../fish/guestfish-actions.pod:3034
26008 msgid "mke2journal-L"
26012 #: ../fish/guestfish-actions.pod:3036
26015 " mke2journal-L blocksize label device\n"
26020 #: ../fish/guestfish-actions.pod:3040
26021 msgid "mke2journal-U"
26025 #: ../fish/guestfish-actions.pod:3042
26028 " mke2journal-U blocksize uuid device\n"
26033 #: ../fish/guestfish-actions.pod:3046
26038 #: ../fish/guestfish-actions.pod:3048
26041 " mkfifo mode path\n"
26046 #: ../fish/guestfish-actions.pod:3050
26048 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26049 "is just a convenient wrapper around L</mknod>."
26053 #: ../fish/guestfish-actions.pod:3056
26058 #: ../fish/guestfish-actions.pod:3058
26061 " mkfs fstype device\n"
26066 #: ../fish/guestfish-actions.pod:3064
26071 #: ../fish/guestfish-actions.pod:3066
26074 " mkfs-b fstype blocksize device\n"
26079 #: ../fish/guestfish-actions.pod:3068
26081 "This call is similar to L</mkfs>, but it allows you to control the block "
26082 "size of the resulting filesystem. Supported block sizes depend on the "
26083 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26087 #: ../fish/guestfish-actions.pod:3083
26092 #: ../fish/guestfish-actions.pod:3085
26095 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
26100 #: ../fish/guestfish-actions.pod:3130
26101 msgid "mkmountpoint"
26105 #: ../fish/guestfish-actions.pod:3132
26108 " mkmountpoint exemptpath\n"
26113 #: ../fish/guestfish-actions.pod:3134
26115 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
26116 "to create extra mountpoints before mounting the first filesystem."
26120 #: ../fish/guestfish-actions.pod:3158
26122 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26123 "unexpected errors if you try to mix these calls. It is safest to manually "
26124 "unmount filesystems and remove mountpoints after use."
26128 #: ../fish/guestfish-actions.pod:3162
26130 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26131 "for this to work for manual mountpoints, you must ensure that the innermost "
26132 "mountpoints have the longest pathnames, as in the example code above."
26136 #: ../fish/guestfish-actions.pod:3169
26138 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
26139 "L</umount-all> to be called when the handle is closed which can also trigger "
26144 #: ../fish/guestfish-actions.pod:3173
26149 #: ../fish/guestfish-actions.pod:3175
26152 " mknod mode devmajor devminor path\n"
26157 #: ../fish/guestfish-actions.pod:3185
26159 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26160 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26161 "regular file). These constants are available in the standard Linux header "
26162 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26163 "wrappers around this command which bitwise OR in the appropriate constant "
26168 #: ../fish/guestfish-actions.pod:3195
26173 #: ../fish/guestfish-actions.pod:3197
26176 " mknod-b mode devmajor devminor path\n"
26181 #: ../fish/guestfish-actions.pod:3199
26183 "This call creates a block device node called C<path> with mode C<mode> and "
26184 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26185 "wrapper around L</mknod>."
26189 #: ../fish/guestfish-actions.pod:3205
26194 #: ../fish/guestfish-actions.pod:3207
26197 " mknod-c mode devmajor devminor path\n"
26202 #: ../fish/guestfish-actions.pod:3209
26204 "This call creates a char device node called C<path> with mode C<mode> and "
26205 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26206 "wrapper around L</mknod>."
26210 #: ../fish/guestfish-actions.pod:3215
26215 #: ../fish/guestfish-actions.pod:3217
26223 #: ../fish/guestfish-actions.pod:3221
26228 #: ../fish/guestfish-actions.pod:3223
26231 " mkswap-L label device\n"
26236 #: ../fish/guestfish-actions.pod:3231
26241 #: ../fish/guestfish-actions.pod:3233
26244 " mkswap-U uuid device\n"
26249 #: ../fish/guestfish-actions.pod:3237
26250 msgid "mkswap-file"
26254 #: ../fish/guestfish-actions.pod:3239
26257 " mkswap-file path\n"
26262 #: ../fish/guestfish-actions.pod:3243
26264 "This command just writes a swap file signature to an existing file. To "
26265 "create the file itself, use something like L</fallocate>."
26269 #: ../fish/guestfish-actions.pod:3246
26274 #: ../fish/guestfish-actions.pod:3248
26277 " modprobe modulename\n"
26282 #: ../fish/guestfish-actions.pod:3255
26287 #: ../fish/guestfish-actions.pod:3257
26290 " mount device mountpoint\n"
26295 #: ../fish/guestfish-actions.pod:3273
26297 "B<Important note:> When you use this call, the filesystem options C<sync> "
26298 "and C<noatime> are set implicitly. This was originally done because we "
26299 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26300 "very large negative performance impact and negligible effect on "
26301 "reliability. Therefore we recommend that you avoid using L</mount> in any "
26302 "code that needs performance, and instead use L</mount-options> (use an empty "
26303 "string for the first parameter if you don't want any options)."
26307 #: ../fish/guestfish-actions.pod:3290
26312 #: ../fish/guestfish-actions.pod:3292
26315 " mount-9p mounttag mountpoint [options:..]\n"
26320 #: ../fish/guestfish-actions.pod:3303
26325 #: ../fish/guestfish-actions.pod:3305
26328 " mount-loop file mountpoint\n"
26333 #: ../fish/guestfish-actions.pod:3311
26334 msgid "mount-options"
26338 #: ../fish/guestfish-actions.pod:3313
26341 " mount-options options device mountpoint\n"
26346 #: ../fish/guestfish-actions.pod:3315
26348 "This is the same as the L</mount> command, but it allows you to set the "
26349 "mount options as for the L<mount(8)> I<-o> flag."
26353 #: ../fish/guestfish-actions.pod:3323
26358 #: ../fish/guestfish-actions.pod:3325
26361 " mount-ro device mountpoint\n"
26366 #: ../fish/guestfish-actions.pod:3327
26368 "This is the same as the L</mount> command, but it mounts the filesystem with "
26369 "the read-only (I<-o ro>) flag."
26373 #: ../fish/guestfish-actions.pod:3330
26378 #: ../fish/guestfish-actions.pod:3332
26381 " mount-vfs options vfstype device mountpoint\n"
26386 #: ../fish/guestfish-actions.pod:3334
26388 "This is the same as the L</mount> command, but it allows you to set both the "
26389 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26393 #: ../fish/guestfish-actions.pod:3338
26394 msgid "mountpoints"
26398 #: ../fish/guestfish-actions.pod:3340
26406 #: ../fish/guestfish-actions.pod:3342
26408 "This call is similar to L</mounts>. That call returns a list of devices. "
26409 "This one returns a hash table (map) of device name to directory where the "
26410 "device is mounted."
26414 #: ../fish/guestfish-actions.pod:3346
26419 #: ../fish/guestfish-actions.pod:3348
26427 #: ../fish/guestfish-actions.pod:3355
26428 msgid "See also: L</mountpoints>"
26432 #: ../fish/guestfish-actions.pod:3357
26437 #: ../fish/guestfish-actions.pod:3359
26445 #: ../fish/guestfish-actions.pod:3364
26446 msgid "ntfs-3g-probe"
26450 #: ../fish/guestfish-actions.pod:3366
26453 " ntfs-3g-probe true|false device\n"
26458 #: ../fish/guestfish-actions.pod:3380
26463 #: ../fish/guestfish-actions.pod:3382
26466 " ntfsresize device\n"
26471 #: ../fish/guestfish-actions.pod:3404
26472 msgid "ntfsresize-opts"
26476 #: ../fish/guestfish-actions.pod:3406
26479 " ntfsresize-opts device [size:..] [force:..]\n"
26484 #: ../fish/guestfish-actions.pod:3425
26486 "After the resize operation, the filesystem is always marked as requiring a "
26487 "consistency check (for safety). You have to boot into Windows to perform "
26488 "this check and clear this condition. If you I<don't> set the C<force> "
26489 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
26490 "a single filesystem without booting into Windows between each resize."
26494 #: ../fish/guestfish-actions.pod:3438
26495 msgid "ntfsresize-size"
26499 #: ../fish/guestfish-actions.pod:3440
26502 " ntfsresize-size device size\n"
26507 #: ../fish/guestfish-actions.pod:3442
26509 "This command is the same as L</ntfsresize> except that it allows you to "
26510 "specify the new size (in bytes) explicitly."
26514 #: ../fish/guestfish-actions.pod:3452
26519 #: ../fish/guestfish-actions.pod:3454
26522 " part-add device prlogex startsect endsect\n"
26527 #: ../fish/guestfish-actions.pod:3456
26529 "This command adds a partition to C<device>. If there is no partition table "
26530 "on the device, call L</part-init> first."
26534 #: ../fish/guestfish-actions.pod:3468
26536 "Creating a partition which covers the whole disk is not so easy. Use L</"
26537 "part-disk> to do that."
26541 #: ../fish/guestfish-actions.pod:3471
26546 #: ../fish/guestfish-actions.pod:3473
26549 " part-del device partnum\n"
26554 #: ../fish/guestfish-actions.pod:3481
26559 #: ../fish/guestfish-actions.pod:3483
26562 " part-disk device parttype\n"
26567 #: ../fish/guestfish-actions.pod:3485
26569 "This command is simply a combination of L</part-init> followed by L</part-"
26570 "add> to create a single primary partition covering the whole disk."
26574 #: ../fish/guestfish-actions.pod:3489
26576 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26577 "possible values are described in L</part-init>."
26581 #: ../fish/guestfish-actions.pod:3495
26582 msgid "part-get-bootable"
26586 #: ../fish/guestfish-actions.pod:3497
26589 " part-get-bootable device partnum\n"
26594 #: ../fish/guestfish-actions.pod:3502
26595 msgid "See also L</part-set-bootable>."
26599 #: ../fish/guestfish-actions.pod:3504
26600 msgid "part-get-mbr-id"
26604 #: ../fish/guestfish-actions.pod:3506
26607 " part-get-mbr-id device partnum\n"
26612 #: ../fish/guestfish-actions.pod:3511 ../fish/guestfish-actions.pod:3649
26614 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26615 "undefined results for other partition table types (see L</part-get-"
26620 #: ../fish/guestfish-actions.pod:3515
26621 msgid "part-get-parttype"
26625 #: ../fish/guestfish-actions.pod:3517
26628 " part-get-parttype device\n"
26633 #: ../fish/guestfish-actions.pod:3522
26635 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26636 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26637 "possible, although unusual. See L</part-init> for a full list."
26641 #: ../fish/guestfish-actions.pod:3527
26646 #: ../fish/guestfish-actions.pod:3529
26649 " part-init device parttype\n"
26654 #: ../fish/guestfish-actions.pod:3535
26656 "Initially there are no partitions. Following this, you should call L</part-"
26657 "add> for each partition required."
26661 #: ../fish/guestfish-actions.pod:3598
26666 #: ../fish/guestfish-actions.pod:3600
26669 " part-list device\n"
26674 #: ../fish/guestfish-actions.pod:3615
26676 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26677 "the device's sector size, see L</blockdev-getss>."
26681 #: ../fish/guestfish-actions.pod:3628
26682 msgid "part-set-bootable"
26686 #: ../fish/guestfish-actions.pod:3630
26689 " part-set-bootable device partnum true|false\n"
26694 #: ../fish/guestfish-actions.pod:3639
26695 msgid "part-set-mbr-id"
26699 #: ../fish/guestfish-actions.pod:3641
26702 " part-set-mbr-id device partnum idbyte\n"
26707 #: ../fish/guestfish-actions.pod:3653
26708 msgid "part-set-name"
26712 #: ../fish/guestfish-actions.pod:3655
26715 " part-set-name device partnum name\n"
26720 #: ../fish/guestfish-actions.pod:3663
26721 msgid "part-to-dev"
26725 #: ../fish/guestfish-actions.pod:3665
26728 " part-to-dev partition\n"
26733 #: ../fish/guestfish-actions.pod:3671
26735 "The named partition must exist, for example as a string returned from L</"
26736 "list-partitions>."
26740 #: ../fish/guestfish-actions.pod:3674
26741 msgid "ping-daemon"
26745 #: ../fish/guestfish-actions.pod:3676
26753 #: ../fish/guestfish-actions.pod:3683
26758 #: ../fish/guestfish-actions.pod:3685
26761 " pread path count offset\n"
26766 #: ../fish/guestfish-actions.pod:3693
26767 msgid "See also L</pwrite>, L</pread-device>."
26771 #: ../fish/guestfish-actions.pod:3698
26772 msgid "pread-device"
26776 #: ../fish/guestfish-actions.pod:3700
26779 " pread-device device count offset\n"
26784 #: ../fish/guestfish-actions.pod:3708
26785 msgid "See also L</pread>."
26789 #: ../fish/guestfish-actions.pod:3713
26794 #: ../fish/guestfish-actions.pod:3715
26797 " pvcreate device\n"
26802 #: ../fish/guestfish-actions.pod:3721
26807 #: ../fish/guestfish-actions.pod:3723
26810 " pvremove device\n"
26815 #: ../fish/guestfish-actions.pod:3732
26820 #: ../fish/guestfish-actions.pod:3734
26823 " pvresize device\n"
26828 #: ../fish/guestfish-actions.pod:3739
26829 msgid "pvresize-size"
26833 #: ../fish/guestfish-actions.pod:3741
26836 " pvresize-size device size\n"
26841 #: ../fish/guestfish-actions.pod:3743
26843 "This command is the same as L</pvresize> except that it allows you to "
26844 "specify the new size (in bytes) explicitly."
26848 #: ../fish/guestfish-actions.pod:3746
26853 #: ../fish/guestfish-actions.pod:3748
26861 #: ../fish/guestfish-actions.pod:3756
26862 msgid "See also L</pvs-full>."
26866 #: ../fish/guestfish-actions.pod:3758
26871 #: ../fish/guestfish-actions.pod:3760
26879 #: ../fish/guestfish-actions.pod:3765
26884 #: ../fish/guestfish-actions.pod:3767
26892 #: ../fish/guestfish-actions.pod:3771
26897 #: ../fish/guestfish-actions.pod:3773
26900 " pwrite path content offset\n"
26905 #: ../fish/guestfish-actions.pod:3784
26906 msgid "See also L</pread>, L</pwrite-device>."
26910 #: ../fish/guestfish-actions.pod:3789
26911 msgid "pwrite-device"
26915 #: ../fish/guestfish-actions.pod:3791
26918 " pwrite-device device content offset\n"
26923 #: ../fish/guestfish-actions.pod:3801
26924 msgid "See also L</pwrite>."
26928 #: ../fish/guestfish-actions.pod:3806
26933 #: ../fish/guestfish-actions.pod:3808
26936 " read-file path\n"
26941 #: ../fish/guestfish-actions.pod:3813
26943 "Unlike L</cat>, this function can correctly handle files that contain "
26944 "embedded ASCII NUL characters. However unlike L</download>, this function "
26945 "is limited in the total size of file that can be handled."
26949 #: ../fish/guestfish-actions.pod:3821
26954 #: ../fish/guestfish-actions.pod:3823
26957 " read-lines path\n"
26962 #: ../fish/guestfish-actions.pod:3830
26964 "Note that this function cannot correctly handle binary files (specifically, "
26965 "files containing C<\\0> character which is treated as end of line). For "
26966 "those you need to use the L</read-file> function which has a more complex "
26971 #: ../fish/guestfish-actions.pod:3835
26976 #: ../fish/guestfish-actions.pod:3837
26984 #: ../fish/guestfish-actions.pod:3889
26986 "This function is primarily intended for use by programs. To get a simple "
26987 "list of names, use L</ls>. To get a printable directory for human "
26988 "consumption, use L</ll>."
26992 #: ../fish/guestfish-actions.pod:3893
26997 #: ../fish/guestfish-actions.pod:3895
27005 #: ../fish/guestfish-actions.pod:3899
27006 msgid "readlinklist"
27010 #: ../fish/guestfish-actions.pod:3901
27013 " readlinklist path 'names ...'\n"
27018 #: ../fish/guestfish-actions.pod:3925
27023 #: ../fish/guestfish-actions.pod:3927
27031 #: ../fish/guestfish-actions.pod:3932
27032 msgid "removexattr"
27036 #: ../fish/guestfish-actions.pod:3934
27039 " removexattr xattr path\n"
27044 #: ../fish/guestfish-actions.pod:3939
27045 msgid "See also: L</lremovexattr>, L<attr(5)>."
27049 #: ../fish/guestfish-actions.pod:3941
27054 #: ../fish/guestfish-actions.pod:3943
27057 " resize2fs device\n"
27062 #: ../fish/guestfish-actions.pod:3948
27064 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
27065 "before calling this command. For unknown reasons C<resize2fs> sometimes "
27066 "gives an error about this and sometimes not. In any case, it is always safe "
27067 "to call L</e2fsck-f> before calling this function."
27071 #: ../fish/guestfish-actions.pod:3954
27072 msgid "resize2fs-M"
27076 #: ../fish/guestfish-actions.pod:3956
27079 " resize2fs-M device\n"
27084 #: ../fish/guestfish-actions.pod:3958
27086 "This command is the same as L</resize2fs>, but the filesystem is resized to "
27087 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
27092 #: ../fish/guestfish-actions.pod:3962
27094 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
27095 "and read the C<Block size> and C<Block count> values. These two numbers, "
27096 "multiplied together, give the resulting size of the minimal filesystem in "
27101 #: ../fish/guestfish-actions.pod:3967
27102 msgid "resize2fs-size"
27106 #: ../fish/guestfish-actions.pod:3969
27109 " resize2fs-size device size\n"
27114 #: ../fish/guestfish-actions.pod:3971
27116 "This command is the same as L</resize2fs> except that it allows you to "
27117 "specify the new size (in bytes) explicitly."
27121 #: ../fish/guestfish-actions.pod:3974
27126 #: ../fish/guestfish-actions.pod:3976
27134 #: ../fish/guestfish-actions.pod:3980
27139 #: ../fish/guestfish-actions.pod:3982
27147 #: ../fish/guestfish-actions.pod:3988
27152 #: ../fish/guestfish-actions.pod:3990
27160 #: ../fish/guestfish-actions.pod:3994
27161 msgid "rmmountpoint"
27165 #: ../fish/guestfish-actions.pod:3996
27168 " rmmountpoint exemptpath\n"
27173 #: ../fish/guestfish-actions.pod:3998
27175 "This calls removes a mountpoint that was previously created with L</"
27176 "mkmountpoint>. See L</mkmountpoint> for full details."
27180 #: ../fish/guestfish-actions.pod:4002
27181 msgid "scrub-device"
27185 #: ../fish/guestfish-actions.pod:4004
27188 " scrub-device device\n"
27193 #: ../fish/guestfish-actions.pod:4015
27198 #: ../fish/guestfish-actions.pod:4017
27201 " scrub-file file\n"
27206 #: ../fish/guestfish-actions.pod:4027
27207 msgid "scrub-freespace"
27211 #: ../fish/guestfish-actions.pod:4029
27214 " scrub-freespace dir\n"
27219 #: ../fish/guestfish-actions.pod:4031
27221 "This command creates the directory C<dir> and then fills it with files until "
27222 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
27223 "deletes them. The intention is to scrub any free space on the partition "
27224 "containing C<dir>."
27228 #: ../fish/guestfish-actions.pod:4040
27233 #: ../fish/guestfish-actions.pod:4042
27238 #: ../fish/guestfish-actions.pod:4044
27241 " set-append append\n"
27246 #: ../fish/guestfish-actions.pod:4055
27247 msgid "set-attach-method"
27251 #: ../fish/guestfish-actions.pod:4057
27252 msgid "attach-method"
27256 #: ../fish/guestfish-actions.pod:4059
27259 " set-attach-method attachmethod\n"
27264 #: ../fish/guestfish-actions.pod:4081
27265 msgid "set-autosync"
27269 #: ../fish/guestfish-actions.pod:4083
27274 #: ../fish/guestfish-actions.pod:4085
27277 " set-autosync true|false\n"
27282 #: ../fish/guestfish-actions.pod:4095
27287 #: ../fish/guestfish-actions.pod:4097
27292 #: ../fish/guestfish-actions.pod:4099
27295 " set-direct true|false\n"
27300 #: ../fish/guestfish-actions.pod:4105
27302 "One consequence of this is that log messages aren't caught by the library "
27303 "and handled by L</set-log-message-callback>, but go straight to stdout."
27307 #: ../fish/guestfish-actions.pod:4114
27308 msgid "set-e2label"
27312 #: ../fish/guestfish-actions.pod:4116
27315 " set-e2label device label\n"
27320 #: ../fish/guestfish-actions.pod:4122
27322 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
27323 "label on a filesystem."
27327 #: ../fish/guestfish-actions.pod:4125
27332 #: ../fish/guestfish-actions.pod:4127
27335 " set-e2uuid device uuid\n"
27340 #: ../fish/guestfish-actions.pod:4134
27342 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
27343 "UUID of a filesystem."
27347 #: ../fish/guestfish-actions.pod:4137
27348 msgid "set-memsize"
27352 #: ../fish/guestfish-actions.pod:4139
27357 #: ../fish/guestfish-actions.pod:4141
27360 " set-memsize memsize\n"
27365 #: ../fish/guestfish-actions.pod:4143
27367 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27368 "This only has any effect if called before L</launch>."
27372 #: ../fish/guestfish-actions.pod:4154
27373 msgid "set-network"
27377 #: ../fish/guestfish-actions.pod:4156
27382 #: ../fish/guestfish-actions.pod:4158
27385 " set-network true|false\n"
27390 #: ../fish/guestfish-actions.pod:4166
27392 "You must call this before calling L</launch>, otherwise it has no effect."
27396 #: ../fish/guestfish-actions.pod:4169
27401 #: ../fish/guestfish-actions.pod:4171
27406 #: ../fish/guestfish-actions.pod:4173
27409 " set-path searchpath\n"
27414 #: ../fish/guestfish-actions.pod:4182
27419 #: ../fish/guestfish-actions.pod:4184
27424 #: ../fish/guestfish-actions.pod:4186
27432 #: ../fish/guestfish-actions.pod:4206
27433 msgid "set-recovery-proc"
27437 #: ../fish/guestfish-actions.pod:4208
27438 msgid "recovery-proc"
27442 #: ../fish/guestfish-actions.pod:4210
27445 " set-recovery-proc true|false\n"
27450 #: ../fish/guestfish-actions.pod:4212
27452 "If this is called with the parameter C<false> then L</launch> does not "
27453 "create a recovery process. The purpose of the recovery process is to stop "
27454 "runaway qemu processes in the case where the main program aborts abruptly."
27458 #: ../fish/guestfish-actions.pod:4217
27460 "This only has any effect if called before L</launch>, and the default is "
27465 #: ../fish/guestfish-actions.pod:4226
27466 msgid "set-selinux"
27470 #: ../fish/guestfish-actions.pod:4228
27475 #: ../fish/guestfish-actions.pod:4230
27478 " set-selinux true|false\n"
27483 #: ../fish/guestfish-actions.pod:4241
27488 #: ../fish/guestfish-actions.pod:4243
27493 #: ../fish/guestfish-actions.pod:4245
27496 " set-trace true|false\n"
27501 #: ../fish/guestfish-actions.pod:4257
27503 "Trace messages are normally sent to C<stderr>, unless you register a "
27504 "callback to send them somewhere else (see L</set-event-callback>)."
27508 #: ../fish/guestfish-actions.pod:4261
27509 msgid "set-verbose"
27513 #: ../fish/guestfish-actions.pod:4263
27518 #: ../fish/guestfish-actions.pod:4265
27521 " set-verbose true|false\n"
27526 #: ../fish/guestfish-actions.pod:4272
27528 "Verbose messages are normally sent to C<stderr>, unless you register a "
27529 "callback to send them somewhere else (see L</set-event-callback>)."
27533 #: ../fish/guestfish-actions.pod:4276
27538 #: ../fish/guestfish-actions.pod:4278
27541 " setcon context\n"
27546 #: ../fish/guestfish-actions.pod:4285
27551 #: ../fish/guestfish-actions.pod:4287
27554 " setxattr xattr val vallen path\n"
27559 #: ../fish/guestfish-actions.pod:4293
27560 msgid "See also: L</lsetxattr>, L<attr(5)>."
27564 #: ../fish/guestfish-actions.pod:4295
27569 #: ../fish/guestfish-actions.pod:4297
27572 " sfdisk device cyls heads sectors 'lines ...'\n"
27577 #: ../fish/guestfish-actions.pod:4319
27578 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27582 #: ../fish/guestfish-actions.pod:4332
27587 #: ../fish/guestfish-actions.pod:4334
27590 " sfdiskM device 'lines ...'\n"
27595 #: ../fish/guestfish-actions.pod:4336
27597 "This is a simplified interface to the L</sfdisk> command, where partition "
27598 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27599 "you don't need to specify the cyls, heads and sectors parameters which were "
27600 "rarely if ever used anyway."
27604 #: ../fish/guestfish-actions.pod:4342
27605 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27609 #: ../fish/guestfish-actions.pod:4355
27614 #: ../fish/guestfish-actions.pod:4357
27617 " sfdisk-N device partnum cyls heads sectors line\n"
27622 #: ../fish/guestfish-actions.pod:4362
27624 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27625 "cyls/heads/sectors parameters."
27629 #: ../fish/guestfish-actions.pod:4365
27630 msgid "See also: L</part-add>"
27634 #: ../fish/guestfish-actions.pod:4377
27635 msgid "sfdisk-disk-geometry"
27639 #: ../fish/guestfish-actions.pod:4379
27642 " sfdisk-disk-geometry device\n"
27647 #: ../fish/guestfish-actions.pod:4381
27649 "This displays the disk geometry of C<device> read from the partition table. "
27650 "Especially in the case where the underlying block device has been resized, "
27651 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
27652 "kernel-geometry>)."
27656 #: ../fish/guestfish-actions.pod:4389
27657 msgid "sfdisk-kernel-geometry"
27661 #: ../fish/guestfish-actions.pod:4391
27664 " sfdisk-kernel-geometry device\n"
27669 #: ../fish/guestfish-actions.pod:4398
27674 #: ../fish/guestfish-actions.pod:4400
27677 " sfdisk-l device\n"
27682 #: ../fish/guestfish-actions.pod:4406
27683 msgid "See also: L</part-list>"
27687 #: ../fish/guestfish-actions.pod:4415
27692 #: ../fish/guestfish-actions.pod:4417
27700 #: ../fish/guestfish-actions.pod:4422
27701 msgid "This is like L</command>, but passes the command to:"
27705 #: ../fish/guestfish-actions.pod:4430
27706 msgid "All the provisos about L</command> apply to this call."
27710 #: ../fish/guestfish-actions.pod:4432
27715 #: ../fish/guestfish-actions.pod:4434
27718 " sh-lines command\n"
27723 #: ../fish/guestfish-actions.pod:4436
27724 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27728 #: ../fish/guestfish-actions.pod:4439
27729 msgid "See also: L</command-lines>"
27733 #: ../fish/guestfish-actions.pod:4441
27738 #: ../fish/guestfish-actions.pod:4443
27746 #: ../fish/guestfish-actions.pod:4447
27751 #: ../fish/guestfish-actions.pod:4449
27759 #: ../fish/guestfish-actions.pod:4455
27764 #: ../fish/guestfish-actions.pod:4457
27772 #: ../fish/guestfish-actions.pod:4465
27777 #: ../fish/guestfish-actions.pod:4467
27785 #: ../fish/guestfish-actions.pod:4475
27790 #: ../fish/guestfish-actions.pod:4477
27793 " strings-e encoding path\n"
27798 #: ../fish/guestfish-actions.pod:4479
27800 "This is like the L</strings> command, but allows you to specify the encoding "
27801 "of strings that are looked for in the source file C<path>."
27805 #: ../fish/guestfish-actions.pod:4489
27807 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27808 "ISO-8859-X (this is what L</strings> uses)."
27812 #: ../fish/guestfish-actions.pod:4521
27813 msgid "swapoff-device"
27817 #: ../fish/guestfish-actions.pod:4523
27820 " swapoff-device device\n"
27825 #: ../fish/guestfish-actions.pod:4525
27827 "This command disables the libguestfs appliance swap device or partition "
27828 "named C<device>. See L</swapon-device>."
27832 #: ../fish/guestfish-actions.pod:4529
27833 msgid "swapoff-file"
27837 #: ../fish/guestfish-actions.pod:4531
27840 " swapoff-file file\n"
27845 #: ../fish/guestfish-actions.pod:4535
27846 msgid "swapoff-label"
27850 #: ../fish/guestfish-actions.pod:4537
27853 " swapoff-label label\n"
27858 #: ../fish/guestfish-actions.pod:4542
27859 msgid "swapoff-uuid"
27863 #: ../fish/guestfish-actions.pod:4544
27866 " swapoff-uuid uuid\n"
27871 #: ../fish/guestfish-actions.pod:4549
27872 msgid "swapon-device"
27876 #: ../fish/guestfish-actions.pod:4551
27879 " swapon-device device\n"
27884 #: ../fish/guestfish-actions.pod:4553
27886 "This command enables the libguestfs appliance to use the swap device or "
27887 "partition named C<device>. The increased memory is made available for all "
27888 "commands, for example those run using L</command> or L</sh>."
27892 #: ../fish/guestfish-actions.pod:4565
27893 msgid "swapon-file"
27897 #: ../fish/guestfish-actions.pod:4567
27900 " swapon-file file\n"
27905 #: ../fish/guestfish-actions.pod:4569
27907 "This command enables swap to a file. See L</swapon-device> for other notes."
27911 #: ../fish/guestfish-actions.pod:4572
27912 msgid "swapon-label"
27916 #: ../fish/guestfish-actions.pod:4574
27919 " swapon-label label\n"
27924 #: ../fish/guestfish-actions.pod:4576
27926 "This command enables swap to a labeled swap partition. See L</swapon-"
27927 "device> for other notes."
27931 #: ../fish/guestfish-actions.pod:4579
27932 msgid "swapon-uuid"
27936 #: ../fish/guestfish-actions.pod:4581
27939 " swapon-uuid uuid\n"
27944 #: ../fish/guestfish-actions.pod:4583
27946 "This command enables swap to a swap partition with the given UUID. See L</"
27947 "swapon-device> for other notes."
27951 #: ../fish/guestfish-actions.pod:4586
27956 #: ../fish/guestfish-actions.pod:4588
27964 #: ../fish/guestfish-actions.pod:4596
27969 #: ../fish/guestfish-actions.pod:4598
27977 #: ../fish/guestfish-actions.pod:4606
27982 #: ../fish/guestfish-actions.pod:4608
27985 " tail-n nrlines path\n"
27990 #: ../fish/guestfish-actions.pod:4621
27995 #: ../fish/guestfish-actions.pod:4623
27998 " tar-in (tarfile|-) directory\n"
28003 #: ../fish/guestfish-actions.pod:4628
28004 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
28008 #: ../fish/guestfish-actions.pod:4633
28013 #: ../fish/guestfish-actions.pod:4635
28016 " tar-out directory (tarfile|-)\n"
28021 #: ../fish/guestfish-actions.pod:4640
28022 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
28026 #: ../fish/guestfish-actions.pod:4645
28031 #: ../fish/guestfish-actions.pod:4647
28034 " tgz-in (tarball|-) directory\n"
28039 #: ../fish/guestfish-actions.pod:4652
28040 msgid "To upload an uncompressed tarball, use L</tar-in>."
28044 #: ../fish/guestfish-actions.pod:4656
28049 #: ../fish/guestfish-actions.pod:4658
28052 " tgz-out directory (tarball|-)\n"
28057 #: ../fish/guestfish-actions.pod:4663
28058 msgid "To download an uncompressed tarball, use L</tar-out>."
28062 #: ../fish/guestfish-actions.pod:4667
28067 #: ../fish/guestfish-actions.pod:4669
28075 #: ../fish/guestfish-actions.pod:4678
28080 #: ../fish/guestfish-actions.pod:4680
28088 #: ../fish/guestfish-actions.pod:4685
28089 msgid "truncate-size"
28093 #: ../fish/guestfish-actions.pod:4687
28096 " truncate-size path size\n"
28101 #: ../fish/guestfish-actions.pod:4692
28103 "If the current file size is less than C<size> then the file is extended to "
28104 "the required size with zero bytes. This creates a sparse file (ie. disk "
28105 "blocks are not allocated for the file until you write to it). To create a "
28106 "non-sparse file of zeroes, use L</fallocate64> instead."
28110 #: ../fish/guestfish-actions.pod:4698
28115 #: ../fish/guestfish-actions.pod:4700
28118 " tune2fs-l device\n"
28123 #: ../fish/guestfish-actions.pod:4710
28128 #: ../fish/guestfish-actions.pod:4712
28131 " txz-in (tarball|-) directory\n"
28136 #: ../fish/guestfish-actions.pod:4719
28141 #: ../fish/guestfish-actions.pod:4721
28144 " txz-out directory (tarball|-)\n"
28149 #: ../fish/guestfish-actions.pod:4728
28154 #: ../fish/guestfish-actions.pod:4730
28162 #: ../fish/guestfish-actions.pod:4744
28163 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
28167 #: ../fish/guestfish-actions.pod:4749
28172 #: ../fish/guestfish-actions.pod:4751
28177 #: ../fish/guestfish-actions.pod:4753
28180 " umount pathordevice\n"
28185 #: ../fish/guestfish-actions.pod:4759
28190 #: ../fish/guestfish-actions.pod:4761
28191 msgid "unmount-all"
28195 #: ../fish/guestfish-actions.pod:4763
28203 #: ../fish/guestfish-actions.pod:4769
28208 #: ../fish/guestfish-actions.pod:4771
28211 " upload (filename|-) remotefilename\n"
28216 #: ../fish/guestfish-actions.pod:4778
28217 msgid "See also L</download>."
28221 #: ../fish/guestfish-actions.pod:4782
28222 msgid "upload-offset"
28226 #: ../fish/guestfish-actions.pod:4784
28229 " upload-offset (filename|-) remotefilename offset\n"
28234 #: ../fish/guestfish-actions.pod:4796
28236 "Note that there is no limit on the amount of data that can be uploaded with "
28237 "this call, unlike with L</pwrite>, and this call always writes the full "
28238 "amount unless an error occurs."
28242 #: ../fish/guestfish-actions.pod:4801
28243 msgid "See also L</upload>, L</pwrite>."
28247 #: ../fish/guestfish-actions.pod:4805
28252 #: ../fish/guestfish-actions.pod:4807
28255 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
28260 #: ../fish/guestfish-actions.pod:4826
28265 #: ../fish/guestfish-actions.pod:4828
28273 #: ../fish/guestfish-actions.pod:4855
28275 "I<Note:> Don't use this call to test for availability of features. In "
28276 "enterprise distributions we backport features from later versions into "
28277 "earlier versions, making this an unreliable way to test for features. Use "
28278 "L</available> instead."
28282 #: ../fish/guestfish-actions.pod:4861
28287 #: ../fish/guestfish-actions.pod:4863
28290 " vfs-label device\n"
28295 #: ../fish/guestfish-actions.pod:4870
28296 msgid "To find a filesystem from the label, use L</findfs-label>."
28300 #: ../fish/guestfish-actions.pod:4872
28305 #: ../fish/guestfish-actions.pod:4874
28308 " vfs-type device\n"
28313 #: ../fish/guestfish-actions.pod:4884
28318 #: ../fish/guestfish-actions.pod:4886
28321 " vfs-uuid device\n"
28326 #: ../fish/guestfish-actions.pod:4893
28327 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
28331 #: ../fish/guestfish-actions.pod:4895
28332 msgid "vg-activate"
28336 #: ../fish/guestfish-actions.pod:4897
28339 " vg-activate true|false 'volgroups ...'\n"
28344 #: ../fish/guestfish-actions.pod:4907
28345 msgid "vg-activate-all"
28349 #: ../fish/guestfish-actions.pod:4909
28352 " vg-activate-all true|false\n"
28357 #: ../fish/guestfish-actions.pod:4916
28362 #: ../fish/guestfish-actions.pod:4918
28365 " vgcreate volgroup 'physvols ...'\n"
28370 #: ../fish/guestfish-actions.pod:4923
28375 #: ../fish/guestfish-actions.pod:4925
28378 " vglvuuids vgname\n"
28383 #: ../fish/guestfish-actions.pod:4930
28385 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28386 "logical volumes and volume groups."
28390 #: ../fish/guestfish-actions.pod:4933
28391 msgid "See also L</vgpvuuids>."
28395 #: ../fish/guestfish-actions.pod:4935
28400 #: ../fish/guestfish-actions.pod:4937
28403 " vgpvuuids vgname\n"
28408 #: ../fish/guestfish-actions.pod:4942
28410 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28411 "physical volumes and volume groups."
28415 #: ../fish/guestfish-actions.pod:4945
28416 msgid "See also L</vglvuuids>."
28420 #: ../fish/guestfish-actions.pod:4947
28425 #: ../fish/guestfish-actions.pod:4949
28428 " vgremove vgname\n"
28433 #: ../fish/guestfish-actions.pod:4956
28438 #: ../fish/guestfish-actions.pod:4958
28441 " vgrename volgroup newvolgroup\n"
28446 #: ../fish/guestfish-actions.pod:4962
28451 #: ../fish/guestfish-actions.pod:4964
28459 #: ../fish/guestfish-actions.pod:4972
28460 msgid "See also L</vgs-full>."
28464 #: ../fish/guestfish-actions.pod:4974
28469 #: ../fish/guestfish-actions.pod:4976
28477 #: ../fish/guestfish-actions.pod:4981
28482 #: ../fish/guestfish-actions.pod:4983
28490 #: ../fish/guestfish-actions.pod:4988
28495 #: ../fish/guestfish-actions.pod:4990
28503 #: ../fish/guestfish-actions.pod:4994
28508 #: ../fish/guestfish-actions.pod:4996
28516 #: ../fish/guestfish-actions.pod:5001
28521 #: ../fish/guestfish-actions.pod:5003
28529 #: ../fish/guestfish-actions.pod:5008
28534 #: ../fish/guestfish-actions.pod:5010
28542 #: ../fish/guestfish-actions.pod:5015
28547 #: ../fish/guestfish-actions.pod:5017
28550 " write path content\n"
28555 #: ../fish/guestfish-actions.pod:5025
28560 #: ../fish/guestfish-actions.pod:5027
28563 " write-file path content size\n"
28568 #: ../fish/guestfish-actions.pod:5050
28573 #: ../fish/guestfish-actions.pod:5052
28576 " zegrep regex path\n"
28581 #: ../fish/guestfish-actions.pod:5060
28586 #: ../fish/guestfish-actions.pod:5062
28589 " zegrepi regex path\n"
28594 #: ../fish/guestfish-actions.pod:5070
28599 #: ../fish/guestfish-actions.pod:5072
28607 #: ../fish/guestfish-actions.pod:5080
28608 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28612 #: ../fish/guestfish-actions.pod:5083
28613 msgid "zero-device"
28617 #: ../fish/guestfish-actions.pod:5085
28620 " zero-device device\n"
28625 #: ../fish/guestfish-actions.pod:5087
28627 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
28628 "which just zeroes the first few blocks of a device."
28632 #: ../fish/guestfish-actions.pod:5094
28637 #: ../fish/guestfish-actions.pod:5096
28640 " zerofree device\n"
28645 #: ../fish/guestfish-actions.pod:5109
28650 #: ../fish/guestfish-actions.pod:5111
28653 " zfgrep pattern path\n"
28658 #: ../fish/guestfish-actions.pod:5119
28663 #: ../fish/guestfish-actions.pod:5121
28666 " zfgrepi pattern path\n"
28671 #: ../fish/guestfish-actions.pod:5129
28676 #: ../fish/guestfish-actions.pod:5131
28679 " zfile meth path\n"
28684 #: ../fish/guestfish-actions.pod:5138
28686 "Since 1.0.63, use L</file> instead which can now process compressed files."
28690 #: ../fish/guestfish-actions.pod:5148
28695 #: ../fish/guestfish-actions.pod:5150
28698 " zgrep regex path\n"
28703 #: ../fish/guestfish-actions.pod:5158
28708 #: ../fish/guestfish-actions.pod:5160
28711 " zgrepi regex path\n"
28716 #: ../fish/guestfish-commands.pod:1
28721 #: ../fish/guestfish-commands.pod:3
28726 #: ../fish/guestfish-commands.pod:5
28729 " alloc filename size\n"
28734 #: ../fish/guestfish-commands.pod:7
28736 "This creates an empty (zeroed) file of the given size, and then adds so it "
28737 "can be further examined."
28741 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
28742 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28746 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
28747 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28751 #: ../fish/guestfish-commands.pod:14
28753 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28754 "image, see L</PREPARED DISK IMAGES>."
28758 #: ../fish/guestfish-commands.pod:17
28763 #: ../fish/guestfish-commands.pod:19
28766 " copy-in local [local ...] /remotedir\n"
28771 #: ../fish/guestfish-commands.pod:21
28773 "C<copy-in> copies local files or directories recursively into the disk "
28774 "image, placing them in the directory called C</remotedir> (which must "
28775 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28776 "other commands as necessary."
28780 #: ../fish/guestfish-commands.pod:26
28782 "Multiple local files and directories can be specified, but the last "
28783 "parameter must always be a remote directory. Wildcards cannot be used."
28787 #: ../fish/guestfish-commands.pod:30
28792 #: ../fish/guestfish-commands.pod:32
28795 " copy-out remote [remote ...] localdir\n"
28800 #: ../fish/guestfish-commands.pod:34
28802 "C<copy-out> copies remote files or directories recursively out of the disk "
28803 "image, placing them on the host disk in a local directory called C<localdir> "
28804 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28805 "download>, L</tar-out> and other commands as necessary."
28809 #: ../fish/guestfish-commands.pod:40
28811 "Multiple remote files and directories can be specified, but the last "
28812 "parameter must always be a local directory. To download to the current "
28813 "directory, use C<.> as in:"
28817 #: ../fish/guestfish-commands.pod:44
28820 " copy-out /home .\n"
28825 #: ../fish/guestfish-commands.pod:46
28827 "Wildcards cannot be used in the ordinary command, but you can use them with "
28828 "the help of L</glob> like this:"
28832 #: ../fish/guestfish-commands.pod:49
28835 " glob copy-out /home/* .\n"
28840 #: ../fish/guestfish-commands.pod:51
28845 #: ../fish/guestfish-commands.pod:53
28848 " display filename\n"
28853 #: ../fish/guestfish-commands.pod:55
28855 "Use C<display> (a graphical display program) to display an image file. It "
28856 "downloads the file, and runs C<display> on it."
28860 #: ../fish/guestfish-commands.pod:58
28862 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
28863 "environment variable. For example to use the GNOME display program:"
28867 #: ../fish/guestfish-commands.pod:61
28870 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
28875 #: ../fish/guestfish-commands.pod:63
28877 #| msgid "See L<guestfish(1)>."
28878 msgid "See also L<display(1)>."
28879 msgstr "Див. L<guestfish(1)>."
28882 #: ../fish/guestfish-commands.pod:65
28887 #: ../fish/guestfish-commands.pod:67
28890 " echo [params ...]\n"
28895 #: ../fish/guestfish-commands.pod:69
28896 msgid "This echos the parameters to the terminal."
28900 #: ../fish/guestfish-commands.pod:71
28905 #: ../fish/guestfish-commands.pod:73
28910 #: ../fish/guestfish-commands.pod:75
28915 #: ../fish/guestfish-commands.pod:77
28923 #: ../fish/guestfish-commands.pod:79
28925 "This is used to edit a file. It downloads the file, edits it locally using "
28926 "your editor, then uploads the result."
28930 #: ../fish/guestfish-commands.pod:82
28932 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28933 "or C<emacs> you will get those corresponding editors."
28937 #: ../fish/guestfish-commands.pod:86
28942 #: ../fish/guestfish-commands.pod:88
28945 " glob command args...\n"
28950 #: ../fish/guestfish-commands.pod:90
28952 "Expand wildcards in any paths in the args list, and run C<command> "
28953 "repeatedly on each matching path."
28957 #: ../fish/guestfish-commands.pod:93
28958 msgid "See L</WILDCARDS AND GLOBBING>."
28962 #: ../fish/guestfish-commands.pod:95
28967 #: ../fish/guestfish-commands.pod:97
28970 " hexedit <filename|device>\n"
28971 " hexedit <filename|device> <max>\n"
28972 " hexedit <filename|device> <start> <max>\n"
28977 #: ../fish/guestfish-commands.pod:101
28979 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28984 #: ../fish/guestfish-commands.pod:104
28986 "This command works by downloading potentially the whole file or device, "
28987 "editing it locally, then uploading it. If the file or device is large, you "
28988 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28989 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28990 "usual modifiers allowed such as C<1M> (1 megabyte)."
28994 #: ../fish/guestfish-commands.pod:111
28995 msgid "For example to edit the first few sectors of a disk you might do:"
28999 #: ../fish/guestfish-commands.pod:114
29002 " hexedit /dev/sda 1M\n"
29007 #: ../fish/guestfish-commands.pod:116
29009 "which would allow you to edit anywhere within the first megabyte of the disk."
29013 #: ../fish/guestfish-commands.pod:119
29014 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
29018 #: ../fish/guestfish-commands.pod:121
29021 " hexedit /dev/sda1 0x400 0x400\n"
29026 #: ../fish/guestfish-commands.pod:123
29027 msgid "(assuming the superblock is in the standard location)."
29031 #: ../fish/guestfish-commands.pod:125
29033 "This command requires the external L<hexedit(1)> program. You can specify "
29034 "another program to use by setting the C<HEXEDITOR> environment variable."
29038 #: ../fish/guestfish-commands.pod:129
29039 msgid "See also L</hexdump>."
29043 #: ../fish/guestfish-commands.pod:131
29048 #: ../fish/guestfish-commands.pod:133
29056 #: ../fish/guestfish-commands.pod:135
29058 "Change the local directory, ie. the current directory of guestfish itself."
29062 #: ../fish/guestfish-commands.pod:138
29063 msgid "Note that C<!cd> won't do what you might expect."
29067 #: ../fish/guestfish-commands.pod:140
29072 #: ../fish/guestfish-commands.pod:142
29077 #: ../fish/guestfish-commands.pod:144
29085 #: ../fish/guestfish-commands.pod:146
29086 msgid "Opens the manual page for guestfish."
29090 #: ../fish/guestfish-commands.pod:148
29095 #: ../fish/guestfish-commands.pod:150
29100 #: ../fish/guestfish-commands.pod:152
29108 #: ../fish/guestfish-commands.pod:154
29116 #: ../fish/guestfish-commands.pod:156
29117 msgid "This is used to view a file."
29121 #: ../fish/guestfish-commands.pod:158
29123 "The default viewer is C<$PAGER>. However if you use the alternate command "
29124 "C<less> you will get the C<less> command specifically."
29128 #: ../fish/guestfish-commands.pod:161
29133 #: ../fish/guestfish-commands.pod:163
29141 #: ../fish/guestfish-commands.pod:165
29143 "Close and reopen the libguestfs handle. It is not necessary to use this "
29144 "normally, because the handle is closed properly when guestfish exits. "
29145 "However this is occasionally useful for testing."
29149 #: ../fish/guestfish-commands.pod:169
29154 #: ../fish/guestfish-commands.pod:171
29157 " sparse filename size\n"
29162 #: ../fish/guestfish-commands.pod:173
29164 "This creates an empty sparse file of the given size, and then adds so it can "
29165 "be further examined."
29169 #: ../fish/guestfish-commands.pod:176
29171 "In all respects it works the same as the L</alloc> command, except that the "
29172 "image file is allocated sparsely, which means that disk blocks are not "
29173 "assigned to the file until they are needed. Sparse disk files only use "
29174 "space when written to, but they are slower and there is a danger you could "
29175 "run out of real disk space during a write operation."
29179 #: ../fish/guestfish-commands.pod:186
29184 #: ../fish/guestfish-commands.pod:188
29192 #: ../fish/guestfish-commands.pod:190
29194 "This command returns a list of the optional groups known to the daemon, and "
29195 "indicates which ones are supported by this build of the libguestfs appliance."
29199 #: ../fish/guestfish-commands.pod:194
29200 msgid "See also L<guestfs(3)/AVAILABILITY>."
29204 #: ../fish/guestfish-commands.pod:196
29209 #: ../fish/guestfish-commands.pod:198
29212 " time command args...\n"
29217 #: ../fish/guestfish-commands.pod:200
29219 "Run the command as usual, but print the elapsed time afterwards. This can "
29220 "be useful for benchmarking operations."
29224 #: ../test-tool/libguestfs-test-tool.pod:5
29225 msgid "libguestfs-test-tool - End user tests for libguestfs"
29229 #: ../test-tool/libguestfs-test-tool.pod:9
29232 " libguestfs-test-tool [--options]\n"
29237 #: ../test-tool/libguestfs-test-tool.pod:13
29239 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
29240 "and developers, to allow them to check basic libguestfs functionality is "
29241 "working. This is needed because libguestfs occasionally breaks for reasons "
29242 "beyond our control: usually because of changes in the underlying qemu or "
29243 "kernel packages, or the host environment."
29247 #: ../test-tool/libguestfs-test-tool.pod:20
29248 msgid "If you suspect a problem in libguestfs, then just run:"
29252 #: ../test-tool/libguestfs-test-tool.pod:22
29255 " libguestfs-test-tool\n"
29260 #: ../test-tool/libguestfs-test-tool.pod:24
29261 msgid "It will print lots of diagnostic messages."
29265 #: ../test-tool/libguestfs-test-tool.pod:26
29266 msgid "If it runs to completion successfully, you will see this near the end:"
29270 #: ../test-tool/libguestfs-test-tool.pod:28
29273 " ===== TEST FINISHED OK =====\n"
29278 #: ../test-tool/libguestfs-test-tool.pod:30
29279 msgid "and the test tool will exit with code 0."
29283 #: ../test-tool/libguestfs-test-tool.pod:32
29285 "If it fails (and/or exits with non-zero error code), please paste the "
29286 "B<complete, unedited> output of the test tool into a bug report. More "
29287 "information about reporting bugs can be found on the L<http://libguestfs.org/"
29292 #: ../test-tool/libguestfs-test-tool.pod:41
29297 #: ../test-tool/libguestfs-test-tool.pod:43
29298 msgid "Display short usage information and exit."
29302 #: ../test-tool/libguestfs-test-tool.pod:45
29303 msgid "I<--qemu qemu_binary>"
29307 #: ../test-tool/libguestfs-test-tool.pod:47
29309 "If you have downloaded another qemu binary, point this option at the full "
29310 "path of the binary to try it."
29314 #: ../test-tool/libguestfs-test-tool.pod:50
29315 msgid "I<--qemudir qemu_source_dir>"
29319 #: ../test-tool/libguestfs-test-tool.pod:52
29321 "If you have compiled qemu from source, point this option at the source "
29322 "directory to try it."
29326 #: ../test-tool/libguestfs-test-tool.pod:55
29327 msgid "I<--timeout N>"
29331 #: ../test-tool/libguestfs-test-tool.pod:57
29333 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
29334 "does not usually need to be adjusted unless your machine is very slow."
29338 #: ../test-tool/libguestfs-test-tool.pod:63
29339 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
29343 #: ../test-tool/libguestfs-test-tool.pod:65
29345 "If you have compiled another version of qemu from source and would like to "
29346 "try that, then you can use the I<--qemudir> option to point to the qemu "
29347 "source directory."
29351 #: ../test-tool/libguestfs-test-tool.pod:69
29353 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
29354 "option to point to the binary."
29358 #: ../test-tool/libguestfs-test-tool.pod:72
29360 "When using an alternate qemu with libguestfs, usually you would need to "
29361 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
29362 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
29363 "use either of the I<--qemudir> or I<--qemu> options."
29367 #: ../test-tool/libguestfs-test-tool.pod:79
29369 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29370 "I<1> if there was an error."
29374 #: ../test-tool/libguestfs-test-tool.pod:84
29376 "For the full list of environment variables which may affect libguestfs, "
29377 "please see the L<guestfs(3)> manual page."
29381 #: ../test-tool/libguestfs-test-tool.pod:89
29382 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29386 #: ../fuse/guestmount.pod:5
29388 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29392 #: ../fuse/guestmount.pod:9
29395 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29400 #: ../fuse/guestmount.pod:11
29403 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29408 #: ../fuse/guestmount.pod:13
29411 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29416 #: ../fuse/guestmount.pod:17
29418 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29419 "machines. If you do this, you risk disk corruption in the VM."
29423 #: ../fuse/guestmount.pod:22
29425 "The guestmount program can be used to mount virtual machine filesystems and "
29426 "other disk images on the host. It uses libguestfs for access to the guest "
29427 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29428 "a mountable device."
29432 #: ../fuse/guestmount.pod:27
29434 "Along with other options, you have to give at least one device (I<-a> "
29435 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
29436 "option) or use the I<-i> inspection option. How this works is better "
29437 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29442 #: ../fuse/guestmount.pod:33
29444 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29445 "by you, and the filesystem will not be visible to any other users unless you "
29446 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
29447 "the filesystem, use the C<fusermount -u> command."
29451 #: ../fuse/guestmount.pod:41
29453 "For a typical Windows guest which has its main filesystem on the first "
29458 #: ../fuse/guestmount.pod:44
29461 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29466 #: ../fuse/guestmount.pod:46
29468 "For a typical Linux guest which has a /boot filesystem on the first "
29469 "partition, and the root filesystem on a logical volume:"
29473 #: ../fuse/guestmount.pod:49
29476 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29481 #: ../fuse/guestmount.pod:51
29482 msgid "To get libguestfs to detect guest mountpoints for you:"
29486 #: ../fuse/guestmount.pod:53
29489 " guestmount -a guest.img -i --ro /mnt\n"
29494 #: ../fuse/guestmount.pod:55
29495 msgid "For a libvirt guest called \"Guest\" you could do:"
29499 #: ../fuse/guestmount.pod:57
29502 " guestmount -d Guest -i --ro /mnt\n"
29507 #: ../fuse/guestmount.pod:59
29509 "If you don't know what filesystems are contained in a guest or disk image, "
29510 "use L<virt-filesystems(1)> first:"
29514 #: ../fuse/guestmount.pod:62
29517 " virt-filesystems MyGuest\n"
29522 #: ../fuse/guestmount.pod:64
29524 "If you want to trace the libguestfs calls but without excessive debugging "
29525 "information, we recommend:"
29529 #: ../fuse/guestmount.pod:67
29532 " guestmount [...] --trace /mnt\n"
29537 #: ../fuse/guestmount.pod:69
29538 msgid "If you want to debug the program, we recommend:"
29542 #: ../fuse/guestmount.pod:71
29545 " guestmount [...] --trace --verbose /mnt\n"
29550 #: ../fuse/guestmount.pod:73
29555 #: ../fuse/guestmount.pod:75
29556 msgid "Other users cannot see the filesystem by default"
29560 #: ../fuse/guestmount.pod:77
29562 "If you mount a filesystem as one user (eg. root), then other users will not "
29563 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29564 "option when mounting:"
29568 #: ../fuse/guestmount.pod:81
29571 " sudo guestmount [...] -o allow_other /mnt\n"
29576 #: ../fuse/guestmount.pod:87
29577 msgid "B<-a image> | B<--add image>"
29581 #: ../fuse/guestmount.pod:89
29582 msgid "Add a block device or virtual machine image."
29586 #: ../fuse/guestmount.pod:94
29587 msgid "B<-c URI> | B<--connect URI>"
29591 #: ../fuse/guestmount.pod:100
29592 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29596 #: ../fuse/guestmount.pod:108
29597 msgid "B<--dir-cache-timeout N>"
29601 #: ../fuse/guestmount.pod:110
29603 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
29604 "seconds. The readdir cache [actually, there are several semi-independent "
29605 "caches] is populated after a readdir(2) call with the stat and extended "
29606 "attributes of the files in the directory, in anticipation that they will be "
29607 "requested soon after."
29611 #: ../fuse/guestmount.pod:116
29613 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29614 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29615 "requests, only cache existing ones."
29619 #: ../fuse/guestmount.pod:127
29620 msgid "B<--format=raw|qcow2|..> | B<--format>"
29624 #: ../fuse/guestmount.pod:134
29626 "If you have untrusted raw-format guest disk images, you should use this "
29627 "option to specify the disk format. This avoids a possible security problem "
29628 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
29629 "guestfs_add_drive_opts>."
29633 #: ../fuse/guestmount.pod:139
29634 msgid "B<--fuse-help>"
29638 #: ../fuse/guestmount.pod:141
29639 msgid "Display help on special FUSE options (see I<-o> below)."
29643 #: ../fuse/guestmount.pod:145
29644 msgid "Display brief help and exit."
29648 #: ../fuse/guestmount.pod:147
29649 msgid "B<-i> | B<--inspector>"
29653 #: ../fuse/guestmount.pod:167
29655 "Mount the named partition or logical volume on the given mountpoint B<in the "
29656 "guest> (this has nothing to do with mountpoints in the host)."
29660 #: ../fuse/guestmount.pod:170
29662 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
29663 "something on C</>."
29667 #: ../fuse/guestmount.pod:183
29668 msgid "B<-n> | B<--no-sync>"
29672 #: ../fuse/guestmount.pod:185
29674 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
29675 "unmounted. If you specify this option, then we don't attempt to sync the "
29676 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
29680 #: ../fuse/guestmount.pod:190
29681 msgid "B<-o option> | B<--option option>"
29685 #: ../fuse/guestmount.pod:192
29686 msgid "Pass extra options to FUSE."
29690 #: ../fuse/guestmount.pod:194
29692 "To get a list of all the extra options supported by FUSE, use the command "
29693 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29694 "of them are a good idea."
29698 #: ../fuse/guestmount.pod:198
29701 " guestmount --fuse-help\n"
29706 #: ../fuse/guestmount.pod:200
29707 msgid "Some potentially useful FUSE options:"
29711 #: ../fuse/guestmount.pod:204
29712 msgid "B<-o allow_other>"
29716 #: ../fuse/guestmount.pod:206
29717 msgid "Allow other users to see the filesystem."
29721 #: ../fuse/guestmount.pod:208
29722 msgid "B<-o attr_timeout=N>"
29726 #: ../fuse/guestmount.pod:210
29727 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29731 #: ../fuse/guestmount.pod:212
29732 msgid "B<-o kernel_cache>"
29736 #: ../fuse/guestmount.pod:214
29738 "Allow the kernel to cache files (reduces the number of reads that have to go "
29739 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29740 "afford the extra memory usage."
29744 #: ../fuse/guestmount.pod:218
29745 msgid "B<-o uid=N> B<-o gid=N>"
29749 #: ../fuse/guestmount.pod:220
29751 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29752 "the chosen values."
29756 #: ../fuse/guestmount.pod:225
29757 msgid "B<-r> | B<--ro>"
29761 #: ../fuse/guestmount.pod:227
29763 "Add devices and mount everything read-only. Also disallow writes and make "
29764 "the disk appear read-only to FUSE."
29768 #: ../fuse/guestmount.pod:230
29770 "This is highly recommended if you are not going to edit the guest disk. If "
29771 "the guest is running and this option is I<not> supplied, then there is a "
29772 "strong risk of disk corruption in the guest. We try to prevent this from "
29773 "happening, but it is not always possible."
29777 #: ../fuse/guestmount.pod:235
29778 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29782 #: ../fuse/guestmount.pod:239
29783 msgid "Enable SELinux support for the guest."
29787 #: ../fuse/guestmount.pod:241
29788 msgid "B<-v> | B<--verbose>"
29792 #: ../fuse/guestmount.pod:243
29793 msgid "Enable verbose messages from underlying libguestfs."
29797 #: ../fuse/guestmount.pod:245
29798 msgid "B<-V> | B<--version>"
29802 #: ../fuse/guestmount.pod:247
29803 msgid "Display the program version and exit."
29807 #: ../fuse/guestmount.pod:249
29808 msgid "B<-w> | B<--rw>"
29812 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
29813 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29817 #: ../fuse/guestmount.pod:256
29818 msgid "B<-x> | B<--trace>"
29822 #: ../fuse/guestmount.pod:258
29823 msgid "Trace libguestfs calls and entry into each FUSE function."
29827 #: ../fuse/guestmount.pod:260
29828 msgid "This also stops the daemon from forking into the background."
29832 #: ../fuse/guestmount.pod:281
29834 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29835 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29840 #: ../fuse/guestmount.pod:296
29841 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29845 #: ../tools/virt-win-reg.pl:37
29847 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29851 #: ../tools/virt-win-reg.pl:41
29854 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29859 #: ../tools/virt-win-reg.pl:43
29862 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29867 #: ../tools/virt-win-reg.pl:45
29870 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29875 #: ../tools/virt-win-reg.pl:47
29878 " virt-win-reg --merge domname [input.reg ...]\n"
29883 #: ../tools/virt-win-reg.pl:49
29886 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29891 #: ../tools/virt-win-reg.pl:53
29893 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29894 "virtual machines. If you do this, you I<will> get irreversible disk "
29895 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29896 "but doesn't catch all cases."
29900 #: ../tools/virt-win-reg.pl:58
29902 "Modifying the Windows Registry is an inherently risky operation. The format "
29903 "is deliberately obscure and undocumented, and Registry changes can leave the "
29904 "system unbootable. Therefore when using the I<--merge> option, make sure "
29905 "you have a reliable backup first."
29909 #: ../tools/virt-win-reg.pl:65
29911 "This program can export and merge Windows Registry entries from a Windows "
29916 #: ../tools/virt-win-reg.pl:68
29918 "The first parameter is the libvirt guest name or the raw disk image of a "
29923 #: ../tools/virt-win-reg.pl:71
29925 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29926 "exported (recursively). For example:"
29930 #: ../tools/virt-win-reg.pl:74
29933 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29938 #: ../tools/virt-win-reg.pl:76
29940 "You can also display single values from within registry keys, for example:"
29944 #: ../tools/virt-win-reg.pl:79
29947 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29948 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29949 " Windows 7 Enterprise\n"
29954 #: ../tools/virt-win-reg.pl:83
29956 "With I<--merge>, you can merge a textual regedit file into the Windows "
29961 #: ../tools/virt-win-reg.pl:86
29964 " $ virt-win-reg --merge Windows7 changes.reg\n"
29969 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29974 #: ../tools/virt-win-reg.pl:90
29976 "This program is only meant for simple access to the registry. If you want "
29977 "to do complicated things with the registry, we suggest you download the "
29978 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29979 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29980 "L<hivexregedit(1)>."
29984 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
29985 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
29986 #: ../tools/virt-list-partitions.pl:64
29987 msgid "Display brief help."
29991 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
29992 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
29993 #: ../tools/virt-list-partitions.pl:72
29994 msgid "Display version number and exit."
29998 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
30003 #: ../tools/virt-win-reg.pl:122
30004 msgid "Enable debugging messages."
30008 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
30009 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
30010 msgid "B<--connect URI> | B<-c URI>"
30014 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
30015 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
30017 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
30018 "to the default libvirt hypervisor."
30022 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
30023 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
30025 "If you specify guest block devices directly, then libvirt is not used at all."
30029 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
30030 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
30031 msgid "B<--format> raw"
30035 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
30036 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
30038 "Specify the format of disk images given on the command line. If this is "
30039 "omitted then the format is autodetected from the content of the disk image."
30043 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
30044 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
30046 "If disk images are requested from libvirt, then this program asks libvirt "
30047 "for this information. In this case, the value of the format parameter is "
30052 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
30053 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
30055 "If working with untrusted raw-format guest disk images, you should ensure "
30056 "the format is always specified."
30060 #: ../tools/virt-win-reg.pl:157
30065 #: ../tools/virt-win-reg.pl:159
30067 "In merge mode, this merges a textual regedit file into the Windows Registry "
30068 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
30069 "displays or exports Registry entries instead."
30073 #: ../tools/virt-win-reg.pl:163
30075 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
30076 "result in disk corruption. However exporting (without this flag) is always "
30081 #: ../tools/virt-win-reg.pl:171
30082 msgid "B<--encoding> UTF-16LE|ASCII"
30086 #: ../tools/virt-win-reg.pl:173
30088 "When merging (only), you may need to specify the encoding for strings to be "
30089 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
30090 "(3)/ENCODING STRINGS>."
30094 #: ../tools/virt-win-reg.pl:177
30096 "The default is to use UTF-16LE, which should work with recent versions of "
30101 #: ../tools/virt-win-reg.pl:184
30102 msgid "B<--unsafe-printable-strings>"
30106 #: ../tools/virt-win-reg.pl:186
30108 "When exporting (only), assume strings are UTF-16LE and print them as strings "
30109 "instead of hex sequences. Remove the final zero codepoint from strings if "
30114 #: ../tools/virt-win-reg.pl:190
30116 "This is unsafe and does not preserve the fidelity of strings in the original "
30117 "Registry for various reasons:"
30121 #: ../tools/virt-win-reg.pl:197
30123 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
30124 "other encodings will be corrupted by this transformation."
30128 #: ../tools/virt-win-reg.pl:202
30130 "Assumes that everything which has type 1 or 2 is really a string and that "
30131 "everything else is not a string, but the type field in real Registries is "
30136 #: ../tools/virt-win-reg.pl:208
30138 "Loses information about whether a zero codepoint followed the string in the "
30143 #: ../tools/virt-win-reg.pl:213
30145 "This all happens because the Registry itself contains no information about "
30146 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
30150 #: ../tools/virt-win-reg.pl:217
30152 "You should only use this option for quick hacking and debugging of the "
30153 "Registry contents, and I<never> use it if the output is going to be passed "
30154 "into another program or stored in another Registry."
30158 #: ../tools/virt-win-reg.pl:554
30159 msgid "SUPPORTED SYSTEMS"
30163 #: ../tools/virt-win-reg.pl:556
30165 "The program currently supports Windows NT-derived guests starting with "
30166 "Windows XP through to at least Windows 7."
30170 #: ../tools/virt-win-reg.pl:559
30171 msgid "The following Registry keys are supported:"
30175 #: ../tools/virt-win-reg.pl:563
30176 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
30180 #: ../tools/virt-win-reg.pl:565
30181 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
30185 #: ../tools/virt-win-reg.pl:567
30186 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
30190 #: ../tools/virt-win-reg.pl:569
30191 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
30195 #: ../tools/virt-win-reg.pl:571
30196 msgid "C<HKEY_USERS\\.DEFAULT>"
30200 #: ../tools/virt-win-reg.pl:573
30201 msgid "C<HKEY_USERS\\I<SID>>"
30205 #: ../tools/virt-win-reg.pl:575
30206 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
30210 #: ../tools/virt-win-reg.pl:577
30211 msgid "C<HKEY_USERS\\I<username>>"
30215 #: ../tools/virt-win-reg.pl:579
30217 "where I<username> is a local user name (this is a libguestfs extension)."
30221 #: ../tools/virt-win-reg.pl:583
30223 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
30228 #: ../tools/virt-win-reg.pl:586
30230 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
30231 "supported (there is no \"current user\")."
30235 #: ../tools/virt-win-reg.pl:589
30240 #: ../tools/virt-win-reg.pl:591
30242 "C<virt-win-reg> expects that regedit files have already been reencoded in "
30243 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
30244 "style line endings. Since Windows regedit files are often in UTF-16LE with "
30245 "Windows-style line endings, you may need to reencode the whole file before "
30246 "or after processing."
30250 #: ../tools/virt-win-reg.pl:597
30252 "To reencode a file from Windows format to Linux (before processing it with "
30253 "the I<--merge> option), you would do something like this:"
30257 #: ../tools/virt-win-reg.pl:600
30260 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
30265 #: ../tools/virt-win-reg.pl:602
30267 "To go in the opposite direction, after exporting and before sending the file "
30268 "to a Windows user, do something like this:"
30272 #: ../tools/virt-win-reg.pl:605
30275 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
30280 #: ../tools/virt-win-reg.pl:607
30281 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
30285 #: ../tools/virt-win-reg.pl:609
30287 "If you are unsure about the current encoding, use the L<file(1)> command. "
30288 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30289 "style (CRLF) line endings, like this:"
30293 #: ../tools/virt-win-reg.pl:613
30296 " $ file software.reg\n"
30297 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30298 " with CRLF line terminators\n"
30303 #: ../tools/virt-win-reg.pl:617
30304 msgid "This file would need conversion before you could I<--merge> it."
30308 #: ../tools/virt-win-reg.pl:619
30309 msgid "CurrentControlSet etc."
30313 #: ../tools/virt-win-reg.pl:621
30315 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30316 "Registry at the level of the hive file, and therefore you cannot modify "
30321 #: ../tools/virt-win-reg.pl:625
30323 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30324 "circumstances it might refer to another control set. The way to find out is "
30325 "to look at the C<HKLM\\SYSTEM\\Select> key:"
30329 #: ../tools/virt-win-reg.pl:629
30332 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30333 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30334 " \"Current\"=dword:00000001\n"
30335 " \"Default\"=dword:00000001\n"
30336 " \"Failed\"=dword:00000000\n"
30337 " \"LastKnownGood\"=dword:00000002\n"
30342 #: ../tools/virt-win-reg.pl:636
30343 msgid "\"Current\" is the one which Windows will choose when it boots."
30347 #: ../tools/virt-win-reg.pl:638
30349 "Similarly, other C<Current...> keys in the path may need to be replaced."
30353 #: ../tools/virt-win-reg.pl:641
30354 msgid "WINDOWS TIPS"
30358 #: ../tools/virt-win-reg.pl:643
30360 "Note that some of these tips modify the guest disk image. The guest I<must> "
30361 "be shut off, else you will get disk corruption."
30365 #: ../tools/virt-win-reg.pl:646
30366 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30370 #: ../tools/virt-win-reg.pl:648
30372 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30373 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30374 "is uploaded into C<C:\\>:"
30378 #: ../tools/virt-win-reg.pl:652
30381 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30386 #: ../tools/virt-win-reg.pl:654
30387 msgid "Prepare a regedit file containing the registry change:"
30391 #: ../tools/virt-win-reg.pl:656
30394 " cat > test.reg <<'EOF'\n"
30395 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30396 " \"Test\"=\"c:\\\\test.bat\"\n"
30402 #: ../tools/virt-win-reg.pl:661
30404 "In this example we use the key C<RunOnce> which means that the script will "
30405 "run precisely once when the first user logs in. If you want it to run every "
30406 "time a user logs in, replace C<RunOnce> with C<Run>."
30410 #: ../tools/virt-win-reg.pl:665
30411 msgid "Now update the registry:"
30415 #: ../tools/virt-win-reg.pl:667
30418 " virt-win-reg --merge WindowsGuest test.reg\n"
30423 #: ../tools/virt-win-reg.pl:669
30424 msgid "INSTALLING A SERVICE"
30428 #: ../tools/virt-win-reg.pl:671
30430 "This section assumes you are familiar with Windows services, and you either "
30431 "have a program which handles the Windows Service Control Protocol directly "
30432 "or you want to run any program using a service wrapper like SrvAny or the "
30437 #: ../tools/virt-win-reg.pl:676
30439 "First upload the program and optionally the service wrapper. In this case "
30440 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30444 #: ../tools/virt-win-reg.pl:680
30447 " guestfish -i -d WindowsGuest <<EOF\n"
30448 " upload rhsrvany.exe /rhsrvany.exe\n"
30449 " upload test.exe /test.exe\n"
30455 #: ../tools/virt-win-reg.pl:685
30457 "Prepare a regedit file containing the registry changes. In this example, "
30458 "the first registry change is needed for the service itself or the service "
30459 "wrapper (if used). The second registry change is only needed because I am "
30460 "using the RHSrvAny service wrapper."
30464 #: ../tools/virt-win-reg.pl:690
30467 " cat > service.reg <<'EOF'\n"
30468 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30469 " \"Type\"=dword:00000010\n"
30470 " \"Start\"=dword:00000002\n"
30471 " \"ErrorControl\"=dword:00000001\n"
30472 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30473 " \"DisplayName\"=\"RHSrvAny\"\n"
30474 " \"ObjectName\"=\"NetworkService\"\n"
30479 #: ../tools/virt-win-reg.pl:699
30482 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30483 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30484 " \"PWD\"=\"c:\\\\Temp\"\n"
30490 #: ../tools/virt-win-reg.pl:710
30492 "For use of C<ControlSet001> see the section above in this manual page. You "
30493 "may need to adjust this according to the control set that is in use by the "
30498 #: ../tools/virt-win-reg.pl:716
30500 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30501 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30502 "privileged account."
30506 #: ../tools/virt-win-reg.pl:722
30508 "For the meaning of the magic numbers, see this Microsoft KB article: "
30509 "L<http://support.microsoft.com/kb/103000>."
30513 #: ../tools/virt-win-reg.pl:727
30514 msgid "Update the registry:"
30518 #: ../tools/virt-win-reg.pl:729
30521 " virt-win-reg --merge WindowsGuest service.reg\n"
30526 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30527 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30528 #: ../tools/virt-list-partitions.pl:250
30529 msgid "SHELL QUOTING"
30533 #: ../tools/virt-win-reg.pl:733
30535 "Be careful when passing parameters containing C<\\> (backslash) in the "
30536 "shell. Usually you will have to use 'single quotes' or double backslashes "
30537 "(but not both) to protect them from the shell."
30541 #: ../tools/virt-win-reg.pl:737
30542 msgid "Paths and value names are case-insensitive."
30546 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30547 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30548 #: ../tools/virt-list-partitions.pl:252
30550 "Libvirt guest names can contain arbitrary characters, some of which have "
30551 "meaning to the shell such as C<#> and space. You may need to quote or "
30552 "escape these characters on the command line. See the shell manual page L<sh"
30553 "(1)> for details."
30557 #: ../tools/virt-win-reg.pl:746
30559 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30560 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30561 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30565 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30567 "When reporting bugs, please enable debugging and capture the I<complete> "
30572 #: ../tools/virt-win-reg.pl:764
30575 " export LIBGUESTFS_DEBUG=1\n"
30576 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30581 #: ../tools/virt-win-reg.pl:767
30583 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30588 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30589 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30590 #: ../tools/virt-list-partitions.pl:269
30595 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30596 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30597 #: ../tools/virt-list-partitions.pl:271
30598 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30602 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30603 msgid "Copyright (C) 2010 Red Hat Inc."
30607 #: ../tools/virt-list-filesystems.pl:32
30609 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30613 #: ../tools/virt-list-filesystems.pl:36
30616 " virt-list-filesystems [--options] domname\n"
30621 #: ../tools/virt-list-filesystems.pl:38
30624 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30629 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30631 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30636 #: ../tools/virt-list-filesystems.pl:45
30638 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30639 "are contained in a virtual machine or disk image."
30643 #: ../tools/virt-list-filesystems.pl:49
30645 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30646 "functionality. For more complex cases you should look at the L<guestfish(1)"
30651 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30652 msgid "B<-l> | B<--long>"
30656 #: ../tools/virt-list-filesystems.pl:108
30658 "With this option, C<virt-list-filesystems> displays the type of each "
30659 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30663 #: ../tools/virt-list-filesystems.pl:115
30664 msgid "B<-a> | B<--all>"
30668 #: ../tools/virt-list-filesystems.pl:117
30670 "Normally we only show mountable filesystems. If this option is given then "
30671 "swap devices are shown too."
30675 #: ../tools/virt-list-filesystems.pl:191
30677 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30678 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30679 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30683 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30684 msgid "Copyright (C) 2009 Red Hat Inc."
30688 #: ../tools/virt-tar.pl:33
30689 msgid "virt-tar - Extract or upload files to a virtual machine"
30693 #: ../tools/virt-tar.pl:37
30696 " virt-tar [--options] -x domname directory tarball\n"
30701 #: ../tools/virt-tar.pl:39
30704 " virt-tar [--options] -u domname tarball directory\n"
30709 #: ../tools/virt-tar.pl:41
30712 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30717 #: ../tools/virt-tar.pl:43
30720 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30725 #: ../tools/virt-tar.pl:47
30727 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30728 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30732 #: ../tools/virt-tar.pl:52
30733 msgid "Download C</home> from the VM into a local tarball:"
30737 #: ../tools/virt-tar.pl:54
30740 " virt-tar -x domname /home home.tar\n"
30745 #: ../tools/virt-tar.pl:56
30748 " virt-tar -zx domname /home home.tar.gz\n"
30753 #: ../tools/virt-tar.pl:58
30754 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30758 #: ../tools/virt-tar.pl:60
30761 " virt-tar -u domname uploadstuff.tar /tmp\n"
30766 #: ../tools/virt-tar.pl:62
30769 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30774 #: ../tools/virt-tar.pl:66
30776 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30777 "virtual machines. If you do this, you risk disk corruption in the VM. "
30778 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30782 #: ../tools/virt-tar.pl:71
30784 "You can use I<-x> (extract) on live virtual machines, but you might get "
30785 "inconsistent results or errors if there is filesystem activity inside the "
30786 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30787 "work, but the only way to guarantee consistent results is if the virtual "
30788 "machine is shut down."
30792 #: ../tools/virt-tar.pl:79
30794 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30795 "parts of a guest filesystem. There are many possibilities: making backups, "
30796 "uploading data files, snooping on guest activity, fixing or customizing "
30801 #: ../tools/virt-tar.pl:84
30803 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30804 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30805 "should look at the L<guestfish(1)> tool."
30809 #: ../tools/virt-tar.pl:88
30811 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30812 "its contents (recursively) from the virtual machine into a local tarball. "
30813 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30814 "virtual machine. You cannot use these two options together."
30818 #: ../tools/virt-tar.pl:94
30820 "In addition, you may need to use the I<-z> (gZip) option to enable "
30821 "compression. When uploading, you have to specify I<-z> if the upload file "
30822 "is compressed because virt-tar won't detect this on its own."
30826 #: ../tools/virt-tar.pl:98
30828 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30829 "example it cannot do PKZip files or bzip2 compression. If you want that "
30830 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30831 "the L<libguestfs(3)> API)."
30835 #: ../tools/virt-tar.pl:156
30836 msgid "B<-x> | B<--extract> | B<--download>"
30840 #: ../tools/virt-tar.pl:158
30841 msgid "B<-u> | B<--upload>"
30845 #: ../tools/virt-tar.pl:160
30847 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30852 #: ../tools/virt-tar.pl:163
30854 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30855 "Please read the L</WARNING> section above before using this option."
30859 #: ../tools/virt-tar.pl:167
30860 msgid "You must specify exactly one of these options."
30864 #: ../tools/virt-tar.pl:173
30865 msgid "B<-z> | B<--gzip>"
30869 #: ../tools/virt-tar.pl:175
30870 msgid "Specify that the input or output tarball is gzip-compressed."
30874 #: ../tools/virt-tar.pl:288
30876 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30877 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30878 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30883 #: ../tools/virt-make-fs.pl:37
30884 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30888 #: ../tools/virt-make-fs.pl:41
30891 " virt-make-fs [--options] input.tar output.img\n"
30896 #: ../tools/virt-make-fs.pl:43
30899 " virt-make-fs [--options] input.tar.gz output.img\n"
30904 #: ../tools/virt-make-fs.pl:45
30907 " virt-make-fs [--options] directory output.img\n"
30912 #: ../tools/virt-make-fs.pl:49
30914 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30915 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30916 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30917 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30918 "you want to attach these filesystems to existing virtual machines (eg. to "
30919 "import large amounts of read-only data to a VM)."
30923 #: ../tools/virt-make-fs.pl:57
30924 msgid "Basic usage is:"
30928 #: ../tools/virt-make-fs.pl:59
30931 " virt-make-fs input output\n"
30936 #: ../tools/virt-make-fs.pl:61
30938 "where C<input> is either a directory containing files that you want to add, "
30939 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30940 "C<output> is a disk image. The input type is detected automatically. The "
30941 "output disk image defaults to a raw ext2 image unless you specify extra "
30942 "flags (see L</OPTIONS> below)."
30946 #: ../tools/virt-make-fs.pl:67
30947 msgid "EXTRA SPACE"
30951 #: ../tools/virt-make-fs.pl:69
30953 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30954 "the files that it contains, but might have extra space. Depending on how "
30955 "you are going to use the output, you might think this extra space is wasted "
30956 "and want to minimize it, or you might want to leave space so that more files "
30957 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30958 "but you can use the I<--size> flag to leave space in the filesystem if you "
30963 #: ../tools/virt-make-fs.pl:77
30965 "An alternative way to leave extra space but not make the output image any "
30966 "bigger is to use an alternative disk image format (instead of the default "
30967 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30968 "image format (check your hypervisor supports this before using it). This "
30969 "allows you to choose a large I<--size> but the extra space won't actually be "
30970 "allocated in the image until you try to store something in it."
30974 #: ../tools/virt-make-fs.pl:85
30976 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30977 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30978 "to build another image from scratch."
30982 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30983 #: ../tools/virt-make-fs.pl:142
30988 #: ../tools/virt-make-fs.pl:91
30991 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30996 #: ../tools/virt-make-fs.pl:93
30997 msgid "FILESYSTEM TYPE"
31001 #: ../tools/virt-make-fs.pl:95
31003 "The default filesystem type is C<ext2>. Just about any filesystem type that "
31004 "libguestfs supports can be used (but I<not> read-only formats like "
31005 "ISO9660). Here are some of the more common choices:"
31009 #: ../tools/virt-make-fs.pl:101
31014 #: ../tools/virt-make-fs.pl:103
31016 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
31017 "you are not going to use the filesystem in a way that requires the journal, "
31018 "then this is just wasted overhead."
31022 #: ../tools/virt-make-fs.pl:107
31023 msgid "I<ntfs> or I<vfat>"
31027 #: ../tools/virt-make-fs.pl:109
31028 msgid "Useful if exporting data to a Windows guest."
31032 #: ../tools/virt-make-fs.pl:111
31034 "I<Note for vfat>: The tar archive or local directory must only contain files "
31035 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
31036 "program running within libguestfs is unable to change the ownership of non-"
31037 "root files, since vfat itself does not support this."
31041 #: ../tools/virt-make-fs.pl:116
31046 #: ../tools/virt-make-fs.pl:118
31048 "Lower overhead than C<ext2>, but certain limitations on filename length and "
31049 "total filesystem size."
31053 #: ../tools/virt-make-fs.pl:125
31056 " virt-make-fs --type=minix input minixfs.img\n"
31061 #: ../tools/virt-make-fs.pl:127
31062 msgid "TO PARTITION OR NOT TO PARTITION"
31066 #: ../tools/virt-make-fs.pl:129
31067 msgid "Optionally virt-make-fs can add a partition table to the output disk."
31071 #: ../tools/virt-make-fs.pl:131
31073 "Adding a partition can make the disk image more compatible with certain "
31074 "virtualized operating systems which don't expect to see a filesystem "
31075 "directly located on a block device (Linux doesn't care and will happily "
31076 "handle both types)."
31080 #: ../tools/virt-make-fs.pl:136
31082 "On the other hand, if you have a partition table then the output image is no "
31083 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
31084 "directly on a partitioned disk image. (However libguestfs tools such as "
31085 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
31089 #: ../tools/virt-make-fs.pl:144
31090 msgid "Add an MBR partition:"
31094 #: ../tools/virt-make-fs.pl:146
31097 " virt-make-fs --partition -- input disk.img\n"
31102 #: ../tools/virt-make-fs.pl:148
31104 "If the output disk image could be terabyte-sized or larger, it's better to "
31105 "use an EFI/GPT-compatible partition table:"
31109 #: ../tools/virt-make-fs.pl:151
31112 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
31117 #: ../tools/virt-make-fs.pl:179
31118 msgid "Enable debugging information."
31122 #: ../tools/virt-make-fs.pl:185
31123 msgid "B<--size=E<lt>NE<gt>>"
31127 #: ../tools/virt-make-fs.pl:187
31128 msgid "B<--size=+E<lt>NE<gt>>"
31132 #: ../tools/virt-make-fs.pl:189
31133 msgid "B<-s E<lt>NE<gt>>"
31137 #: ../tools/virt-make-fs.pl:191
31138 msgid "B<-s +E<lt>NE<gt>>"
31142 #: ../tools/virt-make-fs.pl:193
31144 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
31148 #: ../tools/virt-make-fs.pl:196
31150 "If this option is I<not> given, then the output image will be just large "
31151 "enough to contain all the files, with not much wasted space."
31155 #: ../tools/virt-make-fs.pl:199
31157 "To choose a fixed size output disk, specify an absolute number followed by b/"
31158 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31159 "Petabytes or Exabytes. This must be large enough to contain all the input "
31160 "files, else you will get an error."
31164 #: ../tools/virt-make-fs.pl:204
31166 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
31167 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31168 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
31169 "the input files, and (approximately) an extra 200 MB free space."
31173 #: ../tools/virt-make-fs.pl:210
31175 "Note that virt-make-fs estimates free space, and therefore will not produce "
31176 "filesystems containing precisely the free space requested. (It is much more "
31177 "expensive and time-consuming to produce a filesystem which has precisely the "
31178 "desired free space)."
31182 #: ../tools/virt-make-fs.pl:219
31183 msgid "B<--format=E<lt>fmtE<gt>>"
31187 #: ../tools/virt-make-fs.pl:221
31188 msgid "B<-F E<lt>fmtE<gt>>"
31192 #: ../tools/virt-make-fs.pl:223
31193 msgid "Choose the output disk image format."
31197 #: ../tools/virt-make-fs.pl:225
31198 msgid "The default is C<raw> (raw disk image)."
31202 #: ../tools/virt-make-fs.pl:227
31204 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31205 "that would really make sense here is C<qcow2>."
31209 #: ../tools/virt-make-fs.pl:234
31210 msgid "B<--type=E<lt>fsE<gt>>"
31214 #: ../tools/virt-make-fs.pl:236
31215 msgid "B<-t E<lt>fsE<gt>>"
31219 #: ../tools/virt-make-fs.pl:238
31220 msgid "Choose the output filesystem type."
31224 #: ../tools/virt-make-fs.pl:240
31225 msgid "The default is C<ext2>."
31229 #: ../tools/virt-make-fs.pl:242
31231 "Any filesystem which is supported read-write by libguestfs can be used here."
31235 #: ../tools/virt-make-fs.pl:249
31236 msgid "B<--partition>"
31240 #: ../tools/virt-make-fs.pl:251
31241 msgid "B<--partition=E<lt>parttypeE<gt>>"
31245 #: ../tools/virt-make-fs.pl:253
31247 "If specified, this flag adds an MBR partition table to the output disk image."
31251 #: ../tools/virt-make-fs.pl:256
31253 "You can change the partition table type, eg. I<--partition=gpt> for large "
31258 #: ../tools/virt-make-fs.pl:259
31260 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
31261 "might consider the next parameter to be the partition type. For example:"
31265 #: ../tools/virt-make-fs.pl:263
31268 " virt-make-fs --partition input.tar ...\n"
31273 #: ../tools/virt-make-fs.pl:265
31275 "would cause virt-make-fs to think you wanted to use a partition type of "
31276 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
31277 "dash) between options and the input file argument:"
31281 #: ../tools/virt-make-fs.pl:269
31284 " virt-make-fs --partition -- input.tar ...\n"
31289 #: ../tools/virt-make-fs.pl:541
31291 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31292 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
31293 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31297 #: ../tools/virt-make-fs.pl:558
31300 " export LIBGUESTFS_DEBUG=1\n"
31301 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31306 #: ../tools/virt-make-fs.pl:561
31308 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
31313 #: ../tools/virt-list-partitions.pl:32
31315 "virt-list-partitions - List partitions in a virtual machine or disk image"
31319 #: ../tools/virt-list-partitions.pl:36
31322 " virt-list-partitions [--options] domname\n"
31327 #: ../tools/virt-list-partitions.pl:38
31330 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31335 #: ../tools/virt-list-partitions.pl:45
31337 "C<virt-list-partitions> is a command line tool to list the partitions that "
31338 "are contained in a virtual machine or disk image. It is mainly useful as a "
31339 "first step to using L<virt-resize(1)>."
31343 #: ../tools/virt-list-partitions.pl:50
31345 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31346 "functionality. For more complex cases you should look at the L<guestfish(1)"
31351 #: ../tools/virt-list-partitions.pl:107
31352 msgid "B<-h> | B<--human-readable>"
31356 #: ../tools/virt-list-partitions.pl:109
31357 msgid "Show sizes in human-readable form (eg. \"1G\")."
31361 #: ../tools/virt-list-partitions.pl:117
31363 "With this option, C<virt-list-partitions> displays the type and size of each "
31364 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31368 #: ../tools/virt-list-partitions.pl:124
31369 msgid "B<-t> | B<--total>"
31373 #: ../tools/virt-list-partitions.pl:126
31375 "Display the total size of each block device (as a separate row or rows)."
31379 #: ../tools/virt-list-partitions.pl:259
31381 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31382 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31383 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31387 #: ../tools/virt-list-partitions.pl:275
31388 msgid "Copyright (C) 2009-2010 Red Hat Inc."