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-06-13 15:24+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
25 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31
26 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
34 "guestfs — бібліотека для доступу та внесення змін до образів віртуальних "
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35
42 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
44 msgstr "КОРОТКИЙ ОПИС"
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
53 " #include <guestfs.h>\n"
57 #: ../src/guestfs.pod:11
60 " guestfs_h *g = guestfs_create ();\n"
61 " guestfs_add_drive (g, \"guest.img\");\n"
62 " guestfs_launch (g);\n"
63 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
64 " guestfs_touch (g, \"/hello\");\n"
65 " guestfs_umount (g, \"/\");\n"
66 " guestfs_close (g);\n"
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_close (g);\n"
79 #: ../src/guestfs.pod:19
82 " cc prog.c -o prog -lguestfs\n"
84 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
87 " cc prog.c -o prog -lguestfs\n"
89 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
93 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
94 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
95 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
96 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77
97 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:25
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:33
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:38
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:43
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:48
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:51
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:54
155 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
165 #: ../src/guestfs.pod:59
167 "This section provides a gentler overview of the libguestfs API. We also try "
168 "to group API calls together, where that may not be obvious from reading "
169 "about the individual calls in the main section of this manual."
173 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
188 #: ../src/guestfs.pod:73
189 msgid "The general structure of all libguestfs-using programs looks like this:"
193 #: ../src/guestfs.pod:76
196 " guestfs_h *g = guestfs_create ();\n"
199 " guestfs_h *g = guestfs_create ();\n"
203 #: ../src/guestfs.pod:78
206 " /* Call guestfs_add_drive additional times if there are\n"
207 " * multiple disk images.\n"
209 " guestfs_add_drive (g, \"guest.img\");\n"
214 #: ../src/guestfs.pod:83
217 " /* Most manipulation calls won't work until you've launched\n"
218 " * the handle 'g'. You have to do this _after_ adding drives\n"
219 " * and _before_ other commands.\n"
221 " guestfs_launch (g);\n"
226 #: ../src/guestfs.pod:89
229 " /* Now you can examine what partitions, LVs etc are available.\n"
231 " char **partitions = guestfs_list_partitions (g);\n"
232 " char **logvols = guestfs_lvs (g);\n"
237 #: ../src/guestfs.pod:94
240 " /* To access a filesystem in the image, you must mount it.\n"
242 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
245 " /* Щоб отримати доступ до файлової системи на образі, вам слід його змонтувати.\n"
247 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 #| " /* Now you can perform filesystem actions on the guest\n"
255 #| " * disk image.\n"
257 #| " guestfs_touch (g, \"/hello\");\n"
260 " /* Now you can perform filesystem actions on the guest\n"
263 " guestfs_touch (g, \"/hello\");\n"
266 " /* Тепер ви можете виконувати дії з файловою системою на\n"
267 " * образі диска операційної системи.\n"
269 " guestfs_touch (g, \"/hello\");\n"
273 #: ../src/guestfs.pod:103
276 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
277 " * it is done automatically when you close the handle. See\n"
278 " * discussion of autosync in this page.\n"
280 " guestfs_sync (g);\n"
285 #: ../src/guestfs.pod:109
288 " /* Close the handle 'g'. */\n"
289 " guestfs_close (g);\n"
294 #: ../src/guestfs.pod:112
296 "The code above doesn't include any error checking. In real code you should "
297 "check return values carefully for errors. In general all functions that "
298 "return integers return C<-1> on error, and all functions that return "
299 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
300 "how to handle errors, and consult the documentation for each function call "
301 "below to see precisely how they return error indications. See L<guestfs-"
302 "examples(3)> for fully worked examples."
306 #: ../src/guestfs.pod:121
311 #: ../src/guestfs.pod:123
313 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
314 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
315 "actual block device, or simply an empty file of zeroes that you have created "
316 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
321 #: ../src/guestfs.pod:129
323 "The call you should use in modern code for adding drives is L</"
324 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
325 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
344 #: ../src/guestfs.pod:139
347 " guestfs_add_drive_opts (g, filename,\n"
348 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
349 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
355 #: ../src/guestfs.pod:144
357 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
358 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
370 #: ../src/guestfs.pod:151
372 "You must add at least one disk image, and you may add multiple disk images. "
373 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
374 "first one you added), C</dev/sdb> (for the second one you added), etc."
378 #: ../src/guestfs.pod:156
380 "Once L</guestfs_launch> has been called you cannot add any more images. You "
381 "can call L</guestfs_list_devices> to get a list of the device names, in the "
382 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
386 #: ../src/guestfs.pod:161
391 #: ../src/guestfs.pod:163
393 "Before you can read or write files, create directories and so on in a disk "
394 "image that contains filesystems, you have to mount those filesystems using "
395 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
396 "a disk image contains (for example) one partition with a filesystem on that "
397 "partition, then you can mount it directly:"
401 #: ../src/guestfs.pod:170
404 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
409 #: ../src/guestfs.pod:172
411 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
412 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
413 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
414 "that these are libguestfs virtual devices, and are nothing to do with host "
419 #: ../src/guestfs.pod:178
421 "If you are given a disk image and you don't know what it contains then you "
422 "have to find out. Libguestfs can do that too: use L</"
423 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
424 "LVs, and either try mounting each to see what is mountable, or else examine "
425 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
426 "filesystems, use L</guestfs_list_filesystems>."
430 #: ../src/guestfs.pod:186
432 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
433 "L</INSPECTION> below). But you might find it easier to look at higher level "
434 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
438 #: ../src/guestfs.pod:191
440 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
441 "several other variations of the C<guestfs_mount_*> call."
445 #: ../src/guestfs.pod:194
446 msgid "FILESYSTEM ACCESS AND MODIFICATION"
450 #: ../src/guestfs.pod:196
452 "The majority of the libguestfs API consists of fairly low-level calls for "
453 "accessing and modifying the files, directories, symlinks etc on mounted "
454 "filesystems. There are over a hundred such calls which you can find listed "
455 "in detail below in this man page, and we don't even pretend to cover them "
456 "all in this overview."
460 #: ../src/guestfs.pod:202
462 "Specify filenames as full paths, starting with C<\"/\"> and including the "
467 #: ../src/guestfs.pod:205
469 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
470 "the file called C<\"etc/passwd\"> then you could do:"
474 #: ../src/guestfs.pod:208
477 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
482 #: ../src/guestfs.pod:210
484 "This would return C<data> as a newly allocated buffer containing the full "
485 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
486 "or C<NULL> if there was an error."
490 #: ../src/guestfs.pod:214
492 "As another example, to create a top-level directory on that filesystem "
493 "called C<\"var\"> you would do:"
497 #: ../src/guestfs.pod:217
500 " guestfs_mkdir (g, \"/var\");\n"
505 #: ../src/guestfs.pod:219
506 msgid "To create a symlink you could do:"
510 #: ../src/guestfs.pod:221
513 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
514 " \"/etc/rc3.d/S30portmap\");\n"
519 #: ../src/guestfs.pod:224
521 "Libguestfs will reject attempts to use relative paths and there is no "
522 "concept of a current working directory."
526 #: ../src/guestfs.pod:227
528 "Libguestfs can return errors in many situations: for example if the "
529 "filesystem isn't writable, or if a file or directory that you requested "
530 "doesn't exist. If you are using the C API (documented here) you have to "
531 "check for those error conditions after each call. (Other language bindings "
532 "turn these errors into exceptions)."
536 #: ../src/guestfs.pod:233
538 "File writes are affected by the per-handle umask, set by calling L</"
539 "guestfs_umask> and defaulting to 022. See L</UMASK>."
543 #: ../src/guestfs.pod:236
545 msgstr "ПОДІЛ НА РОЗДІЛИ"
548 #: ../src/guestfs.pod:238
550 "Libguestfs contains API calls to read, create and modify partition tables on "
555 #: ../src/guestfs.pod:241
557 "In the common case where you want to create a single partition covering the "
558 "whole disk, you should use the L</guestfs_part_disk> call:"
562 #: ../src/guestfs.pod:245
565 " const char *parttype = \"mbr\";\n"
566 " if (disk_is_larger_than_2TB)\n"
567 " parttype = \"gpt\";\n"
568 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
573 #: ../src/guestfs.pod:250
575 "Obviously this effectively wipes anything that was on that disk image before."
579 #: ../src/guestfs.pod:253
584 #: ../src/guestfs.pod:255
586 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
587 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
588 "you familiarize yourself with the concepts of physical volumes, volume "
589 "groups and logical volumes."
593 #: ../src/guestfs.pod:260
595 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
596 "tldp.org/HOWTO/LVM-HOWTO/>."
600 #: ../src/guestfs.pod:263
605 #: ../src/guestfs.pod:265
607 "Use L</guestfs_cat> to download small, text only files. This call is "
608 "limited to files which are less than 2 MB and which cannot contain any ASCII "
609 "NUL (C<\\0>) characters. However the API is very simple to use."
613 #: ../src/guestfs.pod:269
615 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
616 "bit data, since it returns a (pointer, size) pair. However it is still "
617 "limited to \"small\" files, less than 2 MB."
621 #: ../src/guestfs.pod:273
623 "L</guestfs_download> can be used to download any file, with no limits on "
624 "content or size (even files larger than 4 GB)."
628 #: ../src/guestfs.pod:276
630 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
634 #: ../src/guestfs.pod:279
636 msgstr "ВИВАНТАЖЕННЯ"
639 #: ../src/guestfs.pod:281
641 "It's often the case that you want to write a file or files to the disk image."
645 #: ../src/guestfs.pod:284
647 "To write a small file with fixed content, use L</guestfs_write>. To create "
648 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
649 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
650 "of other functions for creating test files, for example L</guestfs_fill> and "
651 "L</guestfs_fill_pattern>."
655 #: ../src/guestfs.pod:290
657 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
658 "file content or size (even files larger than 4 GB)."
662 #: ../src/guestfs.pod:293
664 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
668 #: ../src/guestfs.pod:295
670 "However the fastest way to upload I<large numbers of arbitrary files> is to "
671 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
672 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
673 "in a predictable way (eg. adding it last after all other drives) then you "
674 "can get the device name from L</guestfs_list_devices> and mount it directly "
675 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
676 "portable between kernel versions, and they don't support labels or UUIDs. "
677 "If you want to pre-build an image or you need to mount it using a label or "
678 "UUID, use an ISO image instead."
682 #: ../src/guestfs.pod:306
687 #: ../src/guestfs.pod:308
689 "There are various different commands for copying between files and devices "
690 "and in and out of the guest filesystem. These are summarised in the table "
695 #: ../src/guestfs.pod:314
696 msgid "B<file> to B<file>"
700 #: ../src/guestfs.pod:316
702 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
703 "directories recursively."
707 #: ../src/guestfs.pod:319
708 msgid "B<file or device> to B<file or device>"
712 #: ../src/guestfs.pod:321
714 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
715 "devices in the guest."
719 #: ../src/guestfs.pod:324
720 msgid "Example: duplicate the contents of an LV:"
724 #: ../src/guestfs.pod:326
727 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
732 #: ../src/guestfs.pod:328
734 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
735 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
736 "guestfs_copy_size>."
740 #: ../src/guestfs.pod:332
741 msgid "B<file on the host> to B<file or device>"
745 #: ../src/guestfs.pod:334
746 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
750 #: ../src/guestfs.pod:336
751 msgid "B<file or device> to B<file on the host>"
755 #: ../src/guestfs.pod:338
756 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
760 #: ../src/guestfs.pod:342
761 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
765 #: ../src/guestfs.pod:344
767 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
768 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
769 "appears you can only upload and download to files. However many Un*x-like "
770 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
771 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
772 "and arbitrary file descriptor N."
776 #: ../src/guestfs.pod:352
777 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
781 #: ../src/guestfs.pod:355
784 " guestfs_download (g, filename, \"/dev/stdout\");\n"
789 #: ../src/guestfs.pod:357
790 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
794 #: ../src/guestfs.pod:359
798 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
799 " guestfs_tar_out (g, \"/\", devfd);\n"
804 #: ../src/guestfs.pod:363
805 msgid "LISTING FILES"
809 #: ../src/guestfs.pod:365
811 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
812 "L<guestfish(1)>-equivalent command C<ll>)."
816 #: ../src/guestfs.pod:368
818 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
819 "programs, as a flat list of strings."
823 #: ../src/guestfs.pod:371
825 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
826 "directory, plus additional information about each one. It is more "
827 "equivalent to using the L<readdir(3)> call on a local filesystem."
831 #: ../src/guestfs.pod:375
833 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
837 #: ../src/guestfs.pod:378
838 msgid "RUNNING COMMANDS"
842 #: ../src/guestfs.pod:380
844 "Although libguestfs is primarily an API for manipulating files inside guest "
845 "images, we also provide some limited facilities for running commands inside "
850 #: ../src/guestfs.pod:384
851 msgid "There are many limitations to this:"
855 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
856 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
857 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
858 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
859 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
860 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
861 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
862 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
863 #: ../src/guestfs.pod:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762
864 #: ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
865 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380
866 #: ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397
867 #: ../src/guestfs.pod:2962 ../src/guestfs.pod:2966 ../src/guestfs.pod:2970
868 #: ../src/guestfs.pod:2974 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
870 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
871 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1597
872 #: ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1605
873 #: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1617
874 #: ../src/guestfs-actions.pod:1621 ../src/guestfs-actions.pod:1625
875 #: ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1639
876 #: ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1781
877 #: ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1790
878 #: ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1856
879 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865
880 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
881 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
884 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
885 #: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073
886 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081
887 #: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093
888 #: ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1107
889 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1115
890 #: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1209
891 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
892 #: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1265
893 #: ../fish/guestfish-actions.pod:1270 ../tools/virt-edit.pl:351
894 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
895 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
896 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
897 #: ../tools/virt-win-reg.pl:548
902 #: ../src/guestfs.pod:390
904 "The kernel version that the command runs under will be different from what "
909 #: ../src/guestfs.pod:395
911 "If the command needs to communicate with daemons, then most likely they "
916 #: ../src/guestfs.pod:400
917 msgid "The command will be running in limited memory."
921 #: ../src/guestfs.pod:404
923 "The network may not be available unless you enable it (see L</"
924 "guestfs_set_network>)."
928 #: ../src/guestfs.pod:409
929 msgid "Only supports Linux guests (not Windows, BSD, etc)."
933 #: ../src/guestfs.pod:413
935 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
939 #: ../src/guestfs.pod:418
941 "For SELinux guests, you may need to enable SELinux and load policy first. "
942 "See L</SELINUX> in this manpage."
946 #: ../src/guestfs.pod:423
948 "I<Security:> It is not safe to run commands from untrusted, possibly "
949 "malicious guests. These commands may attempt to exploit your program by "
950 "sending unexpected output. They could also try to exploit the Linux kernel "
951 "or qemu provided by the libguestfs appliance. They could use the network "
952 "provided by the libguestfs appliance to bypass ordinary network partitions "
953 "and firewalls. They could use the elevated privileges or different SELinux "
954 "context of your program to their advantage."
958 #: ../src/guestfs.pod:432
960 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
961 "(a script which runs when the guest next boots normally), and to have this "
962 "script run the commands you want in the normal context of the running guest, "
963 "network security and so on. For information about other security issues, "
968 #: ../src/guestfs.pod:440
970 "The two main API calls to run commands are L</guestfs_command> and L</"
971 "guestfs_sh> (there are also variations)."
975 #: ../src/guestfs.pod:443
977 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
978 "shell globs, redirections, etc will work."
982 #: ../src/guestfs.pod:446
983 msgid "CONFIGURATION FILES"
984 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
987 #: ../src/guestfs.pod:448
989 "To read and write configuration files in Linux guest filesystems, we "
990 "strongly recommend using Augeas. For example, Augeas understands how to "
991 "read and write, say, a Linux shadow password file or X.org configuration "
992 "file, and so avoids you having to write that code."
996 #: ../src/guestfs.pod:453
998 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
999 "document Augeas itself here because there is excellent documentation on the "
1000 "L<http://augeas.net/> website."
1004 #: ../src/guestfs.pod:457
1006 "If you don't want to use Augeas (you fool!) then try calling L</"
1007 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1012 #: ../src/guestfs.pod:461
1017 #: ../src/guestfs.pod:463
1019 "We support SELinux guests. To ensure that labeling happens correctly in "
1020 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1024 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1025 #: ../src/guestfs.pod:2425
1030 #: ../src/guestfs.pod:471
1031 msgid "Before launching, do:"
1035 #: ../src/guestfs.pod:473
1038 " guestfs_set_selinux (g, 1);\n"
1043 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1044 #: ../src/guestfs.pod:2450
1049 #: ../src/guestfs.pod:477
1051 "After mounting the guest's filesystem(s), load the policy. This is best "
1052 "done by running the L<load_policy(8)> command in the guest itself:"
1056 #: ../src/guestfs.pod:481
1059 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1064 #: ../src/guestfs.pod:483
1066 "(Older versions of C<load_policy> require you to specify the name of the "
1071 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1076 #: ../src/guestfs.pod:488
1078 "Optionally, set the security context for the API. The correct security "
1079 "context to use can only be known by inspecting the guest. As an example:"
1083 #: ../src/guestfs.pod:492
1086 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1091 #: ../src/guestfs.pod:496
1092 msgid "This will work for running commands and editing existing files."
1096 #: ../src/guestfs.pod:498
1098 "When new files are created, you may need to label them explicitly, for "
1099 "example by running the external command C<restorecon pathname>."
1103 #: ../src/guestfs.pod:502
1108 #: ../src/guestfs.pod:504
1110 "Certain calls are affected by the current file mode creation mask (the "
1111 "\"umask\"). In particular ones which create files or directories, such as "
1112 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1113 "either the default mode that the file is created with or modifies the mode "
1118 #: ../src/guestfs.pod:510
1120 "The default umask is C<022>, so files are created with modes such as C<0644> "
1121 "and directories with C<0755>."
1125 #: ../src/guestfs.pod:513
1127 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1128 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1129 "guestfs_chmod> after creating each file or directory."
1133 #: ../src/guestfs.pod:517
1134 msgid "For more information about umask, see L<umask(2)>."
1138 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1139 msgid "ENCRYPTED DISKS"
1143 #: ../src/guestfs.pod:521
1145 "Libguestfs allows you to access Linux guests which have been encrypted using "
1146 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1147 "standard. This includes nearly all whole disk encryption systems used by "
1148 "modern Linux guests."
1152 #: ../src/guestfs.pod:527
1154 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1155 "returns the string C<crypto_LUKS>)."
1159 #: ../src/guestfs.pod:530
1161 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1162 "will require the passphrase!"
1166 #: ../src/guestfs.pod:533
1168 "Opening a LUKS device creates a new device mapper device called C</dev/"
1169 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1170 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1171 "from and encrypted to the underlying block device respectively."
1175 #: ../src/guestfs.pod:539
1177 "LVM volume groups on the device can be made visible by calling L</"
1178 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1179 "(s) can now be mounted in the usual way."
1183 #: ../src/guestfs.pod:543
1185 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1186 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1187 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1188 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1189 "underlying encrypted block device)."
1193 #: ../src/guestfs.pod:550
1198 #: ../src/guestfs.pod:552
1200 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1201 "contains operating systems, an install CD or a live CD. (These APIs used to "
1202 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1203 "version 1.5.3 the most frequently used part of this library has been "
1204 "rewritten in C and moved into the core code)."
1208 #: ../src/guestfs.pod:559
1210 "Add all disks belonging to the unknown virtual machine and call L</"
1211 "guestfs_launch> in the usual way."
1215 #: ../src/guestfs.pod:562
1217 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1218 "and certain heuristics, and returns a list of operating systems that were "
1219 "found. An empty list means none were found. A single element is the root "
1220 "filesystem of the operating system. For dual- or multi-boot guests, "
1221 "multiple roots can be returned, each one corresponding to a separate "
1222 "operating system. (Multi-boot virtual machines are extremely rare in the "
1223 "world of virtualization, but since this scenario can happen, we have built "
1224 "libguestfs to deal with it.)"
1228 #: ../src/guestfs.pod:571
1230 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1231 "to get additional details about that operating system. For example, call L</"
1232 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1233 "Windows and Linux-based operating systems respectively."
1237 #: ../src/guestfs.pod:577
1239 "Un*x-like and Linux-based operating systems usually consist of several "
1240 "filesystems which are mounted at boot time (for example, a separate boot "
1241 "partition mounted on C</boot>). The inspection rules are able to detect how "
1242 "filesystems correspond to mount points. Call "
1243 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1244 "hash table like this example:"
1248 #: ../src/guestfs.pod:584
1251 " /boot => /dev/sda1\n"
1252 " / => /dev/vg_guest/lv_root\n"
1253 " /usr => /dev/vg_guest/lv_usr\n"
1258 #: ../src/guestfs.pod:588
1260 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1261 "filesystems as suggested."
1265 #: ../src/guestfs.pod:591
1267 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1268 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1272 #: ../src/guestfs.pod:595
1274 "Inspection currently only works for some common operating systems. "
1275 "Contributors are welcome to send patches for other operating systems that we "
1276 "currently cannot detect."
1280 #: ../src/guestfs.pod:599
1282 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1283 "for more details. The L</guestfs_inspect_os> function just ignores any "
1284 "encrypted devices."
1288 #: ../src/guestfs.pod:603
1290 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1291 "inspection and caches the results in the guest handle. Subsequent calls to "
1292 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1293 "read the disks. If you change the content of the guest disks, you can redo "
1294 "inspection by calling L</guestfs_inspect_os> again. (L</"
1295 "guestfs_inspect_list_applications> works a little differently from the other "
1296 "calls and does read the disks. See documentation for that function for "
1301 #: ../src/guestfs.pod:612
1302 msgid "INSPECTING INSTALL DISKS"
1306 #: ../src/guestfs.pod:614
1308 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1313 #: ../src/guestfs.pod:617
1315 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1316 "system, which currently can be C<installed> (a regular operating system) or "
1317 "C<installer> (some sort of install disk)."
1321 #: ../src/guestfs.pod:621
1323 "Further information is available about the operating system that can be "
1324 "installed using the regular inspection APIs like L</"
1325 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1329 #: ../src/guestfs.pod:626
1331 "Some additional information specific to installer disks is also available "
1332 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1333 "guestfs_inspect_is_multipart> calls."
1337 #: ../src/guestfs.pod:631
1338 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1342 #: ../src/guestfs.pod:633
1344 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1345 "ntfs-3g.org/> driver."
1349 #: ../src/guestfs.pod:636
1350 msgid "DRIVE LETTERS AND PATHS"
1354 #: ../src/guestfs.pod:638
1356 "DOS and Windows still use drive letters, and the filesystems are always "
1357 "treated as case insensitive by Windows itself, and therefore you might find "
1358 "a Windows configuration file referring to a path like C<c:\\windows"
1359 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1360 "might be referred to as C</WINDOWS/System32>."
1364 #: ../src/guestfs.pod:644
1366 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1367 "L</guestfs_inspect_get_drive_mappings>)"
1371 #: ../src/guestfs.pod:647
1373 "Dealing with separator characters (backslash vs forward slash) is outside "
1374 "the scope of libguestfs, but usually a simple character replacement will "
1379 #: ../src/guestfs.pod:651
1381 "To resolve the case insensitivity of paths, call L</"
1382 "guestfs_case_sensitive_path>."
1386 #: ../src/guestfs.pod:654
1387 msgid "ACCESSING THE WINDOWS REGISTRY"
1391 #: ../src/guestfs.pod:656
1393 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1394 "files, through the library C<hivex> which is part of the libguestfs project "
1395 "although ships as a separate tarball. You have to locate and download the "
1396 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1397 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1398 "reg(1)> for more help on this issue."
1402 #: ../src/guestfs.pod:664
1403 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1407 #: ../src/guestfs.pod:666
1409 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1410 "provide something which looks like a Linux symlink. The way it tries to do "
1411 "the rewriting is described here:"
1415 #: ../src/guestfs.pod:670
1417 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 #: ../src/guestfs.pod:672
1426 "The essential problem is that ntfs-3g simply does not have enough "
1427 "information to do a correct job. NTFS links can contain drive letters and "
1428 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1429 "It is almost certainly the case that libguestfs callers should ignore what "
1430 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1434 #: ../src/guestfs.pod:679
1436 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1437 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1438 "attribute, and read the raw reparse data from that (you can find the format "
1439 "documented in various places around the web)."
1443 #: ../src/guestfs.pod:684
1444 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1448 #: ../src/guestfs.pod:686
1450 "There are other useful extended attributes that can be read from ntfs-3g "
1451 "filesystems (using L</guestfs_getxattr>). See:"
1455 #: ../src/guestfs.pod:689
1457 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1459 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 #: ../src/guestfs.pod:691
1463 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1467 #: ../src/guestfs.pod:693
1469 "Although we don't want to discourage you from using the C API, we will "
1470 "mention here that the same API is also available in other languages."
1474 #: ../src/guestfs.pod:696
1476 "The API is broadly identical in all supported languages. This means that "
1477 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1478 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1479 "OCaml. In other words, a straightforward, predictable isomorphism between "
1484 #: ../src/guestfs.pod:702
1486 "Error messages are automatically transformed into exceptions if the language "
1491 #: ../src/guestfs.pod:705
1493 "We don't try to \"object orientify\" parts of the API in OO languages, "
1494 "although contributors are welcome to write higher level APIs above what we "
1495 "provide in their favourite languages if they wish."
1499 #: ../src/guestfs.pod:711
1504 #: ../src/guestfs.pod:713
1506 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1507 "identical to the C API. C++ classes and exceptions are not used."
1511 #: ../src/guestfs.pod:717
1516 #: ../src/guestfs.pod:719
1518 "The C# bindings are highly experimental. Please read the warnings at the "
1519 "top of C<csharp/Libguestfs.cs>."
1523 #: ../src/guestfs.pod:722
1528 #: ../src/guestfs.pod:724
1530 "This is the only language binding that is working but incomplete. Only "
1531 "calls which return simple integers have been bound in Haskell, and we are "
1532 "looking for help to complete this binding."
1536 #: ../src/guestfs.pod:728
1541 #: ../src/guestfs.pod:730
1543 "Full documentation is contained in the Javadoc which is distributed with "
1548 #: ../src/guestfs.pod:733
1553 #: ../src/guestfs.pod:735
1554 msgid "See L<guestfs-ocaml(3)>."
1555 msgstr "Див. L<guestfs-ocaml(3)>."
1558 #: ../src/guestfs.pod:737
1563 #: ../src/guestfs.pod:739
1564 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1565 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1568 #: ../src/guestfs.pod:741
1573 #: ../src/guestfs.pod:743
1575 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1576 "the php-libguestfs package for your distribution."
1580 #: ../src/guestfs.pod:746
1581 msgid "The PHP binding only works correctly on 64 bit machines."
1585 #: ../src/guestfs.pod:748
1590 #: ../src/guestfs.pod:750
1591 msgid "See L<guestfs-python(3)>."
1592 msgstr "Див. L<guestfs-python(3)>."
1595 #: ../src/guestfs.pod:752
1600 #: ../src/guestfs.pod:754
1601 msgid "See L<guestfs-ruby(3)>."
1602 msgstr "Див. L<guestfs-ruby(3)>."
1605 #: ../src/guestfs.pod:756
1606 msgid "B<shell scripts>"
1607 msgstr "B<скрипти оболонки>"
1610 #: ../src/guestfs.pod:758
1611 msgid "See L<guestfish(1)>."
1612 msgstr "Див. L<guestfish(1)>."
1615 #: ../src/guestfs.pod:762
1616 msgid "LIBGUESTFS GOTCHAS"
1620 #: ../src/guestfs.pod:764
1622 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1623 "system [...] that works in the way it is documented but is counterintuitive "
1624 "and almost invites mistakes.\""
1628 #: ../src/guestfs.pod:768
1630 "Since we developed libguestfs and the associated tools, there are several "
1631 "things we would have designed differently, but are now stuck with for "
1632 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1633 "release, you can expect these to change. Beware of them."
1637 #: ../src/guestfs.pod:776
1638 msgid "Autosync / forgetting to sync."
1642 #: ../src/guestfs.pod:778
1644 "I<Update:> Autosync is enabled by default for all API users starting from "
1645 "libguestfs 1.5.24. This section only applies to older versions."
1649 #: ../src/guestfs.pod:781
1651 "When modifying a filesystem from C or another language, you B<must> unmount "
1652 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1653 "libguestfs handle. You can also call:"
1657 #: ../src/guestfs.pod:785
1660 " guestfs_set_autosync (g, 1);\n"
1665 #: ../src/guestfs.pod:787
1667 "to have the unmount/sync done automatically for you when the handle 'g' is "
1668 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1672 #: ../src/guestfs.pod:791
1674 "If you forget to do this, then it is entirely possible that your changes "
1675 "won't be written out, or will be partially written, or (very rarely) that "
1676 "you'll get disk corruption."
1680 #: ../src/guestfs.pod:795
1682 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1683 "guestfish scripts that forget to sync will work just fine, which can make "
1684 "this very puzzling if you are trying to debug a problem."
1688 #: ../src/guestfs.pod:799
1689 msgid "Mount option C<-o sync> should not be the default."
1693 #: ../src/guestfs.pod:801
1695 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1696 "However C<-o sync> does not add any reliability benefit, but does have a "
1697 "very large performance impact."
1701 #: ../src/guestfs.pod:805
1703 "The work around is to use L</guestfs_mount_options> and set the mount "
1704 "options that you actually want to use."
1708 #: ../src/guestfs.pod:808
1709 msgid "Read-only should be the default."
1713 #: ../src/guestfs.pod:810
1715 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1716 "specify I<--rw> if you want to make changes to the image."
1720 #: ../src/guestfs.pod:813
1721 msgid "This would reduce the potential to corrupt live VM images."
1725 #: ../src/guestfs.pod:815
1727 "Note that many filesystems change the disk when you just mount and unmount, "
1728 "even if you didn't perform any writes. You need to use L</"
1729 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1733 #: ../src/guestfs.pod:819
1734 msgid "guestfish command line is hard to use."
1738 #: ../src/guestfs.pod:821
1740 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1741 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1742 "exist, so it fails. In earlier versions of guestfish the error message was "
1743 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1744 "we should have used C<guestfish -c command> to run commands."
1748 #: ../src/guestfs.pod:828
1749 msgid "guestfish megabyte modifiers don't work right on all commands"
1753 #: ../src/guestfs.pod:830
1755 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1756 "other modifiers). What guestfish actually does is to multiply the number "
1757 "part by the modifier part and pass the result to the C API. However this "
1758 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1759 "expecting some other unit (eg. megabytes)."
1763 #: ../src/guestfs.pod:837
1764 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1768 #: ../src/guestfs.pod:839
1771 " lvcreate LV VG 100M\n"
1776 #: ../src/guestfs.pod:841
1778 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1779 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1780 "megabytes * megabytes) logical volume. The error message you get from this "
1781 "is also a little obscure."
1785 #: ../src/guestfs.pod:846
1787 "This could be fixed in the generator by specially marking parameters and "
1788 "return values which take bytes or other units."
1792 #: ../src/guestfs.pod:849
1793 msgid "Ambiguity between devices and paths"
1797 #: ../src/guestfs.pod:851
1799 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1800 "sdb2>) and a similar pathname. A file might just happen to be called "
1801 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1805 #: ../src/guestfs.pod:856
1807 "In the current API we usually resolve this ambiguity by having two separate "
1808 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1809 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1810 "detecting if the path supplied begins with C</dev/>."
1814 #: ../src/guestfs.pod:862
1816 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1817 "make paths/devices into structured names. One way to do this would be to "
1818 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1819 "aspect of grub. Another way would be to use a structured type, equivalent "
1820 "to this OCaml type:"
1824 #: ../src/guestfs.pod:868
1827 " type path = Path of string | Device of int | Partition of int * int\n"
1832 #: ../src/guestfs.pod:870
1833 msgid "which would allow you to pass arguments like:"
1837 #: ../src/guestfs.pod:872
1840 " Path \"/foo/bar\"\n"
1841 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1842 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1843 " Path \"/dev/sdb2\" (* not a device *)\n"
1848 #: ../src/guestfs.pod:877
1850 "As you can see there are still problems to resolve even with this "
1851 "representation. Also consider how it might work in guestfish."
1855 #: ../src/guestfs.pod:882
1856 msgid "KEYS AND PASSPHRASES"
1860 #: ../src/guestfs.pod:884
1862 "Certain libguestfs calls take a parameter that contains sensitive key "
1863 "material, passed in as a C string."
1867 #: ../src/guestfs.pod:887
1869 "In the future we would hope to change the libguestfs implementation so that "
1870 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1871 "swap. However this is I<not> done at the moment, because of the complexity "
1872 "of such an implementation."
1876 #: ../src/guestfs.pod:892
1878 "Therefore you should be aware that any key parameter you pass to libguestfs "
1879 "might end up being written out to the swap partition. If this is a concern, "
1880 "scrub the swap partition or don't use libguestfs on encrypted devices."
1884 #: ../src/guestfs.pod:897
1885 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1889 #: ../src/guestfs.pod:899
1891 "All high-level libguestfs actions are synchronous. If you want to use "
1892 "libguestfs asynchronously then you must create a thread."
1896 #: ../src/guestfs.pod:902
1898 "Only use the handle from a single thread. Either use the handle exclusively "
1899 "from one thread, or provide your own mutex so that two threads cannot issue "
1900 "calls on the same handle at the same time."
1904 #: ../src/guestfs.pod:906
1906 "See the graphical program guestfs-browser for one possible architecture for "
1907 "multithreaded programs using libvirt and libguestfs."
1911 #: ../src/guestfs.pod:909
1916 #: ../src/guestfs.pod:911
1918 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1923 #: ../src/guestfs.pod:914
1925 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1926 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1930 #: ../src/guestfs.pod:917
1932 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1933 "to change the directories that libguestfs will search in. The value is a "
1934 "colon-separated list of paths. The current directory is I<not> searched "
1935 "unless the path contains an empty element or C<.>. For example "
1936 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1937 "then C</usr/lib/guestfs>."
1941 #: ../src/guestfs.pod:924
1942 msgid "QEMU WRAPPERS"
1946 #: ../src/guestfs.pod:926
1948 "If you want to compile your own qemu, run qemu from a non-standard location, "
1949 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1954 #: ../src/guestfs.pod:930
1956 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1957 "last command in the shell script (so that qemu replaces the shell and "
1958 "becomes the direct child of the libguestfs-using program). If you don't do "
1959 "this, then the qemu process won't be cleaned up correctly."
1963 #: ../src/guestfs.pod:935
1965 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1970 #: ../src/guestfs.pod:938
1974 " qemudir=/home/rjones/d/qemu\n"
1975 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1980 #: ../src/guestfs.pod:942
1982 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1983 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1988 #: ../src/guestfs.pod:946
1991 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1996 #: ../src/guestfs.pod:948
1998 "Note that libguestfs also calls qemu with the -help and -version options in "
1999 "order to determine features."
2003 #: ../src/guestfs.pod:951
2004 msgid "ATTACHING TO RUNNING DAEMONS"
2008 #: ../src/guestfs.pod:953
2010 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2011 "babies. Use with caution."
2015 #: ../src/guestfs.pod:956
2017 "I<Note (2):> This section explains how to attach to a running daemon from a "
2018 "low level perspective. For most users, simply using virt tools such as "
2019 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2023 #: ../src/guestfs.pod:960
2024 msgid "Using guestfs_set_attach_method"
2028 #: ../src/guestfs.pod:962
2030 "By calling L</guestfs_set_attach_method> you can change how the library "
2031 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2032 "ARCHITECTURE> for some background)."
2036 #: ../src/guestfs.pod:966
2038 "The normal attach method is C<appliance>, where a small appliance is created "
2039 "containing the daemon, and then the library connects to this."
2043 #: ../src/guestfs.pod:969
2045 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2046 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2047 "daemon over the Unix domain socket."
2051 #: ../src/guestfs.pod:973
2053 "The normal use for this is to connect to a running virtual machine that "
2054 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2055 "files inside the live virtual machine."
2059 #: ../src/guestfs.pod:977
2060 msgid "Using guestfs_add_domain with live flag"
2064 #: ../src/guestfs.pod:979
2066 "L</guestfs_add_domain> provides some help for getting the correct attach "
2067 "method. If you pass the C<live> option to this function, then (if the "
2068 "virtual machine is running) it will examine the libvirt XML looking for a "
2069 "virtio-serial channel to connect to:"
2073 #: ../src/guestfs.pod:985
2080 " <channel type='unix'>\n"
2081 " <source mode='bind' path='/path/to/socket'/>\n"
2082 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2091 #: ../src/guestfs.pod:997
2093 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2094 "method to C<unix:/path/to/socket>."
2098 #: ../src/guestfs.pod:1000
2100 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2101 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2102 "to attach to and modify live virtual machines."
2106 #: ../src/guestfs.pod:1004
2108 "The virtual machine needs to have been set up beforehand so that it has the "
2109 "virtio-serial channel and so that guestfsd is running inside it."
2113 #: ../src/guestfs.pod:1008
2114 msgid "ABI GUARANTEE"
2118 #: ../src/guestfs.pod:1010
2120 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2121 "actions as outlined in this section. Although we will deprecate some "
2122 "actions, for example if they get replaced by newer calls, we will keep the "
2123 "old actions forever. This allows you the developer to program in confidence "
2124 "against the libguestfs API."
2128 #: ../src/guestfs.pod:1016
2129 msgid "BLOCK DEVICE NAMING"
2133 #: ../src/guestfs.pod:1018
2135 "In the kernel there is now quite a profusion of schemata for naming block "
2136 "devices (in this context, by I<block device> I mean a physical or virtual "
2137 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2138 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2139 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2140 "for the old IDE driver (particularly for SATA devices) those devices also "
2141 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2142 "paravirtualized drivers. This has created several different naming systems, "
2143 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2147 #: ../src/guestfs.pod:1030
2149 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2150 "Linux kernel to access block devices. We can run a variety of appliances "
2151 "based on a variety of Linux kernels."
2155 #: ../src/guestfs.pod:1034
2157 "This causes a problem for libguestfs because many API calls use device or "
2158 "partition names. Working scripts and the recipe (example) scripts that we "
2159 "make available over the internet could fail if the naming scheme changes."
2163 #: ../src/guestfs.pod:1039
2165 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2166 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2167 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2168 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2172 #: ../src/guestfs.pod:1045
2174 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2175 "L</guestfs_list_partitions> and similar calls return the true names of the "
2176 "devices and partitions as known to the appliance."
2180 #: ../src/guestfs.pod:1050
2181 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2185 #: ../src/guestfs.pod:1052
2187 "Usually this translation is transparent. However in some (very rare) cases "
2188 "you may need to know the exact algorithm. Such cases include where you use "
2189 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2190 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2194 #: ../src/guestfs.pod:1058
2196 "The algorithm is applied only to I<parameters> which are known to be either "
2197 "device or partition names. Return values from functions such as L</"
2198 "guestfs_list_devices> are never changed."
2202 #: ../src/guestfs.pod:1066
2203 msgid "Is the string a parameter which is a device or partition name?"
2207 #: ../src/guestfs.pod:1070
2208 msgid "Does the string begin with C</dev/sd>?"
2212 #: ../src/guestfs.pod:1074
2214 "Does the named device exist? If so, we use that device. However if I<not> "
2215 "then we continue with this algorithm."
2219 #: ../src/guestfs.pod:1079
2220 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2224 #: ../src/guestfs.pod:1081
2225 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2229 #: ../src/guestfs.pod:1083
2230 msgid "If that named device exists, use it. If not, continue."
2234 #: ../src/guestfs.pod:1087
2235 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2239 #: ../src/guestfs.pod:1089
2240 msgid "If that named device exists, use it. If not, return an error."
2244 #: ../src/guestfs.pod:1093
2245 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2249 #: ../src/guestfs.pod:1095
2251 "Although the standard naming scheme and automatic translation is useful for "
2252 "simple programs and guestfish scripts, for larger programs it is best not to "
2253 "rely on this mechanism."
2257 #: ../src/guestfs.pod:1099
2259 "Where possible for maximum future portability programs using libguestfs "
2260 "should use these future-proof techniques:"
2264 #: ../src/guestfs.pod:1106
2266 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2267 "device names, and then use those names directly."
2271 #: ../src/guestfs.pod:1109
2273 "Since those device names exist by definition, they will never be translated."
2277 #: ../src/guestfs.pod:1114
2279 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2280 "filesystem labels."
2284 #: ../src/guestfs.pod:1119
2289 #: ../src/guestfs.pod:1121
2291 "This section discusses security implications of using libguestfs, "
2292 "particularly with untrusted or malicious guests or disk images."
2296 #: ../src/guestfs.pod:1124
2297 msgid "GENERAL SECURITY CONSIDERATIONS"
2301 #: ../src/guestfs.pod:1126
2303 "Be careful with any files or data that you download from a guest (by "
2304 "\"download\" we mean not just the L</guestfs_download> command but any "
2305 "command that reads files, filenames, directories or anything else from a "
2306 "disk image). An attacker could manipulate the data to fool your program "
2307 "into doing the wrong thing. Consider cases such as:"
2311 #: ../src/guestfs.pod:1136
2312 msgid "the data (file etc) not being present"
2316 #: ../src/guestfs.pod:1140
2317 msgid "being present but empty"
2321 #: ../src/guestfs.pod:1144
2322 msgid "being much larger than normal"
2326 #: ../src/guestfs.pod:1148
2327 msgid "containing arbitrary 8 bit data"
2331 #: ../src/guestfs.pod:1152
2332 msgid "being in an unexpected character encoding"
2336 #: ../src/guestfs.pod:1156
2337 msgid "containing homoglyphs."
2341 #: ../src/guestfs.pod:1160
2342 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2346 #: ../src/guestfs.pod:1162
2348 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2349 "(VFS) module can sometimes be escalated into exploits by deliberately "
2350 "creating a malicious, malformed filesystem. These exploits are very severe "
2351 "for two reasons. Firstly there are very many filesystem drivers in the "
2352 "kernel, and many of them are infrequently used and not much developer "
2353 "attention has been paid to the code. Linux userspace helps potential "
2354 "crackers by detecting the filesystem type and automatically choosing the "
2355 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2356 "the administrator. Secondly, a kernel-level exploit is like a local root "
2357 "exploit (worse in some ways), giving immediate and total access to the "
2358 "system right down to the hardware level."
2362 #: ../src/guestfs.pod:1175
2364 "That explains why you should never mount a filesystem from an untrusted "
2365 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2366 "inside a qemu virtual machine, usually running as a non-root user. The "
2367 "attacker would need to write a filesystem which first exploited the kernel, "
2368 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2369 "the libguestfs protocol, and finally to be as serious as the host kernel "
2370 "exploit it would need to escalate its privileges to root. This multi-step "
2371 "escalation, performed by a static piece of data, is thought to be extremely "
2372 "hard to do, although we never say 'never' about security issues."
2376 #: ../src/guestfs.pod:1186
2378 "In any case callers can reduce the attack surface by forcing the filesystem "
2379 "type when mounting (use L</guestfs_mount_vfs>)."
2383 #: ../src/guestfs.pod:1189
2384 msgid "PROTOCOL SECURITY"
2388 #: ../src/guestfs.pod:1191
2390 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2391 "defined upper message size. However a program that uses libguestfs must "
2392 "also take care - for example you can write a program that downloads a binary "
2393 "from a disk image and executes it locally, and no amount of protocol "
2394 "security will save you from the consequences."
2398 #: ../src/guestfs.pod:1197
2399 msgid "INSPECTION SECURITY"
2403 #: ../src/guestfs.pod:1199
2405 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2406 "directly from the guest, and these could contain any 8 bit data. Callers "
2407 "should be careful to escape these before printing them to a structured file "
2408 "(for example, use HTML escaping if creating a web page)."
2412 #: ../src/guestfs.pod:1205
2414 "Guest configuration may be altered in unusual ways by the administrator of "
2415 "the virtual machine, and may not reflect reality (particularly for untrusted "
2416 "or actively malicious guests). For example we parse the hostname from "
2417 "configuration files like C</etc/sysconfig/network> that we find in the "
2418 "guest, but the guest administrator can easily manipulate these files to "
2419 "provide the wrong hostname."
2423 #: ../src/guestfs.pod:1213
2425 "The inspection API parses guest configuration using two external libraries: "
2426 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2427 "designed to be robust in the face of malicious data, although denial of "
2428 "service attacks are still possible, for example with oversized configuration "
2433 #: ../src/guestfs.pod:1219
2434 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2438 #: ../src/guestfs.pod:1221
2440 "Be very cautious about running commands from the guest. By running a "
2441 "command in the guest, you are giving CPU time to a binary that you do not "
2442 "control, under the same user account as the library, albeit wrapped in qemu "
2443 "virtualization. More information and alternatives can be found in the "
2444 "section L</RUNNING COMMANDS>."
2448 #: ../src/guestfs.pod:1227
2449 msgid "CVE-2010-3851"
2450 msgstr "CVE-2010-3851"
2453 #: ../src/guestfs.pod:1229
2454 msgid "https://bugzilla.redhat.com/642934"
2455 msgstr "https://bugzilla.redhat.com/642934"
2458 #: ../src/guestfs.pod:1231
2460 "This security bug concerns the automatic disk format detection that qemu "
2461 "does on disk images."
2465 #: ../src/guestfs.pod:1234
2467 "A raw disk image is just the raw bytes, there is no header. Other disk "
2468 "images like qcow2 contain a special header. Qemu deals with this by looking "
2469 "for one of the known headers, and if none is found then assuming the disk "
2470 "image must be raw."
2474 #: ../src/guestfs.pod:1239
2476 "This allows a guest which has been given a raw disk image to write some "
2477 "other header. At next boot (or when the disk image is accessed by "
2478 "libguestfs) qemu would do autodetection and think the disk image format was, "
2479 "say, qcow2 based on the header written by the guest."
2483 #: ../src/guestfs.pod:1244
2485 "This in itself would not be a problem, but qcow2 offers many features, one "
2486 "of which is to allow a disk image to refer to another image (called the "
2487 "\"backing disk\"). It does this by placing the path to the backing disk "
2488 "into the qcow2 header. This path is not validated and could point to any "
2489 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2490 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2491 "control of the attacker."
2495 #: ../src/guestfs.pod:1252
2497 "In libguestfs this is rather hard to exploit except under two circumstances:"
2501 #: ../src/guestfs.pod:1259
2502 msgid "You have enabled the network or have opened the disk in write mode."
2506 #: ../src/guestfs.pod:1263
2508 "You are also running untrusted code from the guest (see L</RUNNING "
2513 #: ../src/guestfs.pod:1268
2515 "The way to avoid this is to specify the expected disk format when adding "
2516 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2517 "should always do this if the disk is raw format, and it's a good idea for "
2522 #: ../src/guestfs.pod:1273
2524 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2525 "format is fetched from libvirt and passed through."
2529 #: ../src/guestfs.pod:1276
2531 "For libguestfs tools, use the I<--format> command line parameter as "
2536 #: ../src/guestfs.pod:1279
2537 msgid "CONNECTION MANAGEMENT"
2541 #: ../src/guestfs.pod:1281
2546 #: ../src/guestfs.pod:1283
2548 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2549 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2550 "handle and release all resources used."
2554 #: ../src/guestfs.pod:1287
2556 "For information on using multiple handles and threads, see the section L</"
2557 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2561 #: ../src/guestfs.pod:1290
2562 msgid "guestfs_create"
2566 #: ../src/guestfs.pod:1292
2569 " guestfs_h *guestfs_create (void);\n"
2574 #: ../src/guestfs.pod:1294
2575 msgid "Create a connection handle."
2579 #: ../src/guestfs.pod:1296
2581 "On success this returns a non-NULL pointer to a handle. On error it returns "
2586 #: ../src/guestfs.pod:1299
2588 "You have to \"configure\" the handle after creating it. This includes "
2589 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2590 "handle at least once."
2594 #: ../src/guestfs.pod:1303
2595 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2599 #: ../src/guestfs.pod:1305
2601 "You may also want to configure error handling for the handle. See the L</"
2602 "ERROR HANDLING> section below."
2606 #: ../src/guestfs.pod:1308
2607 msgid "guestfs_close"
2611 #: ../src/guestfs.pod:1310
2614 " void guestfs_close (guestfs_h *g);\n"
2619 #: ../src/guestfs.pod:1312
2620 msgid "This closes the connection handle and frees up all resources used."
2624 #: ../src/guestfs.pod:1314
2626 "If autosync was set on the handle and the handle was launched, then this "
2627 "implicitly calls various functions to unmount filesystems and sync the "
2628 "disk. See L</guestfs_set_autosync> for more details."
2632 #: ../src/guestfs.pod:1318
2633 msgid "If a close callback was set on the handle, then it is called."
2637 #: ../src/guestfs.pod:1320
2638 msgid "ERROR HANDLING"
2639 msgstr "ОБРОБКА ПОМИЛОК"
2642 #: ../src/guestfs.pod:1322
2644 "API functions can return errors. For example, almost all functions that "
2645 "return C<int> will return C<-1> to indicate an error."
2649 #: ../src/guestfs.pod:1325
2651 "Additional information is available for errors: an error message string and "
2652 "optionally an error number (errno) if the thing that failed was a system "
2657 #: ../src/guestfs.pod:1329
2659 "You can get at the additional information about the last error on the handle "
2660 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2661 "up an error handler with L</guestfs_set_error_handler>."
2665 #: ../src/guestfs.pod:1334
2667 "When the handle is created, a default error handler is installed which "
2668 "prints the error message string to C<stderr>. For small short-running "
2669 "command line programs it is sufficient to do:"
2673 #: ../src/guestfs.pod:1338
2676 " if (guestfs_launch (g) == -1)\n"
2677 " exit (EXIT_FAILURE);\n"
2682 #: ../src/guestfs.pod:1341
2684 "since the default error handler will ensure that an error message has been "
2685 "printed to C<stderr> before the program exits."
2689 #: ../src/guestfs.pod:1344
2691 "For other programs the caller will almost certainly want to install an "
2692 "alternate error handler or do error handling in-line like this:"
2696 #: ../src/guestfs.pod:1347
2699 " g = guestfs_create ();\n"
2704 #: ../src/guestfs.pod:1349
2707 " /* This disables the default behaviour of printing errors\n"
2709 " guestfs_set_error_handler (g, NULL, NULL);\n"
2714 #: ../src/guestfs.pod:1353
2717 " if (guestfs_launch (g) == -1) {\n"
2718 " /* Examine the error message and print it etc. */\n"
2719 " char *msg = guestfs_last_error (g);\n"
2720 " int errnum = guestfs_last_errno (g);\n"
2721 " fprintf (stderr, \"%s\\n\", msg);\n"
2728 #: ../src/guestfs.pod:1361
2730 "Out of memory errors are handled differently. The default action is to call "
2731 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2732 "guestfs_set_out_of_memory_handler>."
2736 #: ../src/guestfs.pod:1365
2738 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2739 "because there is no handle if this happens there is no way to get additional "
2740 "error information. However L</guestfs_create> is supposed to be a "
2741 "lightweight operation which can only fail because of insufficient memory (it "
2742 "returns NULL in this case)."
2746 #: ../src/guestfs.pod:1371
2747 msgid "guestfs_last_error"
2751 #: ../src/guestfs.pod:1373
2754 " const char *guestfs_last_error (guestfs_h *g);\n"
2759 #: ../src/guestfs.pod:1375
2761 "This returns the last error message that happened on C<g>. If there has not "
2762 "been an error since the handle was created, then this returns C<NULL>."
2766 #: ../src/guestfs.pod:1379
2768 "The lifetime of the returned string is until the next error occurs, or L</"
2769 "guestfs_close> is called."
2773 #: ../src/guestfs.pod:1382
2774 msgid "guestfs_last_errno"
2778 #: ../src/guestfs.pod:1384
2781 " int guestfs_last_errno (guestfs_h *g);\n"
2786 #: ../src/guestfs.pod:1386
2787 msgid "This returns the last error number (errno) that happened on C<g>."
2791 #: ../src/guestfs.pod:1388
2792 msgid "If successful, an errno integer not equal to zero is returned."
2796 #: ../src/guestfs.pod:1390
2798 "If no error, this returns 0. This call can return 0 in three situations:"
2802 #: ../src/guestfs.pod:1397
2803 msgid "There has not been any error on the handle."
2807 #: ../src/guestfs.pod:1401
2809 "There has been an error but the errno was meaningless. This corresponds to "
2810 "the case where the error did not come from a failed system call, but for "
2811 "some other reason."
2815 #: ../src/guestfs.pod:1407
2817 "There was an error from a failed system call, but for some reason the errno "
2818 "was not captured and returned. This usually indicates a bug in libguestfs."
2822 #: ../src/guestfs.pod:1413
2824 "Libguestfs tries to convert the errno from inside the applicance into a "
2825 "corresponding errno for the caller (not entirely trivial: the appliance "
2826 "might be running a completely different operating system from the library "
2827 "and error numbers are not standardized across Un*xen). If this could not be "
2828 "done, then the error is translated to C<EINVAL>. In practice this should "
2829 "only happen in very rare circumstances."
2833 #: ../src/guestfs.pod:1421
2834 msgid "guestfs_set_error_handler"
2838 #: ../src/guestfs.pod:1423
2841 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2843 " const char *msg);\n"
2844 " void guestfs_set_error_handler (guestfs_h *g,\n"
2845 " guestfs_error_handler_cb cb,\n"
2851 #: ../src/guestfs.pod:1430
2853 "The callback C<cb> will be called if there is an error. The parameters "
2854 "passed to the callback are an opaque data pointer and the error message "
2859 #: ../src/guestfs.pod:1434
2861 "C<errno> is not passed to the callback. To get that the callback must call "
2862 "L</guestfs_last_errno>."
2866 #: ../src/guestfs.pod:1437
2868 "Note that the message string C<msg> is freed as soon as the callback "
2869 "function returns, so if you want to stash it somewhere you must make your "
2874 #: ../src/guestfs.pod:1441
2875 msgid "The default handler prints messages on C<stderr>."
2879 #: ../src/guestfs.pod:1443
2880 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2884 #: ../src/guestfs.pod:1445
2885 msgid "guestfs_get_error_handler"
2889 #: ../src/guestfs.pod:1447
2892 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2893 " void **opaque_rtn);\n"
2898 #: ../src/guestfs.pod:1450
2899 msgid "Returns the current error handler callback."
2903 #: ../src/guestfs.pod:1452
2904 msgid "guestfs_set_out_of_memory_handler"
2908 #: ../src/guestfs.pod:1454
2911 " typedef void (*guestfs_abort_cb) (void);\n"
2912 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2913 " guestfs_abort_cb);\n"
2918 #: ../src/guestfs.pod:1458
2920 "The callback C<cb> will be called if there is an out of memory situation. "
2921 "I<Note this callback must not return>."
2925 #: ../src/guestfs.pod:1461
2926 msgid "The default is to call L<abort(3)>."
2930 #: ../src/guestfs.pod:1463
2932 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2936 #: ../src/guestfs.pod:1466
2937 msgid "guestfs_get_out_of_memory_handler"
2941 #: ../src/guestfs.pod:1468
2944 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2949 #: ../src/guestfs.pod:1470
2950 msgid "This returns the current out of memory handler."
2954 #: ../src/guestfs.pod:1472
2959 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1008
2964 #: ../src/guestfs.pod:1476
2969 #: ../src/guestfs.pod:1478
2974 #: ../src/guestfs.pod:1480
2975 msgid "AVAILABILITY"
2979 #: ../src/guestfs.pod:1482
2980 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2984 #: ../src/guestfs.pod:1484
2986 "Using L</guestfs_available> you can test availability of the following "
2987 "groups of functions. This test queries the appliance to see if the "
2988 "appliance you are currently using supports the functionality."
2992 #: ../src/guestfs.pod:1489
2993 msgid "@AVAILABILITY@"
2997 #: ../src/guestfs.pod:1491
2998 msgid "GUESTFISH supported COMMAND"
3002 #: ../src/guestfs.pod:1493
3004 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3005 "prints out the available groups and whether they are supported by this build "
3006 "of libguestfs. Note however that you have to do C<run> first."
3010 #: ../src/guestfs.pod:1498
3011 msgid "SINGLE CALLS AT COMPILE TIME"
3015 #: ../src/guestfs.pod:1500
3017 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3018 "function, such as:"
3022 #: ../src/guestfs.pod:1503
3025 " #define LIBGUESTFS_HAVE_DD 1\n"
3030 #: ../src/guestfs.pod:1505
3031 msgid "if L</guestfs_dd> is available."
3035 #: ../src/guestfs.pod:1507
3037 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3038 "function is available at compile time, we recommended using build tools such "
3039 "as autoconf or cmake. For example in autotools you could use:"
3043 #: ../src/guestfs.pod:1512
3046 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3047 " AC_CHECK_FUNCS([guestfs_dd])\n"
3052 #: ../src/guestfs.pod:1515
3054 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3059 #: ../src/guestfs.pod:1518
3060 msgid "SINGLE CALLS AT RUN TIME"
3064 #: ../src/guestfs.pod:1520
3066 "Testing at compile time doesn't guarantee that a function really exists in "
3067 "the library. The reason is that you might be dynamically linked against a "
3068 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3069 "This situation unfortunately results in a segmentation fault, which is a "
3070 "shortcoming of the C dynamic linking system itself."
3074 #: ../src/guestfs.pod:1527
3076 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3077 "in this example program (note that you still need the compile time check as "
3082 #: ../src/guestfs.pod:1531
3085 " #include <stdio.h>\n"
3086 " #include <stdlib.h>\n"
3087 " #include <unistd.h>\n"
3088 " #include <dlfcn.h>\n"
3089 " #include <guestfs.h>\n"
3094 #: ../src/guestfs.pod:1537
3099 " #ifdef LIBGUESTFS_HAVE_DD\n"
3101 " int has_function;\n"
3106 #: ../src/guestfs.pod:1543
3109 " /* Test if the function guestfs_dd is really available. */\n"
3110 " dl = dlopen (NULL, RTLD_LAZY);\n"
3112 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3113 " exit (EXIT_FAILURE);\n"
3115 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3121 #: ../src/guestfs.pod:1552
3124 " if (!has_function)\n"
3125 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3127 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3128 " /* Now it's safe to call\n"
3129 " guestfs_dd (g, \"foo\", \"bar\");\n"
3133 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3140 #: ../src/guestfs.pod:1565
3142 "You may think the above is an awful lot of hassle, and it is. There are "
3143 "other ways outside of the C linking system to ensure that this kind of "
3144 "incompatibility never arises, such as using package versioning:"
3148 #: ../src/guestfs.pod:1570
3151 " Requires: libguestfs >= 1.0.80\n"
3156 #: ../src/guestfs.pod:1572
3157 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3161 #: ../src/guestfs.pod:1574
3163 "A recent feature of the API is the introduction of calls which take optional "
3164 "arguments. In C these are declared 3 ways. The main way is as a call which "
3165 "takes variable arguments (ie. C<...>), as in this example:"
3169 #: ../src/guestfs.pod:1579
3172 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3177 #: ../src/guestfs.pod:1581
3179 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3180 "call with no optional arguments specified:"
3184 #: ../src/guestfs.pod:1584
3187 " guestfs_add_drive_opts (g, filename, -1);\n"
3192 #: ../src/guestfs.pod:1586
3193 msgid "With a single optional argument:"
3197 #: ../src/guestfs.pod:1588
3200 " guestfs_add_drive_opts (g, filename,\n"
3201 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3207 #: ../src/guestfs.pod:1592
3212 #: ../src/guestfs.pod:1594
3215 " guestfs_add_drive_opts (g, filename,\n"
3216 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3217 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3223 #: ../src/guestfs.pod:1599
3225 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3230 #: ../src/guestfs.pod:1602
3231 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3235 #: ../src/guestfs.pod:1604
3237 "The second variant has the same name with the suffix C<_va>, which works the "
3238 "same way but takes a C<va_list>. See the C manual for details. For the "
3239 "example function, this is declared:"
3243 #: ../src/guestfs.pod:1608
3246 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3252 #: ../src/guestfs.pod:1611
3253 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3257 #: ../src/guestfs.pod:1613
3259 "The third variant is useful where you need to construct these calls. You "
3260 "pass in a structure where you fill in the optional fields. The structure "
3261 "has a bitmask as the first element which you must set to indicate which "
3262 "fields you have filled in. For our example function the structure and call "
3267 #: ../src/guestfs.pod:1619
3270 " struct guestfs_add_drive_opts_argv {\n"
3271 " uint64_t bitmask;\n"
3273 " const char *format;\n"
3276 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3277 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3282 #: ../src/guestfs.pod:1628
3283 msgid "You could call it like this:"
3287 #: ../src/guestfs.pod:1630
3290 " struct guestfs_add_drive_opts_argv optargs = {\n"
3291 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3292 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3294 " .format = \"qcow2\"\n"
3300 #: ../src/guestfs.pod:1637
3303 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3308 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3309 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:9
3310 #: ../fish/guestfish-actions.pod:1257 ../tools/virt-win-reg.pl:532
3315 #: ../src/guestfs.pod:1645
3316 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3320 #: ../src/guestfs.pod:1650
3321 msgid "You do not need to fill in all fields of the structure."
3325 #: ../src/guestfs.pod:1654
3327 "There must be a one-to-one correspondence between fields of the structure "
3328 "that are filled in, and bits set in the bitmask."
3332 #: ../src/guestfs.pod:1659
3333 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3337 #: ../src/guestfs.pod:1661
3339 "In other languages, optional arguments are expressed in the way that is "
3340 "natural for that language. We refer you to the language-specific "
3341 "documentation for more details on that."
3345 #: ../src/guestfs.pod:1665
3346 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3350 #: ../src/guestfs.pod:1667
3351 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3355 #: ../src/guestfs.pod:1669
3357 "B<Note:> This section documents the generic event mechanism introduced in "
3358 "libguestfs 1.10, which you should use in new code if possible. The old "
3359 "functions C<guestfs_set_log_message_callback>, "
3360 "C<guestfs_set_subprocess_quit_callback>, "
3361 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3362 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3367 #: ../src/guestfs.pod:1677
3369 "Handles generate events when certain things happen, such as log messages "
3370 "being generated, progress messages during long-running operations, or the "
3371 "handle being closed. The API calls described below let you register a "
3372 "callback to be called when events happen. You can register multiple "
3373 "callbacks (for the same, different or overlapping sets of events), and "
3374 "individually remove callbacks. If callbacks are not removed, then they "
3375 "remain in force until the handle is closed."
3379 #: ../src/guestfs.pod:1685
3381 "In the current implementation, events are only generated synchronously: that "
3382 "means that events (and hence callbacks) can only happen while you are in the "
3383 "middle of making another libguestfs call. The callback is called in the "
3388 #: ../src/guestfs.pod:1690
3390 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3391 "unsigned integers, or a message buffer. Payloads are discussed later on."
3395 #: ../src/guestfs.pod:1694
3396 msgid "CLASSES OF EVENTS"
3400 #: ../src/guestfs.pod:1698
3401 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3405 #: ../src/guestfs.pod:1701
3407 "The callback function will be called while the handle is being closed "
3408 "(synchronously from L</guestfs_close>)."
3412 #: ../src/guestfs.pod:1704
3414 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3415 "handles that are open when the program exits. This means that this callback "
3416 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3417 "problems in higher-level languages (eg. if your HLL interpreter has already "
3418 "been cleaned up by the time this is called, and if your callback then jumps "
3419 "into some HLL function)."
3423 #: ../src/guestfs.pod:1711
3425 "If no callback is registered: the handle is closed without any callback "
3430 #: ../src/guestfs.pod:1714
3431 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3435 #: ../src/guestfs.pod:1717
3437 "The callback function will be called when the child process quits, either "
3438 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3439 "corresponds to a transition from any state to the CONFIG state)."
3443 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3444 msgid "If no callback is registered: the event is ignored."
3448 #: ../src/guestfs.pod:1723
3449 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3453 #: ../src/guestfs.pod:1726
3455 "The callback function will be called when the child process becomes ready "
3456 "first time after it has been launched. (This corresponds to a transition "
3457 "from LAUNCHING to the READY state)."
3461 #: ../src/guestfs.pod:1732
3462 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3466 #: ../src/guestfs.pod:1735
3468 "Some long-running operations can generate progress messages. If this "
3469 "callback is registered, then it will be called each time a progress message "
3470 "is generated (usually two seconds after the operation started, and three "
3471 "times per second thereafter until it completes, although the frequency may "
3472 "change in future versions)."
3476 #: ../src/guestfs.pod:1741
3478 "The callback receives in the payload four unsigned 64 bit numbers which are "
3479 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3483 #: ../src/guestfs.pod:1744
3485 "The units of C<total> are not defined, although for some operations C<total> "
3486 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3487 "or megabytes), and C<position> may be the portion which has been transferred."
3491 #: ../src/guestfs.pod:1749
3492 msgid "The only defined and stable parts of the API are:"
3496 #: ../src/guestfs.pod:1755
3498 "The callback can display to the user some type of progress bar or indicator "
3499 "which shows the ratio of C<position>:C<total>."
3503 #: ../src/guestfs.pod:1760
3504 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3508 #: ../src/guestfs.pod:1764
3510 "If any progress notification is sent during a call, then a final progress "
3511 "notification is always sent when C<position> = C<total> (I<unless> the call "
3512 "fails with an error)."
3516 #: ../src/guestfs.pod:1768
3518 "This is to simplify caller code, so callers can easily set the progress "
3519 "indicator to \"100%\" at the end of the operation, without requiring special "
3520 "code to detect this case."
3524 #: ../src/guestfs.pod:1774
3526 "For some calls we are unable to estimate the progress of the call, but we "
3527 "can still generate progress messages to indicate activity. This is known as "
3528 "\"pulse mode\", and is directly supported by certain progress bar "
3529 "implementations (eg. GtkProgressBar)."
3533 #: ../src/guestfs.pod:1779
3535 "For these calls, zero or more progress messages are generated with "
3536 "C<position = 0> and C<total = 1>, followed by a final message with "
3537 "C<position = total = 1>."
3541 #: ../src/guestfs.pod:1783
3543 "As noted above, if the call fails with an error then the final message may "
3548 #: ../src/guestfs.pod:1788
3550 "The callback also receives the procedure number (C<proc_nr>) and serial "
3551 "number (C<serial>) of the call. These are only useful for debugging "
3552 "protocol issues, and the callback can normally ignore them. The callback "
3553 "may want to print these numbers in error messages or debugging messages."
3557 #: ../src/guestfs.pod:1794
3558 msgid "If no callback is registered: progress messages are discarded."
3562 #: ../src/guestfs.pod:1796
3563 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3567 #: ../src/guestfs.pod:1799
3569 "The callback function is called whenever a log message is generated by qemu, "
3570 "the appliance kernel, guestfsd (daemon), or utility programs."
3574 #: ../src/guestfs.pod:1802
3576 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3577 "guestfs_launch>) then additional debug messages are generated."
3581 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3583 "If no callback is registered: the messages are discarded unless the verbose "
3584 "flag is set in which case they are sent to stderr. You can override the "
3585 "printing of verbose messages to stderr by setting up a callback."
3589 #: ../src/guestfs.pod:1810
3590 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3594 #: ../src/guestfs.pod:1813
3596 "The callback function is called whenever a log message is generated by the "
3597 "library part of libguestfs."
3601 #: ../src/guestfs.pod:1816
3603 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3604 "messages are generated."
3608 #: ../src/guestfs.pod:1824
3609 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3613 #: ../src/guestfs.pod:1827
3615 "The callback function is called whenever a trace message is generated. This "
3616 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3620 #: ../src/guestfs.pod:1830
3622 "If no callback is registered: the messages are sent to stderr. You can "
3623 "override the printing of trace messages to stderr by setting up a callback."
3627 #: ../src/guestfs.pod:1836
3628 msgid "guestfs_set_event_callback"
3632 #: ../src/guestfs.pod:1838
3635 " int guestfs_set_event_callback (guestfs_h *g,\n"
3636 " guestfs_event_callback cb,\n"
3637 " uint64_t event_bitmask,\n"
3644 #: ../src/guestfs.pod:1844
3646 "This function registers a callback (C<cb>) for all event classes in the "
3651 #: ../src/guestfs.pod:1847
3653 "For example, to register for all log message events, you could call this "
3654 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3655 "To register a single callback for all possible classes of events, use "
3656 "C<GUESTFS_EVENT_ALL>."
3660 #: ../src/guestfs.pod:1853
3661 msgid "C<flags> should always be passed as 0."
3665 #: ../src/guestfs.pod:1855
3667 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3668 "it for any purpose."
3672 #: ../src/guestfs.pod:1858
3674 "The return value is the event handle (an integer) which you can use to "
3675 "delete the callback (see below)."
3679 #: ../src/guestfs.pod:1861
3681 "If there is an error, this function returns C<-1>, and sets the error in the "
3682 "handle in the usual way (see L</guestfs_last_error> etc.)"
3686 #: ../src/guestfs.pod:1864
3688 "Callbacks remain in effect until they are deleted, or until the handle is "
3693 #: ../src/guestfs.pod:1867
3695 "In the case where multiple callbacks are registered for a particular event "
3696 "class, all of the callbacks are called. The order in which multiple "
3697 "callbacks are called is not defined."
3701 #: ../src/guestfs.pod:1871
3702 msgid "guestfs_delete_event_callback"
3706 #: ../src/guestfs.pod:1873
3709 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3714 #: ../src/guestfs.pod:1875
3716 "Delete a callback that was previously registered. C<event_handle> should be "
3717 "the integer that was returned by a previous call to "
3718 "C<guestfs_set_event_callback> on the same handle."
3722 #: ../src/guestfs.pod:1879
3723 msgid "guestfs_event_callback"
3727 #: ../src/guestfs.pod:1881
3730 " typedef void (*guestfs_event_callback) (\n"
3733 " uint64_t event,\n"
3734 " int event_handle,\n"
3736 " const char *buf, size_t buf_len,\n"
3737 " const uint64_t *array, size_t array_len);\n"
3742 #: ../src/guestfs.pod:1890
3744 "This is the type of the event callback function that you have to provide."
3748 #: ../src/guestfs.pod:1893
3750 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3751 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3752 "handle, and C<flags> which in the current API you should ignore."
3756 #: ../src/guestfs.pod:1897
3758 "The remaining parameters contain the event payload (if any). Each event may "
3759 "contain a payload, which usually relates to the event class, but for future "
3760 "proofing your code should be written to handle any payload for any event "
3765 #: ../src/guestfs.pod:1902
3767 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3768 "there is no message buffer). Note that this message buffer can contain "
3769 "arbitrary 8 bit data, including NUL bytes."
3773 #: ../src/guestfs.pod:1906
3775 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3776 "moment this is only used for progress messages."
3780 #: ../src/guestfs.pod:1909
3781 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3785 #: ../src/guestfs.pod:1911
3787 "One motivation for the generic event API was to allow GUI programs to "
3788 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3789 "unconditionally to C<stderr>."
3793 #: ../src/guestfs.pod:1915
3795 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3796 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3797 "messages are not events; you must capture error messages separately)."
3801 #: ../src/guestfs.pod:1920
3803 "Programs have to set up a callback to capture the classes of events of "
3808 #: ../src/guestfs.pod:1923
3812 " guestfs_set_event_callback\n"
3813 " (g, message_callback,\n"
3814 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3815 " GUESTFS_EVENT_TRACE,\n"
3816 " 0, NULL) == -1)\n"
3817 " if (eh == -1) {\n"
3818 " // handle error in the usual way\n"
3824 #: ../src/guestfs.pod:1933
3826 "The callback can then direct messages to the appropriate place. In this "
3827 "example, messages are directed to syslog:"
3831 #: ../src/guestfs.pod:1936
3835 " message_callback (\n"
3838 " uint64_t event,\n"
3839 " int event_handle,\n"
3841 " const char *buf, size_t buf_len,\n"
3842 " const uint64_t *array, size_t array_len)\n"
3844 " const int priority = LOG_USER|LOG_INFO;\n"
3845 " if (buf_len > 0)\n"
3846 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3852 #: ../src/guestfs.pod:1951
3853 msgid "PRIVATE DATA AREA"
3857 #: ../src/guestfs.pod:1953
3859 "You can attach named pieces of private data to the libguestfs handle, fetch "
3860 "them by name, and walk over them, for the lifetime of the handle. This is "
3861 "called the private data area and is only available from the C API."
3865 #: ../src/guestfs.pod:1958
3866 msgid "To attach a named piece of data, use the following call:"
3870 #: ../src/guestfs.pod:1960
3873 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3878 #: ../src/guestfs.pod:1962
3880 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3881 "pointer (which can be C<NULL>). Any previous item with the same key is "
3886 #: ../src/guestfs.pod:1966
3888 "You can use any C<key> you want, but your key should I<not> start with an "
3889 "underscore character. Keys beginning with an underscore character are "
3890 "reserved for internal libguestfs purposes (eg. for implementing language "
3891 "bindings). It is recommended that you prefix the key with some unique "
3892 "string to avoid collisions with other users."
3896 #: ../src/guestfs.pod:1972
3897 msgid "To retrieve the pointer, use:"
3901 #: ../src/guestfs.pod:1974
3904 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3909 #: ../src/guestfs.pod:1976
3911 "This function returns C<NULL> if either no data is found associated with "
3912 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3917 #: ../src/guestfs.pod:1980
3919 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3920 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3921 "all. In particular, libguestfs does I<not> try to free the data when the "
3922 "handle is closed. If the data must be freed, then the caller must either "
3923 "free it before calling L</guestfs_close> or must set up a close callback to "
3924 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3928 #: ../src/guestfs.pod:1987
3929 msgid "To walk over all entries, use these two functions:"
3933 #: ../src/guestfs.pod:1989
3936 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3941 #: ../src/guestfs.pod:1991
3944 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3949 #: ../src/guestfs.pod:1993
3951 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3952 "not have any particular meaning -- keys are not returned in any defined "
3953 "order). A pointer to the key is returned in C<*key_rtn> and the "
3954 "corresponding data pointer is returned from the function. C<NULL> is "
3955 "returned if there are no keys stored in the handle."
3959 #: ../src/guestfs.pod:1999
3961 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3962 "value of this function is also C<NULL> is there are no further entries to "
3967 #: ../src/guestfs.pod:2003
3968 msgid "Notes about walking over entries:"
3972 #: ../src/guestfs.pod:2009
3974 "You must not call C<guestfs_set_private> while walking over the entries."
3978 #: ../src/guestfs.pod:2014
3980 "The handle maintains an internal iterator which is reset when you call "
3981 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3982 "call C<guestfs_set_private>."
3986 #: ../src/guestfs.pod:2020
3987 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3991 #: ../src/guestfs.pod:2022
3994 " guestfs_set_private (g, key, NULL);\n"
3999 #: ../src/guestfs.pod:2024
4000 msgid "then that C<key> is not returned when walking."
4004 #: ../src/guestfs.pod:2028
4006 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4007 "C<guestfs_next_private> or C<guestfs_set_private>."
4011 #: ../src/guestfs.pod:2034
4013 "The following example code shows how to print all keys and data pointers "
4014 "that are associated with the handle C<g>:"
4018 #: ../src/guestfs.pod:2037
4021 " const char *key;\n"
4022 " void *data = guestfs_first_private (g, &key);\n"
4023 " while (data != NULL)\n"
4025 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4026 " data = guestfs_next_private (g, &key);\n"
4032 #: ../src/guestfs.pod:2045
4034 "More commonly you are only interested in keys that begin with an application-"
4035 "specific prefix C<foo_>. Modify the loop like so:"
4039 #: ../src/guestfs.pod:2048
4042 " const char *key;\n"
4043 " void *data = guestfs_first_private (g, &key);\n"
4044 " while (data != NULL)\n"
4046 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4047 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4048 " data = guestfs_next_private (g, &key);\n"
4054 #: ../src/guestfs.pod:2057
4056 "If you need to modify keys while walking, then you have to jump back to the "
4057 "beginning of the loop. For example, to delete all keys prefixed with "
4062 #: ../src/guestfs.pod:2061
4065 " const char *key;\n"
4068 " data = guestfs_first_private (g, &key);\n"
4069 " while (data != NULL)\n"
4071 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4073 " guestfs_set_private (g, key, NULL);\n"
4074 " /* note that 'key' pointer is now invalid, and so is\n"
4075 " the internal iterator */\n"
4078 " data = guestfs_next_private (g, &key);\n"
4084 #: ../src/guestfs.pod:2077
4086 "Note that the above loop is guaranteed to terminate because the keys are "
4087 "being deleted, but other manipulations of keys within the loop might not "
4088 "terminate unless you also maintain an indication of which keys have been "
4093 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4098 #: ../src/guestfs.pod:2084
4100 "<!-- old anchor for the next section --> <a name="
4101 "\"state_machine_and_low_level_event_api\"/>"
4103 "<!-- old anchor for the next section --> <a name="
4104 "\"state_machine_and_low_level_event_api\"/>"
4107 #: ../src/guestfs.pod:2089
4108 msgid "ARCHITECTURE"
4109 msgstr "АРХІТЕКТУРА"
4112 #: ../src/guestfs.pod:2091
4114 "Internally, libguestfs is implemented by running an appliance (a special "
4115 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4116 "process of the main program."
4120 #: ../src/guestfs.pod:2095
4123 " ___________________\n"
4125 " | main program |\n"
4127 " | | child process / appliance\n"
4128 " | | __________________________\n"
4130 " +-------------------+ RPC | +-----------------+ |\n"
4131 " | libguestfs <--------------------> guestfsd | |\n"
4132 " | | | +-----------------+ |\n"
4133 " \\___________________/ | | Linux kernel | |\n"
4134 " | +--^--------------+ |\n"
4135 " \\_________|________________/\n"
4141 " \\______________/\n"
4146 #: ../src/guestfs.pod:2115
4148 "The library, linked to the main program, creates the child process and hence "
4149 "the appliance in the L</guestfs_launch> function."
4153 #: ../src/guestfs.pod:2118
4155 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4156 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4157 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4158 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4159 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4160 "attached to the qemu process which translates device access by the "
4161 "appliance's Linux kernel into accesses to the image."
4165 #: ../src/guestfs.pod:2127
4167 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4168 "Although the disk image you are attached to might also be used by some "
4169 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4170 "care if both libguestfs's qemu process and your virtual machine are trying "
4171 "to update the disk image at the same time, since these usually results in "
4172 "massive disk corruption)."
4176 #: ../src/guestfs.pod:2134
4177 msgid "STATE MACHINE"
4178 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4181 #: ../src/guestfs.pod:2136
4182 msgid "libguestfs uses a state machine to model the child process:"
4186 #: ../src/guestfs.pod:2138
4198 " / | \\ \\ guestfs_launch\n"
4199 " / | _\\__V______\n"
4201 " / | | LAUNCHING |\n"
4202 " / | \\___________/\n"
4204 " / | guestfs_launch\n"
4206 " ______ / __|____V\n"
4207 " / \\ ------> / \\\n"
4208 " | BUSY | | READY |\n"
4209 " \\______/ <------ \\________/\n"
4214 #: ../src/guestfs.pod:2160
4216 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4217 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4218 "(3) alternating between READY and BUSY as commands are issued to, and "
4219 "carried out by, the child process."
4223 #: ../src/guestfs.pod:2165
4225 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4226 "asynchronously at any time (eg. due to some internal error), and that causes "
4227 "the state to transition back to CONFIG."
4231 #: ../src/guestfs.pod:2169
4233 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4234 "issued when in the CONFIG state."
4238 #: ../src/guestfs.pod:2172
4240 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4241 "L</guestfs_launch> blocks until the child process is READY to accept "
4242 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4243 "moves the state from CONFIG to LAUNCHING while it is running."
4247 #: ../src/guestfs.pod:2178
4249 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4250 "state. These API calls block waiting for the command to be carried out (ie. "
4251 "the state to transition to BUSY and then back to READY). There are no non-"
4252 "blocking versions, and no way to issue more than one command per handle at "
4257 #: ../src/guestfs.pod:2184
4259 "Finally, the child process sends asynchronous messages back to the main "
4260 "program, such as kernel log messages. You can register a callback to "
4261 "receive these messages."
4265 #: ../src/guestfs.pod:2188
4270 #: ../src/guestfs.pod:2190
4271 msgid "COMMUNICATION PROTOCOL"
4275 #: ../src/guestfs.pod:2192
4277 "Don't rely on using this protocol directly. This section documents how it "
4278 "currently works, but it may change at any time."
4282 #: ../src/guestfs.pod:2195
4284 "The protocol used to talk between the library and the daemon running inside "
4285 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4286 "1014, RFC 1832, RFC 4506)."
4290 #: ../src/guestfs.pod:2199
4292 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4293 "this file is automatically generated)."
4297 #: ../src/guestfs.pod:2202
4299 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4300 "and C<FileOut> parameters, which are handled with very simple request/reply "
4301 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4302 "parameters, which use the same request and reply messages, but they may also "
4303 "be followed by files sent using a chunked encoding."
4307 #: ../src/guestfs.pod:2209
4308 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4312 #: ../src/guestfs.pod:2211
4313 msgid "For ordinary functions, the request message is:"
4317 #: ../src/guestfs.pod:2213
4320 " total length (header + arguments,\n"
4321 " but not including the length word itself)\n"
4322 " struct guestfs_message_header (encoded as XDR)\n"
4323 " struct guestfs_<foo>_args (encoded as XDR)\n"
4328 #: ../src/guestfs.pod:2218
4330 "The total length field allows the daemon to allocate a fixed size buffer "
4331 "into which it slurps the rest of the message. As a result, the total length "
4332 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4333 "effective size of any request is limited to somewhere under this size."
4337 #: ../src/guestfs.pod:2224
4339 "Note also that many functions don't take any arguments, in which case the "
4340 "C<guestfs_I<foo>_args> is completely omitted."
4344 #: ../src/guestfs.pod:2227
4346 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4347 "receiver knows what type of args structure to expect, or none at all."
4351 #: ../src/guestfs.pod:2231
4353 "For functions that take optional arguments, the optional arguments are "
4354 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4355 "arguments. A bitmask in the header indicates which optional arguments are "
4356 "meaningful. The bitmask is also checked to see if it contains bits set "
4357 "which the daemon does not know about (eg. if more optional arguments were "
4358 "added in a later version of the library), and this causes the call to be "
4363 #: ../src/guestfs.pod:2239
4364 msgid "The reply message for ordinary functions is:"
4368 #: ../src/guestfs.pod:2241
4371 " total length (header + ret,\n"
4372 " but not including the length word itself)\n"
4373 " struct guestfs_message_header (encoded as XDR)\n"
4374 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4379 #: ../src/guestfs.pod:2246
4381 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4382 "functions that return no formal return values."
4386 #: ../src/guestfs.pod:2249
4388 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4392 #: ../src/guestfs.pod:2252
4394 "In the case of an error, a flag is set in the header, and the reply message "
4395 "is slightly changed:"
4399 #: ../src/guestfs.pod:2255
4402 " total length (header + error,\n"
4403 " but not including the length word itself)\n"
4404 " struct guestfs_message_header (encoded as XDR)\n"
4405 " struct guestfs_message_error (encoded as XDR)\n"
4410 #: ../src/guestfs.pod:2260
4412 "The C<guestfs_message_error> structure contains the error message as a "
4417 #: ../src/guestfs.pod:2263
4418 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4422 #: ../src/guestfs.pod:2265
4424 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4425 "The normal request message is sent (see above). However this is followed by "
4426 "a sequence of file chunks."
4430 #: ../src/guestfs.pod:2269
4433 " total length (header + arguments,\n"
4434 " but not including the length word itself,\n"
4435 " and not including the chunks)\n"
4436 " struct guestfs_message_header (encoded as XDR)\n"
4437 " struct guestfs_<foo>_args (encoded as XDR)\n"
4438 " sequence of chunks for FileIn param #0\n"
4439 " sequence of chunks for FileIn param #1 etc.\n"
4444 #: ../src/guestfs.pod:2277
4445 msgid "The \"sequence of chunks\" is:"
4449 #: ../src/guestfs.pod:2279
4452 " length of chunk (not including length word itself)\n"
4453 " struct guestfs_chunk (encoded as XDR)\n"
4454 " length of chunk\n"
4455 " struct guestfs_chunk (encoded as XDR)\n"
4457 " length of chunk\n"
4458 " struct guestfs_chunk (with data.data_len == 0)\n"
4463 #: ../src/guestfs.pod:2287
4465 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4466 "is set in the final chunk to indicate either successful completion or early "
4471 #: ../src/guestfs.pod:2291
4473 "At time of writing there are no functions that have more than one FileIn "
4474 "parameter. However this is (theoretically) supported, by sending the "
4475 "sequence of chunks for each FileIn parameter one after another (from left to "
4480 #: ../src/guestfs.pod:2296
4482 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4483 "transfer. The library does this by sending a chunk with a special flag set "
4484 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4485 "RPC, does I<not> send any reply, and goes back to reading the next request."
4489 #: ../src/guestfs.pod:2302
4491 "The daemon may also cancel. It does this by writing a special word "
4492 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4493 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4494 "cancel chunk). The special word is chosen so that even if cancellation "
4495 "happens right at the end of the transfer (after the library has finished "
4496 "writing and has started listening for the reply), the \"spurious\" cancel "
4497 "flag will not be confused with the reply message."
4501 #: ../src/guestfs.pod:2311
4503 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4504 "limit), and also files where the size is not known in advance (eg. from "
4505 "pipes or sockets). However the chunks are rather small "
4506 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4507 "to keep much in memory."
4511 #: ../src/guestfs.pod:2317
4512 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4516 #: ../src/guestfs.pod:2319
4518 "The protocol for FileOut parameters is exactly the same as for FileIn "
4519 "parameters, but with the roles of daemon and library reversed."
4523 #: ../src/guestfs.pod:2322
4526 " total length (header + ret,\n"
4527 " but not including the length word itself,\n"
4528 " and not including the chunks)\n"
4529 " struct guestfs_message_header (encoded as XDR)\n"
4530 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4531 " sequence of chunks for FileOut param #0\n"
4532 " sequence of chunks for FileOut param #1 etc.\n"
4537 #: ../src/guestfs.pod:2330
4538 msgid "INITIAL MESSAGE"
4542 #: ../src/guestfs.pod:2332
4544 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4545 "which indicates that the guest and daemon is alive. This is what L</"
4546 "guestfs_launch> waits for."
4550 #: ../src/guestfs.pod:2336
4551 msgid "PROGRESS NOTIFICATION MESSAGES"
4555 #: ../src/guestfs.pod:2338
4557 "The daemon may send progress notification messages at any time. These are "
4558 "distinguished by the normal length word being replaced by "
4559 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4563 #: ../src/guestfs.pod:2342
4565 "The library turns them into progress callbacks (see L</"
4566 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4571 #: ../src/guestfs.pod:2346
4573 "The daemon self-limits the frequency of progress messages it sends (see "
4574 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4579 #: ../src/guestfs.pod:2350
4580 msgid "LIBGUESTFS VERSION NUMBERS"
4584 #: ../src/guestfs.pod:2352
4586 "Since April 2010, libguestfs has started to make separate development and "
4587 "stable releases, along with corresponding branches in our git repository. "
4588 "These separate releases can be identified by version number:"
4592 #: ../src/guestfs.pod:2357
4595 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4596 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4602 " | `-------- sub-version\n"
4604 " `------ always '1' because we don't change the ABI\n"
4609 #: ../src/guestfs.pod:2368
4610 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4614 #: ../src/guestfs.pod:2370
4616 "As time passes we cherry pick fixes from the development branch and backport "
4617 "those into the stable branch, the effect being that the stable branch should "
4618 "get more stable and less buggy over time. So the stable releases are ideal "
4619 "for people who don't need new features but would just like the software to "
4624 #: ../src/guestfs.pod:2376
4625 msgid "Our criteria for backporting changes are:"
4629 #: ../src/guestfs.pod:2382
4631 "Documentation changes which don't affect any code are backported unless the "
4632 "documentation refers to a future feature which is not in stable."
4636 #: ../src/guestfs.pod:2388
4638 "Bug fixes which are not controversial, fix obvious problems, and have been "
4639 "well tested are backported."
4643 #: ../src/guestfs.pod:2393
4645 "Simple rearrangements of code which shouldn't affect how it works get "
4646 "backported. This is so that the code in the two branches doesn't get too "
4647 "far out of step, allowing us to backport future fixes more easily."
4651 #: ../src/guestfs.pod:2399
4653 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4654 "exceptional case: the new feature is required in order to implement an "
4655 "important bug fix."
4659 #: ../src/guestfs.pod:2405
4661 "A new stable branch starts when we think the new features in development are "
4662 "substantial and compelling enough over the current stable branch to warrant "
4663 "it. When that happens we create new stable and development versions 1.N.0 "
4664 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4665 "stable at this point, but by backporting fixes from development, that branch "
4666 "will stabilize over time."
4670 #: ../src/guestfs.pod:2413
4671 msgid "EXTENDING LIBGUESTFS"
4675 #: ../src/guestfs.pod:2415
4676 msgid "ADDING A NEW API ACTION"
4680 #: ../src/guestfs.pod:2417
4682 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4683 "documentation) are generated, and this makes it easy to extend the "
4688 #: ../src/guestfs.pod:2421
4689 msgid "To add a new API action there are two changes:"
4693 #: ../src/guestfs.pod:2427
4695 "You need to add a description of the call (name, parameters, return type, "
4696 "tests, documentation) to C<generator/generator_actions.ml>."
4700 #: ../src/guestfs.pod:2430
4702 "There are two sorts of API action, depending on whether the call goes "
4703 "through to the daemon in the appliance, or is serviced entirely by the "
4704 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4705 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4706 "an example of the latter, since a trace flag is maintained in the handle and "
4707 "all tracing is done on the library side."
4711 #: ../src/guestfs.pod:2438
4713 "Most new actions are of the first type, and get added to the "
4714 "C<daemon_functions> list. Each function has a unique procedure number used "
4715 "in the RPC protocol which is assigned to that action when we publish "
4716 "libguestfs and cannot be reused. Take the latest procedure number and "
4721 #: ../src/guestfs.pod:2444
4723 "For library-only actions of the second type, add to the "
4724 "C<non_daemon_functions> list. Since these functions are serviced by the "
4725 "library and do not travel over the RPC mechanism to the daemon, these "
4726 "functions do not need a procedure number, and so the procedure number is set "
4731 #: ../src/guestfs.pod:2452
4732 msgid "Implement the action (in C):"
4736 #: ../src/guestfs.pod:2454
4738 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4739 "C<daemon/> directory."
4743 #: ../src/guestfs.pod:2457
4745 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4746 "(note: double underscore) in the C<src/> directory."
4750 #: ../src/guestfs.pod:2460
4751 msgid "In either case, use another function as an example of what to do."
4755 #: ../src/guestfs.pod:2464
4756 msgid "After making these changes, use C<make> to compile."
4760 #: ../src/guestfs.pod:2466
4762 "Note that you don't need to implement the RPC, language bindings, manual "
4763 "pages or anything else. It's all automatically generated from the OCaml "
4768 #: ../src/guestfs.pod:2470
4769 msgid "ADDING TESTS FOR AN API ACTION"
4773 #: ../src/guestfs.pod:2472
4775 "You can supply zero or as many tests as you want per API call. The tests "
4776 "can either be added as part of the API description (C<generator/"
4777 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4778 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4779 "slower, so if possible use the first method."
4783 #: ../src/guestfs.pod:2478
4785 "The following describes the test environment used when you add an API test "
4786 "in C<generator_actions.ml>."
4790 #: ../src/guestfs.pod:2481
4791 msgid "The test environment has 4 block devices:"
4795 #: ../src/guestfs.pod:2485
4796 msgid "C</dev/sda> 500MB"
4800 #: ../src/guestfs.pod:2487
4801 msgid "General block device for testing."
4805 #: ../src/guestfs.pod:2489
4806 msgid "C</dev/sdb> 50MB"
4810 #: ../src/guestfs.pod:2491
4812 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4817 #: ../src/guestfs.pod:2494
4818 msgid "C</dev/sdc> 10MB"
4822 #: ../src/guestfs.pod:2496
4823 msgid "Used in a few tests where two block devices are needed."
4827 #: ../src/guestfs.pod:2498
4829 msgstr "C</dev/sdd>"
4832 #: ../src/guestfs.pod:2500
4833 msgid "ISO with fixed content (see C<images/test.iso>)."
4837 #: ../src/guestfs.pod:2504
4839 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4840 "appliance and block devices are reused between tests. So don't try testing "
4841 "L</guestfs_kill_subprocess> :-x"
4845 #: ../src/guestfs.pod:2508
4847 "Each test starts with an initial scenario, selected using one of the "
4848 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4849 "initialize the disks mentioned above in a particular way as documented in "
4850 "C<generator_types.ml>. You should not assume anything about the previous "
4851 "contents of other disks that are not initialized."
4855 #: ../src/guestfs.pod:2514
4857 "You can add a prerequisite clause to any individual test. This is a run-"
4858 "time check, which, if it fails, causes the test to be skipped. Useful if "
4859 "testing a command which might not work on all variations of libguestfs "
4860 "builds. A test that has prerequisite of C<Always> means to run "
4865 #: ../src/guestfs.pod:2520
4867 "In addition, packagers can skip individual tests by setting environment "
4868 "variables before running C<make check>."
4872 #: ../src/guestfs.pod:2523
4875 " SKIP_TEST_<CMD>_<NUM>=1\n"
4880 #: ../src/guestfs.pod:2525
4881 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4885 #: ../src/guestfs.pod:2527
4890 #: ../src/guestfs.pod:2529
4893 " SKIP_TEST_<CMD>=1\n"
4898 #: ../src/guestfs.pod:2531
4899 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4903 #: ../src/guestfs.pod:2533
4904 msgid "Packagers can run only certain tests by setting for example:"
4908 #: ../src/guestfs.pod:2535
4911 " TEST_ONLY=\"vfs_type zerofree\"\n"
4916 #: ../src/guestfs.pod:2537
4918 "See C<capitests/tests.c> for more details of how these environment variables "
4923 #: ../src/guestfs.pod:2540
4924 msgid "DEBUGGING NEW API ACTIONS"
4928 #: ../src/guestfs.pod:2542
4929 msgid "Test new actions work before submitting them."
4933 #: ../src/guestfs.pod:2544
4934 msgid "You can use guestfish to try out new commands."
4938 #: ../src/guestfs.pod:2546
4940 "Debugging the daemon is a problem because it runs inside a minimal "
4941 "environment. However you can fprintf messages in the daemon to stderr, and "
4942 "they will show up if you use C<guestfish -v>."
4946 #: ../src/guestfs.pod:2550
4947 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4951 #: ../src/guestfs.pod:2552
4953 "Our C source code generally adheres to some basic code-formatting "
4954 "conventions. The existing code base is not totally consistent on this "
4955 "front, but we do prefer that contributed code be formatted similarly. In "
4956 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4957 "indentation level, and other than that, follow the K&R style."
4961 #: ../src/guestfs.pod:2558
4963 "If you use Emacs, add the following to one of one of your start-up files (e."
4964 "g., ~/.emacs), to help ensure that you get indentation right:"
4968 #: ../src/guestfs.pod:2561
4971 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4972 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4973 " (add-hook 'find-file-hook\n"
4974 " '(lambda () (if (and buffer-file-name\n"
4975 " (string-match \"/libguestfs\\\\>\"\n"
4976 " (buffer-file-name))\n"
4977 " (not (string-equal mode-name \"Change Log\"))\n"
4978 " (not (string-equal mode-name \"Makefile\")))\n"
4979 " (setq indent-tabs-mode nil))))\n"
4984 #: ../src/guestfs.pod:2571
4987 " ;;; When editing C sources in libguestfs, use this style.\n"
4988 " (defun libguestfs-c-mode ()\n"
4989 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4991 " (c-set-style \"K&R\")\n"
4992 " (setq c-indent-level 2)\n"
4993 " (setq c-basic-offset 2))\n"
4994 " (add-hook 'c-mode-hook\n"
4995 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4996 " (buffer-file-name))\n"
4997 " (libguestfs-c-mode))))\n"
5002 #: ../src/guestfs.pod:2583
5003 msgid "Enable warnings when compiling (and fix any problems this finds):"
5007 #: ../src/guestfs.pod:2586
5010 " ./configure --enable-gcc-warnings\n"
5015 #: ../src/guestfs.pod:2588
5016 msgid "Useful targets are:"
5020 #: ../src/guestfs.pod:2590
5023 " make syntax-check # checks the syntax of the C code\n"
5024 " make check # runs the test suite\n"
5029 #: ../src/guestfs.pod:2593
5030 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5034 #: ../src/guestfs.pod:2595
5036 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5037 "which are used to do shell quoting."
5041 #: ../src/guestfs.pod:2600
5046 #: ../src/guestfs.pod:2602
5048 "Simple shell quoted string. Any spaces or other shell characters are "
5053 #: ../src/guestfs.pod:2605
5058 #: ../src/guestfs.pod:2607
5060 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5065 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5066 msgid "For example:"
5070 #: ../src/guestfs.pod:2614
5073 " asprintf (&cmd, \"cat %R\", path);\n"
5078 #: ../src/guestfs.pod:2616
5079 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5083 #: ../src/guestfs.pod:2618
5085 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5086 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5087 "they are not passed via the shell (instead, straight to exec). You probably "
5088 "want to use the C<sysroot_path()> function however."
5092 #: ../src/guestfs.pod:2624
5093 msgid "SUBMITTING YOUR NEW API ACTIONS"
5097 #: ../src/guestfs.pod:2626
5099 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5100 "libguestfs> and CC to L<rjones@redhat.com>."
5104 #: ../src/guestfs.pod:2630
5105 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5109 #: ../src/guestfs.pod:2632
5110 msgid "We support i18n (gettext anyhow) in the library."
5114 #: ../src/guestfs.pod:2634
5116 "However many messages come from the daemon, and we don't translate those at "
5117 "the moment. One reason is that the appliance generally has all locale files "
5118 "removed from it, because they take up a lot of space. So we'd have to readd "
5119 "some of those, as well as copying our PO files into the appliance."
5123 #: ../src/guestfs.pod:2640
5125 "Debugging messages are never translated, since they are intended for the "
5130 #: ../src/guestfs.pod:2643
5131 msgid "SOURCE CODE SUBDIRECTORIES"
5135 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5818
5136 #: ../fish/guestfish-actions.pod:3912
5137 msgid "C<appliance>"
5138 msgstr "C<appliance>"
5141 #: ../src/guestfs.pod:2649
5142 msgid "The libguestfs appliance, build scripts and so on."
5146 #: ../src/guestfs.pod:2651
5147 msgid "C<capitests>"
5148 msgstr "C<capitests>"
5151 #: ../src/guestfs.pod:2653
5152 msgid "Automated tests of the C API."
5156 #: ../src/guestfs.pod:2655
5161 #: ../src/guestfs.pod:2657
5163 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5168 #: ../src/guestfs.pod:2660
5173 #: ../src/guestfs.pod:2662
5174 msgid "Outside contributions, experimental parts."
5178 #: ../src/guestfs.pod:2664
5183 #: ../src/guestfs.pod:2666
5185 "The daemon that runs inside the libguestfs appliance and carries out actions."
5189 #: ../src/guestfs.pod:2669
5194 #: ../src/guestfs.pod:2671
5195 msgid "L<virt-df(1)> command and documentation."
5199 #: ../src/guestfs.pod:2673
5201 msgstr "C<examples>"
5204 #: ../src/guestfs.pod:2675
5205 msgid "C API example code."
5206 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5209 #: ../src/guestfs.pod:2677
5214 #: ../src/guestfs.pod:2679
5216 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5217 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5218 "L<virt-tar-out(1)>."
5222 #: ../src/guestfs.pod:2683
5227 #: ../src/guestfs.pod:2685
5229 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5233 #: ../src/guestfs.pod:2687
5234 msgid "C<generator>"
5235 msgstr "C<generator>"
5238 #: ../src/guestfs.pod:2689
5240 "The crucially important generator, used to automatically generate large "
5241 "amounts of boilerplate C code for things like RPC and bindings."
5245 #: ../src/guestfs.pod:2692
5250 #: ../src/guestfs.pod:2694
5251 msgid "Files used by the test suite."
5255 #: ../src/guestfs.pod:2696
5256 msgid "Some \"phony\" guest images which we test against."
5260 #: ../src/guestfs.pod:2698
5261 msgid "C<inspector>"
5262 msgstr "C<inspector>"
5265 #: ../src/guestfs.pod:2700
5266 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5270 #: ../src/guestfs.pod:2702
5275 #: ../src/guestfs.pod:2704
5276 msgid "Logo used on the website. The fish is called Arthur by the way."
5280 #: ../src/guestfs.pod:2706
5285 #: ../src/guestfs.pod:2708
5286 msgid "M4 macros used by autoconf."
5290 #: ../src/guestfs.pod:2710
5295 #: ../src/guestfs.pod:2712
5296 msgid "Translations of simple gettext strings."
5297 msgstr "Переклади простих рядків gettext."
5300 #: ../src/guestfs.pod:2714
5305 #: ../src/guestfs.pod:2716
5307 "The build infrastructure and PO files for translations of manpages and POD "
5308 "files. Eventually this will be combined with the C<po> directory, but that "
5309 "is rather complicated."
5313 #: ../src/guestfs.pod:2720
5314 msgid "C<regressions>"
5315 msgstr "C<regressions>"
5318 #: ../src/guestfs.pod:2722
5319 msgid "Regression tests."
5320 msgstr "Тести на регресії."
5323 #: ../src/guestfs.pod:2724
5328 #: ../src/guestfs.pod:2726
5329 msgid "L<virt-rescue(1)> command and documentation."
5333 #: ../src/guestfs.pod:2728
5338 #: ../src/guestfs.pod:2730
5339 msgid "Source code to the C library."
5343 #: ../src/guestfs.pod:2732
5348 #: ../src/guestfs.pod:2734
5349 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5353 #: ../src/guestfs.pod:2736
5354 msgid "C<test-tool>"
5355 msgstr "C<test-tool>"
5358 #: ../src/guestfs.pod:2738
5360 "Test tool for end users to test if their qemu/kernel combination will work "
5365 #: ../src/guestfs.pod:2741
5370 #: ../src/guestfs.pod:2743
5375 #: ../src/guestfs.pod:2745
5380 #: ../src/guestfs.pod:2747
5385 #: ../src/guestfs.pod:2749
5390 #: ../src/guestfs.pod:2751
5395 #: ../src/guestfs.pod:2753
5400 #: ../src/guestfs.pod:2755
5405 #: ../src/guestfs.pod:2757
5406 msgid "Language bindings."
5407 msgstr "Прив’язки до мов програмування."
5410 #: ../src/guestfs.pod:2761
5415 #: ../src/guestfs.pod:2763
5416 msgid "PROTOCOL LIMITS"
5420 #: ../src/guestfs.pod:2765
5422 "Internally libguestfs uses a message-based protocol to pass API calls and "
5423 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5424 "plenty more detail about this). The maximum message size used by the "
5425 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5426 "aware of this limit. The API calls which may be affected are individually "
5427 "documented, with a link back to this section of the documentation."
5431 #: ../src/guestfs.pod:2773
5433 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5434 "a simple string. Because this string is at some point internally encoded as "
5435 "a message, the maximum size that it can return is slightly under 4 MB. If "
5436 "the requested file is larger than this then you will get an error."
5440 #: ../src/guestfs.pod:2779
5442 "In order to transfer large files into and out of the guest filesystem, you "
5443 "need to use particular calls that support this. The sections L</UPLOADING> "
5444 "and L</DOWNLOADING> document how to do this."
5448 #: ../src/guestfs.pod:2783
5450 "You might also consider mounting the disk image using our FUSE filesystem "
5451 "support (L<guestmount(1)>)."
5455 #: ../src/guestfs.pod:2786
5456 msgid "MAXIMUM NUMBER OF DISKS"
5460 #: ../src/guestfs.pod:2788
5461 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5465 #: ../src/guestfs.pod:2791
5467 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5468 "slots. However febootstrap only understands disks with names C</dev/vda> "
5469 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5474 #: ../src/guestfs.pod:2796
5476 "We are working to substantially raise this limit in future versions but it "
5477 "requires complex changes to qemu."
5481 #: ../src/guestfs.pod:2799
5483 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5484 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5485 "requires changes to qemu."
5489 #: ../src/guestfs.pod:2803
5490 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5494 #: ../src/guestfs.pod:2805
5495 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5499 #: ../src/guestfs.pod:2807
5501 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5502 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5506 #: ../src/guestfs.pod:2810
5508 "If you attach a disk with more than 15 partitions, the extra partitions are "
5509 "ignored by libguestfs."
5513 #: ../src/guestfs.pod:2813
5514 msgid "MAXIMUM SIZE OF A DISK"
5518 #: ../src/guestfs.pod:2815
5519 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5523 #: ../src/guestfs.pod:2817
5525 "We have tested block devices up to 1 exabyte (2**60 or "
5526 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5531 #: ../src/guestfs.pod:2821
5533 "Although libguestfs probably does not impose any limit, the underlying host "
5534 "storage will. If you store disk images on a host ext4 filesystem, then the "
5535 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5536 "TB). If you store disk images as host logical volumes then you are limited "
5537 "by the maximum size of an LV."
5541 #: ../src/guestfs.pod:2827
5543 "For the hugest disk image files, we recommend using XFS on the host for "
5548 #: ../src/guestfs.pod:2830
5549 msgid "MAXIMUM SIZE OF A PARTITION"
5553 #: ../src/guestfs.pod:2832
5555 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5556 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5557 "address a partition located beyond 2 TB on the disk."
5561 #: ../src/guestfs.pod:2836
5563 "It is recommended that you use GPT partitions on disks which are larger than "
5564 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5565 "which are theoretically larger than the largest disk we could support."
5569 #: ../src/guestfs.pod:2841
5570 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5574 #: ../src/guestfs.pod:2843
5576 "This depends on the filesystem type. libguestfs itself does not impose any "
5577 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5578 "what these limits are."
5582 #: ../src/guestfs.pod:2847
5583 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5587 #: ../src/guestfs.pod:2849
5589 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5590 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5591 "uploads and downloads."
5595 #: ../src/guestfs.pod:2853
5597 #| msgid "INSPECTION"
5598 msgid "INSPECTION LIMITS"
5602 #: ../src/guestfs.pod:2855
5604 "The inspection code has several arbitrary limits on things like the size of "
5605 "Windows Registry hive it will read, and the length of product name. These "
5606 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5607 "memory and disk space on the host, and should not be reached in practice. "
5608 "See the source code for more information."
5612 #: ../src/guestfs.pod:2861 ../fish/guestfish.pod:1015
5613 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5614 msgid "ENVIRONMENT VARIABLES"
5615 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5618 #: ../src/guestfs.pod:2865 ../fish/guestfish.pod:1041
5619 msgid "LIBGUESTFS_APPEND"
5623 #: ../src/guestfs.pod:2867 ../fish/guestfish.pod:1043
5624 msgid "Pass additional options to the guest kernel."
5628 #: ../src/guestfs.pod:2869 ../fish/guestfish.pod:1045
5629 msgid "LIBGUESTFS_DEBUG"
5633 #: ../src/guestfs.pod:2871
5635 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5636 "effect as calling C<guestfs_set_verbose (g, 1)>."
5640 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1050
5641 msgid "LIBGUESTFS_MEMSIZE"
5645 #: ../src/guestfs.pod:2876 ../fish/guestfish.pod:1052
5647 "Set the memory allocated to the qemu process, in megabytes. For example:"
5651 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1055
5654 " LIBGUESTFS_MEMSIZE=700\n"
5659 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1057
5660 msgid "LIBGUESTFS_PATH"
5664 #: ../src/guestfs.pod:2883
5666 "Set the path that libguestfs uses to search for a supermin appliance. See "
5667 "the discussion of paths in section L</PATH> above."
5671 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1062
5672 msgid "LIBGUESTFS_QEMU"
5676 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1064
5678 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5679 "which was found at compile time by the configure script is used."
5683 #: ../src/guestfs.pod:2892
5684 msgid "See also L</QEMU WRAPPERS> above."
5688 #: ../src/guestfs.pod:2894 ../fish/guestfish.pod:1068
5689 msgid "LIBGUESTFS_TRACE"
5693 #: ../src/guestfs.pod:2896
5695 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5696 "effect as calling C<guestfs_set_trace (g, 1)>."
5700 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1077
5705 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1079
5707 "Location of temporary directory, defaults to C</tmp> except for the cached "
5708 "supermin appliance which defaults to C</var/tmp>."
5712 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1082
5714 "If libguestfs was compiled to use the supermin appliance then the real "
5715 "appliance is cached in this directory, shared between all handles belonging "
5716 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5717 "use in case C</var/tmp> is not large enough."
5721 #: ../src/guestfs.pod:2912 ../fish/guestfish.pod:1149
5722 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277
5723 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5724 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5725 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5727 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5730 #: ../src/guestfs.pod:2914
5732 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5733 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5734 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5735 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5736 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5737 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5738 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5742 #: ../src/guestfs.pod:2941
5744 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5745 "(8)>, L<disktype(1)>."
5749 #: ../src/guestfs.pod:2948 ../tools/virt-win-reg.pl:587
5750 #: ../tools/virt-make-fs.pl:553
5755 #: ../src/guestfs.pod:2950
5756 msgid "To get a list of bugs against libguestfs use this link:"
5758 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5762 #: ../src/guestfs.pod:2952
5764 "L<https://bugzilla.redhat.com/buglist.cgi?"
5765 "component=libguestfs&product=Virtualization+Tools>"
5767 "L<https://bugzilla.redhat.com/buglist.cgi?"
5768 "component=libguestfs&product=Virtualization+Tools>"
5771 #: ../src/guestfs.pod:2954
5772 msgid "To report a new bug against libguestfs use this link:"
5773 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5776 #: ../src/guestfs.pod:2956
5778 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5779 "component=libguestfs&product=Virtualization+Tools>"
5781 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5782 "component=libguestfs&product=Virtualization+Tools>"
5785 #: ../src/guestfs.pod:2958
5786 msgid "When reporting a bug, please check:"
5790 #: ../src/guestfs.pod:2964
5791 msgid "That the bug hasn't been reported already."
5795 #: ../src/guestfs.pod:2968
5796 msgid "That you are testing a recent version."
5800 #: ../src/guestfs.pod:2972
5801 msgid "Describe the bug accurately, and give a way to reproduce it."
5805 #: ../src/guestfs.pod:2976
5807 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5812 #: ../src/guestfs.pod:2981 ../fish/guestfish.pod:1172
5813 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
5818 #: ../src/guestfs.pod:2983 ../fish/guestfish.pod:1174
5819 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
5820 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5824 #: ../src/guestfs.pod:2985 ../fish/guestfish.pod:1176
5825 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292
5826 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5827 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5828 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5830 msgstr "АВТОРСЬКІ ПРАВА"
5833 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1178
5834 #: ../test-tool/libguestfs-test-tool.pod:99
5835 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5839 #: ../src/guestfs.pod:2990
5841 "This library is free software; you can redistribute it and/or modify it "
5842 "under the terms of the GNU Lesser General Public License as published by the "
5843 "Free Software Foundation; either version 2 of the License, or (at your "
5844 "option) any later version."
5848 #: ../src/guestfs.pod:2995
5850 "This library is distributed in the hope that it will be useful, but WITHOUT "
5851 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5852 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5857 #: ../src/guestfs.pod:3000
5859 "You should have received a copy of the GNU Lesser General Public License "
5860 "along with this library; if not, write to the Free Software Foundation, "
5861 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5865 #: ../src/guestfs-actions.pod:1
5866 msgid "guestfs_add_cdrom"
5870 #: ../src/guestfs-actions.pod:3
5874 " guestfs_add_cdrom (guestfs_h *g,\n"
5875 " const char *filename);\n"
5880 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5881 msgid "This function adds a virtual CD-ROM disk image to the guest."
5885 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5886 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5890 #: ../src/guestfs-actions.pod:17
5892 "This call checks for the existence of C<filename>. This stops you from "
5893 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5894 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5899 #: ../src/guestfs-actions.pod:24
5901 "If you just want to add an ISO file (often you use this as an efficient way "
5902 "to transfer large files into the guest), then you should probably use "
5903 "C<guestfs_add_drive_ro> instead."
5907 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5908 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5909 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5910 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5911 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5912 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5913 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5914 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5915 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5916 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5917 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5918 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5919 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5920 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5921 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5922 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5923 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5924 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5925 #: ../src/guestfs-actions.pod:1692 ../src/guestfs-actions.pod:1714
5926 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:2263
5927 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2468
5928 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3456
5929 #: ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3496
5930 #: ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3665
5931 #: ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3692
5932 #: ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3743
5933 #: ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3835
5934 #: ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875
5935 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930
5936 #: ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:3968
5937 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4015
5938 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4067
5939 #: ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4095
5940 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4205
5941 #: ../src/guestfs-actions.pod:4225 ../src/guestfs-actions.pod:4238
5942 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4307
5943 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4341
5944 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4369
5945 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4401
5946 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4479
5947 #: ../src/guestfs-actions.pod:4552 ../src/guestfs-actions.pod:4583
5948 #: ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4621
5949 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4650
5950 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4678
5951 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4728
5952 #: ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4770
5953 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4801
5954 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4887
5955 #: ../src/guestfs-actions.pod:4901 ../src/guestfs-actions.pod:4929
5956 #: ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4964
5957 #: ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5155
5958 #: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5195
5959 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5293
5960 #: ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5323
5961 #: ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:5626
5962 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5664
5963 #: ../src/guestfs-actions.pod:5676 ../src/guestfs-actions.pod:5688
5964 #: ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5714
5965 #: ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5744
5966 #: ../src/guestfs-actions.pod:5765 ../src/guestfs-actions.pod:5784
5967 #: ../src/guestfs-actions.pod:5803 ../src/guestfs-actions.pod:5833
5968 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5872
5969 #: ../src/guestfs-actions.pod:5890 ../src/guestfs-actions.pod:5909
5970 #: ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:5949
5971 #: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5994
5972 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6037
5973 #: ../src/guestfs-actions.pod:6061 ../src/guestfs-actions.pod:6080
5974 #: ../src/guestfs-actions.pod:6095 ../src/guestfs-actions.pod:6114
5975 #: ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6181
5976 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6336
5977 #: ../src/guestfs-actions.pod:6457 ../src/guestfs-actions.pod:6469
5978 #: ../src/guestfs-actions.pod:6482 ../src/guestfs-actions.pod:6495
5979 #: ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6530
5980 #: ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6556
5981 #: ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6630
5982 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6663
5983 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6696
5984 #: ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:6729
5985 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6779
5986 #: ../src/guestfs-actions.pod:6820 ../src/guestfs-actions.pod:6833
5987 #: ../src/guestfs-actions.pod:6851 ../src/guestfs-actions.pod:6885
5988 #: ../src/guestfs-actions.pod:6921 ../src/guestfs-actions.pod:7040
5989 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7072
5990 #: ../src/guestfs-actions.pod:7127 ../src/guestfs-actions.pod:7140
5991 #: ../src/guestfs-actions.pod:7185 ../src/guestfs-actions.pod:7218
5992 #: ../src/guestfs-actions.pod:7279 ../src/guestfs-actions.pod:7305
5993 #: ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7390
5994 #: ../src/guestfs-actions.pod:7419
5995 msgid "This function returns 0 on success or -1 on error."
5999 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6000 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6001 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6003 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6008 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6009 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6010 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962
6011 #: ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4733
6012 #: ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6189
6013 #: ../src/guestfs-actions.pod:6222 ../src/guestfs-actions.pod:6281
6014 #: ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7313
6015 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:31
6016 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6017 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1316
6018 #: ../fish/guestfish-actions.pod:1330 ../fish/guestfish-actions.pod:3005
6019 #: ../fish/guestfish-actions.pod:3202 ../fish/guestfish-actions.pod:4174
6020 #: ../fish/guestfish-actions.pod:4197 ../fish/guestfish-actions.pod:4219
6021 #: ../fish/guestfish-actions.pod:4257 ../fish/guestfish-actions.pod:4898
6022 #: ../fish/guestfish-actions.pod:4995
6024 "Deprecated functions will not be removed from the API, but the fact that "
6025 "they are deprecated indicates that there are problems with correct use of "
6030 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6031 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1913
6032 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2114
6033 #: ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3478
6034 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5851
6035 #: ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:6082
6036 #: ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6698
6037 #: ../src/guestfs-actions.pod:7227
6038 msgid "(Added in 0.3)"
6042 #: ../src/guestfs-actions.pod:41
6043 msgid "guestfs_add_domain"
6047 #: ../src/guestfs-actions.pod:43
6051 " guestfs_add_domain (guestfs_h *g,\n"
6052 " const char *dom,\n"
6058 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6059 #: ../src/guestfs-actions.pod:4440
6061 "You may supply a list of optional arguments to this call. Use zero or more "
6062 "of the following pairs of parameters, and terminate the list with C<-1> on "
6063 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6067 #: ../src/guestfs-actions.pod:53
6070 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6071 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6072 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6073 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6078 #: ../src/guestfs-actions.pod:58
6080 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6081 "It works by connecting to libvirt, requesting the domain and domain XML from "
6082 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6087 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6089 "The number of disks added is returned. This operation is atomic: if an "
6090 "error is returned, then no disks are added."
6094 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6096 "This function does some minimal checks to make sure the libvirt domain is "
6097 "not running (unless C<readonly> is true). In a future version we will try "
6098 "to acquire the libvirt lock on each disk."
6102 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6104 "Disks must be accessible locally. This often means that adding disks from a "
6105 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6106 "unless those disks are accessible via the same device path locally too."
6110 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6112 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6113 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6114 "libvirt URI (or one set through an environment variable, see the libvirt "
6115 "documentation for full details)."
6119 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6121 "The optional C<live> flag controls whether this call will try to connect to "
6122 "a running virtual machine C<guestfsd> process if it sees a suitable "
6123 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6124 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6125 "DAEMONS> for more information."
6129 #: ../src/guestfs-actions.pod:88
6131 "The other optional parameters are passed directly through to "
6132 "C<guestfs_add_drive_opts>."
6136 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6137 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6138 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6139 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6140 #: ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1874
6141 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2023
6142 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2101
6143 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2777
6144 #: ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:4873
6145 #: ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5407
6146 #: ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:6806
6147 #: ../src/guestfs-actions.pod:7238 ../src/guestfs-actions.pod:7251
6148 #: ../src/guestfs-actions.pod:7264
6149 msgid "On error this function returns -1."
6153 #: ../src/guestfs-actions.pod:93
6154 msgid "(Added in 1.7.4)"
6158 #: ../src/guestfs-actions.pod:95
6159 msgid "guestfs_add_domain_va"
6163 #: ../src/guestfs-actions.pod:97
6167 " guestfs_add_domain_va (guestfs_h *g,\n"
6168 " const char *dom,\n"
6174 #: ../src/guestfs-actions.pod:102
6175 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6179 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6180 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6181 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4505
6182 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6186 #: ../src/guestfs-actions.pod:106
6187 msgid "guestfs_add_domain_argv"
6191 #: ../src/guestfs-actions.pod:108
6195 " guestfs_add_domain_argv (guestfs_h *g,\n"
6196 " const char *dom,\n"
6197 " const struct guestfs_add_domain_argv *optargs);\n"
6202 #: ../src/guestfs-actions.pod:113
6203 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6207 #: ../src/guestfs-actions.pod:117
6208 msgid "guestfs_add_drive"
6212 #: ../src/guestfs-actions.pod:119
6216 " guestfs_add_drive (guestfs_h *g,\n"
6217 " const char *filename);\n"
6222 #: ../src/guestfs-actions.pod:123
6224 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6225 "optional parameters, so the disk is added writable, with the format being "
6226 "detected automatically."
6230 #: ../src/guestfs-actions.pod:127
6232 "Automatic detection of the format opens you up to a potential security hole "
6233 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6234 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6235 "you should think about replacing calls to this function with calls to "
6236 "C<guestfs_add_drive_opts>, and specifying the format."
6240 #: ../src/guestfs-actions.pod:138
6241 msgid "guestfs_add_drive_opts"
6245 #: ../src/guestfs-actions.pod:140
6249 " guestfs_add_drive_opts (guestfs_h *g,\n"
6250 " const char *filename,\n"
6256 #: ../src/guestfs-actions.pod:150
6259 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6260 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6261 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6266 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6268 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6269 "The first time you call this function, the disk appears as C</dev/sda>, the "
6270 "second time as C</dev/sdb>, and so on."
6274 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6276 "You don't necessarily need to be root when using libguestfs. However you "
6277 "obviously do need sufficient permissions to access the filename for whatever "
6278 "operations you want to perform (ie. read access if you just want to read the "
6279 "image or write access if you want to modify the image)."
6283 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6284 msgid "This call checks that C<filename> exists."
6288 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4451
6289 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3016
6290 msgid "The optional arguments are:"
6294 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6296 msgstr "C<readonly>"
6299 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6301 "If true then the image is treated as read-only. Writes are still allowed, "
6302 "but they are stored in a temporary snapshot overlay which is discarded at "
6303 "the end. The disk that you add is not modified."
6307 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6312 #: ../src/guestfs-actions.pod:179
6314 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6315 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6316 "Possible formats include C<raw> and C<qcow2>."
6320 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6322 "Automatic detection of the format opens you up to a potential security hole "
6323 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6324 "RHBZ#642934. Specifying the format closes this security hole."
6328 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6333 #: ../src/guestfs-actions.pod:190
6335 "This rarely-used option lets you emulate the behaviour of the deprecated "
6336 "C<guestfs_add_drive_with_if> call (q.v.)"
6340 #: ../src/guestfs-actions.pod:197
6341 msgid "(Added in 1.5.23)"
6345 #: ../src/guestfs-actions.pod:199
6346 msgid "guestfs_add_drive_opts_va"
6350 #: ../src/guestfs-actions.pod:201
6354 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6355 " const char *filename,\n"
6361 #: ../src/guestfs-actions.pod:206
6362 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6366 #: ../src/guestfs-actions.pod:210
6367 msgid "guestfs_add_drive_opts_argv"
6371 #: ../src/guestfs-actions.pod:212
6375 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6376 " const char *filename,\n"
6377 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6382 #: ../src/guestfs-actions.pod:217
6383 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6387 #: ../src/guestfs-actions.pod:221
6388 msgid "guestfs_add_drive_ro"
6392 #: ../src/guestfs-actions.pod:223
6396 " guestfs_add_drive_ro (guestfs_h *g,\n"
6397 " const char *filename);\n"
6402 #: ../src/guestfs-actions.pod:227
6404 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6405 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6406 "disk is added read-only, with the format being detected automatically."
6410 #: ../src/guestfs-actions.pod:234
6411 msgid "(Added in 1.0.38)"
6415 #: ../src/guestfs-actions.pod:236
6416 msgid "guestfs_add_drive_ro_with_if"
6420 #: ../src/guestfs-actions.pod:238
6424 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6425 " const char *filename,\n"
6426 " const char *iface);\n"
6431 #: ../src/guestfs-actions.pod:243
6433 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6434 "QEMU interface emulation to use at run time."
6438 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6439 #: ../src/guestfs-actions.pod:2353
6440 msgid "(Added in 1.0.84)"
6444 #: ../src/guestfs-actions.pod:257
6445 msgid "guestfs_add_drive_with_if"
6449 #: ../src/guestfs-actions.pod:259
6453 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6454 " const char *filename,\n"
6455 " const char *iface);\n"
6460 #: ../src/guestfs-actions.pod:264
6462 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6463 "QEMU interface emulation to use at run time."
6467 #: ../src/guestfs-actions.pod:278
6468 msgid "guestfs_aug_clear"
6472 #: ../src/guestfs-actions.pod:280
6476 " guestfs_aug_clear (guestfs_h *g,\n"
6477 " const char *augpath);\n"
6482 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6484 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6485 "L<augtool(1)> C<clear> command."
6489 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2103
6490 msgid "(Added in 1.3.4)"
6494 #: ../src/guestfs-actions.pod:291
6495 msgid "guestfs_aug_close"
6499 #: ../src/guestfs-actions.pod:293
6503 " guestfs_aug_close (guestfs_h *g);\n"
6508 #: ../src/guestfs-actions.pod:296
6510 "Close the current Augeas handle and free up any resources used by it. After "
6511 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6512 "any other Augeas functions."
6516 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6517 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6518 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6519 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6520 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6521 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6522 #: ../src/guestfs-actions.pod:5484
6523 msgid "(Added in 0.7)"
6527 #: ../src/guestfs-actions.pod:305
6528 msgid "guestfs_aug_defnode"
6532 #: ../src/guestfs-actions.pod:307
6535 " struct guestfs_int_bool *\n"
6536 " guestfs_aug_defnode (guestfs_h *g,\n"
6537 " const char *name,\n"
6538 " const char *expr,\n"
6539 " const char *val);\n"
6544 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6546 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6550 #: ../src/guestfs-actions.pod:316
6552 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6553 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6554 "containing that single node."
6558 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6560 "On success this returns a pair containing the number of nodes in the "
6561 "nodeset, and a boolean flag if a node was created."
6565 #: ../src/guestfs-actions.pod:324
6567 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6568 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6572 #: ../src/guestfs-actions.pod:330
6573 msgid "guestfs_aug_defvar"
6577 #: ../src/guestfs-actions.pod:332
6581 " guestfs_aug_defvar (guestfs_h *g,\n"
6582 " const char *name,\n"
6583 " const char *expr);\n"
6588 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6590 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6591 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6595 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6597 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6598 "evaluates to something which is not a nodeset."
6602 #: ../src/guestfs-actions.pod:348
6603 msgid "guestfs_aug_get"
6607 #: ../src/guestfs-actions.pod:350
6611 " guestfs_aug_get (guestfs_h *g,\n"
6612 " const char *augpath);\n"
6617 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6619 "Look up the value associated with C<path>. If C<path> matches exactly one "
6620 "node, the C<value> is returned."
6624 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6625 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6626 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6627 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6628 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6629 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1654
6630 #: ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1834
6631 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:1935
6632 #: ../src/guestfs-actions.pod:1956 ../src/guestfs-actions.pod:2126
6633 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2525
6634 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729
6635 #: ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:2869
6636 #: ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2924
6637 #: ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3021
6638 #: ../src/guestfs-actions.pod:3044 ../src/guestfs-actions.pod:3065
6639 #: ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3987
6640 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4267
6641 #: ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5212
6642 #: ../src/guestfs-actions.pod:5382 ../src/guestfs-actions.pod:5560
6643 #: ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:6242
6644 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6275
6645 #: ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6980
6646 #: ../src/guestfs-actions.pod:6999 ../src/guestfs-actions.pod:7017
6647 #: ../src/guestfs-actions.pod:7197 ../src/guestfs-actions.pod:7476
6649 "This function returns a string, or NULL on error. I<The caller must free "
6650 "the returned string after use>."
6654 #: ../src/guestfs-actions.pod:362
6655 msgid "guestfs_aug_init"
6659 #: ../src/guestfs-actions.pod:364
6663 " guestfs_aug_init (guestfs_h *g,\n"
6664 " const char *root,\n"
6670 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6672 "Create a new Augeas handle for editing configuration files. If there was "
6673 "any previous Augeas handle associated with this guestfs session, then it is "
6678 #: ../src/guestfs-actions.pod:373
6679 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6683 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6685 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6689 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6691 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6692 "logical I<or> of the following integers:"
6696 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6697 msgid "C<AUG_SAVE_BACKUP> = 1"
6698 msgstr "C<AUG_SAVE_BACKUP> = 1"
6701 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6702 msgid "Keep the original file with a C<.augsave> extension."
6706 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6707 msgid "C<AUG_SAVE_NEWFILE> = 2"
6708 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6711 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6713 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6714 "original. Overrides C<AUG_SAVE_BACKUP>."
6718 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6719 msgid "C<AUG_TYPE_CHECK> = 4"
6720 msgstr "C<AUG_TYPE_CHECK> = 4"
6723 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6724 msgid "Typecheck lenses (can be expensive)."
6728 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6729 msgid "C<AUG_NO_STDINC> = 8"
6730 msgstr "C<AUG_NO_STDINC> = 8"
6733 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6734 msgid "Do not use standard load path for modules."
6738 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6739 msgid "C<AUG_SAVE_NOOP> = 16"
6740 msgstr "C<AUG_SAVE_NOOP> = 16"
6743 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6744 msgid "Make save a no-op, just record what would have been changed."
6748 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6749 msgid "C<AUG_NO_LOAD> = 32"
6750 msgstr "C<AUG_NO_LOAD> = 32"
6753 #: ../src/guestfs-actions.pod:408
6754 msgid "Do not load the tree in C<guestfs_aug_init>."
6758 #: ../src/guestfs-actions.pod:412
6759 msgid "To close the handle, you can call C<guestfs_aug_close>."
6763 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6764 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6768 #: ../src/guestfs-actions.pod:420
6769 msgid "guestfs_aug_insert"
6773 #: ../src/guestfs-actions.pod:422
6777 " guestfs_aug_insert (guestfs_h *g,\n"
6778 " const char *augpath,\n"
6779 " const char *label,\n"
6785 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6787 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6788 "or after C<path> (depending on the boolean flag C<before>)."
6792 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6794 "C<path> must match exactly one existing node in the tree, and C<label> must "
6795 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6799 #: ../src/guestfs-actions.pod:440
6800 msgid "guestfs_aug_load"
6804 #: ../src/guestfs-actions.pod:442
6808 " guestfs_aug_load (guestfs_h *g);\n"
6813 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6814 msgid "Load files into the tree."
6815 msgstr "Завантажити файли до ієрархії."
6818 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6819 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6823 #: ../src/guestfs-actions.pod:454
6824 msgid "guestfs_aug_ls"
6828 #: ../src/guestfs-actions.pod:456
6832 " guestfs_aug_ls (guestfs_h *g,\n"
6833 " const char *augpath);\n"
6838 #: ../src/guestfs-actions.pod:460
6840 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6841 "sorting the resulting nodes into alphabetical order."
6845 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6846 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6847 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6848 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6849 #: ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:2198
6850 #: ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2233
6851 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:2300
6852 #: ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2420
6853 #: ../src/guestfs-actions.pod:2687 ../src/guestfs-actions.pod:2978
6854 #: ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3557
6855 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3724
6856 #: ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:4834
6857 #: ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5480
6858 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6322
6859 #: ../src/guestfs-actions.pod:6383 ../src/guestfs-actions.pod:6438
6860 #: ../src/guestfs-actions.pod:6584 ../src/guestfs-actions.pod:6608
6861 #: ../src/guestfs-actions.pod:7090 ../src/guestfs-actions.pod:7110
6862 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7329
6863 #: ../src/guestfs-actions.pod:7348 ../src/guestfs-actions.pod:7433
6864 #: ../src/guestfs-actions.pod:7452 ../src/guestfs-actions.pod:7498
6865 #: ../src/guestfs-actions.pod:7517
6867 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6868 ">), or NULL if there was an error. I<The caller must free the strings and "
6869 "the array after use>."
6873 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6874 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6875 #: ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3376
6876 #: ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4020
6877 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4240
6878 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4838
6879 #: ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5690
6880 #: ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5716
6881 #: ../src/guestfs-actions.pod:6163 ../src/guestfs-actions.pod:6822
6882 #: ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:7074
6883 #: ../src/guestfs-actions.pod:7317
6884 msgid "(Added in 0.8)"
6888 #: ../src/guestfs-actions.pod:469
6889 msgid "guestfs_aug_match"
6893 #: ../src/guestfs-actions.pod:471
6897 " guestfs_aug_match (guestfs_h *g,\n"
6898 " const char *augpath);\n"
6903 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6905 "Returns a list of paths which match the path expression C<path>. The "
6906 "returned paths are sufficiently qualified so that they match exactly one "
6907 "node in the current tree."
6911 #: ../src/guestfs-actions.pod:485
6912 msgid "guestfs_aug_mv"
6916 #: ../src/guestfs-actions.pod:487
6920 " guestfs_aug_mv (guestfs_h *g,\n"
6921 " const char *src,\n"
6922 " const char *dest);\n"
6927 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6929 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6930 "C<dest> is overwritten if it exists."
6934 #: ../src/guestfs-actions.pod:499
6935 msgid "guestfs_aug_rm"
6939 #: ../src/guestfs-actions.pod:501
6943 " guestfs_aug_rm (guestfs_h *g,\n"
6944 " const char *augpath);\n"
6949 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6950 msgid "Remove C<path> and all of its children."
6954 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6955 msgid "On success this returns the number of entries which were removed."
6959 #: ../src/guestfs-actions.pod:513
6960 msgid "guestfs_aug_save"
6964 #: ../src/guestfs-actions.pod:515
6968 " guestfs_aug_save (guestfs_h *g);\n"
6973 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6974 msgid "This writes all pending changes to disk."
6978 #: ../src/guestfs-actions.pod:520
6980 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6985 #: ../src/guestfs-actions.pod:527
6986 msgid "guestfs_aug_set"
6990 #: ../src/guestfs-actions.pod:529
6994 " guestfs_aug_set (guestfs_h *g,\n"
6995 " const char *augpath,\n"
6996 " const char *val);\n"
7001 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7002 msgid "Set the value associated with C<path> to C<val>."
7006 #: ../src/guestfs-actions.pod:536
7008 "In the Augeas API, it is possible to clear a node by setting the value to "
7009 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7010 "this call. Instead you must use the C<guestfs_aug_clear> call."
7014 #: ../src/guestfs-actions.pod:545
7015 msgid "guestfs_available"
7019 #: ../src/guestfs-actions.pod:547
7023 " guestfs_available (guestfs_h *g,\n"
7024 " char *const *groups);\n"
7029 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7031 "This command is used to check the availability of some groups of "
7032 "functionality in the appliance, which not all builds of the libguestfs "
7033 "appliance will be able to provide."
7037 #: ../src/guestfs-actions.pod:555
7039 "The libguestfs groups, and the functions that those groups correspond to, "
7040 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7041 "runtime by calling C<guestfs_available_all_groups>."
7045 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7047 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7048 "\"]> would check for the availability of the Linux inotify functions and "
7049 "Augeas (configuration file editing) functions."
7053 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7054 msgid "The command returns no error if I<all> requested groups are available."
7058 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7060 "It fails with an error if one or more of the requested groups is unavailable "
7065 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7067 "If an unknown group name is included in the list of groups then an error is "
7072 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7074 msgstr "I<Нотатки:>"
7077 #: ../src/guestfs-actions.pod:579
7078 msgid "You must call C<guestfs_launch> before calling this function."
7082 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7084 "The reason is because we don't know what groups are supported by the "
7085 "appliance/daemon until it is running and can be queried."
7089 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7091 "If a group of functions is available, this does not necessarily mean that "
7092 "they will work. You still have to check for errors when calling individual "
7093 "API functions even if they are available."
7097 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7099 "It is usually the job of distro packagers to build complete functionality "
7100 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7101 "with all requirements satisfied, will support everything."
7105 #: ../src/guestfs-actions.pod:601
7107 "This call was added in version C<1.0.80>. In previous versions of "
7108 "libguestfs all you could do would be to speculatively execute a command to "
7109 "find out if the daemon implemented it. See also C<guestfs_version>."
7113 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7114 msgid "(Added in 1.0.80)"
7118 #: ../src/guestfs-actions.pod:612
7119 msgid "guestfs_available_all_groups"
7123 #: ../src/guestfs-actions.pod:614
7127 " guestfs_available_all_groups (guestfs_h *g);\n"
7132 #: ../src/guestfs-actions.pod:617
7134 "This command returns a list of all optional groups that this daemon knows "
7135 "about. Note this returns both supported and unsupported groups. To find "
7136 "out which ones the daemon can actually support you have to call "
7137 "C<guestfs_available> on each member of the returned list."
7141 #: ../src/guestfs-actions.pod:623
7142 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7146 #: ../src/guestfs-actions.pod:629
7147 msgid "(Added in 1.3.15)"
7151 #: ../src/guestfs-actions.pod:631
7152 msgid "guestfs_base64_in"
7156 #: ../src/guestfs-actions.pod:633
7160 " guestfs_base64_in (guestfs_h *g,\n"
7161 " const char *base64file,\n"
7162 " const char *filename);\n"
7167 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7169 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7173 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7174 msgid "(Added in 1.3.5)"
7178 #: ../src/guestfs-actions.pod:645
7179 msgid "guestfs_base64_out"
7183 #: ../src/guestfs-actions.pod:647
7187 " guestfs_base64_out (guestfs_h *g,\n"
7188 " const char *filename,\n"
7189 " const char *base64file);\n"
7194 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7196 "This command downloads the contents of C<filename>, writing it out to local "
7197 "file C<base64file> encoded as base64."
7201 #: ../src/guestfs-actions.pod:659
7202 msgid "guestfs_blockdev_flushbufs"
7206 #: ../src/guestfs-actions.pod:661
7210 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7211 " const char *device);\n"
7216 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7218 "This tells the kernel to flush internal buffers associated with C<device>."
7222 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7223 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7224 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7225 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7226 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7227 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7228 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7229 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7230 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7231 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7232 msgid "This uses the L<blockdev(8)> command."
7236 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7237 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7238 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7239 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7240 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7241 msgid "(Added in 0.9.3)"
7245 #: ../src/guestfs-actions.pod:674
7246 msgid "guestfs_blockdev_getbsz"
7250 #: ../src/guestfs-actions.pod:676
7254 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7255 " const char *device);\n"
7260 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7261 msgid "This returns the block size of a device."
7265 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7266 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7268 "(Note this is different from both I<size in blocks> and I<filesystem block "
7273 #: ../src/guestfs-actions.pod:691
7274 msgid "guestfs_blockdev_getro"
7278 #: ../src/guestfs-actions.pod:693
7282 " guestfs_blockdev_getro (guestfs_h *g,\n"
7283 " const char *device);\n"
7288 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7290 "Returns a boolean indicating if the block device is read-only (true if read-"
7291 "only, false if not)."
7295 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7296 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1911
7297 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1994
7298 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2064
7299 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:2112
7300 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
7301 #: ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3284
7302 #: ../src/guestfs-actions.pod:3298 ../src/guestfs-actions.pod:3313
7303 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3343
7304 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3374
7305 #: ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3401
7306 #: ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3430
7307 #: ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:4983
7308 msgid "This function returns a C truth value on success or -1 on error."
7312 #: ../src/guestfs-actions.pod:706
7313 msgid "guestfs_blockdev_getsize64"
7317 #: ../src/guestfs-actions.pod:708
7321 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7322 " const char *device);\n"
7327 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7328 msgid "This returns the size of the device in bytes."
7332 #: ../src/guestfs-actions.pod:714
7333 msgid "See also C<guestfs_blockdev_getsz>."
7337 #: ../src/guestfs-actions.pod:722
7338 msgid "guestfs_blockdev_getss"
7342 #: ../src/guestfs-actions.pod:724
7346 " guestfs_blockdev_getss (guestfs_h *g,\n"
7347 " const char *device);\n"
7352 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7354 "This returns the size of sectors on a block device. Usually 512, but can be "
7355 "larger for modern devices."
7359 #: ../src/guestfs-actions.pod:731
7361 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7366 #: ../src/guestfs-actions.pod:740
7367 msgid "guestfs_blockdev_getsz"
7371 #: ../src/guestfs-actions.pod:742
7375 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7376 " const char *device);\n"
7381 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7383 "This returns the size of the device in units of 512-byte sectors (even if "
7384 "the sectorsize isn't 512 bytes ... weird)."
7388 #: ../src/guestfs-actions.pod:749
7390 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7391 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7395 #: ../src/guestfs-actions.pod:759
7396 msgid "guestfs_blockdev_rereadpt"
7400 #: ../src/guestfs-actions.pod:761
7404 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7405 " const char *device);\n"
7410 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7411 msgid "Reread the partition table on C<device>."
7415 #: ../src/guestfs-actions.pod:773
7416 msgid "guestfs_blockdev_setbsz"
7420 #: ../src/guestfs-actions.pod:775
7424 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7425 " const char *device,\n"
7426 " int blocksize);\n"
7431 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7432 msgid "This sets the block size of a device."
7436 #: ../src/guestfs-actions.pod:791
7437 msgid "guestfs_blockdev_setro"
7441 #: ../src/guestfs-actions.pod:793
7445 " guestfs_blockdev_setro (guestfs_h *g,\n"
7446 " const char *device);\n"
7451 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7452 msgid "Sets the block device named C<device> to read-only."
7456 #: ../src/guestfs-actions.pod:805
7457 msgid "guestfs_blockdev_setrw"
7461 #: ../src/guestfs-actions.pod:807
7465 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7466 " const char *device);\n"
7471 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7472 msgid "Sets the block device named C<device> to read-write."
7476 #: ../src/guestfs-actions.pod:819
7477 msgid "guestfs_case_sensitive_path"
7481 #: ../src/guestfs-actions.pod:821
7485 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7486 " const char *path);\n"
7491 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7493 "This can be used to resolve case insensitive paths on a filesystem which is "
7494 "case sensitive. The use case is to resolve paths which you have read from "
7495 "Windows configuration files or the Windows Registry, to the true path."
7499 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7501 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7502 "(and probably others), which is that although the underlying filesystem is "
7503 "case-insensitive, the driver exports the filesystem to Linux as case-"
7508 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7510 "One consequence of this is that special directories such as C<c:\\windows> "
7511 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7512 "precise details of how they were created. In Windows itself this would not "
7517 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7519 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7524 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7526 "This function resolves the true case of each element in the path and returns "
7527 "the case-sensitive path."
7531 #: ../src/guestfs-actions.pod:847
7533 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7534 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7535 "how the directories were originally created under Windows)."
7539 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7540 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7544 #: ../src/guestfs-actions.pod:855
7545 msgid "See also C<guestfs_realpath>."
7549 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:7002
7550 msgid "(Added in 1.0.75)"
7554 #: ../src/guestfs-actions.pod:862
7559 #: ../src/guestfs-actions.pod:864
7563 " guestfs_cat (guestfs_h *g,\n"
7564 " const char *path);\n"
7569 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5470
7570 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3671
7571 msgid "Return the contents of the file named C<path>."
7575 #: ../src/guestfs-actions.pod:870
7577 "Note that this function cannot correctly handle binary files (specifically, "
7578 "files containing C<\\0> character which is treated as end of string). For "
7579 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7580 "functions which have a more complex interface."
7584 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7585 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7586 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7587 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1760
7588 #: ../src/guestfs-actions.pod:2218 ../src/guestfs-actions.pod:2237
7589 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2304
7590 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2350
7591 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278
7592 #: ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5435
7593 #: ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:6387
7594 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6588
7595 #: ../src/guestfs-actions.pod:6612 ../src/guestfs-actions.pod:7281
7596 #: ../src/guestfs-actions.pod:7307 ../src/guestfs-actions.pod:7333
7597 #: ../src/guestfs-actions.pod:7352 ../src/guestfs-actions.pod:7437
7598 #: ../src/guestfs-actions.pod:7456 ../src/guestfs-actions.pod:7502
7599 #: ../src/guestfs-actions.pod:7521 ../fish/guestfish-actions.pod:587
7600 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7601 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7602 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7603 #: ../fish/guestfish-actions.pod:1189 ../fish/guestfish-actions.pod:1490
7604 #: ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1528
7605 #: ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1553
7606 #: ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:3541
7607 #: ../fish/guestfish-actions.pod:3556 ../fish/guestfish-actions.pod:3632
7608 #: ../fish/guestfish-actions.pod:3649 ../fish/guestfish-actions.pod:3664
7609 #: ../fish/guestfish-actions.pod:4318 ../fish/guestfish-actions.pod:4364
7610 #: ../fish/guestfish-actions.pod:4449 ../fish/guestfish-actions.pod:4464
7611 #: ../fish/guestfish-actions.pod:4874 ../fish/guestfish-actions.pod:4892
7612 #: ../fish/guestfish-actions.pod:4909 ../fish/guestfish-actions.pod:4919
7613 #: ../fish/guestfish-actions.pod:4967 ../fish/guestfish-actions.pod:4977
7614 #: ../fish/guestfish-actions.pod:5006 ../fish/guestfish-actions.pod:5016
7616 "Because of the message protocol, there is a transfer limit of somewhere "
7617 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7621 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3561
7622 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3640
7623 #: ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4133
7624 #: ../src/guestfs-actions.pod:4147 ../src/guestfs-actions.pod:5358
7625 #: ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:7161
7626 #: ../src/guestfs-actions.pod:7175
7627 msgid "(Added in 0.4)"
7631 #: ../src/guestfs-actions.pod:883
7632 msgid "guestfs_checksum"
7636 #: ../src/guestfs-actions.pod:885
7640 " guestfs_checksum (guestfs_h *g,\n"
7641 " const char *csumtype,\n"
7642 " const char *path);\n"
7647 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7649 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7653 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7655 "The type of checksum to compute is given by the C<csumtype> parameter which "
7656 "must have one of the following values:"
7660 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7665 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7667 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7672 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7677 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7678 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7682 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7687 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7688 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7692 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7697 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7698 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7702 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7707 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7708 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7712 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7717 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7718 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7722 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7727 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7728 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7732 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7733 msgid "The checksum is returned as a printable string."
7737 #: ../src/guestfs-actions.pod:931
7738 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7742 #: ../src/guestfs-actions.pod:933
7743 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7747 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7748 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:3300
7749 #: ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3390
7750 #: ../src/guestfs-actions.pod:3417 ../src/guestfs-actions.pod:6858
7751 msgid "(Added in 1.0.2)"
7755 #: ../src/guestfs-actions.pod:940
7756 msgid "guestfs_checksum_device"
7760 #: ../src/guestfs-actions.pod:942
7764 " guestfs_checksum_device (guestfs_h *g,\n"
7765 " const char *csumtype,\n"
7766 " const char *device);\n"
7771 #: ../src/guestfs-actions.pod:947
7773 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7774 "device named C<device>. For the types of checksums supported see the "
7775 "C<guestfs_checksum> command."
7779 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4889
7780 #: ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4985
7781 #: ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5179
7782 #: ../src/guestfs-actions.pod:6767 ../src/guestfs-actions.pod:6781
7783 #: ../src/guestfs-actions.pod:7187
7784 msgid "(Added in 1.3.2)"
7788 #: ../src/guestfs-actions.pod:956
7789 msgid "guestfs_checksums_out"
7793 #: ../src/guestfs-actions.pod:958
7797 " guestfs_checksums_out (guestfs_h *g,\n"
7798 " const char *csumtype,\n"
7799 " const char *directory,\n"
7800 " const char *sumsfile);\n"
7805 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7807 "This command computes the checksums of all regular files in C<directory> and "
7808 "then emits a list of those checksums to the local output file C<sumsfile>."
7812 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7814 "This can be used for verifying the integrity of a virtual machine. However "
7815 "to be properly secure you should pay attention to the output of the checksum "
7816 "command (it uses the ones from GNU coreutils). In particular when the "
7817 "filename is not printable, coreutils uses a special backslash syntax. For "
7818 "more information, see the GNU coreutils info file."
7822 #: ../src/guestfs-actions.pod:978
7823 msgid "(Added in 1.3.7)"
7827 #: ../src/guestfs-actions.pod:980
7828 msgid "guestfs_chmod"
7832 #: ../src/guestfs-actions.pod:982
7836 " guestfs_chmod (guestfs_h *g,\n"
7838 " const char *path);\n"
7843 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7845 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7850 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7852 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7853 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7858 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4384
7859 #: ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4600
7860 #: ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:676
7861 #: ../fish/guestfish-actions.pod:2980 ../fish/guestfish-actions.pod:3109
7862 #: ../fish/guestfish-actions.pod:3119 ../fish/guestfish-actions.pod:3129
7863 msgid "The mode actually set is affected by the umask."
7867 #: ../src/guestfs-actions.pod:1000
7868 msgid "guestfs_chown"
7872 #: ../src/guestfs-actions.pod:1002
7876 " guestfs_chown (guestfs_h *g,\n"
7879 " const char *path);\n"
7884 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7885 msgid "Change the file owner to C<owner> and group to C<group>."
7889 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3492
7890 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2438
7892 "Only numeric uid and gid are supported. If you want to use names, you will "
7893 "need to locate and parse the password file yourself (Augeas support makes "
7894 "this relatively easy)."
7898 #: ../src/guestfs-actions.pod:1018
7899 msgid "guestfs_command"
7903 #: ../src/guestfs-actions.pod:1020
7907 " guestfs_command (guestfs_h *g,\n"
7908 " char *const *arguments);\n"
7913 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7915 "This call runs a command from the guest filesystem. The filesystem must be "
7916 "mounted, and must contain a compatible operating system (ie. something "
7917 "Linux, with the same or compatible processor architecture)."
7921 #: ../src/guestfs-actions.pod:1029
7923 "The single parameter is an argv-style list of arguments. The first element "
7924 "is the name of the program to run. Subsequent elements are parameters. The "
7925 "list must be non-empty (ie. must contain a program name). Note that the "
7926 "command runs directly, and is I<not> invoked via the shell (see "
7931 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7932 msgid "The return value is anything printed to I<stdout> by the command."
7936 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7938 "If the command returns a non-zero exit status, then this function returns an "
7939 "error message. The error message string is the content of I<stderr> from "
7944 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7946 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7947 "bin>. If you require a program from another location, you should provide "
7948 "the full path in the first parameter."
7952 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7954 "Shared libraries and data files required by the program must be available on "
7955 "filesystems which are mounted in the correct places. It is the caller's "
7956 "responsibility to ensure all filesystems that are needed are mounted at the "
7961 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7962 #: ../src/guestfs-actions.pod:1545
7963 msgid "(Added in 0.9.1)"
7967 #: ../src/guestfs-actions.pod:1062
7968 msgid "guestfs_command_lines"
7972 #: ../src/guestfs-actions.pod:1064
7976 " guestfs_command_lines (guestfs_h *g,\n"
7977 " char *const *arguments);\n"
7982 #: ../src/guestfs-actions.pod:1068
7984 "This is the same as C<guestfs_command>, but splits the result into a list of "
7989 #: ../src/guestfs-actions.pod:1071
7990 msgid "See also: C<guestfs_sh_lines>"
7994 #: ../src/guestfs-actions.pod:1082
7995 msgid "guestfs_config"
7999 #: ../src/guestfs-actions.pod:1084
8003 " guestfs_config (guestfs_h *g,\n"
8004 " const char *qemuparam,\n"
8005 " const char *qemuvalue);\n"
8010 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8012 "This can be used to add arbitrary qemu command line parameters of the form "
8013 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8014 "setting some parameters which would interfere with parameters that we use."
8018 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8019 msgid "The first character of C<param> string must be a C<-> (dash)."
8023 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8024 msgid "C<value> can be NULL."
8028 #: ../src/guestfs-actions.pod:1102
8029 msgid "guestfs_copy_size"
8033 #: ../src/guestfs-actions.pod:1104
8037 " guestfs_copy_size (guestfs_h *g,\n"
8038 " const char *src,\n"
8039 " const char *dest,\n"
8045 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8047 "This command copies exactly C<size> bytes from one source device or file "
8048 "C<src> to another destination device or file C<dest>."
8052 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8054 "Note this will fail if the source is too short or if the destination is not "
8059 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8060 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8061 #: ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:1716
8062 #: ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:6853
8063 #: ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:7373
8064 #: ../src/guestfs-actions.pod:7392
8066 "This long-running command can generate progress notification messages so "
8067 "that the caller can display a progress bar or indicator. To receive these "
8068 "messages, the caller must register a progress event callback. See L<guestfs"
8069 "(3)/GUESTFS_EVENT_PROGRESS>."
8073 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4160
8074 #: ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:7094
8075 #: ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7200
8076 msgid "(Added in 1.0.87)"
8080 #: ../src/guestfs-actions.pod:1125
8085 #: ../src/guestfs-actions.pod:1127
8089 " guestfs_cp (guestfs_h *g,\n"
8090 " const char *src,\n"
8091 " const char *dest);\n"
8096 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8098 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8099 "destination filename or destination directory."
8103 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8104 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8105 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4852
8106 #: ../src/guestfs-actions.pod:5229
8107 msgid "(Added in 1.0.18)"
8111 #: ../src/guestfs-actions.pod:1139
8112 msgid "guestfs_cp_a"
8116 #: ../src/guestfs-actions.pod:1141
8120 " guestfs_cp_a (guestfs_h *g,\n"
8121 " const char *src,\n"
8122 " const char *dest);\n"
8127 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8129 "This copies a file or directory from C<src> to C<dest> recursively using the "
8134 #: ../src/guestfs-actions.pod:1153
8139 #: ../src/guestfs-actions.pod:1155
8143 " guestfs_dd (guestfs_h *g,\n"
8144 " const char *src,\n"
8145 " const char *dest);\n"
8150 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8152 "This command copies from one source device or file C<src> to another "
8153 "destination device or file C<dest>. Normally you would use this to copy to "
8154 "or from a device or partition, for example to duplicate a filesystem."
8158 #: ../src/guestfs-actions.pod:1165
8160 "If the destination is a device, it must be as large or larger than the "
8161 "source file or device, otherwise the copy will fail. This command cannot do "
8162 "partial copies (see C<guestfs_copy_size>)."
8166 #: ../src/guestfs-actions.pod:1173
8171 #: ../src/guestfs-actions.pod:1175
8175 " guestfs_df (guestfs_h *g);\n"
8180 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8181 msgid "This command runs the C<df> command to report disk space used."
8185 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8187 "This command is mostly useful for interactive sessions. It is I<not> "
8188 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8193 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8194 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2283
8195 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2375
8196 #: ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4752
8197 #: ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6615
8198 #: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7253
8199 #: ../src/guestfs-actions.pod:7266
8200 msgid "(Added in 1.0.54)"
8204 #: ../src/guestfs-actions.pod:1189
8205 msgid "guestfs_df_h"
8209 #: ../src/guestfs-actions.pod:1191
8213 " guestfs_df_h (guestfs_h *g);\n"
8218 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8220 "This command runs the C<df -h> command to report disk space used in human-"
8225 #: ../src/guestfs-actions.pod:1206
8226 msgid "guestfs_dmesg"
8230 #: ../src/guestfs-actions.pod:1208
8234 " guestfs_dmesg (guestfs_h *g);\n"
8239 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8241 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8242 "This is sometimes useful for extended debugging of problems."
8246 #: ../src/guestfs-actions.pod:1215
8248 "Another way to get the same information is to enable verbose messages with "
8249 "C<guestfs_set_verbose> or by setting the environment variable "
8250 "C<LIBGUESTFS_DEBUG=1> before running the program."
8254 #: ../src/guestfs-actions.pod:1225
8255 msgid "guestfs_download"
8259 #: ../src/guestfs-actions.pod:1227
8263 " guestfs_download (guestfs_h *g,\n"
8264 " const char *remotefilename,\n"
8265 " const char *filename);\n"
8270 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8271 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8273 "Download file C<remotefilename> and save it as C<filename> on the local "
8278 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6847
8279 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4622
8280 msgid "C<filename> can also be a named pipe."
8284 #: ../src/guestfs-actions.pod:1237
8285 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8289 #: ../src/guestfs-actions.pod:1248
8290 msgid "guestfs_download_offset"
8294 #: ../src/guestfs-actions.pod:1250
8298 " guestfs_download_offset (guestfs_h *g,\n"
8299 " const char *remotefilename,\n"
8300 " const char *filename,\n"
8301 " int64_t offset,\n"
8307 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8309 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8310 "region must be within the file or device)."
8314 #: ../src/guestfs-actions.pod:1263
8316 "Note that there is no limit on the amount of data that can be downloaded "
8317 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8318 "full amount unless an error occurs."
8322 #: ../src/guestfs-actions.pod:1268
8323 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8327 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6892
8328 msgid "(Added in 1.5.17)"
8332 #: ../src/guestfs-actions.pod:1279
8333 msgid "guestfs_drop_caches"
8337 #: ../src/guestfs-actions.pod:1281
8341 " guestfs_drop_caches (guestfs_h *g,\n"
8342 " int whattodrop);\n"
8347 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8349 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8350 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8351 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8355 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8356 msgid "Setting C<whattodrop> to 3 should drop everything."
8360 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8362 "This automatically calls L<sync(2)> before the operation, so that the "
8363 "maximum guest memory is freed."
8367 #: ../src/guestfs-actions.pod:1299
8372 #: ../src/guestfs-actions.pod:1301
8376 " guestfs_du (guestfs_h *g,\n"
8377 " const char *path);\n"
8382 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8384 "This command runs the C<du -s> command to estimate file space usage for "
8389 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8391 "C<path> can be a file or a directory. If C<path> is a directory then the "
8392 "estimate includes the contents of the directory and all subdirectories "
8397 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8399 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8403 #: ../src/guestfs-actions.pod:1324
8404 msgid "guestfs_e2fsck_f"
8408 #: ../src/guestfs-actions.pod:1326
8412 " guestfs_e2fsck_f (guestfs_h *g,\n"
8413 " const char *device);\n"
8418 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8420 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8421 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8426 #: ../src/guestfs-actions.pod:1334
8428 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8429 "Normally you should use C<guestfs_fsck>."
8433 #: ../src/guestfs-actions.pod:1339
8434 msgid "(Added in 1.0.29)"
8438 #: ../src/guestfs-actions.pod:1341
8439 msgid "guestfs_echo_daemon"
8443 #: ../src/guestfs-actions.pod:1343
8447 " guestfs_echo_daemon (guestfs_h *g,\n"
8448 " char *const *words);\n"
8453 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8455 "This command concatenates the list of C<words> passed with single spaces "
8456 "between them and returns the resulting string."
8460 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8461 msgid "You can use this command to test the connection through to the daemon."
8465 #: ../src/guestfs-actions.pod:1352
8466 msgid "See also C<guestfs_ping_daemon>."
8470 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2091
8471 #: ../src/guestfs-actions.pod:6063
8472 msgid "(Added in 1.0.69)"
8476 #: ../src/guestfs-actions.pod:1359
8477 msgid "guestfs_egrep"
8481 #: ../src/guestfs-actions.pod:1361
8485 " guestfs_egrep (guestfs_h *g,\n"
8486 " const char *regex,\n"
8487 " const char *path);\n"
8492 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8494 "This calls the external C<egrep> program and returns the matching lines."
8498 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8499 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8500 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2221
8501 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2396
8502 #: ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2424
8503 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2492
8504 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:3653
8505 #: ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3680
8506 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:4680
8507 #: ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5612
8508 #: ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6471
8509 #: ../src/guestfs-actions.pod:6484 ../src/guestfs-actions.pod:6497
8510 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6532
8511 #: ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6558
8512 #: ../src/guestfs-actions.pod:7336 ../src/guestfs-actions.pod:7355
8513 #: ../src/guestfs-actions.pod:7440 ../src/guestfs-actions.pod:7459
8514 #: ../src/guestfs-actions.pod:7505 ../src/guestfs-actions.pod:7524
8515 msgid "(Added in 1.0.66)"
8519 #: ../src/guestfs-actions.pod:1378
8520 msgid "guestfs_egrepi"
8524 #: ../src/guestfs-actions.pod:1380
8528 " guestfs_egrepi (guestfs_h *g,\n"
8529 " const char *regex,\n"
8530 " const char *path);\n"
8535 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8537 "This calls the external C<egrep -i> program and returns the matching lines."
8541 #: ../src/guestfs-actions.pod:1397
8542 msgid "guestfs_equal"
8546 #: ../src/guestfs-actions.pod:1399
8550 " guestfs_equal (guestfs_h *g,\n"
8551 " const char *file1,\n"
8552 " const char *file2);\n"
8557 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8559 "This compares the two files C<file1> and C<file2> and returns true if their "
8560 "content is exactly equal, or false otherwise."
8564 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8565 msgid "The external L<cmp(1)> program is used for the comparison."
8569 #: ../src/guestfs-actions.pod:1413
8570 msgid "guestfs_exists"
8574 #: ../src/guestfs-actions.pod:1415
8578 " guestfs_exists (guestfs_h *g,\n"
8579 " const char *path);\n"
8584 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8586 "This returns C<true> if and only if there is a file, directory (or anything) "
8587 "with the given C<path> name."
8591 #: ../src/guestfs-actions.pod:1422
8592 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8596 #: ../src/guestfs-actions.pod:1428
8597 msgid "guestfs_fallocate"
8601 #: ../src/guestfs-actions.pod:1430
8605 " guestfs_fallocate (guestfs_h *g,\n"
8606 " const char *path,\n"
8612 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8613 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8615 "This command preallocates a file (containing zero bytes) named C<path> of "
8616 "size C<len> bytes. If the file exists already, it is overwritten."
8620 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8622 "Do not confuse this with the guestfish-specific C<alloc> command which "
8623 "allocates a file in the host and attaches it as a device."
8627 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8629 "This function is deprecated. In new code, use the C<fallocate64> call "
8634 #: ../src/guestfs-actions.pod:1454
8635 msgid "guestfs_fallocate64"
8639 #: ../src/guestfs-actions.pod:1456
8643 " guestfs_fallocate64 (guestfs_h *g,\n"
8644 " const char *path,\n"
8650 #: ../src/guestfs-actions.pod:1465
8652 "Note that this call allocates disk blocks for the file. To create a sparse "
8653 "file use C<guestfs_truncate_size> instead."
8657 #: ../src/guestfs-actions.pod:1468
8659 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8660 "oversight it only allowed 30 bit lengths to be specified, effectively "
8661 "limiting the maximum size of files created through that call to 1GB."
8665 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8667 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8668 "commands which create a file in the host and attach it as a device."
8672 #: ../src/guestfs-actions.pod:1479
8673 msgid "(Added in 1.3.17)"
8677 #: ../src/guestfs-actions.pod:1481
8678 msgid "guestfs_fgrep"
8682 #: ../src/guestfs-actions.pod:1483
8686 " guestfs_fgrep (guestfs_h *g,\n"
8687 " const char *pattern,\n"
8688 " const char *path);\n"
8693 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8695 "This calls the external C<fgrep> program and returns the matching lines."
8699 #: ../src/guestfs-actions.pod:1500
8700 msgid "guestfs_fgrepi"
8704 #: ../src/guestfs-actions.pod:1502
8708 " guestfs_fgrepi (guestfs_h *g,\n"
8709 " const char *pattern,\n"
8710 " const char *path);\n"
8715 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8717 "This calls the external C<fgrep -i> program and returns the matching lines."
8721 #: ../src/guestfs-actions.pod:1519
8722 msgid "guestfs_file"
8726 #: ../src/guestfs-actions.pod:1521
8730 " guestfs_file (guestfs_h *g,\n"
8731 " const char *path);\n"
8736 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8738 "This call uses the standard L<file(1)> command to determine the type or "
8739 "contents of the file."
8743 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8745 "This call will also transparently look inside various types of compressed "
8750 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8752 "The exact command which runs is C<file -zb path>. Note in particular that "
8753 "the filename is not prepended to the output (the I<-b> option)."
8757 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1014
8759 "The output depends on the output of the underlying L<file(1)> command and it "
8760 "can change in future in ways beyond our control. In other words, the output "
8761 "is not guaranteed by the ABI."
8765 #: ../src/guestfs-actions.pod:1539
8767 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8768 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8772 #: ../src/guestfs-actions.pod:1547
8773 msgid "guestfs_file_architecture"
8777 #: ../src/guestfs-actions.pod:1549
8781 " guestfs_file_architecture (guestfs_h *g,\n"
8782 " const char *filename);\n"
8787 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1025
8789 "This detects the architecture of the binary C<filename>, and returns it if "
8794 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8795 msgid "Currently defined architectures are:"
8799 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1032
8804 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1034
8806 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8807 "irrespective of the precise processor requirements of the binary."
8811 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8816 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
8817 msgid "64 bit x86-64."
8821 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1041
8826 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1043
8827 msgid "32 bit SPARC."
8831 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1045
8836 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1047
8837 msgid "64 bit SPARC V9 and above."
8841 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1049
8846 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1051
8847 msgid "Intel Itanium."
8848 msgstr "Intel Itanium."
8851 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1053
8856 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1055
8857 msgid "32 bit Power PC."
8861 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1057
8866 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1059
8867 msgid "64 bit Power PC."
8871 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1063
8872 msgid "Libguestfs may return other architecture strings in future."
8876 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1065
8877 msgid "The function works on at least the following types of files:"
8881 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1071
8882 msgid "many types of Un*x and Linux binary"
8886 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1075
8887 msgid "many types of Un*x and Linux shared library"
8891 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1079
8892 msgid "Windows Win32 and Win64 binaries"
8896 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1083
8897 msgid "Windows Win32 and Win64 DLLs"
8901 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1085
8902 msgid "Win32 binaries and DLLs return C<i386>."
8906 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1087
8907 msgid "Win64 binaries and DLLs return C<x86_64>."
8911 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1091
8912 msgid "Linux kernel modules"
8916 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1095
8917 msgid "Linux new-style initrd images"
8921 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1099
8922 msgid "some non-x86 Linux vmlinuz kernels"
8926 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1103
8927 msgid "What it can't do currently:"
8931 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1109
8932 msgid "static libraries (libfoo.a)"
8936 #: ../src/guestfs-actions.pod:1641 ../fish/guestfish-actions.pod:1113
8937 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8941 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1117
8942 msgid "x86 Linux vmlinuz kernels"
8946 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1119
8948 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8949 "compressed code, and are horribly hard to unpack. If you want to find the "
8950 "architecture of a kernel, use the architecture of the associated initrd or "
8951 "kernel module(s) instead."
8955 #: ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820
8956 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:2528
8957 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2691
8958 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2800
8959 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2927
8960 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3271
8961 #: ../src/guestfs-actions.pod:3403
8962 msgid "(Added in 1.5.3)"
8966 #: ../src/guestfs-actions.pod:1659
8967 msgid "guestfs_filesize"
8971 #: ../src/guestfs-actions.pod:1661
8975 " guestfs_filesize (guestfs_h *g,\n"
8976 " const char *file);\n"
8981 #: ../src/guestfs-actions.pod:1665 ../fish/guestfish-actions.pod:1130
8982 msgid "This command returns the size of C<file> in bytes."
8986 #: ../src/guestfs-actions.pod:1667
8988 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8989 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8990 "devices, use C<guestfs_blockdev_getsize64>."
8994 #: ../src/guestfs-actions.pod:1673
8995 msgid "(Added in 1.0.82)"
8999 #: ../src/guestfs-actions.pod:1675
9000 msgid "guestfs_fill"
9004 #: ../src/guestfs-actions.pod:1677
9008 " guestfs_fill (guestfs_h *g,\n"
9011 " const char *path);\n"
9016 #: ../src/guestfs-actions.pod:1683 ../fish/guestfish-actions.pod:1140
9018 "This command creates a new file called C<path>. The initial content of the "
9019 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9024 #: ../src/guestfs-actions.pod:1687
9026 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9027 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9028 "bytes use C<guestfs_fill_pattern>."
9032 #: ../src/guestfs-actions.pod:1699
9033 msgid "(Added in 1.0.79)"
9037 #: ../src/guestfs-actions.pod:1701
9038 msgid "guestfs_fill_pattern"
9042 #: ../src/guestfs-actions.pod:1703
9046 " guestfs_fill_pattern (guestfs_h *g,\n"
9047 " const char *pattern,\n"
9049 " const char *path);\n"
9054 #: ../src/guestfs-actions.pod:1709
9056 "This function is like C<guestfs_fill> except that it creates a new file of "
9057 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9058 "pattern is truncated if necessary to ensure the length of the file is "
9059 "exactly C<len> bytes."
9063 #: ../src/guestfs-actions.pod:1721
9064 msgid "(Added in 1.3.12)"
9068 #: ../src/guestfs-actions.pod:1723
9069 msgid "guestfs_find"
9073 #: ../src/guestfs-actions.pod:1725
9077 " guestfs_find (guestfs_h *g,\n"
9078 " const char *directory);\n"
9083 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1162
9085 "This command lists out all files and directories, recursively, starting at "
9086 "C<directory>. It is essentially equivalent to running the shell command "
9087 "C<find directory -print> but some post-processing happens on the output, "
9092 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9094 "This returns a list of strings I<without any prefix>. Thus if the directory "
9099 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9109 #: ../src/guestfs-actions.pod:1741
9111 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9115 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1177
9126 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
9127 msgid "If C<directory> is not a directory, then this command returns an error."
9131 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9132 msgid "The returned list is sorted."
9136 #: ../src/guestfs-actions.pod:1754
9137 msgid "See also C<guestfs_find0>."
9141 #: ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:4097
9142 #: ../src/guestfs-actions.pod:5647
9143 msgid "(Added in 1.0.27)"
9147 #: ../src/guestfs-actions.pod:1765
9148 msgid "guestfs_find0"
9152 #: ../src/guestfs-actions.pod:1767
9156 " guestfs_find0 (guestfs_h *g,\n"
9157 " const char *directory,\n"
9158 " const char *files);\n"
9163 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1196
9165 "This command lists out all files and directories, recursively, starting at "
9166 "C<directory>, placing the resulting list in the external file called "
9171 #: ../src/guestfs-actions.pod:1776
9173 "This command works the same way as C<guestfs_find> with the following "
9178 #: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1207
9179 msgid "The resulting list is written to an external file."
9183 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1211
9185 "Items (filenames) in the result are separated by C<\\0> characters. See "
9186 "L<find(1)> option I<-print0>."
9190 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
9191 msgid "This command is not limited in the number of names that it can return."
9195 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
9196 msgid "The result list is not sorted."
9200 #: ../src/guestfs-actions.pod:1803
9201 msgid "(Added in 1.0.74)"
9205 #: ../src/guestfs-actions.pod:1805
9206 msgid "guestfs_findfs_label"
9210 #: ../src/guestfs-actions.pod:1807
9214 " guestfs_findfs_label (guestfs_h *g,\n"
9215 " const char *label);\n"
9220 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1231
9222 "This command searches the filesystems and returns the one which has the "
9223 "given label. An error is returned if no such filesystem can be found."
9227 #: ../src/guestfs-actions.pod:1815
9228 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9232 #: ../src/guestfs-actions.pod:1822
9233 msgid "guestfs_findfs_uuid"
9237 #: ../src/guestfs-actions.pod:1824
9241 " guestfs_findfs_uuid (guestfs_h *g,\n"
9242 " const char *uuid);\n"
9247 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1241
9249 "This command searches the filesystems and returns the one which has the "
9250 "given UUID. An error is returned if no such filesystem can be found."
9254 #: ../src/guestfs-actions.pod:1832
9255 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9259 #: ../src/guestfs-actions.pod:1839
9260 msgid "guestfs_fsck"
9264 #: ../src/guestfs-actions.pod:1841
9268 " guestfs_fsck (guestfs_h *g,\n"
9269 " const char *fstype,\n"
9270 " const char *device);\n"
9275 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1251
9277 "This runs the filesystem checker (fsck) on C<device> which should have "
9278 "filesystem type C<fstype>."
9282 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9284 "The returned integer is the status. See L<fsck(8)> for the list of status "
9285 "codes from C<fsck>."
9289 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1263
9290 msgid "Multiple status codes can be summed together."
9294 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1267
9296 "A non-zero return code can mean \"success\", for example if errors have been "
9297 "corrected on the filesystem."
9301 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
9302 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9306 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
9308 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9312 #: ../src/guestfs-actions.pod:1876 ../src/guestfs-actions.pod:7378
9313 msgid "(Added in 1.0.16)"
9317 #: ../src/guestfs-actions.pod:1878
9318 msgid "guestfs_get_append"
9322 #: ../src/guestfs-actions.pod:1880
9326 " guestfs_get_append (guestfs_h *g);\n"
9331 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1283
9333 "Return the additional kernel options which are added to the guest kernel "
9338 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9339 msgid "If C<NULL> then no options are added."
9343 #: ../src/guestfs-actions.pod:1888
9345 "This function returns a string which may be NULL. There is no way to return "
9346 "an error from this function. The string is owned by the guest handle and "
9347 "must I<not> be freed."
9351 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:5325
9352 #: ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:6226
9353 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:6261
9354 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:7042
9355 #: ../src/guestfs-actions.pod:7060 ../src/guestfs-actions.pod:7421
9356 msgid "(Added in 1.0.26)"
9360 #: ../src/guestfs-actions.pod:1894
9361 msgid "guestfs_get_attach_method"
9365 #: ../src/guestfs-actions.pod:1896
9369 " guestfs_get_attach_method (guestfs_h *g);\n"
9374 #: ../src/guestfs-actions.pod:1899
9375 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9379 #: ../src/guestfs-actions.pod:1904
9380 msgid "guestfs_get_autosync"
9384 #: ../src/guestfs-actions.pod:1906
9388 " guestfs_get_autosync (guestfs_h *g);\n"
9393 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1298
9394 msgid "Get the autosync flag."
9398 #: ../src/guestfs-actions.pod:1915
9399 msgid "guestfs_get_direct"
9403 #: ../src/guestfs-actions.pod:1917
9407 " guestfs_get_direct (guestfs_h *g);\n"
9412 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1304
9413 msgid "Return the direct appliance mode flag."
9417 #: ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:5874
9418 msgid "(Added in 1.0.72)"
9422 #: ../src/guestfs-actions.pod:1926
9423 msgid "guestfs_get_e2label"
9427 #: ../src/guestfs-actions.pod:1928
9431 " guestfs_get_e2label (guestfs_h *g,\n"
9432 " const char *device);\n"
9437 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1310
9439 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9443 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1313
9445 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9449 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:1966
9450 #: ../src/guestfs-actions.pod:5892 ../src/guestfs-actions.pod:5911
9451 msgid "(Added in 1.0.15)"
9455 #: ../src/guestfs-actions.pod:1947
9456 msgid "guestfs_get_e2uuid"
9460 #: ../src/guestfs-actions.pod:1949
9464 " guestfs_get_e2uuid (guestfs_h *g,\n"
9465 " const char *device);\n"
9470 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1324
9472 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9476 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1327
9478 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9482 #: ../src/guestfs-actions.pod:1968
9483 msgid "guestfs_get_memsize"
9487 #: ../src/guestfs-actions.pod:1970
9491 " guestfs_get_memsize (guestfs_h *g);\n"
9496 #: ../src/guestfs-actions.pod:1973 ../fish/guestfish-actions.pod:1338
9498 "This gets the memory size in megabytes allocated to the qemu subprocess."
9502 #: ../src/guestfs-actions.pod:1976
9504 "If C<guestfs_set_memsize> was not called on this handle, and if "
9505 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9506 "value for memsize."
9510 #: ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2061
9511 #: ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:6034
9512 #: ../fish/guestfish-actions.pod:1345 ../fish/guestfish-actions.pod:1396
9513 #: ../fish/guestfish-actions.pod:3997 ../fish/guestfish-actions.pod:4084
9515 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9519 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:4388
9520 #: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4604
9521 #: ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4635
9522 #: ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4665
9523 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5932
9524 #: ../src/guestfs-actions.pod:6193 ../src/guestfs-actions.pod:6808
9525 msgid "(Added in 1.0.55)"
9529 #: ../src/guestfs-actions.pod:1987
9530 msgid "guestfs_get_network"
9534 #: ../src/guestfs-actions.pod:1989
9538 " guestfs_get_network (guestfs_h *g);\n"
9543 #: ../src/guestfs-actions.pod:1992 ../fish/guestfish-actions.pod:1352
9544 msgid "This returns the enable network flag."
9548 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:5951
9549 msgid "(Added in 1.5.4)"
9553 #: ../src/guestfs-actions.pod:1998
9554 msgid "guestfs_get_path"
9558 #: ../src/guestfs-actions.pod:2000
9562 " guestfs_get_path (guestfs_h *g);\n"
9567 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1358
9568 msgid "Return the current search path."
9572 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1360
9574 "This is always non-NULL. If it wasn't set already, then this will return "
9579 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2037
9581 "This function returns a string, or NULL on error. The string is owned by "
9582 "the guest handle and must I<not> be freed."
9586 #: ../src/guestfs-actions.pod:2013
9587 msgid "guestfs_get_pid"
9591 #: ../src/guestfs-actions.pod:2015
9595 " guestfs_get_pid (guestfs_h *g);\n"
9600 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1369
9602 "Return the process ID of the qemu subprocess. If there is no qemu "
9603 "subprocess, then this will return an error."
9607 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9608 msgid "This is an internal call used for debugging and testing."
9612 #: ../src/guestfs-actions.pod:2025
9613 msgid "(Added in 1.0.56)"
9617 #: ../src/guestfs-actions.pod:2027
9618 msgid "guestfs_get_qemu"
9622 #: ../src/guestfs-actions.pod:2029
9626 " guestfs_get_qemu (guestfs_h *g);\n"
9631 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1378
9632 msgid "Return the current qemu binary."
9636 #: ../src/guestfs-actions.pod:2034 ../fish/guestfish-actions.pod:1380
9638 "This is always non-NULL. If it wasn't set already, then this will return "
9639 "the default qemu binary name."
9643 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:5996
9644 msgid "(Added in 1.0.6)"
9648 #: ../src/guestfs-actions.pod:2042
9649 msgid "guestfs_get_recovery_proc"
9653 #: ../src/guestfs-actions.pod:2044
9657 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9662 #: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1387
9663 msgid "Return the recovery process enabled flag."
9667 #: ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:3498
9668 #: ../src/guestfs-actions.pod:3795 ../src/guestfs-actions.pod:4195
9669 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5255
9670 #: ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:6020
9671 #: ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6731
9672 #: ../src/guestfs-actions.pod:6923
9673 msgid "(Added in 1.0.77)"
9677 #: ../src/guestfs-actions.pod:2053
9678 msgid "guestfs_get_selinux"
9682 #: ../src/guestfs-actions.pod:2055
9686 " guestfs_get_selinux (guestfs_h *g);\n"
9691 #: ../src/guestfs-actions.pod:2058
9693 "This returns the current setting of the selinux flag which is passed to the "
9694 "appliance at boot time. See C<guestfs_set_selinux>."
9698 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2129
9699 #: ../src/guestfs-actions.pod:6039 ../src/guestfs-actions.pod:6097
9700 msgid "(Added in 1.0.67)"
9704 #: ../src/guestfs-actions.pod:2068
9705 msgid "guestfs_get_state"
9709 #: ../src/guestfs-actions.pod:2070
9713 " guestfs_get_state (guestfs_h *g);\n"
9718 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1403
9720 "This returns the current state as an opaque integer. This is only useful "
9721 "for printing debug and internal error messages."
9725 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:3296
9726 #: ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3386
9727 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:1406
9728 #: ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2338
9729 #: ../fish/guestfish-actions.pod:2376 ../fish/guestfish-actions.pod:2392
9730 msgid "For more information on states, see L<guestfs(3)>."
9734 #: ../src/guestfs-actions.pod:2082
9735 msgid "guestfs_get_trace"
9739 #: ../src/guestfs-actions.pod:2084
9743 " guestfs_get_trace (guestfs_h *g);\n"
9748 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
9749 msgid "Return the command trace flag."
9753 #: ../src/guestfs-actions.pod:2093
9754 msgid "guestfs_get_umask"
9758 #: ../src/guestfs-actions.pod:2095
9762 " guestfs_get_umask (guestfs_h *g);\n"
9767 #: ../src/guestfs-actions.pod:2098
9769 "Return the current umask. By default the umask is C<022> unless it has been "
9770 "set by calling C<guestfs_umask>."
9774 #: ../src/guestfs-actions.pod:2105
9775 msgid "guestfs_get_verbose"
9779 #: ../src/guestfs-actions.pod:2107
9783 " guestfs_get_verbose (guestfs_h *g);\n"
9788 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1425
9789 msgid "This returns the verbose messages flag."
9793 #: ../src/guestfs-actions.pod:2116
9794 msgid "guestfs_getcon"
9798 #: ../src/guestfs-actions.pod:2118
9802 " guestfs_getcon (guestfs_h *g);\n"
9807 #: ../src/guestfs-actions.pod:2121 ../fish/guestfish-actions.pod:1431
9808 msgid "This gets the SELinux security context of the daemon."
9812 #: ../src/guestfs-actions.pod:2123
9814 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9818 #: ../src/guestfs-actions.pod:2131
9819 msgid "guestfs_getxattr"
9823 #: ../src/guestfs-actions.pod:2133
9827 " guestfs_getxattr (guestfs_h *g,\n"
9828 " const char *path,\n"
9829 " const char *name,\n"
9830 " size_t *size_r);\n"
9835 #: ../src/guestfs-actions.pod:2139
9837 "Get a single extended attribute from file C<path> named C<name>. This call "
9838 "follows symlinks. If you want to lookup an extended attribute for the "
9839 "symlink itself, use C<guestfs_lgetxattr>."
9843 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:3512
9845 "Normally it is better to get all extended attributes from a file in one go "
9846 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9847 "implementations are buggy and do not provide a way to list out attributes. "
9848 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9849 "extended attributes you want in advance and call this function."
9853 #: ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:3519
9854 #: ../fish/guestfish-actions.pod:1451 ../fish/guestfish-actions.pod:2457
9856 "Extended attribute values are blobs of binary data. If there is no extended "
9857 "attribute named C<name>, this returns an error."
9861 #: ../src/guestfs-actions.pod:2153
9862 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9866 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:2346
9867 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:5248
9868 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5455
9870 "This function returns a buffer, or NULL on error. The size of the returned "
9871 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9876 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
9877 msgid "(Added in 1.7.24)"
9881 #: ../src/guestfs-actions.pod:2161
9882 msgid "guestfs_getxattrs"
9886 #: ../src/guestfs-actions.pod:2163
9889 " struct guestfs_xattr_list *\n"
9890 " guestfs_getxattrs (guestfs_h *g,\n"
9891 " const char *path);\n"
9896 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1460
9898 "This call lists the extended attributes of the file or directory C<path>."
9902 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9904 "At the system call level, this is a combination of the L<listxattr(2)> and "
9905 "L<getxattr(2)> calls."
9909 #: ../src/guestfs-actions.pod:2173
9910 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9914 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:3540
9915 #: ../src/guestfs-actions.pod:4191
9917 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9918 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9922 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:3544
9923 #: ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3745
9924 #: ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:6116
9925 #: ../src/guestfs-actions.pod:7486
9926 msgid "(Added in 1.0.59)"
9930 #: ../src/guestfs-actions.pod:2181
9931 msgid "guestfs_glob_expand"
9935 #: ../src/guestfs-actions.pod:2183
9939 " guestfs_glob_expand (guestfs_h *g,\n"
9940 " const char *pattern);\n"
9945 #: ../src/guestfs-actions.pod:2187 ../fish/guestfish-actions.pod:1472
9947 "This command searches for all the pathnames matching C<pattern> according to "
9948 "the wildcard expansion rules used by the shell."
9952 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1476
9954 "If no paths match, then this returns an empty list (note: not an error)."
9958 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9960 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9961 "GLOB_BRACE>. See that manual page for more details."
9965 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:6309
9966 #: ../src/guestfs-actions.pod:6326
9967 msgid "(Added in 1.0.50)"
9971 #: ../src/guestfs-actions.pod:2204
9972 msgid "guestfs_grep"
9976 #: ../src/guestfs-actions.pod:2206
9980 " guestfs_grep (guestfs_h *g,\n"
9981 " const char *regex,\n"
9982 " const char *path);\n"
9987 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1487
9988 msgid "This calls the external C<grep> program and returns the matching lines."
9992 #: ../src/guestfs-actions.pod:2223
9993 msgid "guestfs_grepi"
9997 #: ../src/guestfs-actions.pod:2225
10001 " guestfs_grepi (guestfs_h *g,\n"
10002 " const char *regex,\n"
10003 " const char *path);\n"
10008 #: ../src/guestfs-actions.pod:2230 ../fish/guestfish-actions.pod:1497
10010 "This calls the external C<grep -i> program and returns the matching lines."
10014 #: ../src/guestfs-actions.pod:2242
10015 msgid "guestfs_grub_install"
10019 #: ../src/guestfs-actions.pod:2244
10023 " guestfs_grub_install (guestfs_h *g,\n"
10024 " const char *root,\n"
10025 " const char *device);\n"
10030 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1507
10032 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10033 "the root directory being C<root>."
10037 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10039 "Note: If grub-install reports the error \"No suitable drive was found in the "
10040 "generated device map.\" it may be that you need to create a C</boot/grub/"
10041 "device.map> file first that contains the mapping between grub device names "
10042 "and Linux device names. It is usually sufficient to create a file "
10047 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1517
10050 " (hd0) /dev/vda\n"
10055 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1519
10056 msgid "replacing C</dev/vda> with the name of the installation device."
10060 #: ../src/guestfs-actions.pod:2265
10061 msgid "(Added in 1.0.17)"
10065 #: ../src/guestfs-actions.pod:2267
10066 msgid "guestfs_head"
10070 #: ../src/guestfs-actions.pod:2269
10074 " guestfs_head (guestfs_h *g,\n"
10075 " const char *path);\n"
10080 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1525
10082 "This command returns up to the first 10 lines of a file as a list of strings."
10086 #: ../src/guestfs-actions.pod:2285
10087 msgid "guestfs_head_n"
10091 #: ../src/guestfs-actions.pod:2287
10095 " guestfs_head_n (guestfs_h *g,\n"
10097 " const char *path);\n"
10102 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1535
10104 "If the parameter C<nrlines> is a positive number, this returns the first "
10105 "C<nrlines> lines of the file C<path>."
10109 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10111 "If the parameter C<nrlines> is a negative number, this returns lines from "
10112 "the file C<path>, excluding the last C<nrlines> lines."
10116 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:6606
10117 #: ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:4462
10118 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10122 #: ../src/guestfs-actions.pod:2309
10123 msgid "guestfs_hexdump"
10127 #: ../src/guestfs-actions.pod:2311
10131 " guestfs_hexdump (guestfs_h *g,\n"
10132 " const char *path);\n"
10137 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1550
10139 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10140 "readable, canonical hex dump of the file."
10144 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:6390
10145 #: ../src/guestfs-actions.pod:6445
10146 msgid "(Added in 1.0.22)"
10150 #: ../src/guestfs-actions.pod:2326
10151 msgid "guestfs_initrd_cat"
10155 #: ../src/guestfs-actions.pod:2328
10159 " guestfs_initrd_cat (guestfs_h *g,\n"
10160 " const char *initrdpath,\n"
10161 " const char *filename,\n"
10162 " size_t *size_r);\n"
10167 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1560
10169 "This command unpacks the file C<filename> from the initrd file called "
10170 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10175 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1564
10177 "For example, in guestfish you could use the following command to examine the "
10178 "boot script (usually called C</init>) contained in a Linux initrd or "
10183 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1568
10186 " initrd-cat /boot/initrd-<version>.img init\n"
10191 #: ../src/guestfs-actions.pod:2344
10192 msgid "See also C<guestfs_initrd_list>."
10196 #: ../src/guestfs-actions.pod:2355
10197 msgid "guestfs_initrd_list"
10201 #: ../src/guestfs-actions.pod:2357
10205 " guestfs_initrd_list (guestfs_h *g,\n"
10206 " const char *path);\n"
10211 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1579
10212 msgid "This command lists out files contained in an initrd."
10216 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1581
10218 "The files are listed without any initial C</> character. The files are "
10219 "listed in the order they appear (not necessarily alphabetical). Directory "
10220 "names are listed as separate items."
10224 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1585
10226 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10227 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10232 #: ../src/guestfs-actions.pod:2377
10233 msgid "guestfs_inotify_add_watch"
10237 #: ../src/guestfs-actions.pod:2379
10241 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10242 " const char *path,\n"
10248 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1593
10249 msgid "Watch C<path> for the events listed in C<mask>."
10253 #: ../src/guestfs-actions.pod:2386 ../fish/guestfish-actions.pod:1595
10255 "Note that if C<path> is a directory then events within that directory are "
10256 "watched, but this does I<not> happen recursively (in subdirectories)."
10260 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1599
10262 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10263 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10267 #: ../src/guestfs-actions.pod:2398
10268 msgid "guestfs_inotify_close"
10272 #: ../src/guestfs-actions.pod:2400
10276 " guestfs_inotify_close (guestfs_h *g);\n"
10281 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1607
10283 "This closes the inotify handle which was previously opened by inotify_init. "
10284 "It removes all watches, throws away any pending events, and deallocates all "
10289 #: ../src/guestfs-actions.pod:2411
10290 msgid "guestfs_inotify_files"
10294 #: ../src/guestfs-actions.pod:2413
10298 " guestfs_inotify_files (guestfs_h *g);\n"
10303 #: ../src/guestfs-actions.pod:2416
10305 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10306 "returns a list of pathnames of objects that were touched. The returned "
10307 "pathnames are sorted and deduplicated."
10311 #: ../src/guestfs-actions.pod:2426
10312 msgid "guestfs_inotify_init"
10316 #: ../src/guestfs-actions.pod:2428
10320 " guestfs_inotify_init (guestfs_h *g,\n"
10321 " int maxevents);\n"
10326 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1623
10328 "This command creates a new inotify handle. The inotify subsystem can be "
10329 "used to notify events which happen to objects in the guest filesystem."
10333 #: ../src/guestfs-actions.pod:2436
10335 "C<maxevents> is the maximum number of events which will be queued up between "
10336 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10337 "passed as C<0>, then the kernel (or previously set) default is used. For "
10338 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10339 "throws away events, but records the fact that it threw them away by setting "
10340 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10341 "C<guestfs_inotify_read>)."
10345 #: ../src/guestfs-actions.pod:2446
10347 "Before any events are generated, you have to add some watches to the "
10348 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10349 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10353 #: ../src/guestfs-actions.pod:2452
10355 "Queued up events should be read periodically by calling "
10356 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10357 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10358 "often enough then you risk the internal queue overflowing."
10362 #: ../src/guestfs-actions.pod:2459
10364 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10365 "This also removes any watches automatically."
10369 #: ../src/guestfs-actions.pod:2463 ../fish/guestfish-actions.pod:1654
10371 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10372 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10373 "that there is one global inotify handle per libguestfs instance."
10377 #: ../src/guestfs-actions.pod:2472
10378 msgid "guestfs_inotify_read"
10382 #: ../src/guestfs-actions.pod:2474
10385 " struct guestfs_inotify_event_list *\n"
10386 " guestfs_inotify_read (guestfs_h *g);\n"
10391 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1663
10393 "Return the complete queue of events that have happened since the previous "
10398 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10399 msgid "If no events have happened, this returns an empty list."
10403 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
10405 "I<Note>: In order to make sure that all events have been read, you must call "
10406 "this function repeatedly until it returns an empty list. The reason is that "
10407 "the call will read events up to the maximum appliance-to-host message size "
10408 "and leave remaining events in the queue."
10412 #: ../src/guestfs-actions.pod:2488
10414 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10415 "there was an error. I<The caller must call "
10416 "C<guestfs_free_inotify_event_list> after use>."
10420 #: ../src/guestfs-actions.pod:2494
10421 msgid "guestfs_inotify_rm_watch"
10425 #: ../src/guestfs-actions.pod:2496
10429 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10435 #: ../src/guestfs-actions.pod:2500
10437 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10441 #: ../src/guestfs-actions.pod:2507
10442 msgid "guestfs_inspect_get_arch"
10446 #: ../src/guestfs-actions.pod:2509
10450 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10451 " const char *root);\n"
10456 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2536
10457 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2673
10458 #: ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2738
10459 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:2787
10460 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2851
10461 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2911
10462 #: ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2990
10463 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3053
10464 #: ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3093
10465 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3129
10467 "This function should only be called with a root device string as returned by "
10468 "C<guestfs_inspect_os>."
10472 #: ../src/guestfs-actions.pod:2516
10474 "This returns the architecture of the inspected operating system. The "
10475 "possible return values are listed under C<guestfs_file_architecture>."
10479 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1692
10481 "If the architecture could not be determined, then the string C<unknown> is "
10486 #: ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2616
10487 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2747
10488 #: ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2867
10489 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:2922
10490 #: ../src/guestfs-actions.pod:2976 ../src/guestfs-actions.pod:3019
10491 #: ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063
10492 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3100
10493 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3222
10494 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:1695
10495 #: ../fish/guestfish-actions.pod:1781 ../fish/guestfish-actions.pod:1869
10496 #: ../fish/guestfish-actions.pod:1884 ../fish/guestfish-actions.pod:1905
10497 #: ../fish/guestfish-actions.pod:1975 ../fish/guestfish-actions.pod:1999
10498 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2059
10499 #: ../fish/guestfish-actions.pod:2094 ../fish/guestfish-actions.pod:2110
10500 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2139
10501 #: ../fish/guestfish-actions.pod:2152 ../fish/guestfish-actions.pod:2167
10502 #: ../fish/guestfish-actions.pod:2266 ../fish/guestfish-actions.pod:2300
10503 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10507 #: ../src/guestfs-actions.pod:2530
10508 msgid "guestfs_inspect_get_distro"
10512 #: ../src/guestfs-actions.pod:2532
10516 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10517 " const char *root);\n"
10522 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1704
10524 "This returns the distro (distribution) of the inspected operating system."
10528 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10529 msgid "Currently defined distros are:"
10533 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1711
10534 msgid "\"archlinux\""
10535 msgstr "\"archlinux\""
10538 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1713
10539 msgid "Arch Linux."
10540 msgstr "Arch Linux."
10543 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1715
10545 #| msgid "\"gentoo\""
10547 msgstr "\"gentoo\""
10550 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1717
10555 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1719
10557 msgstr "\"debian\""
10560 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1721
10565 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1723
10567 msgstr "\"fedora\""
10570 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1725
10575 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1727
10577 msgstr "\"gentoo\""
10580 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1729
10585 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1731
10586 msgid "\"linuxmint\""
10587 msgstr "\"linuxmint\""
10590 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1733
10591 msgid "Linux Mint."
10592 msgstr "Linux Mint."
10595 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1735
10596 msgid "\"mandriva\""
10597 msgstr "\"mandriva\""
10600 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1737
10605 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1739
10610 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1741
10615 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1743
10617 msgstr "\"pardus\""
10620 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1745
10625 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1747
10626 msgid "\"redhat-based\""
10627 msgstr "\"redhat-based\""
10630 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1749
10631 msgid "Some Red Hat-derived distro."
10632 msgstr "Дистрибутив, що походить від Red Hat."
10635 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1751
10640 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1753
10642 #| msgid "Red Hat Enterprise Linux and some derivatives."
10643 msgid "Red Hat Enterprise Linux."
10644 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10647 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1755
10648 msgid "\"scientificlinux\""
10652 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1757
10653 msgid "Scientific Linux."
10657 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1759
10658 msgid "\"slackware\""
10662 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1761
10667 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1763
10669 msgstr "\"ubuntu\""
10672 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1765
10677 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2718
10678 #: ../src/guestfs-actions.pod:3010 ../fish/guestfish-actions.pod:1767
10679 #: ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:2085
10680 msgid "\"unknown\""
10681 msgstr "\"unknown\""
10684 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1769
10685 msgid "The distro could not be determined."
10686 msgstr "Дистрибутив, тип якого не вдалося визначити."
10689 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3002
10690 #: ../fish/guestfish-actions.pod:1771 ../fish/guestfish-actions.pod:2077
10691 msgid "\"windows\""
10692 msgstr "\"windows\""
10695 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1773
10697 "Windows does not have distributions. This string is returned if the OS type "
10702 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
10703 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:1778
10704 #: ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:2091
10706 "Future versions of libguestfs may return other strings here. The caller "
10707 "should be prepared to handle any string."
10711 #: ../src/guestfs-actions.pod:2623
10712 msgid "guestfs_inspect_get_drive_mappings"
10716 #: ../src/guestfs-actions.pod:2625
10720 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10721 " const char *root);\n"
10726 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
10728 "This call is useful for Windows which uses a primitive system of assigning "
10729 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10730 "Windows Registry to find out how disks/partitions are mapped to drive "
10731 "letters, and returns a hash table as in the example below:"
10735 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1796
10738 " C => /dev/vda2\n"
10739 " E => /dev/vdb1\n"
10740 " F => /dev/vdc1\n"
10745 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1800
10747 "Note that keys are drive letters. For Windows, the key is case insensitive "
10748 "and just contains the drive letter, without the customary colon separator "
10753 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10755 "In future we may support other operating systems that also used drive "
10756 "letters, but the keys for those might not be case insensitive and might be "
10757 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10762 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
10764 "For Windows guests, currently only hard drive mappings are returned. "
10765 "Removable disks (eg. DVD-ROMs) are ignored."
10769 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
10771 "For guests that do not use drive mappings, or if the drive mappings could "
10772 "not be determined, this returns an empty hash table."
10776 #: ../src/guestfs-actions.pod:2657
10778 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10779 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10783 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2837
10784 #: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:4814
10785 #: ../src/guestfs-actions.pod:6747
10787 "This function returns a NULL-terminated array of strings, or NULL if there "
10788 "was an error. The array of strings will always have length C<2n+1>, where "
10789 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10790 "caller must free the strings and the array after use>."
10794 #: ../src/guestfs-actions.pod:2667
10795 msgid "guestfs_inspect_get_filesystems"
10799 #: ../src/guestfs-actions.pod:2669
10803 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10804 " const char *root);\n"
10809 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10811 "This returns a list of all the filesystems that we think are associated with "
10812 "this operating system. This includes the root filesystem, other ordinary "
10813 "filesystems, and non-mounted devices like swap partitions."
10817 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
10819 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10820 "to be shared between operating systems."
10824 #: ../src/guestfs-actions.pod:2684
10826 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10827 "C<guestfs_inspect_get_mountpoints>."
10831 #: ../src/guestfs-actions.pod:2693
10832 msgid "guestfs_inspect_get_format"
10836 #: ../src/guestfs-actions.pod:2695
10840 " guestfs_inspect_get_format (guestfs_h *g,\n"
10841 " const char *root);\n"
10846 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1844
10848 "This returns the format of the inspected operating system. You can use it "
10849 "to detect install images, live CDs and similar."
10853 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
10854 msgid "Currently defined formats are:"
10858 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1851
10859 msgid "\"installed\""
10860 msgstr "\"installed\""
10863 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1853
10864 msgid "This is an installed operating system."
10865 msgstr "Це встановлена операційна система."
10868 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1855
10869 msgid "\"installer\""
10873 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10875 "The disk image being inspected is not an installed operating system, but a "
10876 "I<bootable> install disk, live CD, or similar."
10880 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
10881 msgid "The format of this disk image is not known."
10885 #: ../src/guestfs-actions.pod:2732
10886 msgid "guestfs_inspect_get_hostname"
10890 #: ../src/guestfs-actions.pod:2734
10894 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10895 " const char *root);\n"
10900 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1878
10902 "This function returns the hostname of the operating system as found by "
10903 "inspection of the guest's configuration files."
10907 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
10909 "If the hostname could not be determined, then the string C<unknown> is "
10914 #: ../src/guestfs-actions.pod:2752
10915 msgid "(Added in 1.7.9)"
10919 #: ../src/guestfs-actions.pod:2754
10920 msgid "guestfs_inspect_get_major_version"
10924 #: ../src/guestfs-actions.pod:2756
10928 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10929 " const char *root);\n"
10934 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1893
10936 "This returns the major version number of the inspected operating system."
10940 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
10942 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10943 "popular public names used by the operating system. Notably the operating "
10944 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10945 "1). You can find out the real versions corresponding to releases of Windows "
10946 "by consulting Wikipedia or MSDN."
10950 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2793
10951 #: ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1917
10952 msgid "If the version could not be determined, then C<0> is returned."
10956 #: ../src/guestfs-actions.pod:2781
10957 msgid "guestfs_inspect_get_minor_version"
10961 #: ../src/guestfs-actions.pod:2783
10965 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10966 " const char *root);\n"
10971 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1914
10973 "This returns the minor version number of the inspected operating system."
10977 #: ../src/guestfs-actions.pod:2795
10979 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10980 "C<guestfs_inspect_get_major_version>."
10984 #: ../src/guestfs-actions.pod:2802
10985 msgid "guestfs_inspect_get_mountpoints"
10989 #: ../src/guestfs-actions.pod:2804
10993 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10994 " const char *root);\n"
10999 #: ../src/guestfs-actions.pod:2811 ../fish/guestfish-actions.pod:1929
11001 "This returns a hash of where we think the filesystems associated with this "
11002 "operating system should be mounted. Callers should note that this is at "
11003 "best an educated guess made by reading configuration files such as C</etc/"
11004 "fstab>. I<In particular note> that this may return filesystems which are "
11005 "non-existent or not mountable and callers should be prepared to handle or "
11006 "ignore failures if they try to mount them."
11010 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
11012 "Each element in the returned hashtable has a key which is the path of the "
11013 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11014 "mounted there (eg. C</dev/sda1>)."
11018 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
11020 "Non-mounted devices such as swap devices are I<not> returned in this list."
11024 #: ../src/guestfs-actions.pod:2828
11026 "For operating systems like Windows which still use drive letters, this call "
11027 "will only return an entry for the first drive \"mounted on\" C</>. For "
11028 "information about the mapping of drive letters to partitions, see "
11029 "C<guestfs_inspect_get_drive_mappings>."
11033 #: ../src/guestfs-actions.pod:2834
11035 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11036 "C<guestfs_inspect_get_filesystems>."
11040 #: ../src/guestfs-actions.pod:2845
11041 msgid "guestfs_inspect_get_package_format"
11045 #: ../src/guestfs-actions.pod:2847
11049 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11050 " const char *root);\n"
11055 #: ../src/guestfs-actions.pod:2854
11057 "This function and C<guestfs_inspect_get_package_management> return the "
11058 "package format and package management tool used by the inspected operating "
11059 "system. For example for Fedora these functions would return C<rpm> (package "
11060 "format) and C<yum> (package management)."
11064 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1968
11066 "This returns the string C<unknown> if we could not determine the package "
11067 "format I<or> if the operating system does not have a real packaging system "
11072 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1972
11074 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11075 "Future versions of libguestfs may return other strings."
11079 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903
11080 msgid "(Added in 1.7.5)"
11084 #: ../src/guestfs-actions.pod:2874
11085 msgid "guestfs_inspect_get_package_management"
11089 #: ../src/guestfs-actions.pod:2876
11093 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11094 " const char *root);\n"
11099 #: ../src/guestfs-actions.pod:2883
11101 "C<guestfs_inspect_get_package_format> and this function return the package "
11102 "format and package management tool used by the inspected operating system. "
11103 "For example for Fedora these functions would return C<rpm> (package format) "
11104 "and C<yum> (package management)."
11108 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1990
11110 "This returns the string C<unknown> if we could not determine the package "
11111 "management tool I<or> if the operating system does not have a real packaging "
11112 "system (eg. Windows)."
11116 #: ../src/guestfs-actions.pod:2893 ../fish/guestfish-actions.pod:1994
11118 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11119 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11120 "libguestfs may return other strings."
11124 #: ../src/guestfs-actions.pod:2905
11125 msgid "guestfs_inspect_get_product_name"
11129 #: ../src/guestfs-actions.pod:2907
11133 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11134 " const char *root);\n"
11139 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
11141 "This returns the product name of the inspected operating system. The "
11142 "product name is generally some freeform string which can be displayed to the "
11143 "user, but should not be parsed by programs."
11147 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
11149 "If the product name could not be determined, then the string C<unknown> is "
11154 #: ../src/guestfs-actions.pod:2929
11155 msgid "guestfs_inspect_get_product_variant"
11159 #: ../src/guestfs-actions.pod:2931
11163 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11164 " const char *root);\n"
11169 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2025
11171 #| msgid "This is an installed operating system."
11172 msgid "This returns the product variant of the inspected operating system."
11173 msgstr "Це встановлена операційна система."
11176 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
11178 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11179 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11180 "is usually a string such as C<Client> or C<Server> (other values are "
11181 "possible). This can be used to distinguish consumer and enterprise versions "
11182 "of Windows that have the same version number (for example, Windows 7 and "
11183 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11184 "the latter is C<Server>)."
11188 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2037
11190 "For enterprise Linux guests, in future we intend this to return the product "
11191 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11192 "implemented at present."
11196 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2041
11198 "If the product variant could not be determined, then the string C<unknown> "
11203 #: ../src/guestfs-actions.pod:2957
11205 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11206 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11210 #: ../src/guestfs-actions.pod:2964
11211 msgid "guestfs_inspect_get_roots"
11215 #: ../src/guestfs-actions.pod:2966
11219 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11224 #: ../src/guestfs-actions.pod:2969
11226 "This function is a convenient way to get the list of root devices, as "
11227 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11228 "the whole inspection process."
11232 #: ../src/guestfs-actions.pod:2973
11234 "This returns an empty list if either no root devices were found or the "
11235 "caller has not called C<guestfs_inspect_os>."
11239 #: ../src/guestfs-actions.pod:2982
11240 msgid "(Added in 1.7.3)"
11244 #: ../src/guestfs-actions.pod:2984
11245 msgid "guestfs_inspect_get_type"
11249 #: ../src/guestfs-actions.pod:2986
11253 " guestfs_inspect_get_type (guestfs_h *g,\n"
11254 " const char *root);\n"
11259 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
11261 "This returns the type of the inspected operating system. Currently defined "
11266 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
11271 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2075
11272 msgid "Any Linux-based operating system."
11276 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2079
11277 msgid "Any Microsoft Windows operating system."
11281 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2081
11282 msgid "\"freebsd\""
11283 msgstr "\"freebsd\""
11286 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2083
11291 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2087
11292 msgid "The operating system type could not be determined."
11296 #: ../src/guestfs-actions.pod:3026
11297 msgid "guestfs_inspect_get_windows_current_control_set"
11301 #: ../src/guestfs-actions.pod:3028
11305 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11306 " const char *root);\n"
11311 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2103
11313 "This returns the Windows CurrentControlSet of the inspected guest. The "
11314 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11318 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
11320 "This call assumes that the guest is Windows and that the Registry could be "
11321 "examined by inspection. If this is not the case then an error is returned."
11325 #: ../src/guestfs-actions.pod:3047
11326 msgid "guestfs_inspect_get_windows_systemroot"
11330 #: ../src/guestfs-actions.pod:3049
11334 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11335 " const char *root);\n"
11340 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2119
11342 "This returns the Windows systemroot of the inspected guest. The systemroot "
11343 "is a directory path such as C</WINDOWS>."
11347 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
11349 "This call assumes that the guest is Windows and that the systemroot could be "
11350 "determined by inspection. If this is not the case then an error is returned."
11354 #: ../src/guestfs-actions.pod:3068
11355 msgid "(Added in 1.5.25)"
11359 #: ../src/guestfs-actions.pod:3070
11360 msgid "guestfs_inspect_is_live"
11364 #: ../src/guestfs-actions.pod:3072
11368 " guestfs_inspect_is_live (guestfs_h *g,\n"
11369 " const char *root);\n"
11374 #: ../src/guestfs-actions.pod:3079
11376 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11377 "disk), then this returns true if a live image was detected on the disk."
11381 #: ../src/guestfs-actions.pod:3087
11382 msgid "guestfs_inspect_is_multipart"
11386 #: ../src/guestfs-actions.pod:3089
11390 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11391 " const char *root);\n"
11396 #: ../src/guestfs-actions.pod:3096
11398 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11399 "disk), then this returns true if the disk is part of a set."
11403 #: ../src/guestfs-actions.pod:3104
11404 msgid "guestfs_inspect_is_netinst"
11408 #: ../src/guestfs-actions.pod:3106
11412 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11413 " const char *root);\n"
11418 #: ../src/guestfs-actions.pod:3113
11420 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11421 "disk), then this returns true if the disk is a network installer, ie. not a "
11422 "self-contained install CD but one which is likely to require network access "
11423 "to complete the install."
11427 #: ../src/guestfs-actions.pod:3123
11428 msgid "guestfs_inspect_list_applications"
11432 #: ../src/guestfs-actions.pod:3125
11435 " struct guestfs_application_list *\n"
11436 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11437 " const char *root);\n"
11442 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2176
11443 msgid "Return the list of applications installed in the operating system."
11447 #: ../src/guestfs-actions.pod:3134
11449 "I<Note:> This call works differently from other parts of the inspection "
11450 "API. You have to call C<guestfs_inspect_os>, then "
11451 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11452 "this. Listing applications is a significantly more difficult operation "
11453 "which requires access to the full filesystem. Also note that unlike the "
11454 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11455 "the libguestfs handle, this call actually reads parts of the mounted "
11456 "filesystems during the call."
11460 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2188
11462 "This returns an empty list if the inspection code was not able to determine "
11463 "the list of applications."
11467 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
11468 msgid "The application structure contains the following fields:"
11472 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
11473 msgid "C<app_name>"
11474 msgstr "C<app_name>"
11477 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
11479 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11480 "guests, this is the package name."
11484 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11485 msgid "C<app_display_name>"
11486 msgstr "C<app_display_name>"
11489 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
11491 "The display name of the application, sometimes localized to the install "
11492 "language of the guest operating system."
11496 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11498 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11499 "to display something can use C<app_name> instead."
11503 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11504 msgid "C<app_epoch>"
11505 msgstr "C<app_epoch>"
11508 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11510 "For package managers which use epochs, this contains the epoch of the "
11511 "package (an integer). If unavailable, this is returned as C<0>."
11515 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11516 msgid "C<app_version>"
11517 msgstr "C<app_version>"
11520 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11522 "The version string of the application or package. If unavailable this is "
11523 "returned as an empty string C<\"\">."
11527 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11528 msgid "C<app_release>"
11529 msgstr "C<app_release>"
11532 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
11534 "The release string of the application or package, for package managers that "
11535 "use this. If unavailable this is returned as an empty string C<\"\">."
11539 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2224
11540 msgid "C<app_install_path>"
11541 msgstr "C<app_install_path>"
11544 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
11546 "The installation path of the application (on operating systems such as "
11547 "Windows which use installation paths). This path is in the format used by "
11548 "the guest operating system, it is not a libguestfs path."
11552 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
11553 msgid "If unavailable this is returned as an empty string C<\"\">."
11557 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
11558 msgid "C<app_trans_path>"
11559 msgstr "C<app_trans_path>"
11562 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11564 "The install path translated into a libguestfs path. If unavailable this is "
11565 "returned as an empty string C<\"\">."
11569 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11570 msgid "C<app_publisher>"
11571 msgstr "C<app_publisher>"
11574 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
11576 "The name of the publisher of the application, for package managers that use "
11577 "this. If unavailable this is returned as an empty string C<\"\">."
11581 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
11583 msgstr "C<app_url>"
11586 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
11588 "The URL (eg. upstream URL) of the application. If unavailable this is "
11589 "returned as an empty string C<\"\">."
11593 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11594 msgid "C<app_source_package>"
11598 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11600 "For packaging systems which support this, the name of the source package. "
11601 "If unavailable this is returned as an empty string C<\"\">."
11605 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11606 msgid "C<app_summary>"
11610 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11612 "A short (usually one line) description of the application or package. If "
11613 "unavailable this is returned as an empty string C<\"\">."
11617 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11618 msgid "C<app_description>"
11622 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
11624 "A longer description of the application or package. If unavailable this is "
11625 "returned as an empty string C<\"\">."
11629 #: ../src/guestfs-actions.pod:3224
11631 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11632 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11637 #: ../src/guestfs-actions.pod:3228
11638 msgid "(Added in 1.7.8)"
11642 #: ../src/guestfs-actions.pod:3230
11643 msgid "guestfs_inspect_os"
11647 #: ../src/guestfs-actions.pod:3232
11651 " guestfs_inspect_os (guestfs_h *g);\n"
11656 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2272
11658 "This function uses other libguestfs functions and certain heuristics to "
11659 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11660 "for operating systems."
11664 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2276
11665 msgid "The list returned is empty if no operating systems were found."
11669 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2278
11671 "If one operating system was found, then this returns a list with a single "
11672 "element, which is the name of the root filesystem of this operating system. "
11673 "It is also possible for this function to return a list containing more than "
11674 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11675 "element being the root filesystem of one of the operating systems."
11679 #: ../src/guestfs-actions.pod:3248
11681 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11682 "functions in order to query further information about each operating system, "
11683 "such as the name and version."
11687 #: ../src/guestfs-actions.pod:3253
11689 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11690 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11691 "the contents. This should be called with no disks currently mounted. The "
11692 "function may also use Augeas, so any existing Augeas handle will be closed."
11696 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2296
11698 "This function cannot decrypt encrypted disks. The caller must do that first "
11699 "(supplying the necessary keys) if the disk is encrypted."
11703 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3555
11704 #: ../src/guestfs-actions.pod:3617
11705 msgid "See also C<guestfs_list_filesystems>."
11709 #: ../src/guestfs-actions.pod:3273
11710 msgid "guestfs_is_blockdev"
11714 #: ../src/guestfs-actions.pod:3275
11718 " guestfs_is_blockdev (guestfs_h *g,\n"
11719 " const char *path);\n"
11724 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2308
11726 "This returns C<true> if and only if there is a block device with the given "
11731 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3311
11732 #: ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:3356
11733 #: ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3428
11734 #: ../src/guestfs-actions.pod:3443
11735 msgid "See also C<guestfs_stat>."
11739 #: ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:3315
11740 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3432
11741 #: ../src/guestfs-actions.pod:3447
11742 msgid "(Added in 1.5.10)"
11746 #: ../src/guestfs-actions.pod:3288
11747 msgid "guestfs_is_busy"
11751 #: ../src/guestfs-actions.pod:3290
11755 " guestfs_is_busy (guestfs_h *g);\n"
11760 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2317
11762 "This returns true iff this handle is busy processing a command (in the "
11767 #: ../src/guestfs-actions.pod:3302
11768 msgid "guestfs_is_chardev"
11772 #: ../src/guestfs-actions.pod:3304
11776 " guestfs_is_chardev (guestfs_h *g,\n"
11777 " const char *path);\n"
11782 #: ../src/guestfs-actions.pod:3308 ../fish/guestfish-actions.pod:2326
11784 "This returns C<true> if and only if there is a character device with the "
11785 "given C<path> name."
11789 #: ../src/guestfs-actions.pod:3317
11790 msgid "guestfs_is_config"
11794 #: ../src/guestfs-actions.pod:3319
11798 " guestfs_is_config (guestfs_h *g);\n"
11803 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2335
11805 "This returns true iff this handle is being configured (in the C<CONFIG> "
11810 #: ../src/guestfs-actions.pod:3331
11811 msgid "guestfs_is_dir"
11815 #: ../src/guestfs-actions.pod:3333
11819 " guestfs_is_dir (guestfs_h *g,\n"
11820 " const char *path);\n"
11825 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2344
11827 "This returns C<true> if and only if there is a directory with the given "
11828 "C<path> name. Note that it returns false for other objects like files."
11832 #: ../src/guestfs-actions.pod:3347
11833 msgid "guestfs_is_fifo"
11837 #: ../src/guestfs-actions.pod:3349
11841 " guestfs_is_fifo (guestfs_h *g,\n"
11842 " const char *path);\n"
11847 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2354
11849 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11850 "given C<path> name."
11854 #: ../src/guestfs-actions.pod:3362
11855 msgid "guestfs_is_file"
11859 #: ../src/guestfs-actions.pod:3364
11863 " guestfs_is_file (guestfs_h *g,\n"
11864 " const char *path);\n"
11869 #: ../src/guestfs-actions.pod:3368 ../fish/guestfish-actions.pod:2363
11871 "This returns C<true> if and only if there is a regular file with the given "
11872 "C<path> name. Note that it returns false for other objects like directories."
11876 #: ../src/guestfs-actions.pod:3378
11877 msgid "guestfs_is_launching"
11881 #: ../src/guestfs-actions.pod:3380
11885 " guestfs_is_launching (guestfs_h *g);\n"
11890 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2373
11892 "This returns true iff this handle is launching the subprocess (in the "
11893 "C<LAUNCHING> state)."
11897 #: ../src/guestfs-actions.pod:3392
11898 msgid "guestfs_is_lv"
11902 #: ../src/guestfs-actions.pod:3394
11906 " guestfs_is_lv (guestfs_h *g,\n"
11907 " const char *device);\n"
11912 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2382
11914 "This command tests whether C<device> is a logical volume, and returns true "
11915 "iff this is the case."
11919 #: ../src/guestfs-actions.pod:3405
11920 msgid "guestfs_is_ready"
11924 #: ../src/guestfs-actions.pod:3407
11928 " guestfs_is_ready (guestfs_h *g);\n"
11933 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2389
11935 "This returns true iff this handle is ready to accept commands (in the "
11940 #: ../src/guestfs-actions.pod:3419
11941 msgid "guestfs_is_socket"
11945 #: ../src/guestfs-actions.pod:3421
11949 " guestfs_is_socket (guestfs_h *g,\n"
11950 " const char *path);\n"
11955 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2398
11957 "This returns C<true> if and only if there is a Unix domain socket with the "
11958 "given C<path> name."
11962 #: ../src/guestfs-actions.pod:3434
11963 msgid "guestfs_is_symlink"
11967 #: ../src/guestfs-actions.pod:3436
11971 " guestfs_is_symlink (guestfs_h *g,\n"
11972 " const char *path);\n"
11977 #: ../src/guestfs-actions.pod:3440 ../fish/guestfish-actions.pod:2407
11979 "This returns C<true> if and only if there is a symbolic link with the given "
11984 #: ../src/guestfs-actions.pod:3449
11985 msgid "guestfs_kill_subprocess"
11989 #: ../src/guestfs-actions.pod:3451
11993 " guestfs_kill_subprocess (guestfs_h *g);\n"
11998 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2416
11999 msgid "This kills the qemu subprocess. You should never need to call this."
12003 #: ../src/guestfs-actions.pod:3460
12004 msgid "guestfs_launch"
12008 #: ../src/guestfs-actions.pod:3462
12012 " guestfs_launch (guestfs_h *g);\n"
12017 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2424
12019 "Internally libguestfs is implemented by running a virtual machine using "
12024 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
12026 "You should call this after configuring the handle (eg. adding drives) but "
12027 "before performing any actions."
12031 #: ../src/guestfs-actions.pod:3480
12032 msgid "guestfs_lchown"
12036 #: ../src/guestfs-actions.pod:3482
12040 " guestfs_lchown (guestfs_h *g,\n"
12043 " const char *path);\n"
12048 #: ../src/guestfs-actions.pod:3488
12050 "Change the file owner to C<owner> and group to C<group>. This is like "
12051 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12052 "changed, not the target."
12056 #: ../src/guestfs-actions.pod:3500
12057 msgid "guestfs_lgetxattr"
12061 #: ../src/guestfs-actions.pod:3502
12065 " guestfs_lgetxattr (guestfs_h *g,\n"
12066 " const char *path,\n"
12067 " const char *name,\n"
12068 " size_t *size_r);\n"
12073 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2446
12075 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12076 "is a symlink, then this call returns an extended attribute from the symlink."
12080 #: ../src/guestfs-actions.pod:3522
12081 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12085 #: ../src/guestfs-actions.pod:3530
12086 msgid "guestfs_lgetxattrs"
12090 #: ../src/guestfs-actions.pod:3532
12093 " struct guestfs_xattr_list *\n"
12094 " guestfs_lgetxattrs (guestfs_h *g,\n"
12095 " const char *path);\n"
12100 #: ../src/guestfs-actions.pod:3536
12102 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12103 "then it returns the extended attributes of the link itself."
12107 #: ../src/guestfs-actions.pod:3546
12108 msgid "guestfs_list_devices"
12112 #: ../src/guestfs-actions.pod:3548
12116 " guestfs_list_devices (guestfs_h *g);\n"
12121 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2474
12122 msgid "List all the block devices."
12126 #: ../src/guestfs-actions.pod:3553 ../fish/guestfish-actions.pod:2476
12127 msgid "The full block device names are returned, eg. C</dev/sda>."
12131 #: ../src/guestfs-actions.pod:3563
12132 msgid "guestfs_list_filesystems"
12136 #: ../src/guestfs-actions.pod:3565
12140 " guestfs_list_filesystems (guestfs_h *g);\n"
12145 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2484
12147 "This inspection command looks for filesystems on partitions, block devices "
12148 "and logical volumes, returning a list of devices containing filesystems and "
12153 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2488
12155 "The return value is a hash, where the keys are the devices containing "
12156 "filesystems, and the values are the filesystem types. For example:"
12160 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
12163 " \"/dev/sda1\" => \"ntfs\"\n"
12164 " \"/dev/sda2\" => \"ext2\"\n"
12165 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12166 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12171 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
12173 "The value can have the special value \"unknown\", meaning the content of the "
12174 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12178 #: ../src/guestfs-actions.pod:3585
12180 "This command runs other libguestfs commands, which might include "
12181 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12182 "soon after launch and only when nothing is mounted."
12186 #: ../src/guestfs-actions.pod:3589
12188 "Not all of the filesystems returned will be mountable. In particular, swap "
12189 "partitions are returned in the list. Also this command does not check that "
12190 "each filesystem found is valid and mountable, and some filesystems might be "
12191 "mountable but require special options. Filesystems may not all belong to a "
12192 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12196 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:5215
12197 msgid "(Added in 1.5.15)"
12201 #: ../src/guestfs-actions.pod:3605
12202 msgid "guestfs_list_partitions"
12206 #: ../src/guestfs-actions.pod:3607
12210 " guestfs_list_partitions (guestfs_h *g);\n"
12215 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2517
12216 msgid "List all the partitions detected on all block devices."
12220 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2519
12221 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12225 #: ../src/guestfs-actions.pod:3614
12227 "This does not return logical volumes. For that you will need to call "
12232 #: ../src/guestfs-actions.pod:3625
12237 #: ../src/guestfs-actions.pod:3627
12241 " guestfs_ll (guestfs_h *g,\n"
12242 " const char *directory);\n"
12247 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2530
12249 "List the files in C<directory> (relative to the root directory, there is no "
12250 "cwd) in the format of 'ls -la'."
12254 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
12256 "This command is mostly useful for interactive sessions. It is I<not> "
12257 "intended that you try to parse the output string."
12261 #: ../src/guestfs-actions.pod:3642
12266 #: ../src/guestfs-actions.pod:3644
12270 " guestfs_ln (guestfs_h *g,\n"
12271 " const char *target,\n"
12272 " const char *linkname);\n"
12277 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2540
12278 msgid "This command creates a hard link using the C<ln> command."
12282 #: ../src/guestfs-actions.pod:3655
12283 msgid "guestfs_ln_f"
12287 #: ../src/guestfs-actions.pod:3657
12291 " guestfs_ln_f (guestfs_h *g,\n"
12292 " const char *target,\n"
12293 " const char *linkname);\n"
12298 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2546
12300 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12301 "option removes the link (C<linkname>) if it exists already."
12305 #: ../src/guestfs-actions.pod:3669
12306 msgid "guestfs_ln_s"
12310 #: ../src/guestfs-actions.pod:3671
12314 " guestfs_ln_s (guestfs_h *g,\n"
12315 " const char *target,\n"
12316 " const char *linkname);\n"
12321 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2553
12322 msgid "This command creates a symbolic link using the C<ln -s> command."
12326 #: ../src/guestfs-actions.pod:3682
12327 msgid "guestfs_ln_sf"
12331 #: ../src/guestfs-actions.pod:3684
12335 " guestfs_ln_sf (guestfs_h *g,\n"
12336 " const char *target,\n"
12337 " const char *linkname);\n"
12342 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2559
12344 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12345 "option removes the link (C<linkname>) if it exists already."
12349 #: ../src/guestfs-actions.pod:3696
12350 msgid "guestfs_lremovexattr"
12354 #: ../src/guestfs-actions.pod:3698
12358 " guestfs_lremovexattr (guestfs_h *g,\n"
12359 " const char *xattr,\n"
12360 " const char *path);\n"
12365 #: ../src/guestfs-actions.pod:3703
12367 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12368 "link, then it removes an extended attribute of the link itself."
12372 #: ../src/guestfs-actions.pod:3711
12377 #: ../src/guestfs-actions.pod:3713
12381 " guestfs_ls (guestfs_h *g,\n"
12382 " const char *directory);\n"
12387 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2574
12389 "List the files in C<directory> (relative to the root directory, there is no "
12390 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12394 #: ../src/guestfs-actions.pod:3721
12396 "This command is mostly useful for interactive sessions. Programs should "
12397 "probably use C<guestfs_readdir> instead."
12401 #: ../src/guestfs-actions.pod:3730
12402 msgid "guestfs_lsetxattr"
12406 #: ../src/guestfs-actions.pod:3732
12410 " guestfs_lsetxattr (guestfs_h *g,\n"
12411 " const char *xattr,\n"
12412 " const char *val,\n"
12414 " const char *path);\n"
12419 #: ../src/guestfs-actions.pod:3739
12421 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12422 "then it sets an extended attribute of the link itself."
12426 #: ../src/guestfs-actions.pod:3747
12427 msgid "guestfs_lstat"
12431 #: ../src/guestfs-actions.pod:3749
12434 " struct guestfs_stat *\n"
12435 " guestfs_lstat (guestfs_h *g,\n"
12436 " const char *path);\n"
12441 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:6346
12442 #: ../fish/guestfish-actions.pod:2593 ../fish/guestfish-actions.pod:4297
12443 msgid "Returns file information for the given C<path>."
12447 #: ../src/guestfs-actions.pod:3755
12449 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12450 "link, then the link is stat-ed, not the file it refers to."
12454 #: ../src/guestfs-actions.pod:3759 ../fish/guestfish-actions.pod:2599
12455 msgid "This is the same as the C<lstat(2)> system call."
12459 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:6350
12461 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12462 "error. I<The caller must call C<guestfs_free_stat> after use>."
12466 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:6354
12467 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6753
12468 msgid "(Added in 0.9.2)"
12472 #: ../src/guestfs-actions.pod:3767
12473 msgid "guestfs_lstatlist"
12477 #: ../src/guestfs-actions.pod:3769
12480 " struct guestfs_stat_list *\n"
12481 " guestfs_lstatlist (guestfs_h *g,\n"
12482 " const char *path,\n"
12483 " char *const *names);\n"
12488 #: ../src/guestfs-actions.pod:3774
12490 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12491 "files, where all files are in the directory C<path>. C<names> is the list "
12492 "of files from this directory."
12496 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2609
12498 "On return you get a list of stat structs, with a one-to-one correspondence "
12499 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12500 "then the C<ino> field of that structure is set to C<-1>."
12504 #: ../src/guestfs-actions.pod:3783
12506 "This call is intended for programs that want to efficiently list a directory "
12507 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12508 "for a similarly efficient call for getting extended attributes. Very long "
12509 "directory listings might cause the protocol message size to be exceeded, "
12510 "causing this call to fail. The caller must split up such requests into "
12511 "smaller groups of names."
12515 #: ../src/guestfs-actions.pod:3791
12517 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12518 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12522 #: ../src/guestfs-actions.pod:3797
12523 msgid "guestfs_luks_add_key"
12527 #: ../src/guestfs-actions.pod:3799
12531 " guestfs_luks_add_key (guestfs_h *g,\n"
12532 " const char *device,\n"
12533 " const char *key,\n"
12534 " const char *newkey,\n"
12540 #: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2626
12542 "This command adds a new key on LUKS device C<device>. C<key> is any "
12543 "existing key, and is used to access the device. C<newkey> is the new key to "
12544 "add. C<keyslot> is the key slot that will be replaced."
12548 #: ../src/guestfs-actions.pod:3811
12550 "Note that if C<keyslot> already contains a key, then this command will "
12551 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12555 #: ../src/guestfs-actions.pod:3817 ../src/guestfs-actions.pod:3857
12556 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3900
12557 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3951
12559 "This function takes a key or passphrase parameter which could contain "
12560 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12565 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:3861
12566 #: ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3904
12567 msgid "(Added in 1.5.2)"
12571 #: ../src/guestfs-actions.pod:3823
12572 msgid "guestfs_luks_close"
12576 #: ../src/guestfs-actions.pod:3825
12580 " guestfs_luks_close (guestfs_h *g,\n"
12581 " const char *device);\n"
12586 #: ../src/guestfs-actions.pod:3829
12588 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12589 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12590 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12591 "underlying block device."
12595 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3936
12596 #: ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:4005
12597 #: ../src/guestfs-actions.pod:4053
12598 msgid "(Added in 1.5.1)"
12602 #: ../src/guestfs-actions.pod:3839
12603 msgid "guestfs_luks_format"
12607 #: ../src/guestfs-actions.pod:3841
12611 " guestfs_luks_format (guestfs_h *g,\n"
12612 " const char *device,\n"
12613 " const char *key,\n"
12619 #: ../src/guestfs-actions.pod:3847 ../fish/guestfish-actions.pod:2652
12621 "This command erases existing data on C<device> and formats the device as a "
12622 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12623 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12627 #: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3877
12628 #: ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4966
12629 #: ../src/guestfs-actions.pod:5746 ../src/guestfs-actions.pod:6153
12630 #: ../src/guestfs-actions.pod:6183 ../src/guestfs-actions.pod:6216
12631 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:2660
12632 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2757
12633 #: ../fish/guestfish-actions.pod:3338 ../fish/guestfish-actions.pod:3858
12634 #: ../fish/guestfish-actions.pod:4168 ../fish/guestfish-actions.pod:4191
12635 #: ../fish/guestfish-actions.pod:4213 ../fish/guestfish-actions.pod:4942
12637 "B<This command is dangerous. Without careful use you can easily destroy all "
12642 #: ../src/guestfs-actions.pod:3863
12643 msgid "guestfs_luks_format_cipher"
12647 #: ../src/guestfs-actions.pod:3865
12651 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12652 " const char *device,\n"
12653 " const char *key,\n"
12655 " const char *cipher);\n"
12660 #: ../src/guestfs-actions.pod:3872
12662 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12663 "set the C<cipher> used."
12667 #: ../src/guestfs-actions.pod:3886
12668 msgid "guestfs_luks_kill_slot"
12672 #: ../src/guestfs-actions.pod:3888
12676 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12677 " const char *device,\n"
12678 " const char *key,\n"
12684 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2680
12686 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12687 "device C<device>. C<key> must be one of the I<other> keys."
12691 #: ../src/guestfs-actions.pod:3906
12692 msgid "guestfs_luks_open"
12696 #: ../src/guestfs-actions.pod:3908
12700 " guestfs_luks_open (guestfs_h *g,\n"
12701 " const char *device,\n"
12702 " const char *key,\n"
12703 " const char *mapname);\n"
12708 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
12710 "This command opens a block device which has been encrypted according to the "
12711 "Linux Unified Key Setup (LUKS) standard."
12715 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12716 msgid "C<device> is the encrypted block device or partition."
12720 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
12722 "The caller must supply one of the keys associated with the LUKS block "
12723 "device, in the C<key> parameter."
12727 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12729 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12730 "writes to this block device are decrypted from and encrypted to the "
12731 "underlying C<device> respectively."
12735 #: ../src/guestfs-actions.pod:3926
12737 "If this block device contains LVM volume groups, then calling "
12738 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12743 #: ../src/guestfs-actions.pod:3938
12744 msgid "guestfs_luks_open_ro"
12748 #: ../src/guestfs-actions.pod:3940
12752 " guestfs_luks_open_ro (guestfs_h *g,\n"
12753 " const char *device,\n"
12754 " const char *key,\n"
12755 " const char *mapname);\n"
12760 #: ../src/guestfs-actions.pod:3946
12762 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12767 #: ../src/guestfs-actions.pod:3957
12768 msgid "guestfs_lvcreate"
12772 #: ../src/guestfs-actions.pod:3959
12776 " guestfs_lvcreate (guestfs_h *g,\n"
12777 " const char *logvol,\n"
12778 " const char *volgroup,\n"
12784 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2724
12786 "This creates an LVM logical volume called C<logvol> on the volume group "
12787 "C<volgroup>, with C<size> megabytes."
12791 #: ../src/guestfs-actions.pod:3972
12792 msgid "guestfs_lvm_canonical_lv_name"
12796 #: ../src/guestfs-actions.pod:3974
12800 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12801 " const char *lvname);\n"
12806 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2731
12808 "This converts alternative naming schemes for LVs that you might find to the "
12809 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12814 #: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:2735
12816 "This command returns an error if the C<lvname> parameter does not refer to a "
12821 #: ../src/guestfs-actions.pod:3985
12822 msgid "See also C<guestfs_is_lv>."
12826 #: ../src/guestfs-actions.pod:3990
12827 msgid "(Added in 1.5.24)"
12831 #: ../src/guestfs-actions.pod:3992
12832 msgid "guestfs_lvm_clear_filter"
12836 #: ../src/guestfs-actions.pod:3994
12840 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12845 #: ../src/guestfs-actions.pod:3997
12847 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12848 "see every block device."
12852 #: ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4042
12853 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2778
12855 "This command also clears the LVM cache and performs a volume group scan."
12859 #: ../src/guestfs-actions.pod:4007
12860 msgid "guestfs_lvm_remove_all"
12864 #: ../src/guestfs-actions.pod:4009
12868 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12873 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:2754
12875 "This command removes all LVM logical volumes, volume groups and physical "
12880 #: ../src/guestfs-actions.pod:4022
12881 msgid "guestfs_lvm_set_filter"
12885 #: ../src/guestfs-actions.pod:4024
12889 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12890 " char *const *devices);\n"
12895 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2764
12897 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12898 "block devices in the list C<devices>, and will ignore all other attached "
12903 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2768
12905 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12906 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12907 "there are two types of duplication possible: either cloned PVs/VGs which "
12908 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12909 "same name. In normal operation you cannot create this situation, but you "
12910 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12911 "inside the LVM metadata."
12915 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2781
12916 msgid "You can filter whole block devices or individual partitions."
12920 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2783
12922 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12923 "filesystem), even if you are not filtering out that VG."
12927 #: ../src/guestfs-actions.pod:4055
12928 msgid "guestfs_lvremove"
12932 #: ../src/guestfs-actions.pod:4057
12936 " guestfs_lvremove (guestfs_h *g,\n"
12937 " const char *device);\n"
12942 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2791
12944 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12945 "LV, such as C</dev/VG/LV>."
12949 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
12951 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12956 #: ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:5312
12957 #: ../src/guestfs-actions.pod:7129
12958 msgid "(Added in 1.0.13)"
12962 #: ../src/guestfs-actions.pod:4071
12963 msgid "guestfs_lvrename"
12967 #: ../src/guestfs-actions.pod:4073
12971 " guestfs_lvrename (guestfs_h *g,\n"
12972 " const char *logvol,\n"
12973 " const char *newlogvol);\n"
12978 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2801
12979 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12983 #: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:7142
12984 msgid "(Added in 1.0.83)"
12988 #: ../src/guestfs-actions.pod:4084
12989 msgid "guestfs_lvresize"
12993 #: ../src/guestfs-actions.pod:4086
12997 " guestfs_lvresize (guestfs_h *g,\n"
12998 " const char *device,\n"
13004 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2807
13006 "This resizes (expands or shrinks) an existing LVM logical volume to "
13007 "C<mbytes>. When reducing, data in the reduced part is lost."
13011 #: ../src/guestfs-actions.pod:4099
13012 msgid "guestfs_lvresize_free"
13016 #: ../src/guestfs-actions.pod:4101
13020 " guestfs_lvresize_free (guestfs_h *g,\n"
13021 " const char *lv,\n"
13027 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2815
13029 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13030 "remaining free space in the volume group. Commonly you would call this with "
13031 "pc = 100 which expands the logical volume as much as possible, using all "
13032 "remaining free space in the volume group."
13036 #: ../src/guestfs-actions.pod:4114
13037 msgid "(Added in 1.3.3)"
13041 #: ../src/guestfs-actions.pod:4116
13042 msgid "guestfs_lvs"
13046 #: ../src/guestfs-actions.pod:4118
13050 " guestfs_lvs (guestfs_h *g);\n"
13055 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2825
13057 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13062 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
13064 "This returns a list of the logical volume device names (eg. C</dev/"
13065 "VolGroup00/LogVol00>)."
13069 #: ../src/guestfs-actions.pod:4127
13070 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13074 #: ../src/guestfs-actions.pod:4135
13075 msgid "guestfs_lvs_full"
13079 #: ../src/guestfs-actions.pod:4137
13082 " struct guestfs_lvm_lv_list *\n"
13083 " guestfs_lvs_full (guestfs_h *g);\n"
13088 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2837
13090 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13091 "(8)> command. The \"full\" version includes all fields."
13095 #: ../src/guestfs-actions.pod:4143
13097 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13098 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13102 #: ../src/guestfs-actions.pod:4149
13103 msgid "guestfs_lvuuid"
13107 #: ../src/guestfs-actions.pod:4151
13111 " guestfs_lvuuid (guestfs_h *g,\n"
13112 " const char *device);\n"
13117 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2844
13118 msgid "This command returns the UUID of the LVM LV C<device>."
13122 #: ../src/guestfs-actions.pod:4162
13123 msgid "guestfs_lxattrlist"
13127 #: ../src/guestfs-actions.pod:4164
13130 " struct guestfs_xattr_list *\n"
13131 " guestfs_lxattrlist (guestfs_h *g,\n"
13132 " const char *path,\n"
13133 " char *const *names);\n"
13138 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2850
13140 "This call allows you to get the extended attributes of multiple files, where "
13141 "all files are in the directory C<path>. C<names> is the list of files from "
13146 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2854
13148 "On return you get a flat list of xattr structs which must be interpreted "
13149 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13150 "C<attrval> in this struct is zero-length to indicate there was an error "
13151 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13152 "number (the number of following attributes for this file, which could be C<"
13153 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13154 "for the first named file. This repeats for the second and subsequent files."
13158 #: ../src/guestfs-actions.pod:4183
13160 "This call is intended for programs that want to efficiently list a directory "
13161 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13162 "a similarly efficient call for getting standard stats. Very long directory "
13163 "listings might cause the protocol message size to be exceeded, causing this "
13164 "call to fail. The caller must split up such requests into smaller groups of "
13169 #: ../src/guestfs-actions.pod:4197
13170 msgid "guestfs_mkdir"
13174 #: ../src/guestfs-actions.pod:4199
13178 " guestfs_mkdir (guestfs_h *g,\n"
13179 " const char *path);\n"
13184 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:2876
13185 msgid "Create a directory named C<path>."
13189 #: ../src/guestfs-actions.pod:4209
13190 msgid "guestfs_mkdir_mode"
13194 #: ../src/guestfs-actions.pod:4211
13198 " guestfs_mkdir_mode (guestfs_h *g,\n"
13199 " const char *path,\n"
13205 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2882
13207 "This command creates a directory, setting the initial permissions of the "
13208 "directory to C<mode>."
13212 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
13214 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13215 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13220 #: ../src/guestfs-actions.pod:4223
13221 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13225 #: ../src/guestfs-actions.pod:4229
13226 msgid "guestfs_mkdir_p"
13230 #: ../src/guestfs-actions.pod:4231
13234 " guestfs_mkdir_p (guestfs_h *g,\n"
13235 " const char *path);\n"
13240 #: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:2895
13242 "Create a directory named C<path>, creating any parent directories as "
13243 "necessary. This is like the C<mkdir -p> shell command."
13247 #: ../src/guestfs-actions.pod:4242
13248 msgid "guestfs_mkdtemp"
13252 #: ../src/guestfs-actions.pod:4244
13256 " guestfs_mkdtemp (guestfs_h *g,\n"
13257 " const char *template);\n"
13262 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
13264 "This command creates a temporary directory. The C<template> parameter "
13265 "should be a full pathname for the temporary directory name with the final "
13266 "six characters being \"XXXXXX\"."
13270 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
13272 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13273 "being suitable for Windows filesystems."
13277 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
13278 msgid "The name of the temporary directory that was created is returned."
13282 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
13283 msgid "The temporary directory is created with mode 0700 and is owned by root."
13287 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
13289 "The caller is responsible for deleting the temporary directory and its "
13290 "contents after use."
13294 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
13295 msgid "See also: L<mkdtemp(3)>"
13299 #: ../src/guestfs-actions.pod:4272
13300 msgid "guestfs_mke2fs_J"
13304 #: ../src/guestfs-actions.pod:4274
13308 " guestfs_mke2fs_J (guestfs_h *g,\n"
13309 " const char *fstype,\n"
13310 " int blocksize,\n"
13311 " const char *device,\n"
13312 " const char *journal);\n"
13317 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2925
13319 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13320 "C<journal>. It is equivalent to the command:"
13324 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2929
13327 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13332 #: ../src/guestfs-actions.pod:4287
13333 msgid "See also C<guestfs_mke2journal>."
13337 #: ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4309
13338 #: ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4343
13339 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4371
13340 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4695
13341 msgid "(Added in 1.0.68)"
13345 #: ../src/guestfs-actions.pod:4293
13346 msgid "guestfs_mke2fs_JL"
13350 #: ../src/guestfs-actions.pod:4295
13354 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13355 " const char *fstype,\n"
13356 " int blocksize,\n"
13357 " const char *device,\n"
13358 " const char *label);\n"
13363 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:2937
13365 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13366 "the journal labeled C<label>."
13370 #: ../src/guestfs-actions.pod:4305
13371 msgid "See also C<guestfs_mke2journal_L>."
13375 #: ../src/guestfs-actions.pod:4311
13376 msgid "guestfs_mke2fs_JU"
13380 #: ../src/guestfs-actions.pod:4313
13384 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13385 " const char *fstype,\n"
13386 " int blocksize,\n"
13387 " const char *device,\n"
13388 " const char *uuid);\n"
13393 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2946
13395 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13396 "the journal with UUID C<uuid>."
13400 #: ../src/guestfs-actions.pod:4323
13401 msgid "See also C<guestfs_mke2journal_U>."
13405 #: ../src/guestfs-actions.pod:4329
13406 msgid "guestfs_mke2journal"
13410 #: ../src/guestfs-actions.pod:4331
13414 " guestfs_mke2journal (guestfs_h *g,\n"
13415 " int blocksize,\n"
13416 " const char *device);\n"
13421 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2955
13423 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13428 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
13431 " mke2fs -O journal_dev -b blocksize device\n"
13436 #: ../src/guestfs-actions.pod:4345
13437 msgid "guestfs_mke2journal_L"
13441 #: ../src/guestfs-actions.pod:4347
13445 " guestfs_mke2journal_L (guestfs_h *g,\n"
13446 " int blocksize,\n"
13447 " const char *label,\n"
13448 " const char *device);\n"
13453 #: ../src/guestfs-actions.pod:4353 ../fish/guestfish-actions.pod:2964
13454 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13458 #: ../src/guestfs-actions.pod:4359
13459 msgid "guestfs_mke2journal_U"
13463 #: ../src/guestfs-actions.pod:4361
13467 " guestfs_mke2journal_U (guestfs_h *g,\n"
13468 " int blocksize,\n"
13469 " const char *uuid,\n"
13470 " const char *device);\n"
13475 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2970
13476 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13480 #: ../src/guestfs-actions.pod:4373
13481 msgid "guestfs_mkfifo"
13485 #: ../src/guestfs-actions.pod:4375
13489 " guestfs_mkfifo (guestfs_h *g,\n"
13491 " const char *path);\n"
13496 #: ../src/guestfs-actions.pod:4380
13498 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13499 "is just a convenient wrapper around C<guestfs_mknod>."
13503 #: ../src/guestfs-actions.pod:4390
13504 msgid "guestfs_mkfs"
13508 #: ../src/guestfs-actions.pod:4392
13512 " guestfs_mkfs (guestfs_h *g,\n"
13513 " const char *fstype,\n"
13514 " const char *device);\n"
13519 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2986
13521 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13522 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13526 #: ../src/guestfs-actions.pod:4405
13527 msgid "guestfs_mkfs_b"
13531 #: ../src/guestfs-actions.pod:4407
13535 " guestfs_mkfs_b (guestfs_h *g,\n"
13536 " const char *fstype,\n"
13537 " int blocksize,\n"
13538 " const char *device);\n"
13543 #: ../src/guestfs-actions.pod:4413
13545 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13546 "block size of the resulting filesystem. Supported block sizes depend on the "
13547 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13551 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4461
13552 #: ../fish/guestfish-actions.pod:2999 ../fish/guestfish-actions.pod:3026
13554 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13559 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3002
13561 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13565 #: ../src/guestfs-actions.pod:4432
13566 msgid "guestfs_mkfs_opts"
13570 #: ../src/guestfs-actions.pod:4434
13574 " guestfs_mkfs_opts (guestfs_h *g,\n"
13575 " const char *fstype,\n"
13576 " const char *device,\n"
13582 #: ../src/guestfs-actions.pod:4445
13585 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13586 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13591 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:3013
13593 "This function creates a filesystem on C<device>. The filesystem type is "
13594 "C<fstype>, for example C<ext3>."
13598 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:3020
13599 msgid "C<blocksize>"
13603 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3022
13605 "The filesystem block size. Supported block sizes depend on the filesystem "
13606 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13611 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3029
13612 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13616 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3031
13617 msgid "C<features>"
13621 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3033
13622 msgid "This passes the I<-O> parameter to the external mkfs program."
13626 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3035
13628 "For certain filesystem types, this allows extra filesystem features to be "
13629 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13633 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3039
13635 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13640 #: ../src/guestfs-actions.pod:4481
13641 msgid "(Added in 1.7.19)"
13645 #: ../src/guestfs-actions.pod:4483
13646 msgid "guestfs_mkfs_opts_va"
13650 #: ../src/guestfs-actions.pod:4485
13654 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13655 " const char *fstype,\n"
13656 " const char *device,\n"
13657 " va_list args);\n"
13662 #: ../src/guestfs-actions.pod:4491
13663 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13667 #: ../src/guestfs-actions.pod:4495
13668 msgid "guestfs_mkfs_opts_argv"
13672 #: ../src/guestfs-actions.pod:4497
13676 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13677 " const char *fstype,\n"
13678 " const char *device,\n"
13679 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13684 #: ../src/guestfs-actions.pod:4503
13685 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13689 #: ../src/guestfs-actions.pod:4507
13690 msgid "guestfs_mkmountpoint"
13694 #: ../src/guestfs-actions.pod:4509
13698 " guestfs_mkmountpoint (guestfs_h *g,\n"
13699 " const char *exemptpath);\n"
13704 #: ../src/guestfs-actions.pod:4513
13706 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13707 "that can be used to create extra mountpoints before mounting the first "
13712 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:3054
13714 "These calls are I<only> necessary in some very limited circumstances, mainly "
13715 "the case where you want to mount a mix of unrelated and/or read-only "
13716 "filesystems together."
13720 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
13722 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13723 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13724 "inside that. You can unpack this as follows in guestfish:"
13728 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
13731 " add-ro Fedora-11-i686-Live.iso\n"
13733 " mkmountpoint /cd\n"
13734 " mkmountpoint /sqsh\n"
13735 " mkmountpoint /ext3fs\n"
13736 " mount /dev/sda /cd\n"
13737 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13738 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13743 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3072
13744 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13748 #: ../src/guestfs-actions.pod:4537
13750 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13751 "may get unexpected errors if you try to mix these calls. It is safest to "
13752 "manually unmount filesystems and remove mountpoints after use."
13756 #: ../src/guestfs-actions.pod:4541
13758 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13759 "first, so for this to work for manual mountpoints, you must ensure that the "
13760 "innermost mountpoints have the longest pathnames, as in the example code "
13765 #: ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3083
13767 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13771 #: ../src/guestfs-actions.pod:4548
13773 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13774 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13775 "can also trigger these issues."
13779 #: ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4820
13780 #: ../src/guestfs-actions.pod:5730
13781 msgid "(Added in 1.0.62)"
13785 #: ../src/guestfs-actions.pod:4556
13786 msgid "guestfs_mknod"
13790 #: ../src/guestfs-actions.pod:4558
13794 " guestfs_mknod (guestfs_h *g,\n"
13798 " const char *path);\n"
13803 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3093
13805 "This call creates block or character special devices, or named pipes (FIFOs)."
13809 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
13811 "The C<mode> parameter should be the mode, using the standard constants. "
13812 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13813 "used when creating block and character special devices."
13817 #: ../src/guestfs-actions.pod:4573
13819 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13820 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13821 "regular file). These constants are available in the standard Linux header "
13822 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13823 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13824 "the appropriate constant for you."
13828 #: ../src/guestfs-actions.pod:4587
13829 msgid "guestfs_mknod_b"
13833 #: ../src/guestfs-actions.pod:4589
13837 " guestfs_mknod_b (guestfs_h *g,\n"
13841 " const char *path);\n"
13846 #: ../src/guestfs-actions.pod:4596
13848 "This call creates a block device node called C<path> with mode C<mode> and "
13849 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13850 "wrapper around C<guestfs_mknod>."
13854 #: ../src/guestfs-actions.pod:4606
13855 msgid "guestfs_mknod_c"
13859 #: ../src/guestfs-actions.pod:4608
13863 " guestfs_mknod_c (guestfs_h *g,\n"
13867 " const char *path);\n"
13872 #: ../src/guestfs-actions.pod:4615
13874 "This call creates a char device node called C<path> with mode C<mode> and "
13875 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13876 "wrapper around C<guestfs_mknod>."
13880 #: ../src/guestfs-actions.pod:4625
13881 msgid "guestfs_mkswap"
13885 #: ../src/guestfs-actions.pod:4627
13889 " guestfs_mkswap (guestfs_h *g,\n"
13890 " const char *device);\n"
13895 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3135
13896 msgid "Create a swap partition on C<device>."
13900 #: ../src/guestfs-actions.pod:4637
13901 msgid "guestfs_mkswap_L"
13905 #: ../src/guestfs-actions.pod:4639
13909 " guestfs_mkswap_L (guestfs_h *g,\n"
13910 " const char *label,\n"
13911 " const char *device);\n"
13916 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3141
13917 msgid "Create a swap partition on C<device> with label C<label>."
13921 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3143
13923 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13924 "sda>), just to a partition. This appears to be a limitation of the kernel "
13929 #: ../src/guestfs-actions.pod:4654
13930 msgid "guestfs_mkswap_U"
13934 #: ../src/guestfs-actions.pod:4656
13938 " guestfs_mkswap_U (guestfs_h *g,\n"
13939 " const char *uuid,\n"
13940 " const char *device);\n"
13945 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3151
13946 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13950 #: ../src/guestfs-actions.pod:4667
13951 msgid "guestfs_mkswap_file"
13955 #: ../src/guestfs-actions.pod:4669
13959 " guestfs_mkswap_file (guestfs_h *g,\n"
13960 " const char *path);\n"
13965 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3157
13966 msgid "Create a swap file."
13970 #: ../src/guestfs-actions.pod:4675
13972 "This command just writes a swap file signature to an existing file. To "
13973 "create the file itself, use something like C<guestfs_fallocate>."
13977 #: ../src/guestfs-actions.pod:4682
13978 msgid "guestfs_modprobe"
13982 #: ../src/guestfs-actions.pod:4684
13986 " guestfs_modprobe (guestfs_h *g,\n"
13987 " const char *modulename);\n"
13992 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3166
13993 msgid "This loads a kernel module in the appliance."
13997 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3168
13999 "The kernel module must have been whitelisted when libguestfs was built (see "
14000 "C<appliance/kmod.whitelist.in> in the source)."
14004 #: ../src/guestfs-actions.pod:4697
14005 msgid "guestfs_mount"
14009 #: ../src/guestfs-actions.pod:4699
14013 " guestfs_mount (guestfs_h *g,\n"
14014 " const char *device,\n"
14015 " const char *mountpoint);\n"
14020 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3175
14022 "Mount a guest disk at a position in the filesystem. Block devices are named "
14023 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14024 "those block devices contain partitions, they will have the usual names (eg. "
14025 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14029 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
14031 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14032 "mounted on C</> before others can be mounted. Other filesystems can only be "
14033 "mounted on directories which already exist."
14037 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
14039 "The mounted filesystem is writable, if we have sufficient permissions on the "
14040 "underlying device."
14044 #: ../src/guestfs-actions.pod:4718
14046 "B<Important note:> When you use this call, the filesystem options C<sync> "
14047 "and C<noatime> are set implicitly. This was originally done because we "
14048 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14049 "very large negative performance impact and negligible effect on "
14050 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14051 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14052 "(use an empty string for the first parameter if you don't want any options)."
14056 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3199
14058 "This function is deprecated. In new code, use the C<mount_options> call "
14063 #: ../src/guestfs-actions.pod:4739
14064 msgid "guestfs_mount_loop"
14068 #: ../src/guestfs-actions.pod:4741
14072 " guestfs_mount_loop (guestfs_h *g,\n"
14073 " const char *file,\n"
14074 " const char *mountpoint);\n"
14079 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3210
14081 "This command lets you mount C<file> (a filesystem image in a file) on a "
14082 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14087 #: ../src/guestfs-actions.pod:4754
14088 msgid "guestfs_mount_options"
14092 #: ../src/guestfs-actions.pod:4756
14096 " guestfs_mount_options (guestfs_h *g,\n"
14097 " const char *options,\n"
14098 " const char *device,\n"
14099 " const char *mountpoint);\n"
14104 #: ../src/guestfs-actions.pod:4762
14106 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14107 "the mount options as for the L<mount(8)> I<-o> flag."
14111 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3222
14113 "If the C<options> parameter is an empty string, then no options are passed "
14114 "(all options default to whatever the filesystem uses)."
14118 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4786
14119 #: ../src/guestfs-actions.pod:4803
14120 msgid "(Added in 1.0.10)"
14124 #: ../src/guestfs-actions.pod:4774
14125 msgid "guestfs_mount_ro"
14129 #: ../src/guestfs-actions.pod:4776
14133 " guestfs_mount_ro (guestfs_h *g,\n"
14134 " const char *device,\n"
14135 " const char *mountpoint);\n"
14140 #: ../src/guestfs-actions.pod:4781
14142 "This is the same as the C<guestfs_mount> command, but it mounts the "
14143 "filesystem with the read-only (I<-o ro>) flag."
14147 #: ../src/guestfs-actions.pod:4788
14148 msgid "guestfs_mount_vfs"
14152 #: ../src/guestfs-actions.pod:4790
14156 " guestfs_mount_vfs (guestfs_h *g,\n"
14157 " const char *options,\n"
14158 " const char *vfstype,\n"
14159 " const char *device,\n"
14160 " const char *mountpoint);\n"
14165 #: ../src/guestfs-actions.pod:4797
14167 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14168 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14173 #: ../src/guestfs-actions.pod:4805
14174 msgid "guestfs_mountpoints"
14178 #: ../src/guestfs-actions.pod:4807
14182 " guestfs_mountpoints (guestfs_h *g);\n"
14187 #: ../src/guestfs-actions.pod:4810
14189 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14190 "devices. This one returns a hash table (map) of device name to directory "
14191 "where the device is mounted."
14195 #: ../src/guestfs-actions.pod:4822
14196 msgid "guestfs_mounts"
14200 #: ../src/guestfs-actions.pod:4824
14204 " guestfs_mounts (guestfs_h *g);\n"
14209 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3253
14211 "This returns the list of currently mounted filesystems. It returns the list "
14212 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14216 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3256
14217 msgid "Some internal mounts are not shown."
14221 #: ../src/guestfs-actions.pod:4832
14222 msgid "See also: C<guestfs_mountpoints>"
14226 #: ../src/guestfs-actions.pod:4840
14231 #: ../src/guestfs-actions.pod:4842
14235 " guestfs_mv (guestfs_h *g,\n"
14236 " const char *src,\n"
14237 " const char *dest);\n"
14242 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3264
14244 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14245 "destination filename or destination directory."
14249 #: ../src/guestfs-actions.pod:4854
14250 msgid "guestfs_ntfs_3g_probe"
14254 #: ../src/guestfs-actions.pod:4856
14258 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14260 " const char *device);\n"
14265 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
14267 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14268 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14269 "write, and some cannot be mounted at all)."
14273 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
14275 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14276 "can be mounted read-write. Set it to false if you want to test if the "
14277 "volume can be mounted read-only."
14281 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3279
14283 "The return value is an integer which C<0> if the operation would succeed, or "
14284 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14288 #: ../src/guestfs-actions.pod:4875
14289 msgid "(Added in 1.0.43)"
14293 #: ../src/guestfs-actions.pod:4877
14294 msgid "guestfs_ntfsresize"
14298 #: ../src/guestfs-actions.pod:4879
14302 " guestfs_ntfsresize (guestfs_h *g,\n"
14303 " const char *device);\n"
14308 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3287
14310 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14311 "size of the underlying device. See also L<ntfsresize(8)>."
14315 #: ../src/guestfs-actions.pod:4891
14316 msgid "guestfs_ntfsresize_size"
14320 #: ../src/guestfs-actions.pod:4893
14324 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14325 " const char *device,\n"
14326 " int64_t size);\n"
14331 #: ../src/guestfs-actions.pod:4898
14333 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14334 "to specify the new size (in bytes) explicitly."
14338 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:5339
14339 #: ../src/guestfs-actions.pod:5412 ../src/guestfs-actions.pod:5678
14340 #: ../src/guestfs-actions.pod:7284
14341 msgid "(Added in 1.3.14)"
14345 #: ../src/guestfs-actions.pod:4905
14346 msgid "guestfs_part_add"
14350 #: ../src/guestfs-actions.pod:4907
14354 " guestfs_part_add (guestfs_h *g,\n"
14355 " const char *device,\n"
14356 " const char *prlogex,\n"
14357 " int64_t startsect,\n"
14358 " int64_t endsect);\n"
14363 #: ../src/guestfs-actions.pod:4914
14365 "This command adds a partition to C<device>. If there is no partition table "
14366 "on the device, call C<guestfs_part_init> first."
14370 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3305
14372 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14373 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14374 "C<logical>) and C<e> (or C<extended>) partition types."
14378 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3310
14380 "C<startsect> and C<endsect> are the start and end of the partition in "
14381 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14382 "from the end of the disk (C<-1> is the last sector)."
14386 #: ../src/guestfs-actions.pod:4926
14388 "Creating a partition which covers the whole disk is not so easy. Use "
14389 "C<guestfs_part_disk> to do that."
14393 #: ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4969
14394 #: ../src/guestfs-actions.pod:5022 ../src/guestfs-actions.pod:5100
14395 #: ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5157
14396 #: ../src/guestfs-actions.pod:5197
14397 msgid "(Added in 1.0.78)"
14401 #: ../src/guestfs-actions.pod:4933
14402 msgid "guestfs_part_del"
14406 #: ../src/guestfs-actions.pod:4935
14410 " guestfs_part_del (guestfs_h *g,\n"
14411 " const char *device,\n"
14417 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3321
14418 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14422 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3323
14424 "Note that in the case of MBR partitioning, deleting an extended partition "
14425 "also deletes any logical partitions it contains."
14429 #: ../src/guestfs-actions.pod:4950
14430 msgid "guestfs_part_disk"
14434 #: ../src/guestfs-actions.pod:4952
14438 " guestfs_part_disk (guestfs_h *g,\n"
14439 " const char *device,\n"
14440 " const char *parttype);\n"
14445 #: ../src/guestfs-actions.pod:4957
14447 "This command is simply a combination of C<guestfs_part_init> followed by "
14448 "C<guestfs_part_add> to create a single primary partition covering the whole "
14453 #: ../src/guestfs-actions.pod:4961
14455 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14456 "possible values are described in C<guestfs_part_init>."
14460 #: ../src/guestfs-actions.pod:4971
14461 msgid "guestfs_part_get_bootable"
14465 #: ../src/guestfs-actions.pod:4973
14469 " guestfs_part_get_bootable (guestfs_h *g,\n"
14470 " const char *device,\n"
14476 #: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3345
14478 "This command returns true if the partition C<partnum> on C<device> has the "
14479 "bootable flag set."
14483 #: ../src/guestfs-actions.pod:4981
14484 msgid "See also C<guestfs_part_set_bootable>."
14488 #: ../src/guestfs-actions.pod:4987
14489 msgid "guestfs_part_get_mbr_id"
14493 #: ../src/guestfs-actions.pod:4989
14497 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14498 " const char *device,\n"
14504 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3354
14506 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14507 "partition C<partnum>."
14511 #: ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5173
14513 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14514 "undefined results for other partition table types (see "
14515 "C<guestfs_part_get_parttype>)."
14519 #: ../src/guestfs-actions.pod:5005
14520 msgid "guestfs_part_get_parttype"
14524 #: ../src/guestfs-actions.pod:5007
14528 " guestfs_part_get_parttype (guestfs_h *g,\n"
14529 " const char *device);\n"
14534 #: ../src/guestfs-actions.pod:5011 ../fish/guestfish-actions.pod:3365
14536 "This command examines the partition table on C<device> and returns the "
14537 "partition table type (format) being used."
14541 #: ../src/guestfs-actions.pod:5014
14543 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14544 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14545 "possible, although unusual. See C<guestfs_part_init> for a full list."
14549 #: ../src/guestfs-actions.pod:5024
14550 msgid "guestfs_part_init"
14554 #: ../src/guestfs-actions.pod:5026
14558 " guestfs_part_init (guestfs_h *g,\n"
14559 " const char *device,\n"
14560 " const char *parttype);\n"
14565 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3377
14567 "This creates an empty partition table on C<device> of one of the partition "
14568 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14569 "(for large disks)."
14573 #: ../src/guestfs-actions.pod:5035
14575 "Initially there are no partitions. Following this, you should call "
14576 "C<guestfs_part_add> for each partition required."
14580 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14581 msgid "Possible values for C<parttype> are:"
14585 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
14586 msgid "B<efi> | B<gpt>"
14590 #: ../src/guestfs-actions.pod:5044 ../fish/guestfish-actions.pod:3390
14591 msgid "Intel EFI / GPT partition table."
14595 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
14597 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14598 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14599 "the C<mbr> format."
14603 #: ../src/guestfs-actions.pod:5050 ../fish/guestfish-actions.pod:3396
14604 msgid "B<mbr> | B<msdos>"
14608 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
14610 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14611 "Windows. This partition type will B<only> work for device sizes up to 2 "
14612 "TB. For large disks we recommend using C<gpt>."
14616 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3405
14618 "Other partition table types that may work but are not supported include:"
14622 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14627 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14628 msgid "AIX disk labels."
14632 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14633 msgid "B<amiga> | B<rdb>"
14637 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14638 msgid "Amiga \"Rigid Disk Block\" format."
14642 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14647 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14648 msgid "BSD disk labels."
14652 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14657 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14658 msgid "DASD, used on IBM mainframes."
14662 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14667 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14668 msgid "MIPS/SGI volumes."
14672 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
14677 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14678 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14682 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14687 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
14688 msgid "NEC PC-98 format, common in Japan apparently."
14692 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3438
14697 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3440
14698 msgid "Sun disk labels."
14702 #: ../src/guestfs-actions.pod:5102
14703 msgid "guestfs_part_list"
14707 #: ../src/guestfs-actions.pod:5104
14710 " struct guestfs_partition_list *\n"
14711 " guestfs_part_list (guestfs_h *g,\n"
14712 " const char *device);\n"
14717 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3448
14719 "This command parses the partition table on C<device> and returns the list of "
14720 "partitions found."
14724 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
14725 msgid "The fields in the returned structure are:"
14729 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
14730 msgid "B<part_num>"
14734 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3457
14735 msgid "Partition number, counting from 1."
14739 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3459
14740 msgid "B<part_start>"
14744 #: ../src/guestfs-actions.pod:5121
14746 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14747 "the device's sector size, see C<guestfs_blockdev_getss>."
14751 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
14752 msgid "B<part_end>"
14756 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
14757 msgid "End of the partition in bytes."
14761 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3468
14762 msgid "B<part_size>"
14766 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3470
14767 msgid "Size of the partition in bytes."
14771 #: ../src/guestfs-actions.pod:5134
14773 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14774 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14779 #: ../src/guestfs-actions.pod:5140
14780 msgid "guestfs_part_set_bootable"
14784 #: ../src/guestfs-actions.pod:5142
14788 " guestfs_part_set_bootable (guestfs_h *g,\n"
14789 " const char *device,\n"
14791 " int bootable);\n"
14796 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3478
14798 "This sets the bootable flag on partition numbered C<partnum> on device "
14799 "C<device>. Note that partitions are numbered from 1."
14803 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3481
14805 "The bootable flag is used by some operating systems (notably Windows) to "
14806 "determine which partition to boot from. It is by no means universally "
14811 #: ../src/guestfs-actions.pod:5159
14812 msgid "guestfs_part_set_mbr_id"
14816 #: ../src/guestfs-actions.pod:5161
14820 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14821 " const char *device,\n"
14828 #: ../src/guestfs-actions.pod:5167 ../fish/guestfish-actions.pod:3489
14830 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14831 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14832 "documentation are in fact hexadecimal numbers, but usually documented "
14833 "without any leading \"0x\" which might be confusing."
14837 #: ../src/guestfs-actions.pod:5181
14838 msgid "guestfs_part_set_name"
14842 #: ../src/guestfs-actions.pod:5183
14846 " guestfs_part_set_name (guestfs_h *g,\n"
14847 " const char *device,\n"
14849 " const char *name);\n"
14854 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3503
14856 "This sets the partition name on partition numbered C<partnum> on device "
14857 "C<device>. Note that partitions are numbered from 1."
14861 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3506
14863 "The partition name can only be set on certain types of partition table. "
14864 "This works on C<gpt> but not on C<mbr> partitions."
14868 #: ../src/guestfs-actions.pod:5199
14869 msgid "guestfs_part_to_dev"
14873 #: ../src/guestfs-actions.pod:5201
14877 " guestfs_part_to_dev (guestfs_h *g,\n"
14878 " const char *partition);\n"
14883 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3513
14885 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14886 "partition number, returning the device name (eg. \"/dev/sdb\")."
14890 #: ../src/guestfs-actions.pod:5209
14892 "The named partition must exist, for example as a string returned from "
14893 "C<guestfs_list_partitions>."
14897 #: ../src/guestfs-actions.pod:5217
14898 msgid "guestfs_ping_daemon"
14902 #: ../src/guestfs-actions.pod:5219
14906 " guestfs_ping_daemon (guestfs_h *g);\n"
14911 #: ../src/guestfs-actions.pod:5222 ../fish/guestfish-actions.pod:3524
14913 "This is a test probe into the guestfs daemon running inside the qemu "
14914 "subprocess. Calling this function checks that the daemon responds to the "
14915 "ping message, without affecting the daemon or attached block device(s) in "
14920 #: ../src/guestfs-actions.pod:5231
14921 msgid "guestfs_pread"
14925 #: ../src/guestfs-actions.pod:5233
14929 " guestfs_pread (guestfs_h *g,\n"
14930 " const char *path,\n"
14932 " int64_t offset,\n"
14933 " size_t *size_r);\n"
14938 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3533
14940 "This command lets you read part of a file. It reads C<count> bytes of the "
14941 "file, starting at C<offset>, from file C<path>."
14945 #: ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5269
14946 #: ../fish/guestfish-actions.pod:3536 ../fish/guestfish-actions.pod:3551
14948 "This may read fewer bytes than requested. For further details see the "
14949 "L<pread(2)> system call."
14953 #: ../src/guestfs-actions.pod:5246
14954 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14958 #: ../src/guestfs-actions.pod:5257
14959 msgid "guestfs_pread_device"
14963 #: ../src/guestfs-actions.pod:5259
14967 " guestfs_pread_device (guestfs_h *g,\n"
14968 " const char *device,\n"
14970 " int64_t offset,\n"
14971 " size_t *size_r);\n"
14976 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3548
14978 "This command lets you read part of a file. It reads C<count> bytes of "
14979 "C<device>, starting at C<offset>."
14983 #: ../src/guestfs-actions.pod:5272
14984 msgid "See also C<guestfs_pread>."
14988 #: ../src/guestfs-actions.pod:5281
14989 msgid "(Added in 1.5.21)"
14993 #: ../src/guestfs-actions.pod:5283
14994 msgid "guestfs_pvcreate"
14998 #: ../src/guestfs-actions.pod:5285
15002 " guestfs_pvcreate (guestfs_h *g,\n"
15003 " const char *device);\n"
15008 #: ../src/guestfs-actions.pod:5289 ../fish/guestfish-actions.pod:3563
15010 "This creates an LVM physical volume on the named C<device>, where C<device> "
15011 "should usually be a partition name such as C</dev/sda1>."
15015 #: ../src/guestfs-actions.pod:5297
15016 msgid "guestfs_pvremove"
15020 #: ../src/guestfs-actions.pod:5299
15024 " guestfs_pvremove (guestfs_h *g,\n"
15025 " const char *device);\n"
15030 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3571
15032 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15037 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3574
15039 "The implementation uses the C<pvremove> command which refuses to wipe "
15040 "physical volumes that contain any volume groups, so you have to remove those "
15045 #: ../src/guestfs-actions.pod:5314
15046 msgid "guestfs_pvresize"
15050 #: ../src/guestfs-actions.pod:5316
15054 " guestfs_pvresize (guestfs_h *g,\n"
15055 " const char *device);\n"
15060 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3582
15062 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15063 "the new size of the underlying device."
15067 #: ../src/guestfs-actions.pod:5327
15068 msgid "guestfs_pvresize_size"
15072 #: ../src/guestfs-actions.pod:5329
15076 " guestfs_pvresize_size (guestfs_h *g,\n"
15077 " const char *device,\n"
15078 " int64_t size);\n"
15083 #: ../src/guestfs-actions.pod:5334
15085 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15086 "specify the new size (in bytes) explicitly."
15090 #: ../src/guestfs-actions.pod:5341
15091 msgid "guestfs_pvs"
15095 #: ../src/guestfs-actions.pod:5343
15099 " guestfs_pvs (guestfs_h *g);\n"
15104 #: ../src/guestfs-actions.pod:5346 ../fish/guestfish-actions.pod:3596
15106 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15111 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:3599
15113 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15118 #: ../src/guestfs-actions.pod:5352
15119 msgid "See also C<guestfs_pvs_full>."
15123 #: ../src/guestfs-actions.pod:5360
15124 msgid "guestfs_pvs_full"
15128 #: ../src/guestfs-actions.pod:5362
15131 " struct guestfs_lvm_pv_list *\n"
15132 " guestfs_pvs_full (guestfs_h *g);\n"
15137 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3608
15139 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15140 "(8)> command. The \"full\" version includes all fields."
15144 #: ../src/guestfs-actions.pod:5368
15146 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15147 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15151 #: ../src/guestfs-actions.pod:5374
15152 msgid "guestfs_pvuuid"
15156 #: ../src/guestfs-actions.pod:5376
15160 " guestfs_pvuuid (guestfs_h *g,\n"
15161 " const char *device);\n"
15166 #: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:3615
15167 msgid "This command returns the UUID of the LVM PV C<device>."
15171 #: ../src/guestfs-actions.pod:5387
15172 msgid "guestfs_pwrite"
15176 #: ../src/guestfs-actions.pod:5389
15180 " guestfs_pwrite (guestfs_h *g,\n"
15181 " const char *path,\n"
15182 " const char *content,\n"
15183 " size_t content_size,\n"
15184 " int64_t offset);\n"
15189 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3621
15191 "This command writes to part of a file. It writes the data buffer C<content> "
15192 "to the file C<path> starting at offset C<offset>."
15196 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3624
15198 "This command implements the L<pwrite(2)> system call, and like that system "
15199 "call it may not write the full data requested. The return value is the "
15200 "number of bytes that were actually written to the file. This could even be "
15201 "0, although short writes are unlikely for regular files in ordinary "
15206 #: ../src/guestfs-actions.pod:5405
15207 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15211 #: ../src/guestfs-actions.pod:5414
15212 msgid "guestfs_pwrite_device"
15216 #: ../src/guestfs-actions.pod:5416
15220 " guestfs_pwrite_device (guestfs_h *g,\n"
15221 " const char *device,\n"
15222 " const char *content,\n"
15223 " size_t content_size,\n"
15224 " int64_t offset);\n"
15229 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3639
15231 "This command writes to part of a device. It writes the data buffer "
15232 "C<content> to C<device> starting at offset C<offset>."
15236 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3642
15238 "This command implements the L<pwrite(2)> system call, and like that system "
15239 "call it may not write the full data requested (although short writes to disk "
15240 "devices and partitions are probably impossible with standard Linux kernels)."
15244 #: ../src/guestfs-actions.pod:5431
15245 msgid "See also C<guestfs_pwrite>."
15249 #: ../src/guestfs-actions.pod:5438
15250 msgid "(Added in 1.5.20)"
15254 #: ../src/guestfs-actions.pod:5440
15255 msgid "guestfs_read_file"
15259 #: ../src/guestfs-actions.pod:5442
15263 " guestfs_read_file (guestfs_h *g,\n"
15264 " const char *path,\n"
15265 " size_t *size_r);\n"
15270 #: ../src/guestfs-actions.pod:5447 ../fish/guestfish-actions.pod:3656
15271 msgid "This calls returns the contents of the file C<path> as a buffer."
15275 #: ../src/guestfs-actions.pod:5450
15277 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15278 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15279 "function is limited in the total size of file that can be handled."
15283 #: ../src/guestfs-actions.pod:5462
15284 msgid "(Added in 1.0.63)"
15288 #: ../src/guestfs-actions.pod:5464
15289 msgid "guestfs_read_lines"
15293 #: ../src/guestfs-actions.pod:5466
15297 " guestfs_read_lines (guestfs_h *g,\n"
15298 " const char *path);\n"
15303 #: ../src/guestfs-actions.pod:5472 ../fish/guestfish-actions.pod:3673
15305 "The file contents are returned as a list of lines. Trailing C<LF> and "
15306 "C<CRLF> character sequences are I<not> returned."
15310 #: ../src/guestfs-actions.pod:5475
15312 "Note that this function cannot correctly handle binary files (specifically, "
15313 "files containing C<\\0> character which is treated as end of line). For "
15314 "those you need to use the C<guestfs_read_file> function which has a more "
15315 "complex interface."
15319 #: ../src/guestfs-actions.pod:5486
15320 msgid "guestfs_readdir"
15324 #: ../src/guestfs-actions.pod:5488
15327 " struct guestfs_dirent_list *\n"
15328 " guestfs_readdir (guestfs_h *g,\n"
15329 " const char *dir);\n"
15334 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3685
15335 msgid "This returns the list of directory entries in directory C<dir>."
15339 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
15341 "All entries in the directory are returned, including C<.> and C<..>. The "
15342 "entries are I<not> sorted, but returned in the same order as the underlying "
15347 #: ../src/guestfs-actions.pod:5498 ../fish/guestfish-actions.pod:3691
15349 "Also this call returns basic file type information about each file. The "
15350 "C<ftyp> field will contain one of the following characters:"
15354 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15359 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
15360 msgid "Block special"
15364 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15369 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
15370 msgid "Char special"
15374 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
15379 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
15384 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
15389 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15390 msgid "FIFO (named pipe)"
15394 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15399 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15400 msgid "Symbolic link"
15404 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15409 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15410 msgid "Regular file"
15414 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
15419 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
15424 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
15429 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
15430 msgid "Unknown file type"
15434 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3728
15439 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3730
15441 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15445 #: ../src/guestfs-actions.pod:5542
15447 "This function is primarily intended for use by programs. To get a simple "
15448 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15449 "consumption, use C<guestfs_ll>."
15453 #: ../src/guestfs-actions.pod:5546
15455 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15456 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15460 #: ../src/guestfs-actions.pod:5552
15461 msgid "guestfs_readlink"
15465 #: ../src/guestfs-actions.pod:5554
15469 " guestfs_readlink (guestfs_h *g,\n"
15470 " const char *path);\n"
15475 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3743
15476 msgid "This command reads the target of a symbolic link."
15480 #: ../src/guestfs-actions.pod:5565
15481 msgid "guestfs_readlinklist"
15485 #: ../src/guestfs-actions.pod:5567
15489 " guestfs_readlinklist (guestfs_h *g,\n"
15490 " const char *path,\n"
15491 " char *const *names);\n"
15496 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
15498 "This call allows you to do a C<readlink> operation on multiple files, where "
15499 "all files are in the directory C<path>. C<names> is the list of files from "
15504 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
15506 "On return you get a list of strings, with a one-to-one correspondence to the "
15507 "C<names> list. Each string is the value of the symbolic link."
15511 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3757
15513 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15514 "result string is the empty string C<\"\">. However the whole operation is "
15515 "completed even if there were C<readlink(2)> errors, and so you can call this "
15516 "function with names where you don't know if they are symbolic links already "
15517 "(albeit slightly less efficient)."
15521 #: ../src/guestfs-actions.pod:5587 ../fish/guestfish-actions.pod:3764
15523 "This call is intended for programs that want to efficiently list a directory "
15524 "contents without making many round-trips. Very long directory listings "
15525 "might cause the protocol message size to be exceeded, causing this call to "
15526 "fail. The caller must split up such requests into smaller groups of names."
15530 #: ../src/guestfs-actions.pod:5600
15531 msgid "guestfs_realpath"
15535 #: ../src/guestfs-actions.pod:5602
15539 " guestfs_realpath (guestfs_h *g,\n"
15540 " const char *path);\n"
15545 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3775
15547 "Return the canonicalized absolute pathname of C<path>. The returned path "
15548 "has no C<.>, C<..> or symbolic link path elements."
15552 #: ../src/guestfs-actions.pod:5614
15553 msgid "guestfs_removexattr"
15557 #: ../src/guestfs-actions.pod:5616
15561 " guestfs_removexattr (guestfs_h *g,\n"
15562 " const char *xattr,\n"
15563 " const char *path);\n"
15568 #: ../src/guestfs-actions.pod:5621 ../fish/guestfish-actions.pod:3782
15570 "This call removes the extended attribute named C<xattr> of the file C<path>."
15574 #: ../src/guestfs-actions.pod:5624
15575 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15579 #: ../src/guestfs-actions.pod:5630
15580 msgid "guestfs_resize2fs"
15584 #: ../src/guestfs-actions.pod:5632
15588 " guestfs_resize2fs (guestfs_h *g,\n"
15589 " const char *device);\n"
15594 #: ../src/guestfs-actions.pod:5636 ../fish/guestfish-actions.pod:3791
15596 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15597 "underlying device."
15601 #: ../src/guestfs-actions.pod:5639
15603 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15604 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15605 "sometimes gives an error about this and sometimes not. In any case, it is "
15606 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15610 #: ../src/guestfs-actions.pod:5649
15611 msgid "guestfs_resize2fs_M"
15615 #: ../src/guestfs-actions.pod:5651
15619 " guestfs_resize2fs_M (guestfs_h *g,\n"
15620 " const char *device);\n"
15625 #: ../src/guestfs-actions.pod:5655
15627 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15628 "resized to its minimum size. This works like the I<-M> option to the "
15629 "C<resize2fs> command."
15633 #: ../src/guestfs-actions.pod:5659
15635 "To get the resulting size of the filesystem you should call "
15636 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15637 "These two numbers, multiplied together, give the resulting size of the "
15638 "minimal filesystem in bytes."
15642 #: ../src/guestfs-actions.pod:5666
15643 msgid "guestfs_resize2fs_size"
15647 #: ../src/guestfs-actions.pod:5668
15651 " guestfs_resize2fs_size (guestfs_h *g,\n"
15652 " const char *device,\n"
15653 " int64_t size);\n"
15658 #: ../src/guestfs-actions.pod:5673
15660 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15661 "to specify the new size (in bytes) explicitly."
15665 #: ../src/guestfs-actions.pod:5680
15670 #: ../src/guestfs-actions.pod:5682
15674 " guestfs_rm (guestfs_h *g,\n"
15675 " const char *path);\n"
15680 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3824
15681 msgid "Remove the single file C<path>."
15685 #: ../src/guestfs-actions.pod:5692
15686 msgid "guestfs_rm_rf"
15690 #: ../src/guestfs-actions.pod:5694
15694 " guestfs_rm_rf (guestfs_h *g,\n"
15695 " const char *path);\n"
15700 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3830
15702 "Remove the file or directory C<path>, recursively removing the contents if "
15703 "its a directory. This is like the C<rm -rf> shell command."
15707 #: ../src/guestfs-actions.pod:5706
15708 msgid "guestfs_rmdir"
15712 #: ../src/guestfs-actions.pod:5708
15716 " guestfs_rmdir (guestfs_h *g,\n"
15717 " const char *path);\n"
15722 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3838
15723 msgid "Remove the single directory C<path>."
15727 #: ../src/guestfs-actions.pod:5718
15728 msgid "guestfs_rmmountpoint"
15732 #: ../src/guestfs-actions.pod:5720
15736 " guestfs_rmmountpoint (guestfs_h *g,\n"
15737 " const char *exemptpath);\n"
15742 #: ../src/guestfs-actions.pod:5724
15744 "This calls removes a mountpoint that was previously created with "
15745 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15749 #: ../src/guestfs-actions.pod:5732
15750 msgid "guestfs_scrub_device"
15754 #: ../src/guestfs-actions.pod:5734
15758 " guestfs_scrub_device (guestfs_h *g,\n"
15759 " const char *device);\n"
15764 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3852
15766 "This command writes patterns over C<device> to make data retrieval more "
15771 #: ../src/guestfs-actions.pod:5741 ../src/guestfs-actions.pod:5762
15772 #: ../src/guestfs-actions.pod:5781 ../fish/guestfish-actions.pod:3855
15773 #: ../fish/guestfish-actions.pod:3870 ../fish/guestfish-actions.pod:3883
15775 "It is an interface to the L<scrub(1)> program. See that manual page for "
15780 #: ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5767
15781 #: ../src/guestfs-actions.pod:5786
15782 msgid "(Added in 1.0.52)"
15786 #: ../src/guestfs-actions.pod:5751
15787 msgid "guestfs_scrub_file"
15791 #: ../src/guestfs-actions.pod:5753
15795 " guestfs_scrub_file (guestfs_h *g,\n"
15796 " const char *file);\n"
15801 #: ../src/guestfs-actions.pod:5757 ../fish/guestfish-actions.pod:3865
15803 "This command writes patterns over a file to make data retrieval more "
15808 #: ../src/guestfs-actions.pod:5760 ../fish/guestfish-actions.pod:3868
15809 msgid "The file is I<removed> after scrubbing."
15813 #: ../src/guestfs-actions.pod:5769
15814 msgid "guestfs_scrub_freespace"
15818 #: ../src/guestfs-actions.pod:5771
15822 " guestfs_scrub_freespace (guestfs_h *g,\n"
15823 " const char *dir);\n"
15828 #: ../src/guestfs-actions.pod:5775
15830 "This command creates the directory C<dir> and then fills it with files until "
15831 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15832 "and deletes them. The intention is to scrub any free space on the partition "
15833 "containing C<dir>."
15837 #: ../src/guestfs-actions.pod:5788
15838 msgid "guestfs_set_append"
15842 #: ../src/guestfs-actions.pod:5790
15846 " guestfs_set_append (guestfs_h *g,\n"
15847 " const char *append);\n"
15852 #: ../src/guestfs-actions.pod:5794 ../fish/guestfish-actions.pod:3892
15854 "This function is used to add additional options to the guest kernel command "
15859 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3895
15861 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15862 "environment variable."
15866 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3898
15868 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15869 "(libguestfs always adds a few of its own)."
15873 #: ../src/guestfs-actions.pod:5807
15874 msgid "guestfs_set_attach_method"
15878 #: ../src/guestfs-actions.pod:5809
15882 " guestfs_set_attach_method (guestfs_h *g,\n"
15883 " const char *attachmethod);\n"
15888 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
15890 "Set the method that libguestfs uses to connect to the back end guestfsd "
15891 "daemon. Possible methods are:"
15895 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3914
15897 "Launch an appliance and connect to it. This is the ordinary method and the "
15902 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
15903 msgid "C<unix:I<path>>"
15907 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3919
15908 msgid "Connect to the Unix domain socket I<path>."
15912 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3921
15914 "This method lets you connect to an existing daemon or (using virtio-serial) "
15915 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15916 "RUNNING DAEMONS>."
15920 #: ../src/guestfs-actions.pod:5835
15921 msgid "guestfs_set_autosync"
15925 #: ../src/guestfs-actions.pod:5837
15929 " guestfs_set_autosync (guestfs_h *g,\n"
15930 " int autosync);\n"
15935 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3933
15937 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15938 "effort attempt to make filesystems consistent and synchronized when the "
15939 "handle is closed (also if the program exits without closing handles)."
15943 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3938
15945 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15946 "disabled by default)."
15950 #: ../src/guestfs-actions.pod:5853
15951 msgid "guestfs_set_direct"
15955 #: ../src/guestfs-actions.pod:5855
15959 " guestfs_set_direct (guestfs_h *g,\n"
15965 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3947
15967 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15968 "passed directly through to the appliance once it is launched."
15972 #: ../src/guestfs-actions.pod:5863
15974 "One consequence of this is that log messages aren't caught by the library "
15975 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15980 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3955
15981 msgid "You probably don't want to use this unless you know what you are doing."
15985 #: ../src/guestfs-actions.pod:5870 ../fish/guestfish-actions.pod:3958
15986 msgid "The default is disabled."
15990 #: ../src/guestfs-actions.pod:5876
15991 msgid "guestfs_set_e2label"
15995 #: ../src/guestfs-actions.pod:5878
15999 " guestfs_set_e2label (guestfs_h *g,\n"
16000 " const char *device,\n"
16001 " const char *label);\n"
16006 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3964
16008 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16009 "C<label>. Filesystem labels are limited to 16 characters."
16013 #: ../src/guestfs-actions.pod:5887
16015 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16016 "the existing label on a filesystem."
16020 #: ../src/guestfs-actions.pod:5894
16021 msgid "guestfs_set_e2uuid"
16025 #: ../src/guestfs-actions.pod:5896
16029 " guestfs_set_e2uuid (guestfs_h *g,\n"
16030 " const char *device,\n"
16031 " const char *uuid);\n"
16036 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3975
16038 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16039 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16040 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16044 #: ../src/guestfs-actions.pod:5906
16046 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16047 "the existing UUID of a filesystem."
16051 #: ../src/guestfs-actions.pod:5913
16052 msgid "guestfs_set_memsize"
16056 #: ../src/guestfs-actions.pod:5915
16060 " guestfs_set_memsize (guestfs_h *g,\n"
16066 #: ../src/guestfs-actions.pod:5919
16068 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16069 "This only has any effect if called before C<guestfs_launch>."
16073 #: ../src/guestfs-actions.pod:5923 ../fish/guestfish-actions.pod:3993
16075 "You can also change this by setting the environment variable "
16076 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16080 #: ../src/guestfs-actions.pod:5934
16081 msgid "guestfs_set_network"
16085 #: ../src/guestfs-actions.pod:5936
16089 " guestfs_set_network (guestfs_h *g,\n"
16095 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:4006
16097 "If C<network> is true, then the network is enabled in the libguestfs "
16098 "appliance. The default is false."
16102 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:4009
16104 "This affects whether commands are able to access the network (see L<guestfs"
16105 "(3)/RUNNING COMMANDS>)."
16109 #: ../src/guestfs-actions.pod:5946
16111 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16116 #: ../src/guestfs-actions.pod:5953
16117 msgid "guestfs_set_path"
16121 #: ../src/guestfs-actions.pod:5955
16125 " guestfs_set_path (guestfs_h *g,\n"
16126 " const char *searchpath);\n"
16131 #: ../src/guestfs-actions.pod:5959 ../fish/guestfish-actions.pod:4021
16132 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16136 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4023
16138 "The default is C<$libdir/guestfs> unless overridden by setting "
16139 "C<LIBGUESTFS_PATH> environment variable."
16143 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4026
16144 msgid "Setting C<path> to C<NULL> restores the default path."
16148 #: ../src/guestfs-actions.pod:5970
16149 msgid "guestfs_set_qemu"
16153 #: ../src/guestfs-actions.pod:5972
16157 " guestfs_set_qemu (guestfs_h *g,\n"
16158 " const char *qemu);\n"
16163 #: ../src/guestfs-actions.pod:5976 ../fish/guestfish-actions.pod:4034
16164 msgid "Set the qemu binary that we will use."
16168 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4036
16170 "The default is chosen when the library was compiled by the configure script."
16174 #: ../src/guestfs-actions.pod:5981 ../fish/guestfish-actions.pod:4039
16176 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16181 #: ../src/guestfs-actions.pod:5984 ../fish/guestfish-actions.pod:4042
16182 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16186 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:4044
16188 "Note that you should call this function as early as possible after creating "
16189 "the handle. This is because some pre-launch operations depend on testing "
16190 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16191 "don't retest features, and so you might see inconsistent results. Using the "
16192 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16193 "the qemu binary at the same time as the handle is created."
16197 #: ../src/guestfs-actions.pod:5998
16198 msgid "guestfs_set_recovery_proc"
16202 #: ../src/guestfs-actions.pod:6000
16206 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16207 " int recoveryproc);\n"
16212 #: ../src/guestfs-actions.pod:6004
16214 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16215 "not create a recovery process. The purpose of the recovery process is to "
16216 "stop runaway qemu processes in the case where the main program aborts "
16221 #: ../src/guestfs-actions.pod:6009
16223 "This only has any effect if called before C<guestfs_launch>, and the default "
16228 #: ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:4066
16230 "About the only time when you would want to disable this is if the main "
16231 "process will fork itself into the background (\"daemonize\" itself). In "
16232 "this case the recovery process thinks that the main program has disappeared "
16233 "and so kills qemu, which is not very helpful."
16237 #: ../src/guestfs-actions.pod:6022
16238 msgid "guestfs_set_selinux"
16242 #: ../src/guestfs-actions.pod:6024
16246 " guestfs_set_selinux (guestfs_h *g,\n"
16252 #: ../src/guestfs-actions.pod:6028 ../fish/guestfish-actions.pod:4078
16254 "This sets the selinux flag that is passed to the appliance at boot time. "
16255 "The default is C<selinux=0> (disabled)."
16259 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4081
16261 "Note that if SELinux is enabled, it is always in Permissive mode "
16262 "(C<enforcing=0>)."
16266 #: ../src/guestfs-actions.pod:6041
16267 msgid "guestfs_set_trace"
16271 #: ../src/guestfs-actions.pod:6043
16275 " guestfs_set_trace (guestfs_h *g,\n"
16281 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4093
16283 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16284 "return values are traced."
16288 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
16290 "If you want to trace C API calls into libguestfs (and other libraries) then "
16291 "possibly a better way is to use the external ltrace(1) command."
16295 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:4100
16297 "Command traces are disabled unless the environment variable "
16298 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16302 #: ../src/guestfs-actions.pod:6057
16304 "Trace messages are normally sent to C<stderr>, unless you register a "
16305 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16309 #: ../src/guestfs-actions.pod:6065
16310 msgid "guestfs_set_verbose"
16314 #: ../src/guestfs-actions.pod:6067
16318 " guestfs_set_verbose (guestfs_h *g,\n"
16324 #: ../src/guestfs-actions.pod:6071 ../fish/guestfish-actions.pod:4113
16325 msgid "If C<verbose> is true, this turns on verbose messages."
16329 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4115
16331 "Verbose messages are disabled unless the environment variable "
16332 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16336 #: ../src/guestfs-actions.pod:6076
16338 "Verbose messages are normally sent to C<stderr>, unless you register a "
16339 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16343 #: ../src/guestfs-actions.pod:6084
16344 msgid "guestfs_setcon"
16348 #: ../src/guestfs-actions.pod:6086
16352 " guestfs_setcon (guestfs_h *g,\n"
16353 " const char *context);\n"
16358 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4126
16360 "This sets the SELinux security context of the daemon to the string "
16365 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4129
16366 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16370 #: ../src/guestfs-actions.pod:6099
16371 msgid "guestfs_setxattr"
16375 #: ../src/guestfs-actions.pod:6101
16379 " guestfs_setxattr (guestfs_h *g,\n"
16380 " const char *xattr,\n"
16381 " const char *val,\n"
16383 " const char *path);\n"
16388 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4135
16390 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16391 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16395 #: ../src/guestfs-actions.pod:6112
16396 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16400 #: ../src/guestfs-actions.pod:6118
16401 msgid "guestfs_sfdisk"
16405 #: ../src/guestfs-actions.pod:6120
16409 " guestfs_sfdisk (guestfs_h *g,\n"
16410 " const char *device,\n"
16414 " char *const *lines);\n"
16419 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4145
16421 "This is a direct interface to the L<sfdisk(8)> program for creating "
16422 "partitions on block devices."
16426 #: ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:4148
16427 msgid "C<device> should be a block device, for example C</dev/sda>."
16431 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4150
16433 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16434 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16435 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16436 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16437 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16438 "the kernel) cannot work out the right geometry and you will need to tell it."
16442 #: ../src/guestfs-actions.pod:6141 ../fish/guestfish-actions.pod:4158
16444 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16445 "refer to the L<sfdisk(8)> manpage."
16449 #: ../src/guestfs-actions.pod:6144 ../fish/guestfish-actions.pod:4161
16451 "To create a single partition occupying the whole disk, you would pass "
16452 "C<lines> as a single element list, when the single element being the string "
16457 #: ../src/guestfs-actions.pod:6148
16459 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16463 #: ../src/guestfs-actions.pod:6156 ../src/guestfs-actions.pod:6186
16464 #: ../src/guestfs-actions.pod:6219 ../fish/guestfish-actions.pod:4171
16465 #: ../fish/guestfish-actions.pod:4194 ../fish/guestfish-actions.pod:4216
16467 "This function is deprecated. In new code, use the C<part_add> call instead."
16471 #: ../src/guestfs-actions.pod:6165
16472 msgid "guestfs_sfdiskM"
16476 #: ../src/guestfs-actions.pod:6167
16480 " guestfs_sfdiskM (guestfs_h *g,\n"
16481 " const char *device,\n"
16482 " char *const *lines);\n"
16487 #: ../src/guestfs-actions.pod:6172
16489 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16490 "partition sizes are specified in megabytes only (rounded to the nearest "
16491 "cylinder) and you don't need to specify the cyls, heads and sectors "
16492 "parameters which were rarely if ever used anyway."
16496 #: ../src/guestfs-actions.pod:6178
16498 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16499 "C<guestfs_part_disk>"
16503 #: ../src/guestfs-actions.pod:6195
16504 msgid "guestfs_sfdisk_N"
16508 #: ../src/guestfs-actions.pod:6197
16512 " guestfs_sfdisk_N (guestfs_h *g,\n"
16513 " const char *device,\n"
16518 " const char *line);\n"
16523 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4205
16525 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16526 "(note: C<n> counts from 1)."
16530 #: ../src/guestfs-actions.pod:6209
16532 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16533 "for the cyls/heads/sectors parameters."
16537 #: ../src/guestfs-actions.pod:6212
16538 msgid "See also: C<guestfs_part_add>"
16542 #: ../src/guestfs-actions.pod:6228
16543 msgid "guestfs_sfdisk_disk_geometry"
16547 #: ../src/guestfs-actions.pod:6230
16551 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16552 " const char *device);\n"
16557 #: ../src/guestfs-actions.pod:6234
16559 "This displays the disk geometry of C<device> read from the partition table. "
16560 "Especially in the case where the underlying block device has been resized, "
16561 "this can be different from the kernel's idea of the geometry (see "
16562 "C<guestfs_sfdisk_kernel_geometry>)."
16566 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6255
16567 #: ../fish/guestfish-actions.pod:4232 ../fish/guestfish-actions.pod:4241
16568 msgid "The result is in human-readable format, and not designed to be parsed."
16572 #: ../src/guestfs-actions.pod:6247
16573 msgid "guestfs_sfdisk_kernel_geometry"
16577 #: ../src/guestfs-actions.pod:6249
16581 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16582 " const char *device);\n"
16587 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4239
16588 msgid "This displays the kernel's idea of the geometry of C<device>."
16592 #: ../src/guestfs-actions.pod:6263
16593 msgid "guestfs_sfdisk_l"
16597 #: ../src/guestfs-actions.pod:6265
16601 " guestfs_sfdisk_l (guestfs_h *g,\n"
16602 " const char *device);\n"
16607 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4248
16609 "This displays the partition table on C<device>, in the human-readable output "
16610 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16614 #: ../src/guestfs-actions.pod:6273
16615 msgid "See also: C<guestfs_part_list>"
16619 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4254
16621 "This function is deprecated. In new code, use the C<part_list> call instead."
16625 #: ../src/guestfs-actions.pod:6287
16630 #: ../src/guestfs-actions.pod:6289
16634 " guestfs_sh (guestfs_h *g,\n"
16635 " const char *command);\n"
16640 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4265
16642 "This call runs a command from the guest filesystem via the guest's C</bin/"
16647 #: ../src/guestfs-actions.pod:6296
16648 msgid "This is like C<guestfs_command>, but passes the command to:"
16652 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4270
16655 " /bin/sh -c \"command\"\n"
16660 #: ../src/guestfs-actions.pod:6300 ../fish/guestfish-actions.pod:4272
16662 "Depending on the guest's shell, this usually results in wildcards being "
16663 "expanded, shell expressions being interpolated and so on."
16667 #: ../src/guestfs-actions.pod:6304
16668 msgid "All the provisos about C<guestfs_command> apply to this call."
16672 #: ../src/guestfs-actions.pod:6311
16673 msgid "guestfs_sh_lines"
16677 #: ../src/guestfs-actions.pod:6313
16681 " guestfs_sh_lines (guestfs_h *g,\n"
16682 " const char *command);\n"
16687 #: ../src/guestfs-actions.pod:6317
16689 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16694 #: ../src/guestfs-actions.pod:6320
16695 msgid "See also: C<guestfs_command_lines>"
16699 #: ../src/guestfs-actions.pod:6328
16700 msgid "guestfs_sleep"
16704 #: ../src/guestfs-actions.pod:6330
16708 " guestfs_sleep (guestfs_h *g,\n"
16714 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4291
16715 msgid "Sleep for C<secs> seconds."
16719 #: ../src/guestfs-actions.pod:6338
16720 msgid "(Added in 1.0.41)"
16724 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-structs.pod:109
16725 msgid "guestfs_stat"
16729 #: ../src/guestfs-actions.pod:6342
16732 " struct guestfs_stat *\n"
16733 " guestfs_stat (guestfs_h *g,\n"
16734 " const char *path);\n"
16739 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4299
16740 msgid "This is the same as the C<stat(2)> system call."
16744 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-structs.pod:135
16745 msgid "guestfs_statvfs"
16749 #: ../src/guestfs-actions.pod:6358
16752 " struct guestfs_statvfs *\n"
16753 " guestfs_statvfs (guestfs_h *g,\n"
16754 " const char *path);\n"
16759 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4305
16761 "Returns file system statistics for any mounted file system. C<path> should "
16762 "be a file or directory in the mounted file system (typically it is the mount "
16763 "point itself, but it doesn't need to be)."
16767 #: ../src/guestfs-actions.pod:6366 ../fish/guestfish-actions.pod:4309
16768 msgid "This is the same as the C<statvfs(2)> system call."
16772 #: ../src/guestfs-actions.pod:6368
16774 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16775 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16779 #: ../src/guestfs-actions.pod:6374
16780 msgid "guestfs_strings"
16784 #: ../src/guestfs-actions.pod:6376
16788 " guestfs_strings (guestfs_h *g,\n"
16789 " const char *path);\n"
16794 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4315
16796 "This runs the L<strings(1)> command on a file and returns the list of "
16797 "printable strings found."
16801 #: ../src/guestfs-actions.pod:6392
16802 msgid "guestfs_strings_e"
16806 #: ../src/guestfs-actions.pod:6394
16810 " guestfs_strings_e (guestfs_h *g,\n"
16811 " const char *encoding,\n"
16812 " const char *path);\n"
16817 #: ../src/guestfs-actions.pod:6399
16819 "This is like the C<guestfs_strings> command, but allows you to specify the "
16820 "encoding of strings that are looked for in the source file C<path>."
16824 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4329
16825 msgid "Allowed encodings are:"
16829 #: ../src/guestfs-actions.pod:6407 ../fish/guestfish-actions.pod:4333
16834 #: ../src/guestfs-actions.pod:6409
16836 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16837 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16841 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4338
16846 #: ../src/guestfs-actions.pod:6414 ../fish/guestfish-actions.pod:4340
16847 msgid "Single 8-bit-byte characters."
16851 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4342
16856 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4344
16857 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16861 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
16862 msgid "l (lower case letter L)"
16866 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4349
16868 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16869 "examining binaries in Windows guests."
16873 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4352
16878 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4354
16879 msgid "32-bit big endian such as UCS-4BE."
16883 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
16888 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
16889 msgid "32-bit little endian such as UCS-4LE."
16893 #: ../src/guestfs-actions.pod:6436 ../fish/guestfish-actions.pod:4362
16894 msgid "The returned strings are transcoded to UTF-8."
16898 #: ../src/guestfs-actions.pod:6447
16899 msgid "guestfs_swapoff_device"
16903 #: ../src/guestfs-actions.pod:6449
16907 " guestfs_swapoff_device (guestfs_h *g,\n"
16908 " const char *device);\n"
16913 #: ../src/guestfs-actions.pod:6453
16915 "This command disables the libguestfs appliance swap device or partition "
16916 "named C<device>. See C<guestfs_swapon_device>."
16920 #: ../src/guestfs-actions.pod:6461
16921 msgid "guestfs_swapoff_file"
16925 #: ../src/guestfs-actions.pod:6463
16929 " guestfs_swapoff_file (guestfs_h *g,\n"
16930 " const char *file);\n"
16935 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4379
16936 msgid "This command disables the libguestfs appliance swap on file."
16940 #: ../src/guestfs-actions.pod:6473
16941 msgid "guestfs_swapoff_label"
16945 #: ../src/guestfs-actions.pod:6475
16949 " guestfs_swapoff_label (guestfs_h *g,\n"
16950 " const char *label);\n"
16955 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4385
16957 "This command disables the libguestfs appliance swap on labeled swap "
16962 #: ../src/guestfs-actions.pod:6486
16963 msgid "guestfs_swapoff_uuid"
16967 #: ../src/guestfs-actions.pod:6488
16971 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16972 " const char *uuid);\n"
16977 #: ../src/guestfs-actions.pod:6492 ../fish/guestfish-actions.pod:4392
16979 "This command disables the libguestfs appliance swap partition with the given "
16984 #: ../src/guestfs-actions.pod:6499
16985 msgid "guestfs_swapon_device"
16989 #: ../src/guestfs-actions.pod:6501
16993 " guestfs_swapon_device (guestfs_h *g,\n"
16994 " const char *device);\n"
16999 #: ../src/guestfs-actions.pod:6505
17001 "This command enables the libguestfs appliance to use the swap device or "
17002 "partition named C<device>. The increased memory is made available for all "
17003 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17007 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4404
17009 "Note that you should not swap to existing guest swap partitions unless you "
17010 "know what you are doing. They may contain hibernation information, or other "
17011 "information that the guest doesn't want you to trash. You also risk leaking "
17012 "information about the host to the guest this way. Instead, attach a new "
17013 "host device to the guest and swap on that."
17017 #: ../src/guestfs-actions.pod:6521
17018 msgid "guestfs_swapon_file"
17022 #: ../src/guestfs-actions.pod:6523
17026 " guestfs_swapon_file (guestfs_h *g,\n"
17027 " const char *file);\n"
17032 #: ../src/guestfs-actions.pod:6527
17034 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17039 #: ../src/guestfs-actions.pod:6534
17040 msgid "guestfs_swapon_label"
17044 #: ../src/guestfs-actions.pod:6536
17048 " guestfs_swapon_label (guestfs_h *g,\n"
17049 " const char *label);\n"
17054 #: ../src/guestfs-actions.pod:6540
17056 "This command enables swap to a labeled swap partition. See "
17057 "C<guestfs_swapon_device> for other notes."
17061 #: ../src/guestfs-actions.pod:6547
17062 msgid "guestfs_swapon_uuid"
17066 #: ../src/guestfs-actions.pod:6549
17070 " guestfs_swapon_uuid (guestfs_h *g,\n"
17071 " const char *uuid);\n"
17076 #: ../src/guestfs-actions.pod:6553
17078 "This command enables swap to a swap partition with the given UUID. See "
17079 "C<guestfs_swapon_device> for other notes."
17083 #: ../src/guestfs-actions.pod:6560
17084 msgid "guestfs_sync"
17088 #: ../src/guestfs-actions.pod:6562
17092 " guestfs_sync (guestfs_h *g);\n"
17097 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4436
17099 "This syncs the disk, so that any writes are flushed through to the "
17100 "underlying disk image."
17104 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4439
17106 "You should always call this if you have modified a disk image, before "
17107 "closing the handle."
17111 #: ../src/guestfs-actions.pod:6575
17112 msgid "guestfs_tail"
17116 #: ../src/guestfs-actions.pod:6577
17120 " guestfs_tail (guestfs_h *g,\n"
17121 " const char *path);\n"
17126 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4446
17128 "This command returns up to the last 10 lines of a file as a list of strings."
17132 #: ../src/guestfs-actions.pod:6593
17133 msgid "guestfs_tail_n"
17137 #: ../src/guestfs-actions.pod:6595
17141 " guestfs_tail_n (guestfs_h *g,\n"
17143 " const char *path);\n"
17148 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4456
17150 "If the parameter C<nrlines> is a positive number, this returns the last "
17151 "C<nrlines> lines of the file C<path>."
17155 #: ../src/guestfs-actions.pod:6603 ../fish/guestfish-actions.pod:4459
17157 "If the parameter C<nrlines> is a negative number, this returns lines from "
17158 "the file C<path>, starting with the C<-nrlines>th line."
17162 #: ../src/guestfs-actions.pod:6617
17163 msgid "guestfs_tar_in"
17167 #: ../src/guestfs-actions.pod:6619
17171 " guestfs_tar_in (guestfs_h *g,\n"
17172 " const char *tarfile,\n"
17173 " const char *directory);\n"
17178 #: ../src/guestfs-actions.pod:6624 ../fish/guestfish-actions.pod:4471
17180 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17181 "tar file) into C<directory>."
17185 #: ../src/guestfs-actions.pod:6627
17187 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17191 #: ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6649
17192 #: ../src/guestfs-actions.pod:6665 ../src/guestfs-actions.pod:6681
17193 msgid "(Added in 1.0.3)"
17197 #: ../src/guestfs-actions.pod:6634
17198 msgid "guestfs_tar_out"
17202 #: ../src/guestfs-actions.pod:6636
17206 " guestfs_tar_out (guestfs_h *g,\n"
17207 " const char *directory,\n"
17208 " const char *tarfile);\n"
17213 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4483
17215 "This command packs the contents of C<directory> and downloads it to local "
17220 #: ../src/guestfs-actions.pod:6644
17222 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17223 "C<guestfs_txz_out>."
17227 #: ../src/guestfs-actions.pod:6651
17228 msgid "guestfs_tgz_in"
17232 #: ../src/guestfs-actions.pod:6653
17236 " guestfs_tgz_in (guestfs_h *g,\n"
17237 " const char *tarball,\n"
17238 " const char *directory);\n"
17243 #: ../src/guestfs-actions.pod:6658 ../fish/guestfish-actions.pod:4495
17245 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17246 "tar file) into C<directory>."
17250 #: ../src/guestfs-actions.pod:6661
17251 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17255 #: ../src/guestfs-actions.pod:6667
17256 msgid "guestfs_tgz_out"
17260 #: ../src/guestfs-actions.pod:6669
17264 " guestfs_tgz_out (guestfs_h *g,\n"
17265 " const char *directory,\n"
17266 " const char *tarball);\n"
17271 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4506
17273 "This command packs the contents of C<directory> and downloads it to local "
17278 #: ../src/guestfs-actions.pod:6677
17279 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17283 #: ../src/guestfs-actions.pod:6683
17284 msgid "guestfs_touch"
17288 #: ../src/guestfs-actions.pod:6685
17292 " guestfs_touch (guestfs_h *g,\n"
17293 " const char *path);\n"
17298 #: ../src/guestfs-actions.pod:6689 ../fish/guestfish-actions.pod:4517
17300 "Touch acts like the L<touch(1)> command. It can be used to update the "
17301 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17306 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4521
17308 "This command only works on regular files, and will fail on other file types "
17309 "such as directories, symbolic links, block special etc."
17313 #: ../src/guestfs-actions.pod:6700
17314 msgid "guestfs_truncate"
17318 #: ../src/guestfs-actions.pod:6702
17322 " guestfs_truncate (guestfs_h *g,\n"
17323 " const char *path);\n"
17328 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4528
17330 "This command truncates C<path> to a zero-length file. The file must exist "
17335 #: ../src/guestfs-actions.pod:6713
17336 msgid "guestfs_truncate_size"
17340 #: ../src/guestfs-actions.pod:6715
17344 " guestfs_truncate_size (guestfs_h *g,\n"
17345 " const char *path,\n"
17346 " int64_t size);\n"
17351 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4535
17353 "This command truncates C<path> to size C<size> bytes. The file must exist "
17358 #: ../src/guestfs-actions.pod:6723
17360 "If the current file size is less than C<size> then the file is extended to "
17361 "the required size with zero bytes. This creates a sparse file (ie. disk "
17362 "blocks are not allocated for the file until you write to it). To create a "
17363 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17367 #: ../src/guestfs-actions.pod:6733
17368 msgid "guestfs_tune2fs_l"
17372 #: ../src/guestfs-actions.pod:6735
17376 " guestfs_tune2fs_l (guestfs_h *g,\n"
17377 " const char *device);\n"
17382 #: ../src/guestfs-actions.pod:6739 ../fish/guestfish-actions.pod:4548
17384 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17389 #: ../src/guestfs-actions.pod:6742 ../fish/guestfish-actions.pod:4551
17391 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17392 "for more details. The list of fields returned isn't clearly defined, and "
17393 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17394 "and the filesystem itself."
17398 #: ../src/guestfs-actions.pod:6755
17399 msgid "guestfs_txz_in"
17403 #: ../src/guestfs-actions.pod:6757
17407 " guestfs_txz_in (guestfs_h *g,\n"
17408 " const char *tarball,\n"
17409 " const char *directory);\n"
17414 #: ../src/guestfs-actions.pod:6762 ../fish/guestfish-actions.pod:4560
17416 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17417 "tar file) into C<directory>."
17421 #: ../src/guestfs-actions.pod:6769
17422 msgid "guestfs_txz_out"
17426 #: ../src/guestfs-actions.pod:6771
17430 " guestfs_txz_out (guestfs_h *g,\n"
17431 " const char *directory,\n"
17432 " const char *tarball);\n"
17437 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4569
17439 "This command packs the contents of C<directory> and downloads it to local "
17440 "file C<tarball> (as an xz compressed tar archive)."
17444 #: ../src/guestfs-actions.pod:6783
17445 msgid "guestfs_umask"
17449 #: ../src/guestfs-actions.pod:6785
17453 " guestfs_umask (guestfs_h *g,\n"
17459 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4578
17461 "This function sets the mask used for creating new files and device nodes to "
17466 #: ../src/guestfs-actions.pod:6792 ../fish/guestfish-actions.pod:4581
17468 "Typical umask values would be C<022> which creates new files with "
17469 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17470 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17474 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4586
17476 "The default umask is C<022>. This is important because it means that "
17477 "directories and device nodes will be created with C<0644> or C<0755> mode "
17478 "even if you specify C<0777>."
17482 #: ../src/guestfs-actions.pod:6801
17484 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17485 "C<guestfs_mkdir>."
17489 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4593
17490 msgid "This call returns the previous umask."
17494 #: ../src/guestfs-actions.pod:6810
17495 msgid "guestfs_umount"
17499 #: ../src/guestfs-actions.pod:6812
17503 " guestfs_umount (guestfs_h *g,\n"
17504 " const char *pathordevice);\n"
17509 #: ../src/guestfs-actions.pod:6816 ../fish/guestfish-actions.pod:4601
17511 "This unmounts the given filesystem. The filesystem may be specified either "
17512 "by its mountpoint (path) or the device which contains the filesystem."
17516 #: ../src/guestfs-actions.pod:6824
17517 msgid "guestfs_umount_all"
17521 #: ../src/guestfs-actions.pod:6826
17525 " guestfs_umount_all (guestfs_h *g);\n"
17530 #: ../src/guestfs-actions.pod:6829 ../fish/guestfish-actions.pod:4611
17531 msgid "This unmounts all mounted filesystems."
17535 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4613
17536 msgid "Some internal mounts are not unmounted by this call."
17540 #: ../src/guestfs-actions.pod:6837
17541 msgid "guestfs_upload"
17545 #: ../src/guestfs-actions.pod:6839
17549 " guestfs_upload (guestfs_h *g,\n"
17550 " const char *filename,\n"
17551 " const char *remotefilename);\n"
17556 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6868
17557 #: ../fish/guestfish-actions.pod:4619 ../fish/guestfish-actions.pod:4632
17558 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17562 #: ../src/guestfs-actions.pod:6849
17563 msgid "See also C<guestfs_download>."
17567 #: ../src/guestfs-actions.pod:6860
17568 msgid "guestfs_upload_offset"
17572 #: ../src/guestfs-actions.pod:6862
17576 " guestfs_upload_offset (guestfs_h *g,\n"
17577 " const char *filename,\n"
17578 " const char *remotefilename,\n"
17579 " int64_t offset);\n"
17584 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4635
17586 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17587 "The intention is to overwrite parts of existing files or devices, although "
17588 "if a non-existant file is specified then it is created with a \"hole\" "
17589 "before C<offset>. The size of the data written is implicit in the size of "
17590 "the source C<filename>."
17594 #: ../src/guestfs-actions.pod:6878
17596 "Note that there is no limit on the amount of data that can be uploaded with "
17597 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17598 "full amount unless an error occurs."
17602 #: ../src/guestfs-actions.pod:6883
17603 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17607 #: ../src/guestfs-actions.pod:6894
17608 msgid "guestfs_utimens"
17612 #: ../src/guestfs-actions.pod:6896
17616 " guestfs_utimens (guestfs_h *g,\n"
17617 " const char *path,\n"
17618 " int64_t atsecs,\n"
17619 " int64_t atnsecs,\n"
17620 " int64_t mtsecs,\n"
17621 " int64_t mtnsecs);\n"
17626 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4655
17627 msgid "This command sets the timestamps of a file with nanosecond precision."
17631 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4658
17633 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17638 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4661
17640 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17641 "nanoseconds from the epoch."
17645 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4664
17647 "If the C<*nsecs> field contains the special value C<-1> then the "
17648 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17649 "ignored in this case)."
17653 #: ../src/guestfs-actions.pod:6917 ../fish/guestfish-actions.pod:4668
17655 "If the C<*nsecs> field contains the special value C<-2> then the "
17656 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17661 #: ../src/guestfs-actions.pod:6925 ../src/guestfs-structs.pod:175
17662 msgid "guestfs_version"
17666 #: ../src/guestfs-actions.pod:6927
17669 " struct guestfs_version *\n"
17670 " guestfs_version (guestfs_h *g);\n"
17675 #: ../src/guestfs-actions.pod:6930 ../fish/guestfish-actions.pod:4676
17677 "Return the libguestfs version number that the program is linked against."
17681 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4679
17683 "Note that because of dynamic linking this is not necessarily the version of "
17684 "libguestfs that you compiled against. You can compile the program, and then "
17685 "at runtime dynamically link against a completely different C<libguestfs.so> "
17690 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4684
17692 "This call was added in version C<1.0.58>. In previous versions of "
17693 "libguestfs there was no way to get the version number. From C code you can "
17694 "use dynamic linker functions to find out if this symbol exists (if it "
17695 "doesn't, then it's an earlier version)."
17699 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4690
17701 "The call returns a structure with four elements. The first three (C<major>, "
17702 "C<minor> and C<release>) are numbers and correspond to the usual version "
17703 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17704 "but may be used for distro-specific information."
17708 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4696
17710 "To construct the original version string: C<$major.$minor.$release$extra>"
17714 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4699
17715 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17719 #: ../src/guestfs-actions.pod:6955
17721 "I<Note:> Don't use this call to test for availability of features. In "
17722 "enterprise distributions we backport features from later versions into "
17723 "earlier versions, making this an unreliable way to test for features. Use "
17724 "C<guestfs_available> instead."
17728 #: ../src/guestfs-actions.pod:6961
17730 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17731 "error. I<The caller must call C<guestfs_free_version> after use>."
17735 #: ../src/guestfs-actions.pod:6965
17736 msgid "(Added in 1.0.58)"
17740 #: ../src/guestfs-actions.pod:6967
17741 msgid "guestfs_vfs_label"
17745 #: ../src/guestfs-actions.pod:6969
17749 " guestfs_vfs_label (guestfs_h *g,\n"
17750 " const char *device);\n"
17755 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4711
17756 msgid "This returns the filesystem label of the filesystem on C<device>."
17760 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4714
17761 msgid "If the filesystem is unlabeled, this returns the empty string."
17765 #: ../src/guestfs-actions.pod:6978
17766 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17770 #: ../src/guestfs-actions.pod:6983 ../src/guestfs-actions.pod:7020
17771 msgid "(Added in 1.3.18)"
17775 #: ../src/guestfs-actions.pod:6985
17776 msgid "guestfs_vfs_type"
17780 #: ../src/guestfs-actions.pod:6987
17784 " guestfs_vfs_type (guestfs_h *g,\n"
17785 " const char *device);\n"
17790 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4722
17792 "This command gets the filesystem type corresponding to the filesystem on "
17797 #: ../src/guestfs-actions.pod:6994 ../fish/guestfish-actions.pod:4725
17799 "For most filesystems, the result is the name of the Linux VFS module which "
17800 "would be used to mount this filesystem if you mounted it without specifying "
17801 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17805 #: ../src/guestfs-actions.pod:7004
17806 msgid "guestfs_vfs_uuid"
17810 #: ../src/guestfs-actions.pod:7006
17814 " guestfs_vfs_uuid (guestfs_h *g,\n"
17815 " const char *device);\n"
17820 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4734
17821 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17825 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4737
17826 msgid "If the filesystem does not have a UUID, this returns the empty string."
17830 #: ../src/guestfs-actions.pod:7015
17831 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17835 #: ../src/guestfs-actions.pod:7022
17836 msgid "guestfs_vg_activate"
17840 #: ../src/guestfs-actions.pod:7024
17844 " guestfs_vg_activate (guestfs_h *g,\n"
17846 " char *const *volgroups);\n"
17851 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4745
17853 "This command activates or (if C<activate> is false) deactivates all logical "
17854 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17855 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17856 "deactivated, then those devices disappear."
17860 #: ../src/guestfs-actions.pod:7035 ../fish/guestfish-actions.pod:4751
17861 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17865 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4753
17867 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17868 "activated or deactivated."
17872 #: ../src/guestfs-actions.pod:7044
17873 msgid "guestfs_vg_activate_all"
17877 #: ../src/guestfs-actions.pod:7046
17881 " guestfs_vg_activate_all (guestfs_h *g,\n"
17882 " int activate);\n"
17887 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4760
17889 "This command activates or (if C<activate> is false) deactivates all logical "
17890 "volumes in all volume groups. If activated, then they are made known to the "
17891 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17892 "those devices disappear."
17896 #: ../src/guestfs-actions.pod:7056 ../fish/guestfish-actions.pod:4766
17897 msgid "This command is the same as running C<vgchange -a y|n>"
17901 #: ../src/guestfs-actions.pod:7062
17902 msgid "guestfs_vgcreate"
17906 #: ../src/guestfs-actions.pod:7064
17910 " guestfs_vgcreate (guestfs_h *g,\n"
17911 " const char *volgroup,\n"
17912 " char *const *physvols);\n"
17917 #: ../src/guestfs-actions.pod:7069 ../fish/guestfish-actions.pod:4772
17919 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17920 "of physical volumes C<physvols>."
17924 #: ../src/guestfs-actions.pod:7076
17925 msgid "guestfs_vglvuuids"
17929 #: ../src/guestfs-actions.pod:7078
17933 " guestfs_vglvuuids (guestfs_h *g,\n"
17934 " const char *vgname);\n"
17939 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4779
17941 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17942 "volumes created in this volume group."
17946 #: ../src/guestfs-actions.pod:7085
17948 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17949 "associate logical volumes and volume groups."
17953 #: ../src/guestfs-actions.pod:7088
17954 msgid "See also C<guestfs_vgpvuuids>."
17958 #: ../src/guestfs-actions.pod:7096
17959 msgid "guestfs_vgpvuuids"
17963 #: ../src/guestfs-actions.pod:7098
17967 " guestfs_vgpvuuids (guestfs_h *g,\n"
17968 " const char *vgname);\n"
17973 #: ../src/guestfs-actions.pod:7102 ../fish/guestfish-actions.pod:4791
17975 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17976 "volumes that this volume group resides on."
17980 #: ../src/guestfs-actions.pod:7105
17982 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17983 "associate physical volumes and volume groups."
17987 #: ../src/guestfs-actions.pod:7108
17988 msgid "See also C<guestfs_vglvuuids>."
17992 #: ../src/guestfs-actions.pod:7116
17993 msgid "guestfs_vgremove"
17997 #: ../src/guestfs-actions.pod:7118
18001 " guestfs_vgremove (guestfs_h *g,\n"
18002 " const char *vgname);\n"
18007 #: ../src/guestfs-actions.pod:7122 ../fish/guestfish-actions.pod:4803
18008 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18012 #: ../src/guestfs-actions.pod:7124 ../fish/guestfish-actions.pod:4805
18014 "This also forcibly removes all logical volumes in the volume group (if any)."
18018 #: ../src/guestfs-actions.pod:7131
18019 msgid "guestfs_vgrename"
18023 #: ../src/guestfs-actions.pod:7133
18027 " guestfs_vgrename (guestfs_h *g,\n"
18028 " const char *volgroup,\n"
18029 " const char *newvolgroup);\n"
18034 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4812
18035 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18039 #: ../src/guestfs-actions.pod:7144
18040 msgid "guestfs_vgs"
18044 #: ../src/guestfs-actions.pod:7146
18048 " guestfs_vgs (guestfs_h *g);\n"
18053 #: ../src/guestfs-actions.pod:7149 ../fish/guestfish-actions.pod:4818
18055 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18060 #: ../src/guestfs-actions.pod:7152 ../fish/guestfish-actions.pod:4821
18062 "This returns a list of just the volume group names that were detected (eg. "
18067 #: ../src/guestfs-actions.pod:7155
18068 msgid "See also C<guestfs_vgs_full>."
18072 #: ../src/guestfs-actions.pod:7163
18073 msgid "guestfs_vgs_full"
18077 #: ../src/guestfs-actions.pod:7165
18080 " struct guestfs_lvm_vg_list *\n"
18081 " guestfs_vgs_full (guestfs_h *g);\n"
18086 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4830
18088 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18089 "> command. The \"full\" version includes all fields."
18093 #: ../src/guestfs-actions.pod:7171
18095 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18096 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18100 #: ../src/guestfs-actions.pod:7177
18101 msgid "guestfs_vgscan"
18105 #: ../src/guestfs-actions.pod:7179
18109 " guestfs_vgscan (guestfs_h *g);\n"
18114 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4837
18116 "This rescans all block devices and rebuilds the list of LVM physical "
18117 "volumes, volume groups and logical volumes."
18121 #: ../src/guestfs-actions.pod:7189
18122 msgid "guestfs_vguuid"
18126 #: ../src/guestfs-actions.pod:7191
18130 " guestfs_vguuid (guestfs_h *g,\n"
18131 " const char *vgname);\n"
18136 #: ../src/guestfs-actions.pod:7195 ../fish/guestfish-actions.pod:4844
18137 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18141 #: ../src/guestfs-actions.pod:7202
18142 msgid "guestfs_wait_ready"
18146 #: ../src/guestfs-actions.pod:7204
18150 " guestfs_wait_ready (guestfs_h *g);\n"
18155 #: ../src/guestfs-actions.pod:7207
18156 msgid "This function is a no op."
18160 #: ../src/guestfs-actions.pod:7209
18162 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18163 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18164 "is no longer necessary because C<guestfs_launch> now does the waiting."
18168 #: ../src/guestfs-actions.pod:7214
18170 "If you see any calls to this function in code then you can just remove them, "
18171 "unless you want to retain compatibility with older versions of the API."
18175 #: ../src/guestfs-actions.pod:7220
18177 "This function is deprecated. In new code, use the C<launch> call instead."
18181 #: ../src/guestfs-actions.pod:7229
18182 msgid "guestfs_wc_c"
18186 #: ../src/guestfs-actions.pod:7231
18190 " guestfs_wc_c (guestfs_h *g,\n"
18191 " const char *path);\n"
18196 #: ../src/guestfs-actions.pod:7235 ../fish/guestfish-actions.pod:4850
18198 "This command counts the characters in a file, using the C<wc -c> external "
18203 #: ../src/guestfs-actions.pod:7242
18204 msgid "guestfs_wc_l"
18208 #: ../src/guestfs-actions.pod:7244
18212 " guestfs_wc_l (guestfs_h *g,\n"
18213 " const char *path);\n"
18218 #: ../src/guestfs-actions.pod:7248 ../fish/guestfish-actions.pod:4857
18220 "This command counts the lines in a file, using the C<wc -l> external command."
18224 #: ../src/guestfs-actions.pod:7255
18225 msgid "guestfs_wc_w"
18229 #: ../src/guestfs-actions.pod:7257
18233 " guestfs_wc_w (guestfs_h *g,\n"
18234 " const char *path);\n"
18239 #: ../src/guestfs-actions.pod:7261 ../fish/guestfish-actions.pod:4864
18241 "This command counts the words in a file, using the C<wc -w> external command."
18245 #: ../src/guestfs-actions.pod:7268
18246 msgid "guestfs_write"
18250 #: ../src/guestfs-actions.pod:7270
18254 " guestfs_write (guestfs_h *g,\n"
18255 " const char *path,\n"
18256 " const char *content,\n"
18257 " size_t content_size);\n"
18262 #: ../src/guestfs-actions.pod:7276 ../fish/guestfish-actions.pod:4871
18264 "This call creates a file called C<path>. The content of the file is the "
18265 "string C<content> (which can contain any 8 bit data)."
18269 #: ../src/guestfs-actions.pod:7286
18270 msgid "guestfs_write_file"
18274 #: ../src/guestfs-actions.pod:7288
18278 " guestfs_write_file (guestfs_h *g,\n"
18279 " const char *path,\n"
18280 " const char *content,\n"
18286 #: ../src/guestfs-actions.pod:7294 ../fish/guestfish-actions.pod:4881
18288 "This call creates a file called C<path>. The contents of the file is the "
18289 "string C<content> (which can contain any 8 bit data), with length C<size>."
18293 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4885
18295 "As a special case, if C<size> is C<0> then the length is calculated using "
18296 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18300 #: ../src/guestfs-actions.pod:7302 ../fish/guestfish-actions.pod:4889
18302 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18303 "I<not> work, even if the length is specified."
18307 #: ../src/guestfs-actions.pod:7310 ../fish/guestfish-actions.pod:4895
18309 "This function is deprecated. In new code, use the C<write> call instead."
18313 #: ../src/guestfs-actions.pod:7319
18314 msgid "guestfs_zegrep"
18318 #: ../src/guestfs-actions.pod:7321
18322 " guestfs_zegrep (guestfs_h *g,\n"
18323 " const char *regex,\n"
18324 " const char *path);\n"
18329 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4906
18331 "This calls the external C<zegrep> program and returns the matching lines."
18335 #: ../src/guestfs-actions.pod:7338
18336 msgid "guestfs_zegrepi"
18340 #: ../src/guestfs-actions.pod:7340
18344 " guestfs_zegrepi (guestfs_h *g,\n"
18345 " const char *regex,\n"
18346 " const char *path);\n"
18351 #: ../src/guestfs-actions.pod:7345 ../fish/guestfish-actions.pod:4916
18353 "This calls the external C<zegrep -i> program and returns the matching lines."
18357 #: ../src/guestfs-actions.pod:7357
18358 msgid "guestfs_zero"
18362 #: ../src/guestfs-actions.pod:7359
18366 " guestfs_zero (guestfs_h *g,\n"
18367 " const char *device);\n"
18372 #: ../src/guestfs-actions.pod:7363 ../fish/guestfish-actions.pod:4926
18373 msgid "This command writes zeroes over the first few blocks of C<device>."
18377 #: ../src/guestfs-actions.pod:7365 ../fish/guestfish-actions.pod:4928
18379 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18380 "securely wipe the device). It should be sufficient to remove any partition "
18381 "tables, filesystem superblocks and so on."
18385 #: ../src/guestfs-actions.pod:7369
18386 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18390 #: ../src/guestfs-actions.pod:7380
18391 msgid "guestfs_zero_device"
18395 #: ../src/guestfs-actions.pod:7382
18399 " guestfs_zero_device (guestfs_h *g,\n"
18400 " const char *device);\n"
18405 #: ../src/guestfs-actions.pod:7386
18407 "This command writes zeroes over the entire C<device>. Compare with "
18408 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18412 #: ../src/guestfs-actions.pod:7400
18413 msgid "(Added in 1.3.1)"
18417 #: ../src/guestfs-actions.pod:7402
18418 msgid "guestfs_zerofree"
18422 #: ../src/guestfs-actions.pod:7404
18426 " guestfs_zerofree (guestfs_h *g,\n"
18427 " const char *device);\n"
18432 #: ../src/guestfs-actions.pod:7408 ../fish/guestfish-actions.pod:4949
18434 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18435 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18436 "possible to compress the filesystem more effectively."
18440 #: ../src/guestfs-actions.pod:7413 ../fish/guestfish-actions.pod:4954
18441 msgid "You should B<not> run this program if the filesystem is mounted."
18445 #: ../src/guestfs-actions.pod:7416 ../fish/guestfish-actions.pod:4957
18447 "It is possible that using this program can damage the filesystem or data on "
18452 #: ../src/guestfs-actions.pod:7423
18453 msgid "guestfs_zfgrep"
18457 #: ../src/guestfs-actions.pod:7425
18461 " guestfs_zfgrep (guestfs_h *g,\n"
18462 " const char *pattern,\n"
18463 " const char *path);\n"
18468 #: ../src/guestfs-actions.pod:7430 ../fish/guestfish-actions.pod:4964
18470 "This calls the external C<zfgrep> program and returns the matching lines."
18474 #: ../src/guestfs-actions.pod:7442
18475 msgid "guestfs_zfgrepi"
18479 #: ../src/guestfs-actions.pod:7444
18483 " guestfs_zfgrepi (guestfs_h *g,\n"
18484 " const char *pattern,\n"
18485 " const char *path);\n"
18490 #: ../src/guestfs-actions.pod:7449 ../fish/guestfish-actions.pod:4974
18492 "This calls the external C<zfgrep -i> program and returns the matching lines."
18496 #: ../src/guestfs-actions.pod:7461
18497 msgid "guestfs_zfile"
18501 #: ../src/guestfs-actions.pod:7463
18505 " guestfs_zfile (guestfs_h *g,\n"
18506 " const char *meth,\n"
18507 " const char *path);\n"
18512 #: ../src/guestfs-actions.pod:7468 ../fish/guestfish-actions.pod:4984
18514 "This command runs C<file> after first decompressing C<path> using C<method>."
18518 #: ../src/guestfs-actions.pod:7471 ../fish/guestfish-actions.pod:4987
18519 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18523 #: ../src/guestfs-actions.pod:7473
18525 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18530 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4992
18532 "This function is deprecated. In new code, use the C<file> call instead."
18536 #: ../src/guestfs-actions.pod:7488
18537 msgid "guestfs_zgrep"
18541 #: ../src/guestfs-actions.pod:7490
18545 " guestfs_zgrep (guestfs_h *g,\n"
18546 " const char *regex,\n"
18547 " const char *path);\n"
18552 #: ../src/guestfs-actions.pod:7495 ../fish/guestfish-actions.pod:5003
18554 "This calls the external C<zgrep> program and returns the matching lines."
18558 #: ../src/guestfs-actions.pod:7507
18559 msgid "guestfs_zgrepi"
18563 #: ../src/guestfs-actions.pod:7509
18567 " guestfs_zgrepi (guestfs_h *g,\n"
18568 " const char *regex,\n"
18569 " const char *path);\n"
18574 #: ../src/guestfs-actions.pod:7514 ../fish/guestfish-actions.pod:5013
18576 "This calls the external C<zgrep -i> program and returns the matching lines."
18580 #: ../src/guestfs-availability.pod:3
18585 #: ../src/guestfs-availability.pod:5
18587 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18588 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18589 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18590 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18591 "L</guestfs_aug_save> L</guestfs_aug_set>"
18595 #: ../src/guestfs-availability.pod:21
18600 #: ../src/guestfs-availability.pod:23
18602 "The following functions: L</guestfs_inotify_add_watch> L</"
18603 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18604 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18608 #: ../src/guestfs-availability.pod:31
18609 msgid "B<linuxfsuuid>"
18613 #: ../src/guestfs-availability.pod:33
18615 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18616 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18620 #: ../src/guestfs-availability.pod:40
18621 msgid "B<linuxmodules>"
18625 #: ../src/guestfs-availability.pod:42
18626 msgid "The following functions: L</guestfs_modprobe>"
18630 #: ../src/guestfs-availability.pod:45
18631 msgid "B<linuxxattrs>"
18635 #: ../src/guestfs-availability.pod:47
18637 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18638 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18639 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18640 "guestfs_setxattr>"
18644 #: ../src/guestfs-availability.pod:58
18649 #: ../src/guestfs-availability.pod:60
18651 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18652 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18653 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18657 #: ../src/guestfs-availability.pod:69
18662 #: ../src/guestfs-availability.pod:71
18664 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18665 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18666 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18667 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18668 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18669 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18670 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18674 #: ../src/guestfs-availability.pod:94
18679 #: ../src/guestfs-availability.pod:96
18681 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18682 "guestfs_mknod_b> L</guestfs_mknod_c>"
18686 #: ../src/guestfs-availability.pod:102
18691 #: ../src/guestfs-availability.pod:104
18692 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18696 #: ../src/guestfs-availability.pod:107
18697 msgid "B<ntfsprogs>"
18701 #: ../src/guestfs-availability.pod:109
18703 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18707 #: ../src/guestfs-availability.pod:113
18708 msgid "B<realpath>"
18712 #: ../src/guestfs-availability.pod:115
18713 msgid "The following functions: L</guestfs_realpath>"
18717 #: ../src/guestfs-availability.pod:118
18722 #: ../src/guestfs-availability.pod:120
18724 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18725 "guestfs_scrub_freespace>"
18729 #: ../src/guestfs-availability.pod:125
18734 #: ../src/guestfs-availability.pod:127
18735 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18739 #: ../src/guestfs-availability.pod:131
18744 #: ../src/guestfs-availability.pod:133
18745 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18749 #: ../src/guestfs-availability.pod:137
18750 msgid "B<zerofree>"
18754 #: ../src/guestfs-availability.pod:139
18755 msgid "The following functions: L</guestfs_zerofree>"
18759 #: ../src/guestfs-structs.pod:1
18760 msgid "guestfs_int_bool"
18764 #: ../src/guestfs-structs.pod:3
18767 " struct guestfs_int_bool {\n"
18775 #: ../src/guestfs-structs.pod:8
18778 " struct guestfs_int_bool_list {\n"
18779 " uint32_t len; /* Number of elements in list. */\n"
18780 " struct guestfs_int_bool *val; /* Elements. */\n"
18786 #: ../src/guestfs-structs.pod:13
18789 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18790 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18795 #: ../src/guestfs-structs.pod:16
18796 msgid "guestfs_lvm_pv"
18800 #: ../src/guestfs-structs.pod:18
18803 " struct guestfs_lvm_pv {\n"
18804 " char *pv_name;\n"
18805 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18806 " char pv_uuid[32];\n"
18808 " uint64_t pv_size;\n"
18809 " uint64_t dev_size;\n"
18810 " uint64_t pv_free;\n"
18811 " uint64_t pv_used;\n"
18812 " char *pv_attr;\n"
18813 " int64_t pv_pe_count;\n"
18814 " int64_t pv_pe_alloc_count;\n"
18815 " char *pv_tags;\n"
18816 " uint64_t pe_start;\n"
18817 " int64_t pv_mda_count;\n"
18818 " uint64_t pv_mda_free;\n"
18824 #: ../src/guestfs-structs.pod:36
18827 " struct guestfs_lvm_pv_list {\n"
18828 " uint32_t len; /* Number of elements in list. */\n"
18829 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18835 #: ../src/guestfs-structs.pod:41
18838 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18839 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18844 #: ../src/guestfs-structs.pod:44
18845 msgid "guestfs_lvm_vg"
18849 #: ../src/guestfs-structs.pod:46
18852 " struct guestfs_lvm_vg {\n"
18853 " char *vg_name;\n"
18854 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18855 " char vg_uuid[32];\n"
18857 " char *vg_attr;\n"
18858 " uint64_t vg_size;\n"
18859 " uint64_t vg_free;\n"
18860 " char *vg_sysid;\n"
18861 " uint64_t vg_extent_size;\n"
18862 " int64_t vg_extent_count;\n"
18863 " int64_t vg_free_count;\n"
18864 " int64_t max_lv;\n"
18865 " int64_t max_pv;\n"
18866 " int64_t pv_count;\n"
18867 " int64_t lv_count;\n"
18868 " int64_t snap_count;\n"
18869 " int64_t vg_seqno;\n"
18870 " char *vg_tags;\n"
18871 " int64_t vg_mda_count;\n"
18872 " uint64_t vg_mda_free;\n"
18878 #: ../src/guestfs-structs.pod:69
18881 " struct guestfs_lvm_vg_list {\n"
18882 " uint32_t len; /* Number of elements in list. */\n"
18883 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18889 #: ../src/guestfs-structs.pod:74
18892 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18893 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18898 #: ../src/guestfs-structs.pod:77
18899 msgid "guestfs_lvm_lv"
18903 #: ../src/guestfs-structs.pod:79
18906 " struct guestfs_lvm_lv {\n"
18907 " char *lv_name;\n"
18908 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18909 " char lv_uuid[32];\n"
18910 " char *lv_attr;\n"
18911 " int64_t lv_major;\n"
18912 " int64_t lv_minor;\n"
18913 " int64_t lv_kernel_major;\n"
18914 " int64_t lv_kernel_minor;\n"
18915 " uint64_t lv_size;\n"
18916 " int64_t seg_count;\n"
18918 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18919 " float snap_percent;\n"
18920 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18921 " float copy_percent;\n"
18922 " char *move_pv;\n"
18923 " char *lv_tags;\n"
18924 " char *mirror_log;\n"
18925 " char *modules;\n"
18931 #: ../src/guestfs-structs.pod:101
18934 " struct guestfs_lvm_lv_list {\n"
18935 " uint32_t len; /* Number of elements in list. */\n"
18936 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18942 #: ../src/guestfs-structs.pod:106
18945 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18946 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18951 #: ../src/guestfs-structs.pod:111
18954 " struct guestfs_stat {\n"
18958 " int64_t nlink;\n"
18963 " int64_t blksize;\n"
18964 " int64_t blocks;\n"
18965 " int64_t atime;\n"
18966 " int64_t mtime;\n"
18967 " int64_t ctime;\n"
18973 #: ../src/guestfs-structs.pod:127
18976 " struct guestfs_stat_list {\n"
18977 " uint32_t len; /* Number of elements in list. */\n"
18978 " struct guestfs_stat *val; /* Elements. */\n"
18984 #: ../src/guestfs-structs.pod:132
18987 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18988 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18993 #: ../src/guestfs-structs.pod:137
18996 " struct guestfs_statvfs {\n"
18997 " int64_t bsize;\n"
18998 " int64_t frsize;\n"
18999 " int64_t blocks;\n"
19000 " int64_t bfree;\n"
19001 " int64_t bavail;\n"
19002 " int64_t files;\n"
19003 " int64_t ffree;\n"
19004 " int64_t favail;\n"
19007 " int64_t namemax;\n"
19013 #: ../src/guestfs-structs.pod:151
19016 " struct guestfs_statvfs_list {\n"
19017 " uint32_t len; /* Number of elements in list. */\n"
19018 " struct guestfs_statvfs *val; /* Elements. */\n"
19024 #: ../src/guestfs-structs.pod:156
19027 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19028 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19033 #: ../src/guestfs-structs.pod:159
19034 msgid "guestfs_dirent"
19038 #: ../src/guestfs-structs.pod:161
19041 " struct guestfs_dirent {\n"
19050 #: ../src/guestfs-structs.pod:167
19053 " struct guestfs_dirent_list {\n"
19054 " uint32_t len; /* Number of elements in list. */\n"
19055 " struct guestfs_dirent *val; /* Elements. */\n"
19061 #: ../src/guestfs-structs.pod:172
19064 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19065 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19070 #: ../src/guestfs-structs.pod:177
19073 " struct guestfs_version {\n"
19074 " int64_t major;\n"
19075 " int64_t minor;\n"
19076 " int64_t release;\n"
19083 #: ../src/guestfs-structs.pod:184
19086 " struct guestfs_version_list {\n"
19087 " uint32_t len; /* Number of elements in list. */\n"
19088 " struct guestfs_version *val; /* Elements. */\n"
19094 #: ../src/guestfs-structs.pod:189
19097 " void guestfs_free_version (struct guestfs_free_version *);\n"
19098 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19103 #: ../src/guestfs-structs.pod:192
19104 msgid "guestfs_xattr"
19108 #: ../src/guestfs-structs.pod:194
19111 " struct guestfs_xattr {\n"
19112 " char *attrname;\n"
19113 " /* The next two fields describe a byte array. */\n"
19114 " uint32_t attrval_len;\n"
19115 " char *attrval;\n"
19121 #: ../src/guestfs-structs.pod:201
19124 " struct guestfs_xattr_list {\n"
19125 " uint32_t len; /* Number of elements in list. */\n"
19126 " struct guestfs_xattr *val; /* Elements. */\n"
19132 #: ../src/guestfs-structs.pod:206
19135 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19136 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19141 #: ../src/guestfs-structs.pod:209
19142 msgid "guestfs_inotify_event"
19146 #: ../src/guestfs-structs.pod:211
19149 " struct guestfs_inotify_event {\n"
19150 " int64_t in_wd;\n"
19151 " uint32_t in_mask;\n"
19152 " uint32_t in_cookie;\n"
19153 " char *in_name;\n"
19159 #: ../src/guestfs-structs.pod:218
19162 " struct guestfs_inotify_event_list {\n"
19163 " uint32_t len; /* Number of elements in list. */\n"
19164 " struct guestfs_inotify_event *val; /* Elements. */\n"
19170 #: ../src/guestfs-structs.pod:223
19173 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19174 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19179 #: ../src/guestfs-structs.pod:226
19180 msgid "guestfs_partition"
19184 #: ../src/guestfs-structs.pod:228
19187 " struct guestfs_partition {\n"
19188 " int32_t part_num;\n"
19189 " uint64_t part_start;\n"
19190 " uint64_t part_end;\n"
19191 " uint64_t part_size;\n"
19197 #: ../src/guestfs-structs.pod:235
19200 " struct guestfs_partition_list {\n"
19201 " uint32_t len; /* Number of elements in list. */\n"
19202 " struct guestfs_partition *val; /* Elements. */\n"
19208 #: ../src/guestfs-structs.pod:240
19211 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19212 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19217 #: ../src/guestfs-structs.pod:243
19218 msgid "guestfs_application"
19222 #: ../src/guestfs-structs.pod:245
19225 " struct guestfs_application {\n"
19226 " char *app_name;\n"
19227 " char *app_display_name;\n"
19228 " int32_t app_epoch;\n"
19229 " char *app_version;\n"
19230 " char *app_release;\n"
19231 " char *app_install_path;\n"
19232 " char *app_trans_path;\n"
19233 " char *app_publisher;\n"
19234 " char *app_url;\n"
19235 " char *app_source_package;\n"
19236 " char *app_summary;\n"
19237 " char *app_description;\n"
19243 #: ../src/guestfs-structs.pod:260
19246 " struct guestfs_application_list {\n"
19247 " uint32_t len; /* Number of elements in list. */\n"
19248 " struct guestfs_application *val; /* Elements. */\n"
19254 #: ../src/guestfs-structs.pod:265
19257 " void guestfs_free_application (struct guestfs_free_application *);\n"
19258 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19263 #: ../fish/guestfish.pod:5
19264 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19268 #: ../fish/guestfish.pod:9
19271 " guestfish [--options] [commands]\n"
19276 #: ../fish/guestfish.pod:11
19284 #: ../fish/guestfish.pod:13
19287 " guestfish [--ro|--rw] -a disk.img\n"
19292 #: ../fish/guestfish.pod:15
19295 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19300 #: ../fish/guestfish.pod:17
19303 " guestfish -d libvirt-domain\n"
19308 #: ../fish/guestfish.pod:19
19311 " guestfish [--ro|--rw] -a disk.img -i\n"
19316 #: ../fish/guestfish.pod:21
19319 " guestfish -d libvirt-domain -i\n"
19324 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19325 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19330 #: ../fish/guestfish.pod:25
19332 "Using guestfish in read/write mode on live virtual machines can be "
19333 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19334 "option to use guestfish safely if the disk image or virtual machine might be "
19339 #: ../fish/guestfish.pod:32
19341 "Guestfish is a shell and command-line tool for examining and modifying "
19342 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19343 "functionality of the guestfs API, see L<guestfs(3)>."
19347 #: ../fish/guestfish.pod:36
19349 "Guestfish gives you structured access to the libguestfs API, from shell "
19350 "scripts or the command line or interactively. If you want to rescue a "
19351 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19356 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
19357 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19362 #: ../fish/guestfish.pod:43
19363 msgid "As an interactive shell"
19367 #: ../fish/guestfish.pod:45
19375 #: ../fish/guestfish.pod:47
19378 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19379 " editing virtual machine filesystems.\n"
19384 #: ../fish/guestfish.pod:50
19387 " Type: 'help' for a list of commands\n"
19388 " 'man' to read the manual\n"
19389 " 'quit' to quit the shell\n"
19394 #: ../fish/guestfish.pod:54
19397 " ><fs> add-ro disk.img\n"
19399 " ><fs> list-filesystems\n"
19400 " /dev/sda1: ext4\n"
19401 " /dev/vg_guest/lv_root: ext4\n"
19402 " /dev/vg_guest/lv_swap: swap\n"
19403 " ><fs> mount /dev/vg_guest/lv_root /\n"
19404 " ><fs> cat /etc/fstab\n"
19406 " # Created by anaconda\n"
19413 #: ../fish/guestfish.pod:67
19414 msgid "From shell scripts"
19418 #: ../fish/guestfish.pod:69
19419 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19423 #: ../fish/guestfish.pod:71
19426 " guestfish <<_EOF_\n"
19429 " mount /dev/vg_guest/lv_root /\n"
19430 " write /etc/motd \"Welcome, new users\"\n"
19436 #: ../fish/guestfish.pod:78
19437 msgid "List the LVM logical volumes in a disk image:"
19441 #: ../fish/guestfish.pod:80
19444 " guestfish -a disk.img --ro <<_EOF_\n"
19452 #: ../fish/guestfish.pod:85
19453 msgid "List all the filesystems in a disk image:"
19457 #: ../fish/guestfish.pod:87
19460 " guestfish -a disk.img --ro <<_EOF_\n"
19462 " list-filesystems\n"
19468 #: ../fish/guestfish.pod:92
19469 msgid "On one command line"
19473 #: ../fish/guestfish.pod:94
19474 msgid "Update C</etc/resolv.conf> in a guest:"
19478 #: ../fish/guestfish.pod:96
19482 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19483 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19488 #: ../fish/guestfish.pod:100
19489 msgid "Edit C</boot/grub/grub.conf> interactively:"
19493 #: ../fish/guestfish.pod:102
19496 " guestfish --rw --add disk.img \\\n"
19497 " --mount /dev/vg_guest/lv_root \\\n"
19498 " --mount /dev/sda1:/boot \\\n"
19499 " edit /boot/grub/grub.conf\n"
19504 #: ../fish/guestfish.pod:107
19505 msgid "Mount disks automatically"
19509 #: ../fish/guestfish.pod:109
19511 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19515 #: ../fish/guestfish.pod:112
19518 " guestfish --ro -a disk.img -i cat /etc/group\n"
19523 #: ../fish/guestfish.pod:114
19526 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19531 #: ../fish/guestfish.pod:116
19532 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19536 #: ../fish/guestfish.pod:118
19539 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19544 #: ../fish/guestfish.pod:120
19545 msgid "As a script interpreter"
19549 #: ../fish/guestfish.pod:122
19550 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19554 #: ../fish/guestfish.pod:124
19557 " #!/usr/bin/guestfish -f\n"
19558 " sparse test1.img 100M\n"
19560 " part-disk /dev/sda mbr\n"
19561 " mkfs ext2 /dev/sda1\n"
19566 #: ../fish/guestfish.pod:130
19567 msgid "Start with a prepared disk"
19571 #: ../fish/guestfish.pod:132
19573 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19574 "single ext2-formatted partition:"
19578 #: ../fish/guestfish.pod:135
19581 " guestfish -N fs\n"
19586 #: ../fish/guestfish.pod:137
19587 msgid "To list what is available do:"
19591 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19594 " guestfish -N help | less\n"
19599 #: ../fish/guestfish.pod:141
19600 msgid "Remote control"
19604 #: ../fish/guestfish.pod:143
19607 " eval \"`guestfish --listen`\"\n"
19608 " guestfish --remote add-ro disk.img\n"
19609 " guestfish --remote run\n"
19610 " guestfish --remote lvs\n"
19615 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19616 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
19617 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19618 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19619 #: ../tools/virt-list-partitions.pl:54
19624 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
19625 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19626 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19627 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19632 #: ../fish/guestfish.pod:154
19633 msgid "Displays general help on options."
19637 #: ../fish/guestfish.pod:156
19642 #: ../fish/guestfish.pod:158
19643 msgid "B<--cmd-help>"
19647 #: ../fish/guestfish.pod:160
19648 msgid "Lists all available guestfish commands."
19652 #: ../fish/guestfish.pod:162
19657 #: ../fish/guestfish.pod:164
19658 msgid "B<--cmd-help cmd>"
19662 #: ../fish/guestfish.pod:166
19663 msgid "Displays detailed help on a single command C<cmd>."
19667 #: ../fish/guestfish.pod:168
19668 msgid "B<-a image>"
19672 #: ../fish/guestfish.pod:170
19673 msgid "B<--add image>"
19677 #: ../fish/guestfish.pod:172
19678 msgid "Add a block device or virtual machine image to the shell."
19682 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19684 "The format of the disk image is auto-detected. To override this and force a "
19685 "particular format use the I<--format=..> option."
19689 #: ../fish/guestfish.pod:177
19691 "Using this flag is mostly equivalent to using the C<add> command, with "
19692 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19693 "the I<--format=...> flag was given."
19697 #: ../fish/guestfish.pod:181
19702 #: ../fish/guestfish.pod:183
19703 msgid "B<--connect URI>"
19707 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19709 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19710 "URI to use. The default is to use the default libvirt connection."
19714 #: ../fish/guestfish.pod:189
19719 #: ../fish/guestfish.pod:191
19721 "If using the I<--listen> option and a csh-like shell, use this option. See "
19722 "section L</REMOTE CONTROL AND CSH> below."
19726 #: ../fish/guestfish.pod:194
19727 msgid "B<-d libvirt-domain>"
19731 #: ../fish/guestfish.pod:196
19732 msgid "B<--domain libvirt-domain>"
19736 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19738 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19739 "used, then any libvirt domain can be used. However in write mode, only "
19740 "libvirt domains which are shut down can be named here."
19744 #: ../fish/guestfish.pod:202
19746 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19747 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19748 "if the I<--format:...> flag was given."
19752 #: ../fish/guestfish.pod:206
19757 #: ../fish/guestfish.pod:208
19758 msgid "B<--no-dest-paths>"
19762 #: ../fish/guestfish.pod:210
19764 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19765 "to hit the tab key to complete paths on the guest filesystem, but this "
19766 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19767 "allow this feature to be disabled."
19771 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
19772 msgid "B<--echo-keys>"
19776 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19778 "When prompting for keys and passphrases, guestfish normally turns echoing "
19779 "off so you cannot see what you are typing. If you are not worried about "
19780 "Tempest attacks and there is no one else in the room you can specify this "
19781 "flag to see what you are typing."
19785 #: ../fish/guestfish.pod:222
19790 #: ../fish/guestfish.pod:224
19791 msgid "B<--file file>"
19795 #: ../fish/guestfish.pod:226
19796 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19800 #: ../fish/guestfish.pod:229
19803 " #!/usr/bin/guestfish -f\n"
19808 #: ../fish/guestfish.pod:231
19809 msgid "B<--format=raw|qcow2|..>"
19813 #: ../fish/guestfish.pod:233
19814 msgid "B<--format>"
19818 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
19820 "The default for the I<-a> option is to auto-detect the format of the disk "
19821 "image. Using this forces the disk format for I<-a> options which follow on "
19822 "the command line. Using I<--format> with no argument switches back to auto-"
19823 "detection for subsequent I<-a> options."
19827 #: ../fish/guestfish.pod:242
19830 " guestfish --format=raw -a disk.img\n"
19835 #: ../fish/guestfish.pod:244
19836 msgid "forces raw format (no auto-detection) for C<disk.img>."
19840 #: ../fish/guestfish.pod:246
19843 " guestfish --format=raw -a disk.img --format -a another.img\n"
19848 #: ../fish/guestfish.pod:248
19850 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19851 "detection for C<another.img>."
19855 #: ../fish/guestfish.pod:251
19857 "If you have untrusted raw-format guest disk images, you should use this "
19858 "option to specify the disk format. This avoids a possible security problem "
19859 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19863 #: ../fish/guestfish.pod:256
19868 #: ../fish/guestfish.pod:258
19869 msgid "B<--inspector>"
19873 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
19875 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19876 "system and mount filesystems as they would be mounted on the real virtual "
19881 #: ../fish/guestfish.pod:264
19882 msgid "Typical usage is either:"
19886 #: ../fish/guestfish.pod:266
19889 " guestfish -d myguest -i\n"
19894 #: ../fish/guestfish.pod:268
19895 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19899 #: ../fish/guestfish.pod:270
19902 " guestfish --ro -d myguest -i\n"
19907 #: ../fish/guestfish.pod:272
19908 msgid "(for active domains, readonly), or specify the block device directly:"
19912 #: ../fish/guestfish.pod:274
19915 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19920 #: ../fish/guestfish.pod:276
19922 "Note that the command line syntax changed slightly over older versions of "
19923 "guestfish. You can still use the old syntax:"
19927 #: ../fish/guestfish.pod:279
19930 " guestfish [--ro] -i disk.img\n"
19935 #: ../fish/guestfish.pod:281
19938 " guestfish [--ro] -i libvirt-domain\n"
19943 #: ../fish/guestfish.pod:283
19945 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19946 "then using other commands to mount the filesystems that were found."
19950 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
19951 msgid "B<--keys-from-stdin>"
19955 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19957 "Read key or passphrase parameters from stdin. The default is to try to read "
19958 "passphrases from the user by opening C</dev/tty>."
19962 #: ../fish/guestfish.pod:292
19963 msgid "B<--listen>"
19967 #: ../fish/guestfish.pod:294
19969 "Fork into the background and listen for remote commands. See section L</"
19970 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19974 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
19979 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
19981 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19982 "ATTACHING TO RUNNING DAEMONS>)."
19986 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
19987 msgid "B<-m dev[:mountpoint[:options]]>"
19991 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
19992 msgid "B<--mount dev[:mountpoint[:options]]>"
19996 #: ../fish/guestfish.pod:306
19997 msgid "Mount the named partition or logical volume on the given mountpoint."
20001 #: ../fish/guestfish.pod:308
20002 msgid "If the mountpoint is omitted, it defaults to C</>."
20006 #: ../fish/guestfish.pod:310
20007 msgid "You have to mount something on C</> before most commands will work."
20011 #: ../fish/guestfish.pod:312
20013 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20018 #: ../fish/guestfish.pod:315
20020 "If you don't know what filesystems a disk image contains, you can either run "
20021 "guestfish without this option, then list the partitions, filesystems and LVs "
20022 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20023 "commands), or you can use the L<virt-filesystems(1)> program."
20027 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
20029 "The third (and rarely used) part of the mount parameter is the list of mount "
20030 "options used to mount the underlying filesystem. If this is not given, then "
20031 "the mount options are either the empty string or C<ro> (the latter if the "
20032 "I<--ro> flag is used). By specifying the mount options, you override this "
20033 "default choice. Probably the only time you would use this is to enable ACLs "
20034 "and/or extended attributes if the filesystem can support them:"
20038 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
20041 " -m /dev/sda1:/:acl,user_xattr\n"
20046 #: ../fish/guestfish.pod:331
20047 msgid "Using this flag is equivalent to using the C<mount-options> command."
20051 #: ../fish/guestfish.pod:333
20056 #: ../fish/guestfish.pod:335
20057 msgid "B<--no-sync>"
20061 #: ../fish/guestfish.pod:337
20063 "Disable autosync. This is enabled by default. See the discussion of "
20064 "autosync in the L<guestfs(3)> manpage."
20068 #: ../fish/guestfish.pod:340
20073 #: ../fish/guestfish.pod:342
20074 msgid "B<--new type>"
20078 #: ../fish/guestfish.pod:344
20083 #: ../fish/guestfish.pod:346
20085 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20086 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20087 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20092 #: ../fish/guestfish.pod:351
20093 msgid "B<--progress-bars>"
20097 #: ../fish/guestfish.pod:353
20098 msgid "Enable progress bars, even when guestfish is used non-interactively."
20102 #: ../fish/guestfish.pod:355
20104 "Progress bars are enabled by default when guestfish is used as an "
20105 "interactive shell."
20109 #: ../fish/guestfish.pod:358
20110 msgid "B<--no-progress-bars>"
20114 #: ../fish/guestfish.pod:360
20115 msgid "Disable progress bars."
20119 #: ../fish/guestfish.pod:362
20120 msgid "B<--remote[=pid]>"
20124 #: ../fish/guestfish.pod:364
20126 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20127 "CONTROL GUESTFISH OVER A SOCKET> below."
20131 #: ../fish/guestfish.pod:367
20136 #: ../fish/guestfish.pod:369
20141 #: ../fish/guestfish.pod:371
20143 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20144 "mounts are done read-only."
20148 #: ../fish/guestfish.pod:374
20150 "The option must always be used if the disk image or virtual machine might be "
20151 "running, and is generally recommended in cases where you don't need write "
20152 "access to the disk."
20156 #: ../fish/guestfish.pod:378
20158 "Note that prepared disk images created with I<-N> are not affected by this "
20159 "option. Also commands like C<add> are not affected - you have to specify "
20160 "the C<readonly:true> option explicitly if you need it."
20164 #: ../fish/guestfish.pod:382
20165 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20169 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
20170 msgid "B<--selinux>"
20174 #: ../fish/guestfish.pod:386
20175 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20179 #: ../fish/guestfish.pod:388
20184 #: ../fish/guestfish.pod:390
20185 msgid "B<--verbose>"
20189 #: ../fish/guestfish.pod:392
20191 "Enable very verbose messages. This is particularly useful if you find a bug."
20195 #: ../fish/guestfish.pod:395
20200 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
20201 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
20202 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
20203 #: ../tools/virt-list-partitions.pl:70
20204 msgid "B<--version>"
20208 #: ../fish/guestfish.pod:399
20209 msgid "Display the guestfish / libguestfs version number and exit."
20213 #: ../fish/guestfish.pod:401
20218 #: ../fish/guestfish.pod:403
20223 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
20225 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20226 "mounts are done read-write."
20230 #: ../fish/guestfish.pod:408
20231 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20235 #: ../fish/guestfish.pod:410
20240 #: ../fish/guestfish.pod:412
20241 msgid "Echo each command before executing it."
20245 #: ../fish/guestfish.pod:416
20246 msgid "COMMANDS ON COMMAND LINE"
20250 #: ../fish/guestfish.pod:418
20252 "Any additional (non-option) arguments are treated as commands to execute."
20256 #: ../fish/guestfish.pod:421
20258 "Commands to execute should be separated by a colon (C<:>), where the colon "
20259 "is a separate parameter. Thus:"
20263 #: ../fish/guestfish.pod:424
20266 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20271 #: ../fish/guestfish.pod:426
20273 "If there are no additional arguments, then we enter a shell, either an "
20274 "interactive shell with a prompt (if the input is a terminal) or a non-"
20275 "interactive shell."
20279 #: ../fish/guestfish.pod:430
20281 "In either command line mode or non-interactive shell, the first command that "
20282 "gives an error causes the whole shell to exit. In interactive mode (with a "
20283 "prompt) if a command fails, you can continue to enter commands."
20287 #: ../fish/guestfish.pod:435
20288 msgid "USING launch (OR run)"
20292 #: ../fish/guestfish.pod:437
20294 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20295 "then launch it, then mount any disks you need, and finally issue actions/"
20296 "commands. So the general order of the day is:"
20300 #: ../fish/guestfish.pod:445
20301 msgid "add or -a/--add"
20305 #: ../fish/guestfish.pod:449
20306 msgid "launch (aka run)"
20310 #: ../fish/guestfish.pod:453
20311 msgid "mount or -m/--mount"
20315 #: ../fish/guestfish.pod:457
20316 msgid "any other commands"
20320 #: ../fish/guestfish.pod:461
20322 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20323 "guest before mounting or performing any other commands."
20327 #: ../fish/guestfish.pod:464
20329 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20330 "I<--new> options were given then C<run> is done automatically, simply "
20331 "because guestfish can't perform the action you asked for without doing this."
20335 #: ../fish/guestfish.pod:469
20336 msgid "OPENING DISKS FOR READ AND WRITE"
20340 #: ../fish/guestfish.pod:471
20342 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20343 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20344 "I<-i> and I<-m> open disk images read-only or for writing."
20348 #: ../fish/guestfish.pod:476
20350 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20351 "opening disk images supplied on the command line for write. To open a disk "
20352 "image read-only you have to do I<-a image --ro>."
20356 #: ../fish/guestfish.pod:480
20358 "This matters: If you accidentally open a live VM disk image writable then "
20359 "you will cause irreversible disk corruption."
20363 #: ../fish/guestfish.pod:483
20365 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20366 "images will be opened read-only. You will have to either specify "
20367 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20368 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20369 "access for disk images specified by those other command line options."
20373 #: ../fish/guestfish.pod:490
20375 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20376 "which does nothing (it is already the default). However it is highly "
20377 "recommended that you use this option to indicate that you need write access, "
20378 "and prepare your scripts for the day when this option will be required for "
20383 #: ../fish/guestfish.pod:496
20385 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20386 "other libguestfs program apart from guestfish and guestmount."
20390 #: ../fish/guestfish.pod:499
20395 #: ../fish/guestfish.pod:501
20397 "You can quote ordinary parameters using either single or double quotes. For "
20402 #: ../fish/guestfish.pod:504
20405 " add \"file with a space.img\"\n"
20410 #: ../fish/guestfish.pod:506
20413 " rm '/file name'\n"
20418 #: ../fish/guestfish.pod:508
20426 #: ../fish/guestfish.pod:510
20428 "A few commands require a list of strings to be passed. For these, use a "
20429 "whitespace-separated list, enclosed in quotes. Strings containing "
20430 "whitespace to be passed through must be enclosed in single quotes. A "
20431 "literal single quote must be escaped with a backslash."
20435 #: ../fish/guestfish.pod:515
20438 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20439 " command \"/bin/echo 'foo bar'\"\n"
20440 " command \"/bin/echo \\'foo\\'\"\n"
20445 #: ../fish/guestfish.pod:519
20446 msgid "OPTIONAL ARGUMENTS"
20450 #: ../fish/guestfish.pod:521
20452 "Some commands take optional arguments. These arguments appear in this "
20453 "documentation as C<[argname:..]>. You can use them as in these examples:"
20457 #: ../fish/guestfish.pod:525
20460 " add-drive-opts filename\n"
20465 #: ../fish/guestfish.pod:527
20468 " add-drive-opts filename readonly:true\n"
20473 #: ../fish/guestfish.pod:529
20476 " add-drive-opts filename format:qcow2 readonly:false\n"
20481 #: ../fish/guestfish.pod:531
20483 "Each optional argument can appear at most once. All optional arguments must "
20484 "appear after the required ones."
20488 #: ../fish/guestfish.pod:534
20493 #: ../fish/guestfish.pod:536
20495 "This section applies to all commands which can take integers as parameters."
20499 #: ../fish/guestfish.pod:539
20500 msgid "SIZE SUFFIX"
20504 #: ../fish/guestfish.pod:541
20506 "When the command takes a parameter measured in bytes, you can use one of the "
20507 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20511 #: ../fish/guestfish.pod:547
20512 msgid "B<k> or B<K> or B<KiB>"
20516 #: ../fish/guestfish.pod:549
20517 msgid "The size in kilobytes (multiplied by 1024)."
20521 #: ../fish/guestfish.pod:551
20526 #: ../fish/guestfish.pod:553
20527 msgid "The size in SI 1000 byte units."
20531 #: ../fish/guestfish.pod:555
20532 msgid "B<M> or B<MiB>"
20536 #: ../fish/guestfish.pod:557
20537 msgid "The size in megabytes (multiplied by 1048576)."
20541 #: ../fish/guestfish.pod:559
20546 #: ../fish/guestfish.pod:561
20547 msgid "The size in SI 1000000 byte units."
20551 #: ../fish/guestfish.pod:563
20552 msgid "B<G> or B<GiB>"
20556 #: ../fish/guestfish.pod:565
20557 msgid "The size in gigabytes (multiplied by 2**30)."
20561 #: ../fish/guestfish.pod:567
20566 #: ../fish/guestfish.pod:569
20567 msgid "The size in SI 10**9 byte units."
20571 #: ../fish/guestfish.pod:571
20572 msgid "B<T> or B<TiB>"
20576 #: ../fish/guestfish.pod:573
20577 msgid "The size in terabytes (multiplied by 2**40)."
20581 #: ../fish/guestfish.pod:575
20586 #: ../fish/guestfish.pod:577
20587 msgid "The size in SI 10**12 byte units."
20591 #: ../fish/guestfish.pod:579
20592 msgid "B<P> or B<PiB>"
20596 #: ../fish/guestfish.pod:581
20597 msgid "The size in petabytes (multiplied by 2**50)."
20601 #: ../fish/guestfish.pod:583
20606 #: ../fish/guestfish.pod:585
20607 msgid "The size in SI 10**15 byte units."
20611 #: ../fish/guestfish.pod:587
20612 msgid "B<E> or B<EiB>"
20616 #: ../fish/guestfish.pod:589
20617 msgid "The size in exabytes (multiplied by 2**60)."
20621 #: ../fish/guestfish.pod:591
20626 #: ../fish/guestfish.pod:593
20627 msgid "The size in SI 10**18 byte units."
20631 #: ../fish/guestfish.pod:595
20632 msgid "B<Z> or B<ZiB>"
20636 #: ../fish/guestfish.pod:597
20637 msgid "The size in zettabytes (multiplied by 2**70)."
20641 #: ../fish/guestfish.pod:599
20646 #: ../fish/guestfish.pod:601
20647 msgid "The size in SI 10**21 byte units."
20651 #: ../fish/guestfish.pod:603
20652 msgid "B<Y> or B<YiB>"
20656 #: ../fish/guestfish.pod:605
20657 msgid "The size in yottabytes (multiplied by 2**80)."
20661 #: ../fish/guestfish.pod:607
20666 #: ../fish/guestfish.pod:609
20667 msgid "The size in SI 10**24 byte units."
20671 #: ../fish/guestfish.pod:615
20674 " truncate-size /file 1G\n"
20679 #: ../fish/guestfish.pod:617
20680 msgid "would truncate the file to 1 gigabyte."
20684 #: ../fish/guestfish.pod:619
20686 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20687 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20688 "suffix will probably not do what you expect."
20692 #: ../fish/guestfish.pod:623
20693 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20697 #: ../fish/guestfish.pod:625
20699 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20700 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20704 #: ../fish/guestfish.pod:628
20707 " 1234 decimal number 1234\n"
20708 " 02322 octal number, equivalent to decimal 1234\n"
20709 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20714 #: ../fish/guestfish.pod:632
20716 "When using the C<chmod> command, you almost always want to specify an octal "
20717 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20718 "L<chmod(1)> program):"
20722 #: ../fish/guestfish.pod:636
20725 " chmod 0777 /public # OK\n"
20726 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20731 #: ../fish/guestfish.pod:639
20733 "Commands that return numbers usually print them in decimal, but some "
20734 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20735 "octal, preceeded by C<0>)."
20739 #: ../fish/guestfish.pod:643
20740 msgid "WILDCARDS AND GLOBBING"
20744 #: ../fish/guestfish.pod:645
20746 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20747 "(globbing) by default. So for example the following will not do what you "
20752 #: ../fish/guestfish.pod:649
20760 #: ../fish/guestfish.pod:651
20762 "Assuming you don't have a directory called literally C</home/*> then the "
20763 "above command will return an error."
20767 #: ../fish/guestfish.pod:654
20768 msgid "To perform wildcard expansion, use the C<glob> command."
20772 #: ../fish/guestfish.pod:656
20775 " glob rm-rf /home/*\n"
20780 #: ../fish/guestfish.pod:658
20782 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20783 "many times), equivalent to:"
20787 #: ../fish/guestfish.pod:661
20790 " rm-rf /home/jim\n"
20791 " rm-rf /home/joe\n"
20792 " rm-rf /home/mary\n"
20797 #: ../fish/guestfish.pod:665
20798 msgid "C<glob> only works on simple guest paths and not on device names."
20802 #: ../fish/guestfish.pod:667
20804 "If you have several parameters, each containing a wildcard, then glob will "
20805 "perform a Cartesian product."
20809 #: ../fish/guestfish.pod:670
20814 #: ../fish/guestfish.pod:672
20816 "Any line which starts with a I<#> character is treated as a comment and "
20817 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20818 "a command. For example:"
20822 #: ../fish/guestfish.pod:676
20825 " # this is a comment\n"
20826 " # this is a comment\n"
20827 " foo # NOT a comment\n"
20832 #: ../fish/guestfish.pod:680
20833 msgid "Blank lines are also ignored."
20837 #: ../fish/guestfish.pod:682
20838 msgid "RUNNING COMMANDS LOCALLY"
20842 #: ../fish/guestfish.pod:684
20844 "Any line which starts with a I<!> character is treated as a command sent to "
20845 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20849 #: ../fish/guestfish.pod:688
20853 " tgz-out /remote local/remote-data.tar.gz\n"
20858 #: ../fish/guestfish.pod:691
20860 "will create a directory C<local> on the host, and then export the contents "
20861 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20862 "(See C<tgz-out>)."
20866 #: ../fish/guestfish.pod:695
20868 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20869 "effect, due to the way that subprocesses work in Unix."
20873 #: ../fish/guestfish.pod:698
20874 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20878 #: ../fish/guestfish.pod:700
20880 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20881 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20882 "and executed as guestfish commands."
20886 #: ../fish/guestfish.pod:704
20888 "Thus you can use shell script to construct arbitrary guestfish commands "
20889 "which are then parsed by guestfish."
20893 #: ../fish/guestfish.pod:707
20895 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20896 "through C</foo.100>) using guestfish commands alone. However this is simple "
20897 "if we use a shell script to create the guestfish commands for us:"
20901 #: ../fish/guestfish.pod:712
20904 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20909 #: ../fish/guestfish.pod:714
20910 msgid "or with names like C</foo.001>:"
20914 #: ../fish/guestfish.pod:716
20917 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20922 #: ../fish/guestfish.pod:718
20924 "When using guestfish interactively it can be helpful to just run the shell "
20925 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20926 "ordinary I<!> local command), see what guestfish commands it would run, and "
20927 "when you are happy with those prepend the C<E<lt>> character to run the "
20928 "guestfish commands for real."
20932 #: ../fish/guestfish.pod:724
20937 #: ../fish/guestfish.pod:726
20939 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20940 "command (a guestfish command) to the second command (any host command). For "
20945 #: ../fish/guestfish.pod:730
20948 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20953 #: ../fish/guestfish.pod:732
20955 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20956 "program). The above command would list all accounts in the guest filesystem "
20957 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20961 #: ../fish/guestfish.pod:737
20964 " hexdump /bin/ls | head\n"
20965 " list-devices | tail -1\n"
20966 " tgz-out / - | tar ztf -\n"
20971 #: ../fish/guestfish.pod:741
20973 "The space before the pipe symbol is required, any space after the pipe "
20974 "symbol is optional. Everything after the pipe symbol is just passed "
20975 "straight to the host shell, so it can contain redirections, globs and "
20976 "anything else that makes sense on the host side."
20980 #: ../fish/guestfish.pod:746
20982 "To use a literal argument which begins with a pipe symbol, you have to quote "
20987 #: ../fish/guestfish.pod:749
20995 #: ../fish/guestfish.pod:751
20996 msgid "HOME DIRECTORIES"
21000 #: ../fish/guestfish.pod:753
21002 "If a parameter starts with the character C<~> then the tilde may be expanded "
21003 "as a home directory path (either C<~> for the current user's home directory, "
21004 "or C<~user> for another user)."
21008 #: ../fish/guestfish.pod:757
21010 "Note that home directory expansion happens for users known I<on the host>, "
21011 "not in the guest filesystem."
21015 #: ../fish/guestfish.pod:760
21017 "To use a literal argument which begins with a tilde, you have to quote it, "
21022 #: ../fish/guestfish.pod:763
21030 #: ../fish/guestfish.pod:767
21032 "Libguestfs has some support for Linux guests encrypted according to the "
21033 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21034 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21035 "LUKS is supported."
21039 #: ../fish/guestfish.pod:772
21040 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21044 #: ../fish/guestfish.pod:774
21047 " ><fs> vfs-type /dev/sda2\n"
21053 #: ../fish/guestfish.pod:777
21055 "Then open those devices using L</luks-open>. This creates a device-mapper "
21056 "device called C</dev/mapper/luksdev>."
21060 #: ../fish/guestfish.pod:780
21063 " ><fs> luks-open /dev/sda2 luksdev\n"
21064 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21069 #: ../fish/guestfish.pod:783
21071 "Finally you have to tell LVM to scan for volume groups on the newly created "
21076 #: ../fish/guestfish.pod:786
21080 " vg-activate-all true\n"
21085 #: ../fish/guestfish.pod:789
21086 msgid "The logical volume(s) can now be mounted in the usual way."
21090 #: ../fish/guestfish.pod:791
21092 "Before closing a LUKS device you must unmount any logical volumes on it and "
21093 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21094 "one. Then you can close the mapper device:"
21098 #: ../fish/guestfish.pod:795
21101 " vg-activate false /dev/VG\n"
21102 " luks-close /dev/mapper/luksdev\n"
21107 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
21108 msgid "WINDOWS PATHS"
21112 #: ../fish/guestfish.pod:800
21114 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21115 "letters and paths (with some limitations). The following commands are "
21120 #: ../fish/guestfish.pod:804
21123 " file /WINDOWS/system32/config/system.LOG\n"
21128 #: ../fish/guestfish.pod:806
21131 " file win:\\windows\\system32\\config\\system.log\n"
21136 #: ../fish/guestfish.pod:808
21139 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21144 #: ../fish/guestfish.pod:810
21146 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21147 "where the drive is mounted, prepending that to the path, changing all "
21148 "backslash characters to forward slash, then resolving the result using L</"
21149 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21150 "the parameter might be rewritten like this:"
21154 #: ../fish/guestfish.pod:816
21157 " win:e:\\foo\\bar => /e/FOO/bar\n"
21162 #: ../fish/guestfish.pod:818
21163 msgid "This only works in argument positions that expect a path."
21167 #: ../fish/guestfish.pod:820
21168 msgid "UPLOADING AND DOWNLOADING FILES"
21172 #: ../fish/guestfish.pod:822
21174 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21175 "others which upload from or download to a local file, you can use the "
21176 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21180 #: ../fish/guestfish.pod:826
21188 #: ../fish/guestfish.pod:828
21190 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21194 #: ../fish/guestfish.pod:831
21197 " tar-out /etc - | tar tf -\n"
21202 #: ../fish/guestfish.pod:833
21204 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21205 "command (see L</PIPES>)."
21209 #: ../fish/guestfish.pod:836
21211 "When using C<-> to read from stdin, the input is read up to the end of "
21212 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21213 "some arbitrary end marker:"
21217 #: ../fish/guestfish.pod:840
21220 " upload -<<END /foo\n"
21229 #: ../fish/guestfish.pod:846
21231 "Any string of characters can be used instead of C<END>. The end marker must "
21232 "appear on a line of its own, without any preceeding or following characters "
21233 "(not even spaces)."
21237 #: ../fish/guestfish.pod:850
21239 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21240 "upload local files (so-called \"FileIn\" parameters in the generator)."
21244 #: ../fish/guestfish.pod:853
21245 msgid "EXIT ON ERROR BEHAVIOUR"
21249 #: ../fish/guestfish.pod:855
21251 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21252 "taking commands from a human over a tty), and will exit on the first error "
21253 "in non-interactive mode (scripts, commands given on the command line)."
21257 #: ../fish/guestfish.pod:860
21259 "If you prefix a command with a I<-> character, then that command will not "
21260 "cause guestfish to exit, even if that (one) command returns an error."
21264 #: ../fish/guestfish.pod:864
21265 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21269 #: ../fish/guestfish.pod:866
21271 "Guestfish can be remote-controlled over a socket. This is useful "
21272 "particularly in shell scripts where you want to make several different "
21273 "changes to a filesystem, but you don't want the overhead of starting up a "
21274 "guestfish process each time."
21278 #: ../fish/guestfish.pod:871
21279 msgid "Start a guestfish server process using:"
21283 #: ../fish/guestfish.pod:873
21286 " eval \"`guestfish --listen`\"\n"
21291 #: ../fish/guestfish.pod:875
21292 msgid "and then send it commands by doing:"
21296 #: ../fish/guestfish.pod:877
21299 " guestfish --remote cmd [...]\n"
21304 #: ../fish/guestfish.pod:879
21305 msgid "To cause the server to exit, send it the exit command:"
21309 #: ../fish/guestfish.pod:881
21312 " guestfish --remote exit\n"
21317 #: ../fish/guestfish.pod:883
21319 "Note that the server will normally exit if there is an error in a command. "
21320 "You can change this in the usual way. See section L</EXIT ON ERROR "
21325 #: ../fish/guestfish.pod:887
21326 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21330 #: ../fish/guestfish.pod:889
21332 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21333 "is how the I<--remote> option knows where to send the commands. You can "
21334 "have several guestfish listener processes running using:"
21338 #: ../fish/guestfish.pod:893
21341 " eval \"`guestfish --listen`\"\n"
21342 " pid1=$GUESTFISH_PID\n"
21343 " eval \"`guestfish --listen`\"\n"
21344 " pid2=$GUESTFISH_PID\n"
21346 " guestfish --remote=$pid1 cmd\n"
21347 " guestfish --remote=$pid2 cmd\n"
21352 #: ../fish/guestfish.pod:901
21353 msgid "REMOTE CONTROL AND CSH"
21357 #: ../fish/guestfish.pod:903
21359 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21364 #: ../fish/guestfish.pod:906
21367 " eval \"`guestfish --listen --csh`\"\n"
21372 #: ../fish/guestfish.pod:908
21373 msgid "REMOTE CONTROL DETAILS"
21377 #: ../fish/guestfish.pod:910
21379 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21380 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21381 "and C<$PID> is the process ID of the server."
21385 #: ../fish/guestfish.pod:914
21386 msgid "Guestfish client and server versions must match exactly."
21390 #: ../fish/guestfish.pod:916
21391 msgid "PREPARED DISK IMAGES"
21395 #: ../fish/guestfish.pod:918
21397 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21398 "preformatted disk images that guestfish can make for you to save typing. "
21399 "This is particularly useful for testing purposes. This option is used "
21400 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21401 "can be mixed with I<-a>)."
21405 #: ../fish/guestfish.pod:924
21407 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21408 "the second and so on. Existing files in the current directory are "
21413 #: ../fish/guestfish.pod:928
21415 "The type briefly describes how the disk should be sized, partitioned, how "
21416 "filesystem(s) should be created, and how content should be added. "
21417 "Optionally the type can be followed by extra parameters, separated by C<:> "
21418 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21419 "allocated disk, containing a single partition, with the partition formatted "
21420 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21425 #: ../fish/guestfish.pod:936
21426 msgid "To list the available types and any extra parameters they take, run:"
21430 #: ../fish/guestfish.pod:940
21432 "Note that the prepared filesystem is not mounted. You would usually have to "
21433 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21437 #: ../fish/guestfish.pod:944
21439 "If any I<-N> or I<--new> options are given, the guest is automatically "
21444 #: ../fish/guestfish.pod:949
21445 msgid "Create a 100MB disk with an ext4-formatted partition:"
21449 #: ../fish/guestfish.pod:951
21452 " guestfish -N fs:ext4\n"
21457 #: ../fish/guestfish.pod:953
21458 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21462 #: ../fish/guestfish.pod:955
21465 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21470 #: ../fish/guestfish.pod:957
21471 msgid "Create a blank 200MB disk:"
21475 #: ../fish/guestfish.pod:959
21478 " guestfish -N disk:200M\n"
21483 #: ../fish/guestfish.pod:961
21484 msgid "PROGRESS BARS"
21488 #: ../fish/guestfish.pod:963
21490 "Some (not all) long-running commands send progress notification messages as "
21491 "they are running. Guestfish turns these messages into progress bars."
21495 #: ../fish/guestfish.pod:967
21497 "When a command that supports progress bars takes longer than two seconds to "
21498 "run, and if progress bars are enabled, then you will see one appearing below "
21503 #: ../fish/guestfish.pod:971
21506 " ><fs> copy-size /large-file /another-file 2048M\n"
21507 " / 10% [#####-----------------------------------------] 00:30\n"
21512 #: ../fish/guestfish.pod:974
21514 "The spinner on the left hand side moves round once for every progress "
21515 "notification received from the backend. This is a (reasonably) golden "
21516 "assurance that the command is \"doing something\" even if the progress bar "
21517 "is not moving, because the command is able to send the progress "
21518 "notifications. When the bar reaches 100% and the command finishes, the "
21519 "spinner disappears."
21523 #: ../fish/guestfish.pod:981
21525 "Progress bars are enabled by default when guestfish is used interactively. "
21526 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21527 "and you can disable them completely using I<--no-progress-bars>."
21531 #: ../fish/guestfish.pod:986
21532 msgid "GUESTFISH COMMANDS"
21536 #: ../fish/guestfish.pod:988
21538 "The commands in this section are guestfish convenience commands, in other "
21539 "words, they are not part of the L<guestfs(3)> API."
21543 #: ../fish/guestfish.pod:991
21548 #: ../fish/guestfish.pod:993
21557 #: ../fish/guestfish.pod:996
21558 msgid "Without any parameter, this provides general help."
21562 #: ../fish/guestfish.pod:998
21563 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21567 #: ../fish/guestfish.pod:1000
21568 msgid "quit | exit"
21572 #: ../fish/guestfish.pod:1002
21573 msgid "This exits guestfish. You can also use C<^D> key."
21577 #: ../fish/guestfish.pod:1004
21578 msgid "@FISH_COMMANDS@"
21582 #: ../fish/guestfish.pod:1006
21587 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
21592 #: ../fish/guestfish.pod:1012
21594 "guestfish returns 0 if the commands completed without error, or 1 if there "
21599 #: ../fish/guestfish.pod:1019
21604 #: ../fish/guestfish.pod:1021
21606 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21611 #: ../fish/guestfish.pod:1024
21612 msgid "GUESTFISH_PID"
21616 #: ../fish/guestfish.pod:1026
21618 "Used with the I<--remote> option to specify the remote guestfish process to "
21619 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21623 #: ../fish/guestfish.pod:1030
21628 #: ../fish/guestfish.pod:1032
21630 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21631 "not specified, the external L<hexedit(1)> program is used."
21635 #: ../fish/guestfish.pod:1036
21640 #: ../fish/guestfish.pod:1038
21642 "If compiled with GNU readline support, various files in the home directory "
21643 "can be used. See L</FILES>."
21647 #: ../fish/guestfish.pod:1047
21649 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21650 "effect as using the B<-v> option."
21654 #: ../fish/guestfish.pod:1059
21656 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21657 "the discussion of paths in L<guestfs(3)>."
21661 #: ../fish/guestfish.pod:1070
21662 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21666 #: ../fish/guestfish.pod:1072
21671 #: ../fish/guestfish.pod:1074
21673 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21678 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:262
21683 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:266
21684 msgid "$HOME/.libguestfs-tools.rc"
21688 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:268
21689 msgid "/etc/libguestfs-tools.conf"
21693 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:270
21695 "This configuration file controls the default read-only or read-write mode "
21696 "(I<--ro> or I<--rw>)."
21700 #: ../fish/guestfish.pod:1101
21701 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21705 #: ../fish/guestfish.pod:1103
21706 msgid "$HOME/.guestfish"
21710 #: ../fish/guestfish.pod:1105
21712 "If compiled with GNU readline support, then the command history is saved in "
21717 #: ../fish/guestfish.pod:1108
21718 msgid "$HOME/.inputrc"
21722 #: ../fish/guestfish.pod:1110
21723 msgid "/etc/inputrc"
21727 #: ../fish/guestfish.pod:1112
21729 "If compiled with GNU readline support, then these files can be used to "
21730 "configure readline. For further information, please see L<readline(3)/"
21731 "INITIALIZATION FILE>."
21735 #: ../fish/guestfish.pod:1116
21736 msgid "To write rules which only apply to guestfish, use:"
21740 #: ../fish/guestfish.pod:1118
21750 #: ../fish/guestfish.pod:1122
21752 "Variables that you can set in inputrc that change the behaviour of guestfish "
21753 "in useful ways include:"
21757 #: ../fish/guestfish.pod:1127
21758 msgid "completion-ignore-case (default: on)"
21762 #: ../fish/guestfish.pod:1129
21764 "By default, guestfish will ignore case when tab-completing paths on the "
21769 #: ../fish/guestfish.pod:1132
21772 " set completion-ignore-case off\n"
21777 #: ../fish/guestfish.pod:1134
21778 msgid "to make guestfish case sensitive."
21782 #: ../fish/guestfish.pod:1138
21787 #: ../fish/guestfish.pod:1140
21788 msgid "test2.img (etc)"
21792 #: ../fish/guestfish.pod:1142
21794 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21795 "will be created in the file C<test1.img> in the current directory. The "
21796 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21797 "the same name will be overwritten."
21801 #: ../fish/guestfish.pod:1151
21803 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21804 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21805 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21806 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21807 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21808 ">, L<hexedit(1)>."
21812 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
21813 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
21814 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21815 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21816 #: ../tools/virt-list-partitions.pl:277
21818 "This program is free software; you can redistribute it and/or modify it "
21819 "under the terms of the GNU General Public License as published by the Free "
21820 "Software Foundation; either version 2 of the License, or (at your option) "
21821 "any later version."
21825 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
21826 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
21827 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21828 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21829 #: ../tools/virt-list-partitions.pl:282
21831 "This program is distributed in the hope that it will be useful, but WITHOUT "
21832 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21833 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21838 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
21839 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
21840 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21841 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21842 #: ../tools/virt-list-partitions.pl:287
21844 "You should have received a copy of the GNU General Public License along with "
21845 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21846 "Ave, Cambridge, MA 02139, USA."
21850 #: ../fish/guestfish-actions.pod:1
21855 #: ../fish/guestfish-actions.pod:3
21858 " add-cdrom filename\n"
21863 #: ../fish/guestfish-actions.pod:15
21865 "This call checks for the existence of C<filename>. This stops you from "
21866 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21867 "and C<http:> URLs. To specify those, use the general L</config> call "
21872 #: ../fish/guestfish-actions.pod:22
21874 "If you just want to add an ISO file (often you use this as an efficient way "
21875 "to transfer large files into the guest), then you should probably use L</add-"
21876 "drive-ro> instead."
21880 #: ../fish/guestfish-actions.pod:35
21885 #: ../fish/guestfish-actions.pod:37
21890 #: ../fish/guestfish-actions.pod:39
21893 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21898 #: ../fish/guestfish-actions.pod:41
21900 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21901 "It works by connecting to libvirt, requesting the domain and domain XML from "
21902 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21906 #: ../fish/guestfish-actions.pod:71
21908 "The other optional parameters are passed directly through to L</add-drive-"
21913 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21914 #: ../fish/guestfish-actions.pod:3044
21916 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21920 #: ../fish/guestfish-actions.pod:76
21925 #: ../fish/guestfish-actions.pod:78
21928 " add-drive filename\n"
21933 #: ../fish/guestfish-actions.pod:80
21935 "This function is the equivalent of calling L</add-drive-opts> with no "
21936 "optional parameters, so the disk is added writable, with the format being "
21937 "detected automatically."
21941 #: ../fish/guestfish-actions.pod:84
21943 "Automatic detection of the format opens you up to a potential security hole "
21944 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21945 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21946 "you should think about replacing calls to this function with calls to L</add-"
21947 "drive-opts>, and specifying the format."
21951 #: ../fish/guestfish-actions.pod:91
21952 msgid "add-drive-opts"
21956 #: ../fish/guestfish-actions.pod:93
21961 #: ../fish/guestfish-actions.pod:95
21964 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21969 #: ../fish/guestfish-actions.pod:122
21971 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21972 "add-drive-ro>) then the format is automatically detected. Possible formats "
21973 "include C<raw> and C<qcow2>."
21977 #: ../fish/guestfish-actions.pod:133
21979 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21980 "add-drive-with-if> call (q.v.)"
21984 #: ../fish/guestfish-actions.pod:140
21985 msgid "add-drive-ro"
21989 #: ../fish/guestfish-actions.pod:142
21994 #: ../fish/guestfish-actions.pod:144
21997 " add-drive-ro filename\n"
22002 #: ../fish/guestfish-actions.pod:146
22004 "This function is the equivalent of calling L</add-drive-opts> with the "
22005 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22006 "is added read-only, with the format being detected automatically."
22010 #: ../fish/guestfish-actions.pod:151
22011 msgid "add-drive-ro-with-if"
22015 #: ../fish/guestfish-actions.pod:153
22018 " add-drive-ro-with-if filename iface\n"
22023 #: ../fish/guestfish-actions.pod:155
22025 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22026 "interface emulation to use at run time."
22030 #: ../fish/guestfish-actions.pod:165
22031 msgid "add-drive-with-if"
22035 #: ../fish/guestfish-actions.pod:167
22038 " add-drive-with-if filename iface\n"
22043 #: ../fish/guestfish-actions.pod:169
22045 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22046 "interface emulation to use at run time."
22050 #: ../fish/guestfish-actions.pod:179
22055 #: ../fish/guestfish-actions.pod:181
22058 " aug-clear augpath\n"
22063 #: ../fish/guestfish-actions.pod:186
22068 #: ../fish/guestfish-actions.pod:188
22076 #: ../fish/guestfish-actions.pod:190
22078 "Close the current Augeas handle and free up any resources used by it. After "
22079 "calling this, you have to call L</aug-init> again before you can use any "
22080 "other Augeas functions."
22084 #: ../fish/guestfish-actions.pod:195
22085 msgid "aug-defnode"
22089 #: ../fish/guestfish-actions.pod:197
22092 " aug-defnode name expr val\n"
22097 #: ../fish/guestfish-actions.pod:202
22099 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22100 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22101 "containing that single node."
22105 #: ../fish/guestfish-actions.pod:210
22110 #: ../fish/guestfish-actions.pod:212
22113 " aug-defvar name expr\n"
22118 #: ../fish/guestfish-actions.pod:221
22123 #: ../fish/guestfish-actions.pod:223
22126 " aug-get augpath\n"
22131 #: ../fish/guestfish-actions.pod:228
22136 #: ../fish/guestfish-actions.pod:230
22139 " aug-init root flags\n"
22144 #: ../fish/guestfish-actions.pod:236
22145 msgid "You must call this before using any other L</aug-*> commands."
22149 #: ../fish/guestfish-actions.pod:271
22150 msgid "Do not load the tree in L</aug-init>."
22154 #: ../fish/guestfish-actions.pod:275
22155 msgid "To close the handle, you can call L</aug-close>."
22159 #: ../fish/guestfish-actions.pod:279
22164 #: ../fish/guestfish-actions.pod:281
22167 " aug-insert augpath label true|false\n"
22172 #: ../fish/guestfish-actions.pod:291
22177 #: ../fish/guestfish-actions.pod:293
22185 #: ../fish/guestfish-actions.pod:300
22190 #: ../fish/guestfish-actions.pod:302
22193 " aug-ls augpath\n"
22198 #: ../fish/guestfish-actions.pod:304
22200 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22201 "resulting nodes into alphabetical order."
22205 #: ../fish/guestfish-actions.pod:307
22210 #: ../fish/guestfish-actions.pod:309
22213 " aug-match augpath\n"
22218 #: ../fish/guestfish-actions.pod:315
22223 #: ../fish/guestfish-actions.pod:317
22226 " aug-mv src dest\n"
22231 #: ../fish/guestfish-actions.pod:322
22236 #: ../fish/guestfish-actions.pod:324
22239 " aug-rm augpath\n"
22244 #: ../fish/guestfish-actions.pod:330
22249 #: ../fish/guestfish-actions.pod:332
22257 #: ../fish/guestfish-actions.pod:336
22259 "The flags which were passed to L</aug-init> affect exactly how files are "
22264 #: ../fish/guestfish-actions.pod:339
22269 #: ../fish/guestfish-actions.pod:341
22272 " aug-set augpath val\n"
22277 #: ../fish/guestfish-actions.pod:345
22279 "In the Augeas API, it is possible to clear a node by setting the value to "
22280 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22281 "this call. Instead you must use the L</aug-clear> call."
22285 #: ../fish/guestfish-actions.pod:350
22290 #: ../fish/guestfish-actions.pod:352
22293 " available 'groups ...'\n"
22298 #: ../fish/guestfish-actions.pod:358
22300 "The libguestfs groups, and the functions that those groups correspond to, "
22301 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22302 "runtime by calling L</available-all-groups>."
22306 #: ../fish/guestfish-actions.pod:382
22307 msgid "You must call L</launch> before calling this function."
22311 #: ../fish/guestfish-actions.pod:404
22313 "This call was added in version C<1.0.80>. In previous versions of "
22314 "libguestfs all you could do would be to speculatively execute a command to "
22315 "find out if the daemon implemented it. See also L</version>."
22319 #: ../fish/guestfish-actions.pod:411
22320 msgid "available-all-groups"
22324 #: ../fish/guestfish-actions.pod:413
22327 " available-all-groups\n"
22332 #: ../fish/guestfish-actions.pod:415
22334 "This command returns a list of all optional groups that this daemon knows "
22335 "about. Note this returns both supported and unsupported groups. To find "
22336 "out which ones the daemon can actually support you have to call L</"
22337 "available> on each member of the returned list."
22341 #: ../fish/guestfish-actions.pod:421
22342 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22346 #: ../fish/guestfish-actions.pod:423
22351 #: ../fish/guestfish-actions.pod:425
22354 " base64-in (base64file|-) filename\n"
22359 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22360 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22361 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1225
22362 #: ../fish/guestfish-actions.pod:4477 ../fish/guestfish-actions.pod:4489
22363 #: ../fish/guestfish-actions.pod:4500 ../fish/guestfish-actions.pod:4511
22364 #: ../fish/guestfish-actions.pod:4563 ../fish/guestfish-actions.pod:4572
22365 #: ../fish/guestfish-actions.pod:4626 ../fish/guestfish-actions.pod:4649
22366 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22370 #: ../fish/guestfish-actions.pod:432
22375 #: ../fish/guestfish-actions.pod:434
22378 " base64-out filename (base64file|-)\n"
22383 #: ../fish/guestfish-actions.pod:441
22384 msgid "blockdev-flushbufs"
22388 #: ../fish/guestfish-actions.pod:443
22391 " blockdev-flushbufs device\n"
22396 #: ../fish/guestfish-actions.pod:450
22397 msgid "blockdev-getbsz"
22401 #: ../fish/guestfish-actions.pod:452
22404 " blockdev-getbsz device\n"
22409 #: ../fish/guestfish-actions.pod:461
22410 msgid "blockdev-getro"
22414 #: ../fish/guestfish-actions.pod:463
22417 " blockdev-getro device\n"
22422 #: ../fish/guestfish-actions.pod:470
22423 msgid "blockdev-getsize64"
22427 #: ../fish/guestfish-actions.pod:472
22430 " blockdev-getsize64 device\n"
22435 #: ../fish/guestfish-actions.pod:476
22436 msgid "See also L</blockdev-getsz>."
22440 #: ../fish/guestfish-actions.pod:480
22441 msgid "blockdev-getss"
22445 #: ../fish/guestfish-actions.pod:482
22448 " blockdev-getss device\n"
22453 #: ../fish/guestfish-actions.pod:487
22455 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22459 #: ../fish/guestfish-actions.pod:492
22460 msgid "blockdev-getsz"
22464 #: ../fish/guestfish-actions.pod:494
22467 " blockdev-getsz device\n"
22472 #: ../fish/guestfish-actions.pod:499
22474 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22475 "blockdev-getsize64> for the more useful I<size in bytes>."
22479 #: ../fish/guestfish-actions.pod:505
22480 msgid "blockdev-rereadpt"
22484 #: ../fish/guestfish-actions.pod:507
22487 " blockdev-rereadpt device\n"
22492 #: ../fish/guestfish-actions.pod:513
22493 msgid "blockdev-setbsz"
22497 #: ../fish/guestfish-actions.pod:515
22500 " blockdev-setbsz device blocksize\n"
22505 #: ../fish/guestfish-actions.pod:524
22506 msgid "blockdev-setro"
22510 #: ../fish/guestfish-actions.pod:526
22513 " blockdev-setro device\n"
22518 #: ../fish/guestfish-actions.pod:532
22519 msgid "blockdev-setrw"
22523 #: ../fish/guestfish-actions.pod:534
22526 " blockdev-setrw device\n"
22531 #: ../fish/guestfish-actions.pod:540
22532 msgid "case-sensitive-path"
22536 #: ../fish/guestfish-actions.pod:542
22539 " case-sensitive-path path\n"
22544 #: ../fish/guestfish-actions.pod:566
22546 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22547 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22548 "the directories were originally created under Windows)."
22552 #: ../fish/guestfish-actions.pod:574
22553 msgid "See also L</realpath>."
22557 #: ../fish/guestfish-actions.pod:576
22562 #: ../fish/guestfish-actions.pod:578
22570 #: ../fish/guestfish-actions.pod:582
22572 "Note that this function cannot correctly handle binary files (specifically, "
22573 "files containing C<\\0> character which is treated as end of string). For "
22574 "those you need to use the L</read-file> or L</download> functions which have "
22575 "a more complex interface."
22579 #: ../fish/guestfish-actions.pod:590
22584 #: ../fish/guestfish-actions.pod:592
22587 " checksum csumtype path\n"
22592 #: ../fish/guestfish-actions.pod:635
22593 msgid "To get the checksum for a device, use L</checksum-device>."
22597 #: ../fish/guestfish-actions.pod:637
22598 msgid "To get the checksums for many files, use L</checksums-out>."
22602 #: ../fish/guestfish-actions.pod:639
22603 msgid "checksum-device"
22607 #: ../fish/guestfish-actions.pod:641
22610 " checksum-device csumtype device\n"
22615 #: ../fish/guestfish-actions.pod:643
22617 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22618 "device named C<device>. For the types of checksums supported see the L</"
22619 "checksum> command."
22623 #: ../fish/guestfish-actions.pod:647
22624 msgid "checksums-out"
22628 #: ../fish/guestfish-actions.pod:649
22631 " checksums-out csumtype directory (sumsfile|-)\n"
22636 #: ../fish/guestfish-actions.pod:665
22641 #: ../fish/guestfish-actions.pod:667
22644 " chmod mode path\n"
22649 #: ../fish/guestfish-actions.pod:678
22654 #: ../fish/guestfish-actions.pod:680
22657 " chown owner group path\n"
22662 #: ../fish/guestfish-actions.pod:688
22667 #: ../fish/guestfish-actions.pod:690
22670 " command 'arguments ...'\n"
22675 #: ../fish/guestfish-actions.pod:697
22677 "The single parameter is an argv-style list of arguments. The first element "
22678 "is the name of the program to run. Subsequent elements are parameters. The "
22679 "list must be non-empty (ie. must contain a program name). Note that the "
22680 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22684 #: ../fish/guestfish-actions.pod:725
22685 msgid "command-lines"
22689 #: ../fish/guestfish-actions.pod:727
22692 " command-lines 'arguments ...'\n"
22697 #: ../fish/guestfish-actions.pod:729
22699 "This is the same as L</command>, but splits the result into a list of lines."
22703 #: ../fish/guestfish-actions.pod:732
22704 msgid "See also: L</sh-lines>"
22708 #: ../fish/guestfish-actions.pod:737
22713 #: ../fish/guestfish-actions.pod:739
22716 " config qemuparam qemuvalue\n"
22721 #: ../fish/guestfish-actions.pod:750
22726 #: ../fish/guestfish-actions.pod:752
22729 " copy-size src dest size\n"
22734 #: ../fish/guestfish-actions.pod:760
22739 #: ../fish/guestfish-actions.pod:762
22747 #: ../fish/guestfish-actions.pod:767
22752 #: ../fish/guestfish-actions.pod:769
22760 #: ../fish/guestfish-actions.pod:774
22765 #: ../fish/guestfish-actions.pod:776
22773 #: ../fish/guestfish-actions.pod:783
22775 "If the destination is a device, it must be as large or larger than the "
22776 "source file or device, otherwise the copy will fail. This command cannot do "
22777 "partial copies (see L</copy-size>)."
22781 #: ../fish/guestfish-actions.pod:787
22786 #: ../fish/guestfish-actions.pod:789
22794 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22796 "This command is mostly useful for interactive sessions. It is I<not> "
22797 "intended that you try to parse the output string. Use L</statvfs> from "
22802 #: ../fish/guestfish-actions.pod:797
22807 #: ../fish/guestfish-actions.pod:799
22815 #: ../fish/guestfish-actions.pod:808
22820 #: ../fish/guestfish-actions.pod:810
22828 #: ../fish/guestfish-actions.pod:816
22830 "Another way to get the same information is to enable verbose messages with "
22831 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22832 "before running the program."
22836 #: ../fish/guestfish-actions.pod:821
22841 #: ../fish/guestfish-actions.pod:823
22844 " download remotefilename (filename|-)\n"
22849 #: ../fish/guestfish-actions.pod:830
22850 msgid "See also L</upload>, L</cat>."
22854 #: ../fish/guestfish-actions.pod:834
22855 msgid "download-offset"
22859 #: ../fish/guestfish-actions.pod:836
22862 " download-offset remotefilename (filename|-) offset size\n"
22867 #: ../fish/guestfish-actions.pod:844
22869 "Note that there is no limit on the amount of data that can be downloaded "
22870 "with this call, unlike with L</pread>, and this call always reads the full "
22871 "amount unless an error occurs."
22875 #: ../fish/guestfish-actions.pod:849
22876 msgid "See also L</download>, L</pread>."
22880 #: ../fish/guestfish-actions.pod:853
22881 msgid "drop-caches"
22885 #: ../fish/guestfish-actions.pod:855
22888 " drop-caches whattodrop\n"
22893 #: ../fish/guestfish-actions.pod:867
22898 #: ../fish/guestfish-actions.pod:869
22906 #: ../fish/guestfish-actions.pod:881
22911 #: ../fish/guestfish-actions.pod:883
22914 " e2fsck-f device\n"
22919 #: ../fish/guestfish-actions.pod:889
22921 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22922 "should use L</fsck>."
22926 #: ../fish/guestfish-actions.pod:892
22927 msgid "echo-daemon"
22931 #: ../fish/guestfish-actions.pod:894
22934 " echo-daemon 'words ...'\n"
22939 #: ../fish/guestfish-actions.pod:901
22940 msgid "See also L</ping-daemon>."
22944 #: ../fish/guestfish-actions.pod:903
22949 #: ../fish/guestfish-actions.pod:905
22952 " egrep regex path\n"
22957 #: ../fish/guestfish-actions.pod:913
22962 #: ../fish/guestfish-actions.pod:915
22965 " egrepi regex path\n"
22970 #: ../fish/guestfish-actions.pod:923
22975 #: ../fish/guestfish-actions.pod:925
22978 " equal file1 file2\n"
22983 #: ../fish/guestfish-actions.pod:932
22988 #: ../fish/guestfish-actions.pod:934
22996 #: ../fish/guestfish-actions.pod:939
22997 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23001 #: ../fish/guestfish-actions.pod:941
23006 #: ../fish/guestfish-actions.pod:943
23009 " fallocate path len\n"
23014 #: ../fish/guestfish-actions.pod:960
23015 msgid "fallocate64"
23019 #: ../fish/guestfish-actions.pod:962
23022 " fallocate64 path len\n"
23027 #: ../fish/guestfish-actions.pod:968
23029 "Note that this call allocates disk blocks for the file. To create a sparse "
23030 "file use L</truncate-size> instead."
23034 #: ../fish/guestfish-actions.pod:971
23036 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23037 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23038 "maximum size of files created through that call to 1GB."
23042 #: ../fish/guestfish-actions.pod:980
23047 #: ../fish/guestfish-actions.pod:982
23050 " fgrep pattern path\n"
23055 #: ../fish/guestfish-actions.pod:990
23060 #: ../fish/guestfish-actions.pod:992
23063 " fgrepi pattern path\n"
23068 #: ../fish/guestfish-actions.pod:1000
23073 #: ../fish/guestfish-actions.pod:1002
23081 #: ../fish/guestfish-actions.pod:1018
23083 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23088 #: ../fish/guestfish-actions.pod:1021
23089 msgid "file-architecture"
23093 #: ../fish/guestfish-actions.pod:1023
23096 " file-architecture filename\n"
23101 #: ../fish/guestfish-actions.pod:1126
23106 #: ../fish/guestfish-actions.pod:1128
23114 #: ../fish/guestfish-actions.pod:1132
23116 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23117 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23121 #: ../fish/guestfish-actions.pod:1136
23126 #: ../fish/guestfish-actions.pod:1138
23129 " fill c len path\n"
23134 #: ../fish/guestfish-actions.pod:1144
23136 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23137 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23138 "L</fill-pattern>."
23142 #: ../fish/guestfish-actions.pod:1149
23143 msgid "fill-pattern"
23147 #: ../fish/guestfish-actions.pod:1151
23150 " fill-pattern pattern len path\n"
23155 #: ../fish/guestfish-actions.pod:1153
23157 "This function is like L</fill> except that it creates a new file of length "
23158 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23159 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23164 #: ../fish/guestfish-actions.pod:1158
23169 #: ../fish/guestfish-actions.pod:1160
23172 " find directory\n"
23177 #: ../fish/guestfish-actions.pod:1174
23178 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23182 #: ../fish/guestfish-actions.pod:1187
23183 msgid "See also L</find0>."
23187 #: ../fish/guestfish-actions.pod:1192
23192 #: ../fish/guestfish-actions.pod:1194
23195 " find0 directory (files|-)\n"
23200 #: ../fish/guestfish-actions.pod:1200
23202 "This command works the same way as L</find> with the following exceptions:"
23206 #: ../fish/guestfish-actions.pod:1227
23207 msgid "findfs-label"
23211 #: ../fish/guestfish-actions.pod:1229
23214 " findfs-label label\n"
23219 #: ../fish/guestfish-actions.pod:1235
23220 msgid "To find the label of a filesystem, use L</vfs-label>."
23224 #: ../fish/guestfish-actions.pod:1237
23225 msgid "findfs-uuid"
23229 #: ../fish/guestfish-actions.pod:1239
23232 " findfs-uuid uuid\n"
23237 #: ../fish/guestfish-actions.pod:1245
23238 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23242 #: ../fish/guestfish-actions.pod:1247
23247 #: ../fish/guestfish-actions.pod:1249
23250 " fsck fstype device\n"
23255 #: ../fish/guestfish-actions.pod:1279
23260 #: ../fish/guestfish-actions.pod:1281
23268 #: ../fish/guestfish-actions.pod:1288
23269 msgid "get-attach-method"
23273 #: ../fish/guestfish-actions.pod:1290
23276 " get-attach-method\n"
23281 #: ../fish/guestfish-actions.pod:1292
23282 msgid "Return the current attach method. See L</set-attach-method>."
23286 #: ../fish/guestfish-actions.pod:1294
23287 msgid "get-autosync"
23291 #: ../fish/guestfish-actions.pod:1296
23299 #: ../fish/guestfish-actions.pod:1300
23304 #: ../fish/guestfish-actions.pod:1302
23312 #: ../fish/guestfish-actions.pod:1306
23313 msgid "get-e2label"
23317 #: ../fish/guestfish-actions.pod:1308
23320 " get-e2label device\n"
23325 #: ../fish/guestfish-actions.pod:1320
23330 #: ../fish/guestfish-actions.pod:1322
23333 " get-e2uuid device\n"
23338 #: ../fish/guestfish-actions.pod:1334
23339 msgid "get-memsize"
23343 #: ../fish/guestfish-actions.pod:1336
23351 #: ../fish/guestfish-actions.pod:1341
23353 "If L</set-memsize> was not called on this handle, and if "
23354 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23355 "value for memsize."
23359 #: ../fish/guestfish-actions.pod:1348
23360 msgid "get-network"
23364 #: ../fish/guestfish-actions.pod:1350
23372 #: ../fish/guestfish-actions.pod:1354
23377 #: ../fish/guestfish-actions.pod:1356
23385 #: ../fish/guestfish-actions.pod:1363
23390 #: ../fish/guestfish-actions.pod:1365
23395 #: ../fish/guestfish-actions.pod:1367
23403 #: ../fish/guestfish-actions.pod:1374
23408 #: ../fish/guestfish-actions.pod:1376
23416 #: ../fish/guestfish-actions.pod:1383
23417 msgid "get-recovery-proc"
23421 #: ../fish/guestfish-actions.pod:1385
23424 " get-recovery-proc\n"
23429 #: ../fish/guestfish-actions.pod:1389
23430 msgid "get-selinux"
23434 #: ../fish/guestfish-actions.pod:1391
23442 #: ../fish/guestfish-actions.pod:1393
23444 "This returns the current setting of the selinux flag which is passed to the "
23445 "appliance at boot time. See L</set-selinux>."
23449 #: ../fish/guestfish-actions.pod:1399
23454 #: ../fish/guestfish-actions.pod:1401
23462 #: ../fish/guestfish-actions.pod:1408
23467 #: ../fish/guestfish-actions.pod:1410
23475 #: ../fish/guestfish-actions.pod:1414
23480 #: ../fish/guestfish-actions.pod:1416
23488 #: ../fish/guestfish-actions.pod:1418
23490 "Return the current umask. By default the umask is C<022> unless it has been "
23491 "set by calling L</umask>."
23495 #: ../fish/guestfish-actions.pod:1421
23496 msgid "get-verbose"
23500 #: ../fish/guestfish-actions.pod:1423
23508 #: ../fish/guestfish-actions.pod:1427
23513 #: ../fish/guestfish-actions.pod:1429
23521 #: ../fish/guestfish-actions.pod:1433
23522 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23526 #: ../fish/guestfish-actions.pod:1436
23531 #: ../fish/guestfish-actions.pod:1438
23534 " getxattr path name\n"
23539 #: ../fish/guestfish-actions.pod:1440
23541 "Get a single extended attribute from file C<path> named C<name>. This call "
23542 "follows symlinks. If you want to lookup an extended attribute for the "
23543 "symlink itself, use L</lgetxattr>."
23547 #: ../fish/guestfish-actions.pod:1444 ../fish/guestfish-actions.pod:2450
23549 "Normally it is better to get all extended attributes from a file in one go "
23550 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23551 "buggy and do not provide a way to list out attributes. For these "
23552 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23553 "attributes you want in advance and call this function."
23557 #: ../fish/guestfish-actions.pod:1454
23558 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23562 #: ../fish/guestfish-actions.pod:1456
23567 #: ../fish/guestfish-actions.pod:1458
23570 " getxattrs path\n"
23575 #: ../fish/guestfish-actions.pod:1466
23576 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23580 #: ../fish/guestfish-actions.pod:1468
23581 msgid "glob-expand"
23585 #: ../fish/guestfish-actions.pod:1470
23588 " glob-expand pattern\n"
23593 #: ../fish/guestfish-actions.pod:1483
23598 #: ../fish/guestfish-actions.pod:1485
23601 " grep regex path\n"
23606 #: ../fish/guestfish-actions.pod:1493
23611 #: ../fish/guestfish-actions.pod:1495
23614 " grepi regex path\n"
23619 #: ../fish/guestfish-actions.pod:1503
23620 msgid "grub-install"
23624 #: ../fish/guestfish-actions.pod:1505
23627 " grub-install root device\n"
23632 #: ../fish/guestfish-actions.pod:1521
23637 #: ../fish/guestfish-actions.pod:1523
23645 #: ../fish/guestfish-actions.pod:1531
23650 #: ../fish/guestfish-actions.pod:1533
23653 " head-n nrlines path\n"
23658 #: ../fish/guestfish-actions.pod:1546
23663 #: ../fish/guestfish-actions.pod:1548
23671 #: ../fish/guestfish-actions.pod:1556
23676 #: ../fish/guestfish-actions.pod:1558
23679 " initrd-cat initrdpath filename\n"
23684 #: ../fish/guestfish-actions.pod:1570
23685 msgid "See also L</initrd-list>."
23689 #: ../fish/guestfish-actions.pod:1575
23690 msgid "initrd-list"
23694 #: ../fish/guestfish-actions.pod:1577
23697 " initrd-list path\n"
23702 #: ../fish/guestfish-actions.pod:1589
23703 msgid "inotify-add-watch"
23707 #: ../fish/guestfish-actions.pod:1591
23710 " inotify-add-watch path mask\n"
23715 #: ../fish/guestfish-actions.pod:1603
23716 msgid "inotify-close"
23720 #: ../fish/guestfish-actions.pod:1605
23728 #: ../fish/guestfish-actions.pod:1611
23729 msgid "inotify-files"
23733 #: ../fish/guestfish-actions.pod:1613
23741 #: ../fish/guestfish-actions.pod:1615
23743 "This function is a helpful wrapper around L</inotify-read> which just "
23744 "returns a list of pathnames of objects that were touched. The returned "
23745 "pathnames are sorted and deduplicated."
23749 #: ../fish/guestfish-actions.pod:1619
23750 msgid "inotify-init"
23754 #: ../fish/guestfish-actions.pod:1621
23757 " inotify-init maxevents\n"
23762 #: ../fish/guestfish-actions.pod:1627
23764 "C<maxevents> is the maximum number of events which will be queued up between "
23765 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23766 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23767 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23768 "but records the fact that it threw them away by setting a flag "
23769 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23773 #: ../fish/guestfish-actions.pod:1637
23775 "Before any events are generated, you have to add some watches to the "
23776 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23777 "L</inotify-watch-all>."
23781 #: ../fish/guestfish-actions.pod:1643
23783 "Queued up events should be read periodically by calling L</inotify-read> (or "
23784 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23785 "If you don't read the events out often enough then you risk the internal "
23786 "queue overflowing."
23790 #: ../fish/guestfish-actions.pod:1650
23792 "The handle should be closed after use by calling L</inotify-close>. This "
23793 "also removes any watches automatically."
23797 #: ../fish/guestfish-actions.pod:1659
23798 msgid "inotify-read"
23802 #: ../fish/guestfish-actions.pod:1661
23810 #: ../fish/guestfish-actions.pod:1674
23811 msgid "inotify-rm-watch"
23815 #: ../fish/guestfish-actions.pod:1676
23818 " inotify-rm-watch wd\n"
23823 #: ../fish/guestfish-actions.pod:1678
23824 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23828 #: ../fish/guestfish-actions.pod:1681
23829 msgid "inspect-get-arch"
23833 #: ../fish/guestfish-actions.pod:1683
23836 " inspect-get-arch root\n"
23841 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1701
23842 #: ../fish/guestfish-actions.pod:1787 ../fish/guestfish-actions.pod:1823
23843 #: ../fish/guestfish-actions.pod:1841 ../fish/guestfish-actions.pod:1875
23844 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1911
23845 #: ../fish/guestfish-actions.pod:1926 ../fish/guestfish-actions.pod:1959
23846 #: ../fish/guestfish-actions.pod:1981 ../fish/guestfish-actions.pod:2005
23847 #: ../fish/guestfish-actions.pod:2022 ../fish/guestfish-actions.pod:2065
23848 #: ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2116
23849 #: ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2145
23850 #: ../fish/guestfish-actions.pod:2158 ../fish/guestfish-actions.pod:2173
23852 "This function should only be called with a root device string as returned by "
23857 #: ../fish/guestfish-actions.pod:1688
23859 "This returns the architecture of the inspected operating system. The "
23860 "possible return values are listed under L</file-architecture>."
23864 #: ../fish/guestfish-actions.pod:1697
23865 msgid "inspect-get-distro"
23869 #: ../fish/guestfish-actions.pod:1699
23872 " inspect-get-distro root\n"
23877 #: ../fish/guestfish-actions.pod:1783
23878 msgid "inspect-get-drive-mappings"
23882 #: ../fish/guestfish-actions.pod:1785
23885 " inspect-get-drive-mappings root\n"
23890 #: ../fish/guestfish-actions.pod:1815
23892 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23893 "get-mountpoints>, L</inspect-get-filesystems>."
23897 #: ../fish/guestfish-actions.pod:1819
23898 msgid "inspect-get-filesystems"
23902 #: ../fish/guestfish-actions.pod:1821
23905 " inspect-get-filesystems root\n"
23910 #: ../fish/guestfish-actions.pod:1834
23912 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23913 "get-mountpoints>."
23917 #: ../fish/guestfish-actions.pod:1837
23918 msgid "inspect-get-format"
23922 #: ../fish/guestfish-actions.pod:1839
23925 " inspect-get-format root\n"
23930 #: ../fish/guestfish-actions.pod:1871
23931 msgid "inspect-get-hostname"
23935 #: ../fish/guestfish-actions.pod:1873
23938 " inspect-get-hostname root\n"
23943 #: ../fish/guestfish-actions.pod:1886
23944 msgid "inspect-get-major-version"
23948 #: ../fish/guestfish-actions.pod:1888
23951 " inspect-get-major-version root\n"
23956 #: ../fish/guestfish-actions.pod:1907
23957 msgid "inspect-get-minor-version"
23961 #: ../fish/guestfish-actions.pod:1909
23964 " inspect-get-minor-version root\n"
23969 #: ../fish/guestfish-actions.pod:1919
23971 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23972 "get-major-version>."
23976 #: ../fish/guestfish-actions.pod:1922
23977 msgid "inspect-get-mountpoints"
23981 #: ../fish/guestfish-actions.pod:1924
23984 " inspect-get-mountpoints root\n"
23989 #: ../fish/guestfish-actions.pod:1946
23991 "For operating systems like Windows which still use drive letters, this call "
23992 "will only return an entry for the first drive \"mounted on\" C</>. For "
23993 "information about the mapping of drive letters to partitions, see L</inspect-"
23994 "get-drive-mappings>."
23998 #: ../fish/guestfish-actions.pod:1952
24000 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24001 "get-filesystems>."
24005 #: ../fish/guestfish-actions.pod:1955
24006 msgid "inspect-get-package-format"
24010 #: ../fish/guestfish-actions.pod:1957
24013 " inspect-get-package-format root\n"
24018 #: ../fish/guestfish-actions.pod:1962
24020 "This function and L</inspect-get-package-management> return the package "
24021 "format and package management tool used by the inspected operating system. "
24022 "For example for Fedora these functions would return C<rpm> (package format) "
24023 "and C<yum> (package management)."
24027 #: ../fish/guestfish-actions.pod:1977
24028 msgid "inspect-get-package-management"
24032 #: ../fish/guestfish-actions.pod:1979
24035 " inspect-get-package-management root\n"
24040 #: ../fish/guestfish-actions.pod:1984
24042 "L</inspect-get-package-format> and this function return the package format "
24043 "and package management tool used by the inspected operating system. For "
24044 "example for Fedora these functions would return C<rpm> (package format) and "
24045 "C<yum> (package management)."
24049 #: ../fish/guestfish-actions.pod:2001
24050 msgid "inspect-get-product-name"
24054 #: ../fish/guestfish-actions.pod:2003
24057 " inspect-get-product-name root\n"
24062 #: ../fish/guestfish-actions.pod:2018
24063 msgid "inspect-get-product-variant"
24067 #: ../fish/guestfish-actions.pod:2020
24070 " inspect-get-product-variant root\n"
24075 #: ../fish/guestfish-actions.pod:2044
24077 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24078 "get-product-name>, L</inspect-get-major-version>."
24082 #: ../fish/guestfish-actions.pod:2048
24083 msgid "inspect-get-roots"
24087 #: ../fish/guestfish-actions.pod:2050
24090 " inspect-get-roots\n"
24095 #: ../fish/guestfish-actions.pod:2052
24097 "This function is a convenient way to get the list of root devices, as "
24098 "returned from a previous call to L</inspect-os>, but without redoing the "
24099 "whole inspection process."
24103 #: ../fish/guestfish-actions.pod:2056
24105 "This returns an empty list if either no root devices were found or the "
24106 "caller has not called L</inspect-os>."
24110 #: ../fish/guestfish-actions.pod:2061
24111 msgid "inspect-get-type"
24115 #: ../fish/guestfish-actions.pod:2063
24118 " inspect-get-type root\n"
24123 #: ../fish/guestfish-actions.pod:2096
24124 msgid "inspect-get-windows-current-control-set"
24128 #: ../fish/guestfish-actions.pod:2098
24131 " inspect-get-windows-current-control-set root\n"
24136 #: ../fish/guestfish-actions.pod:2112
24137 msgid "inspect-get-windows-systemroot"
24141 #: ../fish/guestfish-actions.pod:2114
24144 " inspect-get-windows-systemroot root\n"
24149 #: ../fish/guestfish-actions.pod:2128
24150 msgid "inspect-is-live"
24154 #: ../fish/guestfish-actions.pod:2130
24157 " inspect-is-live root\n"
24162 #: ../fish/guestfish-actions.pod:2135
24164 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24165 "then this returns true if a live image was detected on the disk."
24169 #: ../fish/guestfish-actions.pod:2141
24170 msgid "inspect-is-multipart"
24174 #: ../fish/guestfish-actions.pod:2143
24177 " inspect-is-multipart root\n"
24182 #: ../fish/guestfish-actions.pod:2148
24184 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24185 "then this returns true if the disk is part of a set."
24189 #: ../fish/guestfish-actions.pod:2154
24190 msgid "inspect-is-netinst"
24194 #: ../fish/guestfish-actions.pod:2156
24197 " inspect-is-netinst root\n"
24202 #: ../fish/guestfish-actions.pod:2161
24204 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24205 "then this returns true if the disk is a network installer, ie. not a self-"
24206 "contained install CD but one which is likely to require network access to "
24207 "complete the install."
24211 #: ../fish/guestfish-actions.pod:2169
24212 msgid "inspect-list-applications"
24216 #: ../fish/guestfish-actions.pod:2171
24219 " inspect-list-applications root\n"
24224 #: ../fish/guestfish-actions.pod:2178
24226 "I<Note:> This call works differently from other parts of the inspection "
24227 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24228 "then mount up the disks, before calling this. Listing applications is a "
24229 "significantly more difficult operation which requires access to the full "
24230 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24231 "are just returning data cached in the libguestfs handle, this call actually "
24232 "reads parts of the mounted filesystems during the call."
24236 #: ../fish/guestfish-actions.pod:2268
24241 #: ../fish/guestfish-actions.pod:2270
24249 #: ../fish/guestfish-actions.pod:2285
24251 "You can pass the root string(s) returned to other L</inspect-get-*> "
24252 "functions in order to query further information about each operating system, "
24253 "such as the name and version."
24257 #: ../fish/guestfish-actions.pod:2290
24259 "This function uses other libguestfs features such as L</mount-ro> and L</"
24260 "umount-all> in order to mount and unmount filesystems and look at the "
24261 "contents. This should be called with no disks currently mounted. The "
24262 "function may also use Augeas, so any existing Augeas handle will be closed."
24266 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2478
24267 #: ../fish/guestfish-actions.pod:2524
24268 msgid "See also L</list-filesystems>."
24272 #: ../fish/guestfish-actions.pod:2304
24273 msgid "is-blockdev"
24277 #: ../fish/guestfish-actions.pod:2306
24280 " is-blockdev path\n"
24285 #: ../fish/guestfish-actions.pod:2311 ../fish/guestfish-actions.pod:2329
24286 #: ../fish/guestfish-actions.pod:2348 ../fish/guestfish-actions.pod:2357
24287 #: ../fish/guestfish-actions.pod:2367 ../fish/guestfish-actions.pod:2401
24288 #: ../fish/guestfish-actions.pod:2410
24289 msgid "See also L</stat>."
24293 #: ../fish/guestfish-actions.pod:2313
24298 #: ../fish/guestfish-actions.pod:2315
24306 #: ../fish/guestfish-actions.pod:2322
24311 #: ../fish/guestfish-actions.pod:2324
24314 " is-chardev path\n"
24319 #: ../fish/guestfish-actions.pod:2331
24324 #: ../fish/guestfish-actions.pod:2333
24332 #: ../fish/guestfish-actions.pod:2340
24337 #: ../fish/guestfish-actions.pod:2342
24345 #: ../fish/guestfish-actions.pod:2350
24350 #: ../fish/guestfish-actions.pod:2352
24358 #: ../fish/guestfish-actions.pod:2359
24363 #: ../fish/guestfish-actions.pod:2361
24371 #: ../fish/guestfish-actions.pod:2369
24372 msgid "is-launching"
24376 #: ../fish/guestfish-actions.pod:2371
24384 #: ../fish/guestfish-actions.pod:2378
24389 #: ../fish/guestfish-actions.pod:2380
24397 #: ../fish/guestfish-actions.pod:2385
24402 #: ../fish/guestfish-actions.pod:2387
24410 #: ../fish/guestfish-actions.pod:2394
24415 #: ../fish/guestfish-actions.pod:2396
24418 " is-socket path\n"
24423 #: ../fish/guestfish-actions.pod:2403
24428 #: ../fish/guestfish-actions.pod:2405
24431 " is-symlink path\n"
24436 #: ../fish/guestfish-actions.pod:2412
24437 msgid "kill-subprocess"
24441 #: ../fish/guestfish-actions.pod:2414
24444 " kill-subprocess\n"
24449 #: ../fish/guestfish-actions.pod:2418
24454 #: ../fish/guestfish-actions.pod:2420
24459 #: ../fish/guestfish-actions.pod:2422
24467 #: ../fish/guestfish-actions.pod:2430
24472 #: ../fish/guestfish-actions.pod:2432
24475 " lchown owner group path\n"
24480 #: ../fish/guestfish-actions.pod:2434
24482 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24483 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24488 #: ../fish/guestfish-actions.pod:2442
24493 #: ../fish/guestfish-actions.pod:2444
24496 " lgetxattr path name\n"
24501 #: ../fish/guestfish-actions.pod:2460
24502 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24506 #: ../fish/guestfish-actions.pod:2462
24511 #: ../fish/guestfish-actions.pod:2464
24514 " lgetxattrs path\n"
24519 #: ../fish/guestfish-actions.pod:2466
24521 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24522 "it returns the extended attributes of the link itself."
24526 #: ../fish/guestfish-actions.pod:2470
24527 msgid "list-devices"
24531 #: ../fish/guestfish-actions.pod:2472
24539 #: ../fish/guestfish-actions.pod:2480
24540 msgid "list-filesystems"
24544 #: ../fish/guestfish-actions.pod:2482
24547 " list-filesystems\n"
24552 #: ../fish/guestfish-actions.pod:2501
24554 "This command runs other libguestfs commands, which might include L</mount> "
24555 "and L</umount>, and therefore you should use this soon after launch and only "
24556 "when nothing is mounted."
24560 #: ../fish/guestfish-actions.pod:2505
24562 "Not all of the filesystems returned will be mountable. In particular, swap "
24563 "partitions are returned in the list. Also this command does not check that "
24564 "each filesystem found is valid and mountable, and some filesystems might be "
24565 "mountable but require special options. Filesystems may not all belong to a "
24566 "single logical operating system (use L</inspect-os> to look for OSes)."
24570 #: ../fish/guestfish-actions.pod:2513
24571 msgid "list-partitions"
24575 #: ../fish/guestfish-actions.pod:2515
24578 " list-partitions\n"
24583 #: ../fish/guestfish-actions.pod:2521
24585 "This does not return logical volumes. For that you will need to call L</"
24590 #: ../fish/guestfish-actions.pod:2526
24595 #: ../fish/guestfish-actions.pod:2528
24603 #: ../fish/guestfish-actions.pod:2536
24608 #: ../fish/guestfish-actions.pod:2538
24611 " ln target linkname\n"
24616 #: ../fish/guestfish-actions.pod:2542
24621 #: ../fish/guestfish-actions.pod:2544
24624 " ln-f target linkname\n"
24629 #: ../fish/guestfish-actions.pod:2549
24634 #: ../fish/guestfish-actions.pod:2551
24637 " ln-s target linkname\n"
24642 #: ../fish/guestfish-actions.pod:2555
24647 #: ../fish/guestfish-actions.pod:2557
24650 " ln-sf target linkname\n"
24655 #: ../fish/guestfish-actions.pod:2562
24656 msgid "lremovexattr"
24660 #: ../fish/guestfish-actions.pod:2564
24663 " lremovexattr xattr path\n"
24668 #: ../fish/guestfish-actions.pod:2566
24670 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24671 "it removes an extended attribute of the link itself."
24675 #: ../fish/guestfish-actions.pod:2570
24680 #: ../fish/guestfish-actions.pod:2572
24688 #: ../fish/guestfish-actions.pod:2578
24690 "This command is mostly useful for interactive sessions. Programs should "
24691 "probably use L</readdir> instead."
24695 #: ../fish/guestfish-actions.pod:2581
24700 #: ../fish/guestfish-actions.pod:2583
24703 " lsetxattr xattr val vallen path\n"
24708 #: ../fish/guestfish-actions.pod:2585
24710 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24711 "sets an extended attribute of the link itself."
24715 #: ../fish/guestfish-actions.pod:2589
24720 #: ../fish/guestfish-actions.pod:2591
24728 #: ../fish/guestfish-actions.pod:2595
24730 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24731 "the link is stat-ed, not the file it refers to."
24735 #: ../fish/guestfish-actions.pod:2601
24740 #: ../fish/guestfish-actions.pod:2603
24743 " lstatlist path 'names ...'\n"
24748 #: ../fish/guestfish-actions.pod:2605
24750 "This call allows you to perform the L</lstat> operation on multiple files, "
24751 "where all files are in the directory C<path>. C<names> is the list of files "
24752 "from this directory."
24756 #: ../fish/guestfish-actions.pod:2614
24758 "This call is intended for programs that want to efficiently list a directory "
24759 "contents without making many round-trips. See also L</lxattrlist> for a "
24760 "similarly efficient call for getting extended attributes. Very long "
24761 "directory listings might cause the protocol message size to be exceeded, "
24762 "causing this call to fail. The caller must split up such requests into "
24763 "smaller groups of names."
24767 #: ../fish/guestfish-actions.pod:2622
24768 msgid "luks-add-key"
24772 #: ../fish/guestfish-actions.pod:2624
24775 " luks-add-key device keyslot\n"
24780 #: ../fish/guestfish-actions.pod:2631
24782 "Note that if C<keyslot> already contains a key, then this command will "
24783 "fail. You have to use L</luks-kill-slot> first to remove that key."
24787 #: ../fish/guestfish-actions.pod:2635 ../fish/guestfish-actions.pod:2657
24788 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:2684
24789 #: ../fish/guestfish-actions.pod:2707 ../fish/guestfish-actions.pod:2717
24791 "This command has one or more key or passphrase parameters. Guestfish will "
24792 "prompt for these separately."
24796 #: ../fish/guestfish-actions.pod:2638
24801 #: ../fish/guestfish-actions.pod:2640
24804 " luks-close device\n"
24809 #: ../fish/guestfish-actions.pod:2642
24811 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24812 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24813 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24818 #: ../fish/guestfish-actions.pod:2648
24819 msgid "luks-format"
24823 #: ../fish/guestfish-actions.pod:2650
24826 " luks-format device keyslot\n"
24831 #: ../fish/guestfish-actions.pod:2663
24832 msgid "luks-format-cipher"
24836 #: ../fish/guestfish-actions.pod:2665
24839 " luks-format-cipher device keyslot cipher\n"
24844 #: ../fish/guestfish-actions.pod:2667
24846 "This command is the same as L</luks-format> but it also allows you to set "
24847 "the C<cipher> used."
24851 #: ../fish/guestfish-actions.pod:2676
24852 msgid "luks-kill-slot"
24856 #: ../fish/guestfish-actions.pod:2678
24859 " luks-kill-slot device keyslot\n"
24864 #: ../fish/guestfish-actions.pod:2687
24869 #: ../fish/guestfish-actions.pod:2689
24872 " luks-open device mapname\n"
24877 #: ../fish/guestfish-actions.pod:2703
24879 "If this block device contains LVM volume groups, then calling L</vgscan> "
24880 "followed by L</vg-activate-all> will make them visible."
24884 #: ../fish/guestfish-actions.pod:2710
24885 msgid "luks-open-ro"
24889 #: ../fish/guestfish-actions.pod:2712
24892 " luks-open-ro device mapname\n"
24897 #: ../fish/guestfish-actions.pod:2714
24899 "This is the same as L</luks-open> except that a read-only mapping is created."
24903 #: ../fish/guestfish-actions.pod:2720
24908 #: ../fish/guestfish-actions.pod:2722
24911 " lvcreate logvol volgroup mbytes\n"
24916 #: ../fish/guestfish-actions.pod:2727
24917 msgid "lvm-canonical-lv-name"
24921 #: ../fish/guestfish-actions.pod:2729
24924 " lvm-canonical-lv-name lvname\n"
24929 #: ../fish/guestfish-actions.pod:2738
24930 msgid "See also L</is-lv>."
24934 #: ../fish/guestfish-actions.pod:2740
24935 msgid "lvm-clear-filter"
24939 #: ../fish/guestfish-actions.pod:2742
24942 " lvm-clear-filter\n"
24947 #: ../fish/guestfish-actions.pod:2744
24949 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24954 #: ../fish/guestfish-actions.pod:2750
24955 msgid "lvm-remove-all"
24959 #: ../fish/guestfish-actions.pod:2752
24962 " lvm-remove-all\n"
24967 #: ../fish/guestfish-actions.pod:2760
24968 msgid "lvm-set-filter"
24972 #: ../fish/guestfish-actions.pod:2762
24975 " lvm-set-filter 'devices ...'\n"
24980 #: ../fish/guestfish-actions.pod:2787
24985 #: ../fish/guestfish-actions.pod:2789
24988 " lvremove device\n"
24993 #: ../fish/guestfish-actions.pod:2797
24998 #: ../fish/guestfish-actions.pod:2799
25001 " lvrename logvol newlogvol\n"
25006 #: ../fish/guestfish-actions.pod:2803
25011 #: ../fish/guestfish-actions.pod:2805
25014 " lvresize device mbytes\n"
25019 #: ../fish/guestfish-actions.pod:2811
25020 msgid "lvresize-free"
25024 #: ../fish/guestfish-actions.pod:2813
25027 " lvresize-free lv percent\n"
25032 #: ../fish/guestfish-actions.pod:2821
25037 #: ../fish/guestfish-actions.pod:2823
25045 #: ../fish/guestfish-actions.pod:2831
25046 msgid "See also L</lvs-full>, L</list-filesystems>."
25050 #: ../fish/guestfish-actions.pod:2833
25055 #: ../fish/guestfish-actions.pod:2835
25063 #: ../fish/guestfish-actions.pod:2840
25068 #: ../fish/guestfish-actions.pod:2842
25076 #: ../fish/guestfish-actions.pod:2846
25081 #: ../fish/guestfish-actions.pod:2848
25084 " lxattrlist path 'names ...'\n"
25089 #: ../fish/guestfish-actions.pod:2864
25091 "This call is intended for programs that want to efficiently list a directory "
25092 "contents without making many round-trips. See also L</lstatlist> for a "
25093 "similarly efficient call for getting standard stats. Very long directory "
25094 "listings might cause the protocol message size to be exceeded, causing this "
25095 "call to fail. The caller must split up such requests into smaller groups of "
25100 #: ../fish/guestfish-actions.pod:2872
25105 #: ../fish/guestfish-actions.pod:2874
25113 #: ../fish/guestfish-actions.pod:2878
25118 #: ../fish/guestfish-actions.pod:2880
25121 " mkdir-mode path mode\n"
25126 #: ../fish/guestfish-actions.pod:2889
25127 msgid "See also L</mkdir>, L</umask>"
25131 #: ../fish/guestfish-actions.pod:2891
25136 #: ../fish/guestfish-actions.pod:2893
25144 #: ../fish/guestfish-actions.pod:2898
25149 #: ../fish/guestfish-actions.pod:2900
25152 " mkdtemp template\n"
25157 #: ../fish/guestfish-actions.pod:2921
25162 #: ../fish/guestfish-actions.pod:2923
25165 " mke2fs-J fstype blocksize device journal\n"
25170 #: ../fish/guestfish-actions.pod:2931
25171 msgid "See also L</mke2journal>."
25175 #: ../fish/guestfish-actions.pod:2933
25180 #: ../fish/guestfish-actions.pod:2935
25183 " mke2fs-JL fstype blocksize device label\n"
25188 #: ../fish/guestfish-actions.pod:2940
25189 msgid "See also L</mke2journal-L>."
25193 #: ../fish/guestfish-actions.pod:2942
25198 #: ../fish/guestfish-actions.pod:2944
25201 " mke2fs-JU fstype blocksize device uuid\n"
25206 #: ../fish/guestfish-actions.pod:2949
25207 msgid "See also L</mke2journal-U>."
25211 #: ../fish/guestfish-actions.pod:2951
25212 msgid "mke2journal"
25216 #: ../fish/guestfish-actions.pod:2953
25219 " mke2journal blocksize device\n"
25224 #: ../fish/guestfish-actions.pod:2960
25225 msgid "mke2journal-L"
25229 #: ../fish/guestfish-actions.pod:2962
25232 " mke2journal-L blocksize label device\n"
25237 #: ../fish/guestfish-actions.pod:2966
25238 msgid "mke2journal-U"
25242 #: ../fish/guestfish-actions.pod:2968
25245 " mke2journal-U blocksize uuid device\n"
25250 #: ../fish/guestfish-actions.pod:2972
25255 #: ../fish/guestfish-actions.pod:2974
25258 " mkfifo mode path\n"
25263 #: ../fish/guestfish-actions.pod:2976
25265 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25266 "is just a convenient wrapper around L</mknod>."
25270 #: ../fish/guestfish-actions.pod:2982
25275 #: ../fish/guestfish-actions.pod:2984
25278 " mkfs fstype device\n"
25283 #: ../fish/guestfish-actions.pod:2990
25288 #: ../fish/guestfish-actions.pod:2992
25291 " mkfs-b fstype blocksize device\n"
25296 #: ../fish/guestfish-actions.pod:2994
25298 "This call is similar to L</mkfs>, but it allows you to control the block "
25299 "size of the resulting filesystem. Supported block sizes depend on the "
25300 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25304 #: ../fish/guestfish-actions.pod:3009
25309 #: ../fish/guestfish-actions.pod:3011
25312 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25317 #: ../fish/guestfish-actions.pod:3046
25318 msgid "mkmountpoint"
25322 #: ../fish/guestfish-actions.pod:3048
25325 " mkmountpoint exemptpath\n"
25330 #: ../fish/guestfish-actions.pod:3050
25332 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25333 "to create extra mountpoints before mounting the first filesystem."
25337 #: ../fish/guestfish-actions.pod:3074
25339 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25340 "unexpected errors if you try to mix these calls. It is safest to manually "
25341 "unmount filesystems and remove mountpoints after use."
25345 #: ../fish/guestfish-actions.pod:3078
25347 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25348 "for this to work for manual mountpoints, you must ensure that the innermost "
25349 "mountpoints have the longest pathnames, as in the example code above."
25353 #: ../fish/guestfish-actions.pod:3085
25355 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25356 "L</umount-all> to be called when the handle is closed which can also trigger "
25361 #: ../fish/guestfish-actions.pod:3089
25366 #: ../fish/guestfish-actions.pod:3091
25369 " mknod mode devmajor devminor path\n"
25374 #: ../fish/guestfish-actions.pod:3101
25376 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25377 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25378 "regular file). These constants are available in the standard Linux header "
25379 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25380 "wrappers around this command which bitwise OR in the appropriate constant "
25385 #: ../fish/guestfish-actions.pod:3111
25390 #: ../fish/guestfish-actions.pod:3113
25393 " mknod-b mode devmajor devminor path\n"
25398 #: ../fish/guestfish-actions.pod:3115
25400 "This call creates a block device node called C<path> with mode C<mode> and "
25401 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25402 "wrapper around L</mknod>."
25406 #: ../fish/guestfish-actions.pod:3121
25411 #: ../fish/guestfish-actions.pod:3123
25414 " mknod-c mode devmajor devminor path\n"
25419 #: ../fish/guestfish-actions.pod:3125
25421 "This call creates a char device node called C<path> with mode C<mode> and "
25422 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25423 "wrapper around L</mknod>."
25427 #: ../fish/guestfish-actions.pod:3131
25432 #: ../fish/guestfish-actions.pod:3133
25440 #: ../fish/guestfish-actions.pod:3137
25445 #: ../fish/guestfish-actions.pod:3139
25448 " mkswap-L label device\n"
25453 #: ../fish/guestfish-actions.pod:3147
25458 #: ../fish/guestfish-actions.pod:3149
25461 " mkswap-U uuid device\n"
25466 #: ../fish/guestfish-actions.pod:3153
25467 msgid "mkswap-file"
25471 #: ../fish/guestfish-actions.pod:3155
25474 " mkswap-file path\n"
25479 #: ../fish/guestfish-actions.pod:3159
25481 "This command just writes a swap file signature to an existing file. To "
25482 "create the file itself, use something like L</fallocate>."
25486 #: ../fish/guestfish-actions.pod:3162
25491 #: ../fish/guestfish-actions.pod:3164
25494 " modprobe modulename\n"
25499 #: ../fish/guestfish-actions.pod:3171
25504 #: ../fish/guestfish-actions.pod:3173
25507 " mount device mountpoint\n"
25512 #: ../fish/guestfish-actions.pod:3189
25514 "B<Important note:> When you use this call, the filesystem options C<sync> "
25515 "and C<noatime> are set implicitly. This was originally done because we "
25516 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25517 "very large negative performance impact and negligible effect on "
25518 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25519 "code that needs performance, and instead use L</mount-options> (use an empty "
25520 "string for the first parameter if you don't want any options)."
25524 #: ../fish/guestfish-actions.pod:3206
25529 #: ../fish/guestfish-actions.pod:3208
25532 " mount-loop file mountpoint\n"
25537 #: ../fish/guestfish-actions.pod:3214
25538 msgid "mount-options"
25542 #: ../fish/guestfish-actions.pod:3216
25545 " mount-options options device mountpoint\n"
25550 #: ../fish/guestfish-actions.pod:3218
25552 "This is the same as the L</mount> command, but it allows you to set the "
25553 "mount options as for the L<mount(8)> I<-o> flag."
25557 #: ../fish/guestfish-actions.pod:3226
25562 #: ../fish/guestfish-actions.pod:3228
25565 " mount-ro device mountpoint\n"
25570 #: ../fish/guestfish-actions.pod:3230
25572 "This is the same as the L</mount> command, but it mounts the filesystem with "
25573 "the read-only (I<-o ro>) flag."
25577 #: ../fish/guestfish-actions.pod:3233
25582 #: ../fish/guestfish-actions.pod:3235
25585 " mount-vfs options vfstype device mountpoint\n"
25590 #: ../fish/guestfish-actions.pod:3237
25592 "This is the same as the L</mount> command, but it allows you to set both the "
25593 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25597 #: ../fish/guestfish-actions.pod:3241
25598 msgid "mountpoints"
25602 #: ../fish/guestfish-actions.pod:3243
25610 #: ../fish/guestfish-actions.pod:3245
25612 "This call is similar to L</mounts>. That call returns a list of devices. "
25613 "This one returns a hash table (map) of device name to directory where the "
25614 "device is mounted."
25618 #: ../fish/guestfish-actions.pod:3249
25623 #: ../fish/guestfish-actions.pod:3251
25631 #: ../fish/guestfish-actions.pod:3258
25632 msgid "See also: L</mountpoints>"
25636 #: ../fish/guestfish-actions.pod:3260
25641 #: ../fish/guestfish-actions.pod:3262
25649 #: ../fish/guestfish-actions.pod:3267
25650 msgid "ntfs-3g-probe"
25654 #: ../fish/guestfish-actions.pod:3269
25657 " ntfs-3g-probe true|false device\n"
25662 #: ../fish/guestfish-actions.pod:3283
25667 #: ../fish/guestfish-actions.pod:3285
25670 " ntfsresize device\n"
25675 #: ../fish/guestfish-actions.pod:3291
25676 msgid "ntfsresize-size"
25680 #: ../fish/guestfish-actions.pod:3293
25683 " ntfsresize-size device size\n"
25688 #: ../fish/guestfish-actions.pod:3295
25690 "This command is the same as L</ntfsresize> except that it allows you to "
25691 "specify the new size (in bytes) explicitly."
25695 #: ../fish/guestfish-actions.pod:3298
25700 #: ../fish/guestfish-actions.pod:3300
25703 " part-add device prlogex startsect endsect\n"
25708 #: ../fish/guestfish-actions.pod:3302
25710 "This command adds a partition to C<device>. If there is no partition table "
25711 "on the device, call L</part-init> first."
25715 #: ../fish/guestfish-actions.pod:3314
25717 "Creating a partition which covers the whole disk is not so easy. Use L</"
25718 "part-disk> to do that."
25722 #: ../fish/guestfish-actions.pod:3317
25727 #: ../fish/guestfish-actions.pod:3319
25730 " part-del device partnum\n"
25735 #: ../fish/guestfish-actions.pod:3327
25740 #: ../fish/guestfish-actions.pod:3329
25743 " part-disk device parttype\n"
25748 #: ../fish/guestfish-actions.pod:3331
25750 "This command is simply a combination of L</part-init> followed by L</part-"
25751 "add> to create a single primary partition covering the whole disk."
25755 #: ../fish/guestfish-actions.pod:3335
25757 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25758 "possible values are described in L</part-init>."
25762 #: ../fish/guestfish-actions.pod:3341
25763 msgid "part-get-bootable"
25767 #: ../fish/guestfish-actions.pod:3343
25770 " part-get-bootable device partnum\n"
25775 #: ../fish/guestfish-actions.pod:3348
25776 msgid "See also L</part-set-bootable>."
25780 #: ../fish/guestfish-actions.pod:3350
25781 msgid "part-get-mbr-id"
25785 #: ../fish/guestfish-actions.pod:3352
25788 " part-get-mbr-id device partnum\n"
25793 #: ../fish/guestfish-actions.pod:3357 ../fish/guestfish-actions.pod:3495
25795 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25796 "undefined results for other partition table types (see L</part-get-"
25801 #: ../fish/guestfish-actions.pod:3361
25802 msgid "part-get-parttype"
25806 #: ../fish/guestfish-actions.pod:3363
25809 " part-get-parttype device\n"
25814 #: ../fish/guestfish-actions.pod:3368
25816 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25817 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25818 "possible, although unusual. See L</part-init> for a full list."
25822 #: ../fish/guestfish-actions.pod:3373
25827 #: ../fish/guestfish-actions.pod:3375
25830 " part-init device parttype\n"
25835 #: ../fish/guestfish-actions.pod:3381
25837 "Initially there are no partitions. Following this, you should call L</part-"
25838 "add> for each partition required."
25842 #: ../fish/guestfish-actions.pod:3444
25847 #: ../fish/guestfish-actions.pod:3446
25850 " part-list device\n"
25855 #: ../fish/guestfish-actions.pod:3461
25857 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25858 "the device's sector size, see L</blockdev-getss>."
25862 #: ../fish/guestfish-actions.pod:3474
25863 msgid "part-set-bootable"
25867 #: ../fish/guestfish-actions.pod:3476
25870 " part-set-bootable device partnum true|false\n"
25875 #: ../fish/guestfish-actions.pod:3485
25876 msgid "part-set-mbr-id"
25880 #: ../fish/guestfish-actions.pod:3487
25883 " part-set-mbr-id device partnum idbyte\n"
25888 #: ../fish/guestfish-actions.pod:3499
25889 msgid "part-set-name"
25893 #: ../fish/guestfish-actions.pod:3501
25896 " part-set-name device partnum name\n"
25901 #: ../fish/guestfish-actions.pod:3509
25902 msgid "part-to-dev"
25906 #: ../fish/guestfish-actions.pod:3511
25909 " part-to-dev partition\n"
25914 #: ../fish/guestfish-actions.pod:3517
25916 "The named partition must exist, for example as a string returned from L</"
25917 "list-partitions>."
25921 #: ../fish/guestfish-actions.pod:3520
25922 msgid "ping-daemon"
25926 #: ../fish/guestfish-actions.pod:3522
25934 #: ../fish/guestfish-actions.pod:3529
25939 #: ../fish/guestfish-actions.pod:3531
25942 " pread path count offset\n"
25947 #: ../fish/guestfish-actions.pod:3539
25948 msgid "See also L</pwrite>, L</pread-device>."
25952 #: ../fish/guestfish-actions.pod:3544
25953 msgid "pread-device"
25957 #: ../fish/guestfish-actions.pod:3546
25960 " pread-device device count offset\n"
25965 #: ../fish/guestfish-actions.pod:3554
25966 msgid "See also L</pread>."
25970 #: ../fish/guestfish-actions.pod:3559
25975 #: ../fish/guestfish-actions.pod:3561
25978 " pvcreate device\n"
25983 #: ../fish/guestfish-actions.pod:3567
25988 #: ../fish/guestfish-actions.pod:3569
25991 " pvremove device\n"
25996 #: ../fish/guestfish-actions.pod:3578
26001 #: ../fish/guestfish-actions.pod:3580
26004 " pvresize device\n"
26009 #: ../fish/guestfish-actions.pod:3585
26010 msgid "pvresize-size"
26014 #: ../fish/guestfish-actions.pod:3587
26017 " pvresize-size device size\n"
26022 #: ../fish/guestfish-actions.pod:3589
26024 "This command is the same as L</pvresize> except that it allows you to "
26025 "specify the new size (in bytes) explicitly."
26029 #: ../fish/guestfish-actions.pod:3592
26034 #: ../fish/guestfish-actions.pod:3594
26042 #: ../fish/guestfish-actions.pod:3602
26043 msgid "See also L</pvs-full>."
26047 #: ../fish/guestfish-actions.pod:3604
26052 #: ../fish/guestfish-actions.pod:3606
26060 #: ../fish/guestfish-actions.pod:3611
26065 #: ../fish/guestfish-actions.pod:3613
26073 #: ../fish/guestfish-actions.pod:3617
26078 #: ../fish/guestfish-actions.pod:3619
26081 " pwrite path content offset\n"
26086 #: ../fish/guestfish-actions.pod:3630
26087 msgid "See also L</pread>, L</pwrite-device>."
26091 #: ../fish/guestfish-actions.pod:3635
26092 msgid "pwrite-device"
26096 #: ../fish/guestfish-actions.pod:3637
26099 " pwrite-device device content offset\n"
26104 #: ../fish/guestfish-actions.pod:3647
26105 msgid "See also L</pwrite>."
26109 #: ../fish/guestfish-actions.pod:3652
26114 #: ../fish/guestfish-actions.pod:3654
26117 " read-file path\n"
26122 #: ../fish/guestfish-actions.pod:3659
26124 "Unlike L</cat>, this function can correctly handle files that contain "
26125 "embedded ASCII NUL characters. However unlike L</download>, this function "
26126 "is limited in the total size of file that can be handled."
26130 #: ../fish/guestfish-actions.pod:3667
26135 #: ../fish/guestfish-actions.pod:3669
26138 " read-lines path\n"
26143 #: ../fish/guestfish-actions.pod:3676
26145 "Note that this function cannot correctly handle binary files (specifically, "
26146 "files containing C<\\0> character which is treated as end of line). For "
26147 "those you need to use the L</read-file> function which has a more complex "
26152 #: ../fish/guestfish-actions.pod:3681
26157 #: ../fish/guestfish-actions.pod:3683
26165 #: ../fish/guestfish-actions.pod:3735
26167 "This function is primarily intended for use by programs. To get a simple "
26168 "list of names, use L</ls>. To get a printable directory for human "
26169 "consumption, use L</ll>."
26173 #: ../fish/guestfish-actions.pod:3739
26178 #: ../fish/guestfish-actions.pod:3741
26186 #: ../fish/guestfish-actions.pod:3745
26187 msgid "readlinklist"
26191 #: ../fish/guestfish-actions.pod:3747
26194 " readlinklist path 'names ...'\n"
26199 #: ../fish/guestfish-actions.pod:3771
26204 #: ../fish/guestfish-actions.pod:3773
26212 #: ../fish/guestfish-actions.pod:3778
26213 msgid "removexattr"
26217 #: ../fish/guestfish-actions.pod:3780
26220 " removexattr xattr path\n"
26225 #: ../fish/guestfish-actions.pod:3785
26226 msgid "See also: L</lremovexattr>, L<attr(5)>."
26230 #: ../fish/guestfish-actions.pod:3787
26235 #: ../fish/guestfish-actions.pod:3789
26238 " resize2fs device\n"
26243 #: ../fish/guestfish-actions.pod:3794
26245 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26246 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26247 "gives an error about this and sometimes not. In any case, it is always safe "
26248 "to call L</e2fsck-f> before calling this function."
26252 #: ../fish/guestfish-actions.pod:3800
26253 msgid "resize2fs-M"
26257 #: ../fish/guestfish-actions.pod:3802
26260 " resize2fs-M device\n"
26265 #: ../fish/guestfish-actions.pod:3804
26267 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26268 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26273 #: ../fish/guestfish-actions.pod:3808
26275 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26276 "and read the C<Block size> and C<Block count> values. These two numbers, "
26277 "multiplied together, give the resulting size of the minimal filesystem in "
26282 #: ../fish/guestfish-actions.pod:3813
26283 msgid "resize2fs-size"
26287 #: ../fish/guestfish-actions.pod:3815
26290 " resize2fs-size device size\n"
26295 #: ../fish/guestfish-actions.pod:3817
26297 "This command is the same as L</resize2fs> except that it allows you to "
26298 "specify the new size (in bytes) explicitly."
26302 #: ../fish/guestfish-actions.pod:3820
26307 #: ../fish/guestfish-actions.pod:3822
26315 #: ../fish/guestfish-actions.pod:3826
26320 #: ../fish/guestfish-actions.pod:3828
26328 #: ../fish/guestfish-actions.pod:3834
26333 #: ../fish/guestfish-actions.pod:3836
26341 #: ../fish/guestfish-actions.pod:3840
26342 msgid "rmmountpoint"
26346 #: ../fish/guestfish-actions.pod:3842
26349 " rmmountpoint exemptpath\n"
26354 #: ../fish/guestfish-actions.pod:3844
26356 "This calls removes a mountpoint that was previously created with L</"
26357 "mkmountpoint>. See L</mkmountpoint> for full details."
26361 #: ../fish/guestfish-actions.pod:3848
26362 msgid "scrub-device"
26366 #: ../fish/guestfish-actions.pod:3850
26369 " scrub-device device\n"
26374 #: ../fish/guestfish-actions.pod:3861
26379 #: ../fish/guestfish-actions.pod:3863
26382 " scrub-file file\n"
26387 #: ../fish/guestfish-actions.pod:3873
26388 msgid "scrub-freespace"
26392 #: ../fish/guestfish-actions.pod:3875
26395 " scrub-freespace dir\n"
26400 #: ../fish/guestfish-actions.pod:3877
26402 "This command creates the directory C<dir> and then fills it with files until "
26403 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26404 "deletes them. The intention is to scrub any free space on the partition "
26405 "containing C<dir>."
26409 #: ../fish/guestfish-actions.pod:3886
26414 #: ../fish/guestfish-actions.pod:3888
26419 #: ../fish/guestfish-actions.pod:3890
26422 " set-append append\n"
26427 #: ../fish/guestfish-actions.pod:3901
26428 msgid "set-attach-method"
26432 #: ../fish/guestfish-actions.pod:3903
26433 msgid "attach-method"
26437 #: ../fish/guestfish-actions.pod:3905
26440 " set-attach-method attachmethod\n"
26445 #: ../fish/guestfish-actions.pod:3927
26446 msgid "set-autosync"
26450 #: ../fish/guestfish-actions.pod:3929
26455 #: ../fish/guestfish-actions.pod:3931
26458 " set-autosync true|false\n"
26463 #: ../fish/guestfish-actions.pod:3941
26468 #: ../fish/guestfish-actions.pod:3943
26473 #: ../fish/guestfish-actions.pod:3945
26476 " set-direct true|false\n"
26481 #: ../fish/guestfish-actions.pod:3951
26483 "One consequence of this is that log messages aren't caught by the library "
26484 "and handled by L</set-log-message-callback>, but go straight to stdout."
26488 #: ../fish/guestfish-actions.pod:3960
26489 msgid "set-e2label"
26493 #: ../fish/guestfish-actions.pod:3962
26496 " set-e2label device label\n"
26501 #: ../fish/guestfish-actions.pod:3968
26503 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26504 "label on a filesystem."
26508 #: ../fish/guestfish-actions.pod:3971
26513 #: ../fish/guestfish-actions.pod:3973
26516 " set-e2uuid device uuid\n"
26521 #: ../fish/guestfish-actions.pod:3980
26523 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26524 "UUID of a filesystem."
26528 #: ../fish/guestfish-actions.pod:3983
26529 msgid "set-memsize"
26533 #: ../fish/guestfish-actions.pod:3985
26538 #: ../fish/guestfish-actions.pod:3987
26541 " set-memsize memsize\n"
26546 #: ../fish/guestfish-actions.pod:3989
26548 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26549 "This only has any effect if called before L</launch>."
26553 #: ../fish/guestfish-actions.pod:4000
26554 msgid "set-network"
26558 #: ../fish/guestfish-actions.pod:4002
26563 #: ../fish/guestfish-actions.pod:4004
26566 " set-network true|false\n"
26571 #: ../fish/guestfish-actions.pod:4012
26573 "You must call this before calling L</launch>, otherwise it has no effect."
26577 #: ../fish/guestfish-actions.pod:4015
26582 #: ../fish/guestfish-actions.pod:4017
26587 #: ../fish/guestfish-actions.pod:4019
26590 " set-path searchpath\n"
26595 #: ../fish/guestfish-actions.pod:4028
26600 #: ../fish/guestfish-actions.pod:4030
26605 #: ../fish/guestfish-actions.pod:4032
26613 #: ../fish/guestfish-actions.pod:4052
26614 msgid "set-recovery-proc"
26618 #: ../fish/guestfish-actions.pod:4054
26619 msgid "recovery-proc"
26623 #: ../fish/guestfish-actions.pod:4056
26626 " set-recovery-proc true|false\n"
26631 #: ../fish/guestfish-actions.pod:4058
26633 "If this is called with the parameter C<false> then L</launch> does not "
26634 "create a recovery process. The purpose of the recovery process is to stop "
26635 "runaway qemu processes in the case where the main program aborts abruptly."
26639 #: ../fish/guestfish-actions.pod:4063
26641 "This only has any effect if called before L</launch>, and the default is "
26646 #: ../fish/guestfish-actions.pod:4072
26647 msgid "set-selinux"
26651 #: ../fish/guestfish-actions.pod:4074
26656 #: ../fish/guestfish-actions.pod:4076
26659 " set-selinux true|false\n"
26664 #: ../fish/guestfish-actions.pod:4087
26669 #: ../fish/guestfish-actions.pod:4089
26674 #: ../fish/guestfish-actions.pod:4091
26677 " set-trace true|false\n"
26682 #: ../fish/guestfish-actions.pod:4103
26684 "Trace messages are normally sent to C<stderr>, unless you register a "
26685 "callback to send them somewhere else (see L</set-event-callback>)."
26689 #: ../fish/guestfish-actions.pod:4107
26690 msgid "set-verbose"
26694 #: ../fish/guestfish-actions.pod:4109
26699 #: ../fish/guestfish-actions.pod:4111
26702 " set-verbose true|false\n"
26707 #: ../fish/guestfish-actions.pod:4118
26709 "Verbose messages are normally sent to C<stderr>, unless you register a "
26710 "callback to send them somewhere else (see L</set-event-callback>)."
26714 #: ../fish/guestfish-actions.pod:4122
26719 #: ../fish/guestfish-actions.pod:4124
26722 " setcon context\n"
26727 #: ../fish/guestfish-actions.pod:4131
26732 #: ../fish/guestfish-actions.pod:4133
26735 " setxattr xattr val vallen path\n"
26740 #: ../fish/guestfish-actions.pod:4139
26741 msgid "See also: L</lsetxattr>, L<attr(5)>."
26745 #: ../fish/guestfish-actions.pod:4141
26750 #: ../fish/guestfish-actions.pod:4143
26753 " sfdisk device cyls heads sectors 'lines ...'\n"
26758 #: ../fish/guestfish-actions.pod:4165
26759 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26763 #: ../fish/guestfish-actions.pod:4178
26768 #: ../fish/guestfish-actions.pod:4180
26771 " sfdiskM device 'lines ...'\n"
26776 #: ../fish/guestfish-actions.pod:4182
26778 "This is a simplified interface to the L</sfdisk> command, where partition "
26779 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26780 "you don't need to specify the cyls, heads and sectors parameters which were "
26781 "rarely if ever used anyway."
26785 #: ../fish/guestfish-actions.pod:4188
26786 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26790 #: ../fish/guestfish-actions.pod:4201
26795 #: ../fish/guestfish-actions.pod:4203
26798 " sfdisk-N device partnum cyls heads sectors line\n"
26803 #: ../fish/guestfish-actions.pod:4208
26805 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26806 "cyls/heads/sectors parameters."
26810 #: ../fish/guestfish-actions.pod:4211
26811 msgid "See also: L</part-add>"
26815 #: ../fish/guestfish-actions.pod:4223
26816 msgid "sfdisk-disk-geometry"
26820 #: ../fish/guestfish-actions.pod:4225
26823 " sfdisk-disk-geometry device\n"
26828 #: ../fish/guestfish-actions.pod:4227
26830 "This displays the disk geometry of C<device> read from the partition table. "
26831 "Especially in the case where the underlying block device has been resized, "
26832 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26833 "kernel-geometry>)."
26837 #: ../fish/guestfish-actions.pod:4235
26838 msgid "sfdisk-kernel-geometry"
26842 #: ../fish/guestfish-actions.pod:4237
26845 " sfdisk-kernel-geometry device\n"
26850 #: ../fish/guestfish-actions.pod:4244
26855 #: ../fish/guestfish-actions.pod:4246
26858 " sfdisk-l device\n"
26863 #: ../fish/guestfish-actions.pod:4252
26864 msgid "See also: L</part-list>"
26868 #: ../fish/guestfish-actions.pod:4261
26873 #: ../fish/guestfish-actions.pod:4263
26881 #: ../fish/guestfish-actions.pod:4268
26882 msgid "This is like L</command>, but passes the command to:"
26886 #: ../fish/guestfish-actions.pod:4276
26887 msgid "All the provisos about L</command> apply to this call."
26891 #: ../fish/guestfish-actions.pod:4278
26896 #: ../fish/guestfish-actions.pod:4280
26899 " sh-lines command\n"
26904 #: ../fish/guestfish-actions.pod:4282
26905 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26909 #: ../fish/guestfish-actions.pod:4285
26910 msgid "See also: L</command-lines>"
26914 #: ../fish/guestfish-actions.pod:4287
26919 #: ../fish/guestfish-actions.pod:4289
26927 #: ../fish/guestfish-actions.pod:4293
26932 #: ../fish/guestfish-actions.pod:4295
26940 #: ../fish/guestfish-actions.pod:4301
26945 #: ../fish/guestfish-actions.pod:4303
26953 #: ../fish/guestfish-actions.pod:4311
26958 #: ../fish/guestfish-actions.pod:4313
26966 #: ../fish/guestfish-actions.pod:4321
26971 #: ../fish/guestfish-actions.pod:4323
26974 " strings-e encoding path\n"
26979 #: ../fish/guestfish-actions.pod:4325
26981 "This is like the L</strings> command, but allows you to specify the encoding "
26982 "of strings that are looked for in the source file C<path>."
26986 #: ../fish/guestfish-actions.pod:4335
26988 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26989 "ISO-8859-X (this is what L</strings> uses)."
26993 #: ../fish/guestfish-actions.pod:4367
26994 msgid "swapoff-device"
26998 #: ../fish/guestfish-actions.pod:4369
27001 " swapoff-device device\n"
27006 #: ../fish/guestfish-actions.pod:4371
27008 "This command disables the libguestfs appliance swap device or partition "
27009 "named C<device>. See L</swapon-device>."
27013 #: ../fish/guestfish-actions.pod:4375
27014 msgid "swapoff-file"
27018 #: ../fish/guestfish-actions.pod:4377
27021 " swapoff-file file\n"
27026 #: ../fish/guestfish-actions.pod:4381
27027 msgid "swapoff-label"
27031 #: ../fish/guestfish-actions.pod:4383
27034 " swapoff-label label\n"
27039 #: ../fish/guestfish-actions.pod:4388
27040 msgid "swapoff-uuid"
27044 #: ../fish/guestfish-actions.pod:4390
27047 " swapoff-uuid uuid\n"
27052 #: ../fish/guestfish-actions.pod:4395
27053 msgid "swapon-device"
27057 #: ../fish/guestfish-actions.pod:4397
27060 " swapon-device device\n"
27065 #: ../fish/guestfish-actions.pod:4399
27067 "This command enables the libguestfs appliance to use the swap device or "
27068 "partition named C<device>. The increased memory is made available for all "
27069 "commands, for example those run using L</command> or L</sh>."
27073 #: ../fish/guestfish-actions.pod:4411
27074 msgid "swapon-file"
27078 #: ../fish/guestfish-actions.pod:4413
27081 " swapon-file file\n"
27086 #: ../fish/guestfish-actions.pod:4415
27088 "This command enables swap to a file. See L</swapon-device> for other notes."
27092 #: ../fish/guestfish-actions.pod:4418
27093 msgid "swapon-label"
27097 #: ../fish/guestfish-actions.pod:4420
27100 " swapon-label label\n"
27105 #: ../fish/guestfish-actions.pod:4422
27107 "This command enables swap to a labeled swap partition. See L</swapon-"
27108 "device> for other notes."
27112 #: ../fish/guestfish-actions.pod:4425
27113 msgid "swapon-uuid"
27117 #: ../fish/guestfish-actions.pod:4427
27120 " swapon-uuid uuid\n"
27125 #: ../fish/guestfish-actions.pod:4429
27127 "This command enables swap to a swap partition with the given UUID. See L</"
27128 "swapon-device> for other notes."
27132 #: ../fish/guestfish-actions.pod:4432
27137 #: ../fish/guestfish-actions.pod:4434
27145 #: ../fish/guestfish-actions.pod:4442
27150 #: ../fish/guestfish-actions.pod:4444
27158 #: ../fish/guestfish-actions.pod:4452
27163 #: ../fish/guestfish-actions.pod:4454
27166 " tail-n nrlines path\n"
27171 #: ../fish/guestfish-actions.pod:4467
27176 #: ../fish/guestfish-actions.pod:4469
27179 " tar-in (tarfile|-) directory\n"
27184 #: ../fish/guestfish-actions.pod:4474
27185 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27189 #: ../fish/guestfish-actions.pod:4479
27194 #: ../fish/guestfish-actions.pod:4481
27197 " tar-out directory (tarfile|-)\n"
27202 #: ../fish/guestfish-actions.pod:4486
27203 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27207 #: ../fish/guestfish-actions.pod:4491
27212 #: ../fish/guestfish-actions.pod:4493
27215 " tgz-in (tarball|-) directory\n"
27220 #: ../fish/guestfish-actions.pod:4498
27221 msgid "To upload an uncompressed tarball, use L</tar-in>."
27225 #: ../fish/guestfish-actions.pod:4502
27230 #: ../fish/guestfish-actions.pod:4504
27233 " tgz-out directory (tarball|-)\n"
27238 #: ../fish/guestfish-actions.pod:4509
27239 msgid "To download an uncompressed tarball, use L</tar-out>."
27243 #: ../fish/guestfish-actions.pod:4513
27248 #: ../fish/guestfish-actions.pod:4515
27256 #: ../fish/guestfish-actions.pod:4524
27261 #: ../fish/guestfish-actions.pod:4526
27269 #: ../fish/guestfish-actions.pod:4531
27270 msgid "truncate-size"
27274 #: ../fish/guestfish-actions.pod:4533
27277 " truncate-size path size\n"
27282 #: ../fish/guestfish-actions.pod:4538
27284 "If the current file size is less than C<size> then the file is extended to "
27285 "the required size with zero bytes. This creates a sparse file (ie. disk "
27286 "blocks are not allocated for the file until you write to it). To create a "
27287 "non-sparse file of zeroes, use L</fallocate64> instead."
27291 #: ../fish/guestfish-actions.pod:4544
27296 #: ../fish/guestfish-actions.pod:4546
27299 " tune2fs-l device\n"
27304 #: ../fish/guestfish-actions.pod:4556
27309 #: ../fish/guestfish-actions.pod:4558
27312 " txz-in (tarball|-) directory\n"
27317 #: ../fish/guestfish-actions.pod:4565
27322 #: ../fish/guestfish-actions.pod:4567
27325 " txz-out directory (tarball|-)\n"
27330 #: ../fish/guestfish-actions.pod:4574
27335 #: ../fish/guestfish-actions.pod:4576
27343 #: ../fish/guestfish-actions.pod:4590
27344 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27348 #: ../fish/guestfish-actions.pod:4595
27353 #: ../fish/guestfish-actions.pod:4597
27358 #: ../fish/guestfish-actions.pod:4599
27361 " umount pathordevice\n"
27366 #: ../fish/guestfish-actions.pod:4605
27371 #: ../fish/guestfish-actions.pod:4607
27372 msgid "unmount-all"
27376 #: ../fish/guestfish-actions.pod:4609
27384 #: ../fish/guestfish-actions.pod:4615
27389 #: ../fish/guestfish-actions.pod:4617
27392 " upload (filename|-) remotefilename\n"
27397 #: ../fish/guestfish-actions.pod:4624
27398 msgid "See also L</download>."
27402 #: ../fish/guestfish-actions.pod:4628
27403 msgid "upload-offset"
27407 #: ../fish/guestfish-actions.pod:4630
27410 " upload-offset (filename|-) remotefilename offset\n"
27415 #: ../fish/guestfish-actions.pod:4642
27417 "Note that there is no limit on the amount of data that can be uploaded with "
27418 "this call, unlike with L</pwrite>, and this call always writes the full "
27419 "amount unless an error occurs."
27423 #: ../fish/guestfish-actions.pod:4647
27424 msgid "See also L</upload>, L</pwrite>."
27428 #: ../fish/guestfish-actions.pod:4651
27433 #: ../fish/guestfish-actions.pod:4653
27436 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27441 #: ../fish/guestfish-actions.pod:4672
27446 #: ../fish/guestfish-actions.pod:4674
27454 #: ../fish/guestfish-actions.pod:4701
27456 "I<Note:> Don't use this call to test for availability of features. In "
27457 "enterprise distributions we backport features from later versions into "
27458 "earlier versions, making this an unreliable way to test for features. Use "
27459 "L</available> instead."
27463 #: ../fish/guestfish-actions.pod:4707
27468 #: ../fish/guestfish-actions.pod:4709
27471 " vfs-label device\n"
27476 #: ../fish/guestfish-actions.pod:4716
27477 msgid "To find a filesystem from the label, use L</findfs-label>."
27481 #: ../fish/guestfish-actions.pod:4718
27486 #: ../fish/guestfish-actions.pod:4720
27489 " vfs-type device\n"
27494 #: ../fish/guestfish-actions.pod:4730
27499 #: ../fish/guestfish-actions.pod:4732
27502 " vfs-uuid device\n"
27507 #: ../fish/guestfish-actions.pod:4739
27508 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27512 #: ../fish/guestfish-actions.pod:4741
27513 msgid "vg-activate"
27517 #: ../fish/guestfish-actions.pod:4743
27520 " vg-activate true|false 'volgroups ...'\n"
27525 #: ../fish/guestfish-actions.pod:4756
27526 msgid "vg-activate-all"
27530 #: ../fish/guestfish-actions.pod:4758
27533 " vg-activate-all true|false\n"
27538 #: ../fish/guestfish-actions.pod:4768
27543 #: ../fish/guestfish-actions.pod:4770
27546 " vgcreate volgroup 'physvols ...'\n"
27551 #: ../fish/guestfish-actions.pod:4775
27556 #: ../fish/guestfish-actions.pod:4777
27559 " vglvuuids vgname\n"
27564 #: ../fish/guestfish-actions.pod:4782
27566 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27567 "logical volumes and volume groups."
27571 #: ../fish/guestfish-actions.pod:4785
27572 msgid "See also L</vgpvuuids>."
27576 #: ../fish/guestfish-actions.pod:4787
27581 #: ../fish/guestfish-actions.pod:4789
27584 " vgpvuuids vgname\n"
27589 #: ../fish/guestfish-actions.pod:4794
27591 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27592 "physical volumes and volume groups."
27596 #: ../fish/guestfish-actions.pod:4797
27597 msgid "See also L</vglvuuids>."
27601 #: ../fish/guestfish-actions.pod:4799
27606 #: ../fish/guestfish-actions.pod:4801
27609 " vgremove vgname\n"
27614 #: ../fish/guestfish-actions.pod:4808
27619 #: ../fish/guestfish-actions.pod:4810
27622 " vgrename volgroup newvolgroup\n"
27627 #: ../fish/guestfish-actions.pod:4814
27632 #: ../fish/guestfish-actions.pod:4816
27640 #: ../fish/guestfish-actions.pod:4824
27641 msgid "See also L</vgs-full>."
27645 #: ../fish/guestfish-actions.pod:4826
27650 #: ../fish/guestfish-actions.pod:4828
27658 #: ../fish/guestfish-actions.pod:4833
27663 #: ../fish/guestfish-actions.pod:4835
27671 #: ../fish/guestfish-actions.pod:4840
27676 #: ../fish/guestfish-actions.pod:4842
27684 #: ../fish/guestfish-actions.pod:4846
27689 #: ../fish/guestfish-actions.pod:4848
27697 #: ../fish/guestfish-actions.pod:4853
27702 #: ../fish/guestfish-actions.pod:4855
27710 #: ../fish/guestfish-actions.pod:4860
27715 #: ../fish/guestfish-actions.pod:4862
27723 #: ../fish/guestfish-actions.pod:4867
27728 #: ../fish/guestfish-actions.pod:4869
27731 " write path content\n"
27736 #: ../fish/guestfish-actions.pod:4877
27741 #: ../fish/guestfish-actions.pod:4879
27744 " write-file path content size\n"
27749 #: ../fish/guestfish-actions.pod:4902
27754 #: ../fish/guestfish-actions.pod:4904
27757 " zegrep regex path\n"
27762 #: ../fish/guestfish-actions.pod:4912
27767 #: ../fish/guestfish-actions.pod:4914
27770 " zegrepi regex path\n"
27775 #: ../fish/guestfish-actions.pod:4922
27780 #: ../fish/guestfish-actions.pod:4924
27788 #: ../fish/guestfish-actions.pod:4932
27789 msgid "See also: L</zero-device>, L</scrub-device>."
27793 #: ../fish/guestfish-actions.pod:4934
27794 msgid "zero-device"
27798 #: ../fish/guestfish-actions.pod:4936
27801 " zero-device device\n"
27806 #: ../fish/guestfish-actions.pod:4938
27808 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27809 "which just zeroes the first few blocks of a device."
27813 #: ../fish/guestfish-actions.pod:4945
27818 #: ../fish/guestfish-actions.pod:4947
27821 " zerofree device\n"
27826 #: ../fish/guestfish-actions.pod:4960
27831 #: ../fish/guestfish-actions.pod:4962
27834 " zfgrep pattern path\n"
27839 #: ../fish/guestfish-actions.pod:4970
27844 #: ../fish/guestfish-actions.pod:4972
27847 " zfgrepi pattern path\n"
27852 #: ../fish/guestfish-actions.pod:4980
27857 #: ../fish/guestfish-actions.pod:4982
27860 " zfile meth path\n"
27865 #: ../fish/guestfish-actions.pod:4989
27867 "Since 1.0.63, use L</file> instead which can now process compressed files."
27871 #: ../fish/guestfish-actions.pod:4999
27876 #: ../fish/guestfish-actions.pod:5001
27879 " zgrep regex path\n"
27884 #: ../fish/guestfish-actions.pod:5009
27889 #: ../fish/guestfish-actions.pod:5011
27892 " zgrepi regex path\n"
27897 #: ../fish/guestfish-commands.pod:1
27902 #: ../fish/guestfish-commands.pod:3
27907 #: ../fish/guestfish-commands.pod:5
27910 " alloc filename size\n"
27915 #: ../fish/guestfish-commands.pod:7
27917 "This creates an empty (zeroed) file of the given size, and then adds so it "
27918 "can be further examined."
27922 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27923 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27927 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27928 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27932 #: ../fish/guestfish-commands.pod:14
27934 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27935 "image, see L</PREPARED DISK IMAGES>."
27939 #: ../fish/guestfish-commands.pod:17
27944 #: ../fish/guestfish-commands.pod:19
27947 " copy-in local [local ...] /remotedir\n"
27952 #: ../fish/guestfish-commands.pod:21
27954 "C<copy-in> copies local files or directories recursively into the disk "
27955 "image, placing them in the directory called C</remotedir> (which must "
27956 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27957 "other commands as necessary."
27961 #: ../fish/guestfish-commands.pod:26
27963 "Multiple local files and directories can be specified, but the last "
27964 "parameter must always be a remote directory. Wildcards cannot be used."
27968 #: ../fish/guestfish-commands.pod:30
27973 #: ../fish/guestfish-commands.pod:32
27976 " copy-out remote [remote ...] localdir\n"
27981 #: ../fish/guestfish-commands.pod:34
27983 "C<copy-out> copies remote files or directories recursively out of the disk "
27984 "image, placing them on the host disk in a local directory called C<localdir> "
27985 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27986 "download>, L</tar-out> and other commands as necessary."
27990 #: ../fish/guestfish-commands.pod:40
27992 "Multiple remote files and directories can be specified, but the last "
27993 "parameter must always be a local directory. To download to the current "
27994 "directory, use C<.> as in:"
27998 #: ../fish/guestfish-commands.pod:44
28001 " copy-out /home .\n"
28006 #: ../fish/guestfish-commands.pod:46
28008 "Wildcards cannot be used in the ordinary command, but you can use them with "
28009 "the help of L</glob> like this:"
28013 #: ../fish/guestfish-commands.pod:49
28016 " glob copy-out /home/* .\n"
28021 #: ../fish/guestfish-commands.pod:51
28026 #: ../fish/guestfish-commands.pod:53
28029 " echo [params ...]\n"
28034 #: ../fish/guestfish-commands.pod:55
28035 msgid "This echos the parameters to the terminal."
28039 #: ../fish/guestfish-commands.pod:57
28044 #: ../fish/guestfish-commands.pod:59
28049 #: ../fish/guestfish-commands.pod:61
28054 #: ../fish/guestfish-commands.pod:63
28062 #: ../fish/guestfish-commands.pod:65
28064 "This is used to edit a file. It downloads the file, edits it locally using "
28065 "your editor, then uploads the result."
28069 #: ../fish/guestfish-commands.pod:68
28071 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28072 "or C<emacs> you will get those corresponding editors."
28076 #: ../fish/guestfish-commands.pod:72
28081 #: ../fish/guestfish-commands.pod:74
28084 " glob command args...\n"
28089 #: ../fish/guestfish-commands.pod:76
28091 "Expand wildcards in any paths in the args list, and run C<command> "
28092 "repeatedly on each matching path."
28096 #: ../fish/guestfish-commands.pod:79
28097 msgid "See L</WILDCARDS AND GLOBBING>."
28101 #: ../fish/guestfish-commands.pod:81
28106 #: ../fish/guestfish-commands.pod:83
28109 " hexedit <filename|device>\n"
28110 " hexedit <filename|device> <max>\n"
28111 " hexedit <filename|device> <start> <max>\n"
28116 #: ../fish/guestfish-commands.pod:87
28118 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28123 #: ../fish/guestfish-commands.pod:90
28125 "This command works by downloading potentially the whole file or device, "
28126 "editing it locally, then uploading it. If the file or device is large, you "
28127 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28128 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28129 "usual modifiers allowed such as C<1M> (1 megabyte)."
28133 #: ../fish/guestfish-commands.pod:97
28134 msgid "For example to edit the first few sectors of a disk you might do:"
28138 #: ../fish/guestfish-commands.pod:100
28141 " hexedit /dev/sda 1M\n"
28146 #: ../fish/guestfish-commands.pod:102
28148 "which would allow you to edit anywhere within the first megabyte of the disk."
28152 #: ../fish/guestfish-commands.pod:105
28153 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28157 #: ../fish/guestfish-commands.pod:107
28160 " hexedit /dev/sda1 0x400 0x400\n"
28165 #: ../fish/guestfish-commands.pod:109
28166 msgid "(assuming the superblock is in the standard location)."
28170 #: ../fish/guestfish-commands.pod:111
28172 "This command requires the external L<hexedit(1)> program. You can specify "
28173 "another program to use by setting the C<HEXEDITOR> environment variable."
28177 #: ../fish/guestfish-commands.pod:115
28178 msgid "See also L</hexdump>."
28182 #: ../fish/guestfish-commands.pod:117
28187 #: ../fish/guestfish-commands.pod:119
28195 #: ../fish/guestfish-commands.pod:121
28197 "Change the local directory, ie. the current directory of guestfish itself."
28201 #: ../fish/guestfish-commands.pod:124
28202 msgid "Note that C<!cd> won't do what you might expect."
28206 #: ../fish/guestfish-commands.pod:126
28211 #: ../fish/guestfish-commands.pod:128
28216 #: ../fish/guestfish-commands.pod:130
28224 #: ../fish/guestfish-commands.pod:132
28225 msgid "Opens the manual page for guestfish."
28229 #: ../fish/guestfish-commands.pod:134
28234 #: ../fish/guestfish-commands.pod:136
28239 #: ../fish/guestfish-commands.pod:138
28247 #: ../fish/guestfish-commands.pod:140
28255 #: ../fish/guestfish-commands.pod:142
28256 msgid "This is used to view a file."
28260 #: ../fish/guestfish-commands.pod:144
28262 "The default viewer is C<$PAGER>. However if you use the alternate command "
28263 "C<less> you will get the C<less> command specifically."
28267 #: ../fish/guestfish-commands.pod:147
28272 #: ../fish/guestfish-commands.pod:149
28280 #: ../fish/guestfish-commands.pod:151
28282 "Close and reopen the libguestfs handle. It is not necessary to use this "
28283 "normally, because the handle is closed properly when guestfish exits. "
28284 "However this is occasionally useful for testing."
28288 #: ../fish/guestfish-commands.pod:155
28293 #: ../fish/guestfish-commands.pod:157
28296 " sparse filename size\n"
28301 #: ../fish/guestfish-commands.pod:159
28303 "This creates an empty sparse file of the given size, and then adds so it can "
28304 "be further examined."
28308 #: ../fish/guestfish-commands.pod:162
28310 "In all respects it works the same as the L</alloc> command, except that the "
28311 "image file is allocated sparsely, which means that disk blocks are not "
28312 "assigned to the file until they are needed. Sparse disk files only use "
28313 "space when written to, but they are slower and there is a danger you could "
28314 "run out of real disk space during a write operation."
28318 #: ../fish/guestfish-commands.pod:172
28323 #: ../fish/guestfish-commands.pod:174
28331 #: ../fish/guestfish-commands.pod:176
28333 "This command returns a list of the optional groups known to the daemon, and "
28334 "indicates which ones are supported by this build of the libguestfs appliance."
28338 #: ../fish/guestfish-commands.pod:180
28339 msgid "See also L<guestfs(3)/AVAILABILITY>."
28343 #: ../fish/guestfish-commands.pod:182
28348 #: ../fish/guestfish-commands.pod:184
28351 " time command args...\n"
28356 #: ../fish/guestfish-commands.pod:186
28358 "Run the command as usual, but print the elapsed time afterwards. This can "
28359 "be useful for benchmarking operations."
28363 #: ../test-tool/libguestfs-test-tool.pod:5
28364 msgid "libguestfs-test-tool - End user tests for libguestfs"
28368 #: ../test-tool/libguestfs-test-tool.pod:9
28371 " libguestfs-test-tool [--options]\n"
28376 #: ../test-tool/libguestfs-test-tool.pod:13
28378 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28379 "and developers, to allow them to check basic libguestfs functionality is "
28380 "working. This is needed because libguestfs occasionally breaks for reasons "
28381 "beyond our control: usually because of changes in the underlying qemu or "
28382 "kernel packages, or the host environment."
28386 #: ../test-tool/libguestfs-test-tool.pod:20
28387 msgid "If you suspect a problem in libguestfs, then just run:"
28391 #: ../test-tool/libguestfs-test-tool.pod:22
28394 " libguestfs-test-tool\n"
28399 #: ../test-tool/libguestfs-test-tool.pod:24
28400 msgid "It will print lots of diagnostic messages."
28404 #: ../test-tool/libguestfs-test-tool.pod:26
28405 msgid "If it runs to completion successfully, you will see this near the end:"
28409 #: ../test-tool/libguestfs-test-tool.pod:28
28412 " ===== TEST FINISHED OK =====\n"
28417 #: ../test-tool/libguestfs-test-tool.pod:30
28418 msgid "and the test tool will exit with code 0."
28422 #: ../test-tool/libguestfs-test-tool.pod:32
28424 "If it fails (and/or exits with non-zero error code), please paste the "
28425 "B<complete, unedited> output of the test tool into a bug report. More "
28426 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28431 #: ../test-tool/libguestfs-test-tool.pod:41
28436 #: ../test-tool/libguestfs-test-tool.pod:43
28437 msgid "Display short usage information and exit."
28441 #: ../test-tool/libguestfs-test-tool.pod:45
28442 msgid "I<--qemu qemu_binary>"
28446 #: ../test-tool/libguestfs-test-tool.pod:47
28448 "If you have downloaded another qemu binary, point this option at the full "
28449 "path of the binary to try it."
28453 #: ../test-tool/libguestfs-test-tool.pod:50
28454 msgid "I<--qemudir qemu_source_dir>"
28458 #: ../test-tool/libguestfs-test-tool.pod:52
28460 "If you have compiled qemu from source, point this option at the source "
28461 "directory to try it."
28465 #: ../test-tool/libguestfs-test-tool.pod:55
28466 msgid "I<--timeout N>"
28470 #: ../test-tool/libguestfs-test-tool.pod:57
28472 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28473 "does not usually need to be adjusted unless your machine is very slow."
28477 #: ../test-tool/libguestfs-test-tool.pod:63
28478 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28482 #: ../test-tool/libguestfs-test-tool.pod:65
28484 "If you have compiled another version of qemu from source and would like to "
28485 "try that, then you can use the I<--qemudir> option to point to the qemu "
28486 "source directory."
28490 #: ../test-tool/libguestfs-test-tool.pod:69
28492 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28493 "option to point to the binary."
28497 #: ../test-tool/libguestfs-test-tool.pod:72
28499 "When using an alternate qemu with libguestfs, usually you would need to "
28500 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28501 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28502 "use either of the I<--qemudir> or I<--qemu> options."
28506 #: ../test-tool/libguestfs-test-tool.pod:79
28508 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28509 "I<1> if there was an error."
28513 #: ../test-tool/libguestfs-test-tool.pod:84
28515 "For the full list of environment variables which may affect libguestfs, "
28516 "please see the L<guestfs(3)> manual page."
28520 #: ../test-tool/libguestfs-test-tool.pod:89
28521 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28525 #: ../fuse/guestmount.pod:5
28527 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28531 #: ../fuse/guestmount.pod:9
28534 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28539 #: ../fuse/guestmount.pod:11
28542 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28547 #: ../fuse/guestmount.pod:13
28550 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28555 #: ../fuse/guestmount.pod:17
28557 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28558 "machines. If you do this, you risk disk corruption in the VM."
28562 #: ../fuse/guestmount.pod:22
28564 "The guestmount program can be used to mount virtual machine filesystems and "
28565 "other disk images on the host. It uses libguestfs for access to the guest "
28566 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28567 "a mountable device."
28571 #: ../fuse/guestmount.pod:27
28573 "Along with other options, you have to give at least one device (I<-a> "
28574 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28575 "option) or use the I<-i> inspection option. How this works is better "
28576 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28581 #: ../fuse/guestmount.pod:33
28583 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28584 "by you, and the filesystem will not be visible to any other users unless you "
28585 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28586 "the filesystem, use the C<fusermount -u> command."
28590 #: ../fuse/guestmount.pod:41
28592 "For a typical Windows guest which has its main filesystem on the first "
28597 #: ../fuse/guestmount.pod:44
28600 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28605 #: ../fuse/guestmount.pod:46
28607 "For a typical Linux guest which has a /boot filesystem on the first "
28608 "partition, and the root filesystem on a logical volume:"
28612 #: ../fuse/guestmount.pod:49
28615 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28620 #: ../fuse/guestmount.pod:51
28621 msgid "To get libguestfs to detect guest mountpoints for you:"
28625 #: ../fuse/guestmount.pod:53
28628 " guestmount -a guest.img -i --ro /mnt\n"
28633 #: ../fuse/guestmount.pod:55
28634 msgid "For a libvirt guest called \"Guest\" you could do:"
28638 #: ../fuse/guestmount.pod:57
28641 " guestmount -d Guest -i --ro /mnt\n"
28646 #: ../fuse/guestmount.pod:59
28648 "If you don't know what filesystems are contained in a guest or disk image, "
28649 "use L<virt-filesystems(1)> first:"
28653 #: ../fuse/guestmount.pod:62
28656 " virt-filesystems MyGuest\n"
28661 #: ../fuse/guestmount.pod:64
28663 "If you want to trace the libguestfs calls but without excessive debugging "
28664 "information, we recommend:"
28668 #: ../fuse/guestmount.pod:67
28671 " guestmount [...] --trace /mnt\n"
28676 #: ../fuse/guestmount.pod:69
28677 msgid "If you want to debug the program, we recommend:"
28681 #: ../fuse/guestmount.pod:71
28684 " guestmount [...] --trace --verbose /mnt\n"
28689 #: ../fuse/guestmount.pod:73
28694 #: ../fuse/guestmount.pod:75
28695 msgid "Other users cannot see the filesystem by default"
28699 #: ../fuse/guestmount.pod:77
28701 "If you mount a filesystem as one user (eg. root), then other users will not "
28702 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28703 "option when mounting:"
28707 #: ../fuse/guestmount.pod:81
28710 " sudo guestmount [...] -o allow_other /mnt\n"
28715 #: ../fuse/guestmount.pod:87
28716 msgid "B<-a image> | B<--add image>"
28720 #: ../fuse/guestmount.pod:89
28721 msgid "Add a block device or virtual machine image."
28725 #: ../fuse/guestmount.pod:94
28726 msgid "B<-c URI> | B<--connect URI>"
28730 #: ../fuse/guestmount.pod:100
28731 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28735 #: ../fuse/guestmount.pod:106
28736 msgid "B<--dir-cache-timeout N>"
28740 #: ../fuse/guestmount.pod:108
28742 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28743 "seconds. The readdir cache [actually, there are several semi-independent "
28744 "caches] is populated after a readdir(2) call with the stat and extended "
28745 "attributes of the files in the directory, in anticipation that they will be "
28746 "requested soon after."
28750 #: ../fuse/guestmount.pod:114
28752 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28753 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28754 "requests, only cache existing ones."
28758 #: ../fuse/guestmount.pod:125
28759 msgid "B<--format=raw|qcow2|..> | B<--format>"
28763 #: ../fuse/guestmount.pod:132
28765 "If you have untrusted raw-format guest disk images, you should use this "
28766 "option to specify the disk format. This avoids a possible security problem "
28767 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28768 "guestfs_add_drive_opts>."
28772 #: ../fuse/guestmount.pod:137
28773 msgid "B<--fuse-help>"
28777 #: ../fuse/guestmount.pod:139
28778 msgid "Display help on special FUSE options (see I<-o> below)."
28782 #: ../fuse/guestmount.pod:143
28783 msgid "Display brief help and exit."
28787 #: ../fuse/guestmount.pod:145
28788 msgid "B<-i> | B<--inspector>"
28792 #: ../fuse/guestmount.pod:165
28794 "Mount the named partition or logical volume on the given mountpoint B<in the "
28795 "guest> (this has nothing to do with mountpoints in the host)."
28799 #: ../fuse/guestmount.pod:168
28801 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28802 "something on C</>."
28806 #: ../fuse/guestmount.pod:181
28807 msgid "B<-n> | B<--no-sync>"
28811 #: ../fuse/guestmount.pod:183
28813 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28814 "unmounted. If you specify this option, then we don't attempt to sync the "
28815 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28819 #: ../fuse/guestmount.pod:188
28820 msgid "B<-o option> | B<--option option>"
28824 #: ../fuse/guestmount.pod:190
28825 msgid "Pass extra options to FUSE."
28829 #: ../fuse/guestmount.pod:192
28831 "To get a list of all the extra options supported by FUSE, use the command "
28832 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28833 "of them are a good idea."
28837 #: ../fuse/guestmount.pod:196
28840 " guestmount --fuse-help\n"
28845 #: ../fuse/guestmount.pod:198
28846 msgid "Some potentially useful FUSE options:"
28850 #: ../fuse/guestmount.pod:202
28851 msgid "B<-o allow_other>"
28855 #: ../fuse/guestmount.pod:204
28856 msgid "Allow other users to see the filesystem."
28860 #: ../fuse/guestmount.pod:206
28861 msgid "B<-o attr_timeout=N>"
28865 #: ../fuse/guestmount.pod:208
28866 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28870 #: ../fuse/guestmount.pod:210
28871 msgid "B<-o kernel_cache>"
28875 #: ../fuse/guestmount.pod:212
28877 "Allow the kernel to cache files (reduces the number of reads that have to go "
28878 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28879 "afford the extra memory usage."
28883 #: ../fuse/guestmount.pod:216
28884 msgid "B<-o uid=N> B<-o gid=N>"
28888 #: ../fuse/guestmount.pod:218
28890 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28891 "the chosen values."
28895 #: ../fuse/guestmount.pod:223
28896 msgid "B<-r> | B<--ro>"
28900 #: ../fuse/guestmount.pod:225
28902 "Add devices and mount everything read-only. Also disallow writes and make "
28903 "the disk appear read-only to FUSE."
28907 #: ../fuse/guestmount.pod:228
28909 "This is highly recommended if you are not going to edit the guest disk. If "
28910 "the guest is running and this option is I<not> supplied, then there is a "
28911 "strong risk of disk corruption in the guest. We try to prevent this from "
28912 "happening, but it is not always possible."
28916 #: ../fuse/guestmount.pod:233
28917 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28921 #: ../fuse/guestmount.pod:237
28922 msgid "Enable SELinux support for the guest."
28926 #: ../fuse/guestmount.pod:239
28927 msgid "B<-v> | B<--verbose>"
28931 #: ../fuse/guestmount.pod:241
28932 msgid "Enable verbose messages from underlying libguestfs."
28936 #: ../fuse/guestmount.pod:243
28937 msgid "B<-V> | B<--version>"
28941 #: ../fuse/guestmount.pod:245
28942 msgid "Display the program version and exit."
28946 #: ../fuse/guestmount.pod:247
28947 msgid "B<-w> | B<--rw>"
28951 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
28952 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28956 #: ../fuse/guestmount.pod:254
28957 msgid "B<-x> | B<--trace>"
28961 #: ../fuse/guestmount.pod:256
28962 msgid "Trace libguestfs calls and entry into each FUSE function."
28966 #: ../fuse/guestmount.pod:258
28967 msgid "This also stops the daemon from forking into the background."
28971 #: ../fuse/guestmount.pod:279
28973 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28974 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28979 #: ../fuse/guestmount.pod:294
28980 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28984 #: ../tools/virt-edit.pl:34
28985 msgid "virt-edit - Edit a file in a virtual machine"
28989 #: ../tools/virt-edit.pl:38
28992 " virt-edit [--options] domname file\n"
28997 #: ../tools/virt-edit.pl:40
29000 " virt-edit [--options] disk.img [disk.img ...] file\n"
29005 #: ../tools/virt-edit.pl:42
29008 " virt-edit [domname|disk.img] file -e 'expr'\n"
29013 #: ../tools/virt-edit.pl:46
29015 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
29016 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
29017 "doing this, but doesn't catch all cases."
29021 #: ../tools/virt-edit.pl:52
29023 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
29024 "the named virtual machine (or disk image)."
29028 #: ../tools/virt-edit.pl:55
29029 msgid "If you want to just view a file, use L<virt-cat(1)>."
29033 #: ../tools/virt-edit.pl:57
29035 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
29036 "USING GUESTFISH> below)."
29040 #: ../tools/virt-edit.pl:60
29042 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
29043 "files. L<guestfish(1)> can do that and much more."
29047 #: ../tools/virt-edit.pl:65
29048 msgid "Edit the named files interactively:"
29052 #: ../tools/virt-edit.pl:67
29055 " virt-edit mydomain /boot/grub/grub.conf\n"
29060 #: ../tools/virt-edit.pl:69
29063 " virt-edit mydomain /etc/passwd\n"
29068 #: ../tools/virt-edit.pl:71
29069 msgid "For Windows guests, some Windows paths are understood:"
29073 #: ../tools/virt-edit.pl:73
29076 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
29081 #: ../tools/virt-edit.pl:75
29083 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
29084 "below). To change the init default level to 5:"
29088 #: ../tools/virt-edit.pl:79
29091 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
29096 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
29097 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
29098 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29099 msgid "Display brief help."
29103 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
29104 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
29105 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29106 msgid "Display version number and exit."
29110 #: ../tools/virt-edit.pl:105
29111 msgid "B<--backup extension> | B<-b extension>"
29115 #: ../tools/virt-edit.pl:107
29117 "Create a backup of the original file I<in the guest disk image>. The backup "
29118 "has the original filename with C<extension> added."
29122 #: ../tools/virt-edit.pl:110
29124 "Usually the first character of C<extension> would be a dot C<.> so you would "
29129 #: ../tools/virt-edit.pl:113
29132 " virt-edit -b .orig [etc]\n"
29137 #: ../tools/virt-edit.pl:115
29138 msgid "By default, no backup file is made."
29142 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
29143 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
29144 #: ../tools/virt-list-partitions.pl:78
29145 msgid "B<--connect URI> | B<-c URI>"
29149 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
29150 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
29151 #: ../tools/virt-list-partitions.pl:80
29153 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29154 "to the default libvirt hypervisor."
29158 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
29159 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
29160 #: ../tools/virt-list-partitions.pl:83
29162 "If you specify guest block devices directly, then libvirt is not used at all."
29166 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
29167 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
29168 #: ../tools/virt-list-partitions.pl:90
29169 msgid "B<--format> raw"
29173 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
29174 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
29175 #: ../tools/virt-list-partitions.pl:92
29177 "Specify the format of disk images given on the command line. If this is "
29178 "omitted then the format is autodetected from the content of the disk image."
29182 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
29183 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
29184 #: ../tools/virt-list-partitions.pl:96
29186 "If disk images are requested from libvirt, then this program asks libvirt "
29187 "for this information. In this case, the value of the format parameter is "
29192 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
29193 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
29194 #: ../tools/virt-list-partitions.pl:100
29196 "If working with untrusted raw-format guest disk images, you should ensure "
29197 "the format is always specified."
29201 #: ../tools/virt-edit.pl:150
29202 msgid "B<--expr EXPR> | B<-e EXPR>"
29206 #: ../tools/virt-edit.pl:152
29208 "Instead of launching the external editor, non-interactively apply the Perl "
29209 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29214 #: ../tools/virt-edit.pl:156
29216 "Be careful to properly quote the expression to prevent it from being altered "
29221 #: ../tools/virt-edit.pl:280
29222 msgid "NON-INTERACTIVE EDITING"
29226 #: ../tools/virt-edit.pl:282
29228 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29229 "administrator can interactively edit the file."
29233 #: ../tools/virt-edit.pl:285
29235 "There are two ways also to use C<virt-edit> from scripts in order to make "
29236 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29237 "like this, it's less error-prone to write scripts directly using the "
29238 "libguestfs API and Augeas for configuration file editing.)"
29242 #: ../tools/virt-edit.pl:291
29244 "The first method is to temporarily set C<$EDITOR> to any script or program "
29245 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29246 "update C<tmpfile> in place however it likes."
29250 #: ../tools/virt-edit.pl:295
29252 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
29253 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29254 "instances of C<foo> with C<bar> in a file:"
29258 #: ../tools/virt-edit.pl:299
29261 " virt-edit domname filename -e 's/foo/bar/'\n"
29266 #: ../tools/virt-edit.pl:301
29268 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29269 "For example to delete root's password you could do:"
29273 #: ../tools/virt-edit.pl:304
29276 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29281 #: ../tools/virt-edit.pl:306
29283 "What really happens is that the snippet is evaluated as a Perl expression "
29284 "for each line of the file. The line, including the final C<\\n>, is passed "
29285 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29289 #: ../tools/virt-edit.pl:311
29291 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29292 "C<apache> user account from the password file you can do:"
29296 #: ../tools/virt-edit.pl:314
29299 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29304 #: ../tools/virt-edit.pl:316
29306 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29307 "the end of the file is rather difficult this way since there is no concept "
29308 "of \"last line of the file\" - your expression just doesn't get called "
29309 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29314 #: ../tools/virt-edit.pl:322
29316 "The variable C<$lineno> contains the current line number. As is "
29317 "traditional, the first line in the file is number C<1>."
29321 #: ../tools/virt-edit.pl:325
29323 "The return value from the expression is ignored, but the expression may call "
29324 "C<die> in order to abort the whole program, leaving the original file "
29329 #: ../tools/virt-edit.pl:329
29331 "Remember when matching the end of a line that C<$_> may contain the final C<"
29332 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29333 "newline then neither of these. Thus to match or substitute some text at the "
29334 "end of a line, use this regular expression:"
29338 #: ../tools/virt-edit.pl:334
29341 " /some text(\\r?\\n)?$/\n"
29346 #: ../tools/virt-edit.pl:336
29348 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29349 "$_> itself (since that would remove all newlines from the file):"
29353 #: ../tools/virt-edit.pl:340
29356 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29361 #: ../tools/virt-edit.pl:344
29363 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29364 "paths (eg. C<E:\\foo\\bar.txt>)."
29368 #: ../tools/virt-edit.pl:347
29369 msgid "If and only if the guest is running Windows then:"
29373 #: ../tools/virt-edit.pl:353
29375 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29376 "to the correct filesystem."
29380 #: ../tools/virt-edit.pl:358
29382 "Any backslash (C<\\>) characters in the path are replaced with forward "
29383 "slashes so that libguestfs can process it."
29387 #: ../tools/virt-edit.pl:363
29389 "The path is resolved case insensitively to locate the file that should be "
29394 #: ../tools/virt-edit.pl:368
29395 msgid "There are some known shortcomings:"
29399 #: ../tools/virt-edit.pl:374
29400 msgid "Some NTFS symbolic links may not be followed correctly."
29404 #: ../tools/virt-edit.pl:378
29405 msgid "NTFS junction points that cross filesystems are not followed."
29409 #: ../tools/virt-edit.pl:435
29410 msgid "USING GUESTFISH"
29414 #: ../tools/virt-edit.pl:437
29416 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29417 "C<virt-edit> doesn't work."
29421 #: ../tools/virt-edit.pl:440
29422 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29426 #: ../tools/virt-edit.pl:442
29429 " guestfish --rw -i -d domname edit /file\n"
29434 #: ../tools/virt-edit.pl:444
29436 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29437 "path to the file."
29441 #: ../tools/virt-edit.pl:447
29443 "The command above uses libguestfs's guest inspection feature and so does not "
29444 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29445 "disk images that don't contain guests. To edit a file on a disk image "
29450 #: ../tools/virt-edit.pl:452
29453 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29458 #: ../tools/virt-edit.pl:454
29460 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29461 "the disk image to edit, and C</file> is the full path to the file."
29465 #: ../tools/virt-edit.pl:458
29467 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29468 "C<write> or C<upload> instead:"
29472 #: ../tools/virt-edit.pl:461
29475 " guestfish --rw -i -d domname touch /newfile\n"
29480 #: ../tools/virt-edit.pl:463
29483 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29488 #: ../tools/virt-edit.pl:465
29491 " guestfish --rw -i -d domname upload localfile /newfile\n"
29496 #: ../tools/virt-edit.pl:467
29498 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29502 #: ../tools/virt-edit.pl:470
29505 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29510 #: ../tools/virt-edit.pl:480
29515 #: ../tools/virt-edit.pl:482
29517 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29522 #: ../tools/virt-edit.pl:485
29523 msgid "If not set, C<vi> is used."
29527 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29528 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29529 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29530 msgid "SHELL QUOTING"
29534 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29535 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29536 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29538 "Libvirt guest names can contain arbitrary characters, some of which have "
29539 "meaning to the shell such as C<#> and space. You may need to quote or "
29540 "escape these characters on the command line. See the shell manual page L<sh"
29541 "(1)> for details."
29545 #: ../tools/virt-edit.pl:498
29547 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29548 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29549 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29553 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29554 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29555 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29560 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29561 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29562 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29563 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29567 #: ../tools/virt-edit.pl:516
29568 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29572 #: ../tools/virt-win-reg.pl:37
29574 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29578 #: ../tools/virt-win-reg.pl:41
29581 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29586 #: ../tools/virt-win-reg.pl:43
29589 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29594 #: ../tools/virt-win-reg.pl:45
29597 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29602 #: ../tools/virt-win-reg.pl:47
29605 " virt-win-reg --merge domname [input.reg ...]\n"
29610 #: ../tools/virt-win-reg.pl:49
29613 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29618 #: ../tools/virt-win-reg.pl:53
29620 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29621 "virtual machines. If you do this, you I<will> get irreversible disk "
29622 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29623 "but doesn't catch all cases."
29627 #: ../tools/virt-win-reg.pl:58
29629 "Modifying the Windows Registry is an inherently risky operation. The format "
29630 "is deliberately obscure and undocumented, and Registry changes can leave the "
29631 "system unbootable. Therefore when using the I<--merge> option, make sure "
29632 "you have a reliable backup first."
29636 #: ../tools/virt-win-reg.pl:65
29638 "This program can export and merge Windows Registry entries from a Windows "
29643 #: ../tools/virt-win-reg.pl:68
29645 "The first parameter is the libvirt guest name or the raw disk image of a "
29650 #: ../tools/virt-win-reg.pl:71
29652 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29653 "exported (recursively). For example:"
29657 #: ../tools/virt-win-reg.pl:74
29660 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29665 #: ../tools/virt-win-reg.pl:76
29667 "You can also display single values from within registry keys, for example:"
29671 #: ../tools/virt-win-reg.pl:79
29674 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29675 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29676 " Windows 7 Enterprise\n"
29681 #: ../tools/virt-win-reg.pl:83
29683 "With I<--merge>, you can merge a textual regedit file into the Windows "
29688 #: ../tools/virt-win-reg.pl:86
29691 " $ virt-win-reg --merge Windows7 changes.reg\n"
29696 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29701 #: ../tools/virt-win-reg.pl:90
29703 "This program is only meant for simple access to the registry. If you want "
29704 "to do complicated things with the registry, we suggest you download the "
29705 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29706 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29707 "L<hivexregedit(1)>."
29711 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29716 #: ../tools/virt-win-reg.pl:122
29717 msgid "Enable debugging messages."
29721 #: ../tools/virt-win-reg.pl:157
29726 #: ../tools/virt-win-reg.pl:159
29728 "In merge mode, this merges a textual regedit file into the Windows Registry "
29729 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29730 "displays or exports Registry entries instead."
29734 #: ../tools/virt-win-reg.pl:163
29736 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29737 "result in disk corruption. However exporting (without this flag) is always "
29742 #: ../tools/virt-win-reg.pl:171
29743 msgid "B<--encoding> UTF-16LE|ASCII"
29747 #: ../tools/virt-win-reg.pl:173
29749 "When merging (only), you may need to specify the encoding for strings to be "
29750 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29751 "(3)/ENCODING STRINGS>."
29755 #: ../tools/virt-win-reg.pl:177
29757 "The default is to use UTF-16LE, which should work with recent versions of "
29762 #: ../tools/virt-win-reg.pl:402
29763 msgid "SUPPORTED SYSTEMS"
29767 #: ../tools/virt-win-reg.pl:404
29769 "The program currently supports Windows NT-derived guests starting with "
29770 "Windows XP through to at least Windows 7."
29774 #: ../tools/virt-win-reg.pl:407
29776 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29777 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29778 "and C<HKEY_USERS\\.DEFAULT>."
29782 #: ../tools/virt-win-reg.pl:411
29784 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29789 #: ../tools/virt-win-reg.pl:414
29791 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29796 #: ../tools/virt-win-reg.pl:417
29801 #: ../tools/virt-win-reg.pl:419
29803 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29804 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29805 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29806 "Windows-style line endings, you may need to reencode the whole file before "
29807 "or after processing."
29811 #: ../tools/virt-win-reg.pl:425
29813 "To reencode a file from Windows format to Linux (before processing it with "
29814 "the I<--merge> option), you would do something like this:"
29818 #: ../tools/virt-win-reg.pl:428
29821 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29826 #: ../tools/virt-win-reg.pl:430
29828 "To go in the opposite direction, after exporting and before sending the file "
29829 "to a Windows user, do something like this:"
29833 #: ../tools/virt-win-reg.pl:433
29836 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29841 #: ../tools/virt-win-reg.pl:435
29842 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29846 #: ../tools/virt-win-reg.pl:437
29848 "If you are unsure about the current encoding, use the L<file(1)> command. "
29849 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29850 "style (CRLF) line endings, like this:"
29854 #: ../tools/virt-win-reg.pl:441
29857 " $ file software.reg\n"
29858 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29859 " with CRLF line terminators\n"
29864 #: ../tools/virt-win-reg.pl:445
29865 msgid "This file would need conversion before you could I<--merge> it."
29869 #: ../tools/virt-win-reg.pl:447
29870 msgid "CurrentControlSet etc."
29874 #: ../tools/virt-win-reg.pl:449
29876 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29877 "Registry at the level of the hive file, and therefore you cannot modify "
29882 #: ../tools/virt-win-reg.pl:453
29884 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29885 "circumstances it might refer to another control set. The way to find out is "
29886 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29890 #: ../tools/virt-win-reg.pl:457
29893 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29894 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29895 " \"Current\"=dword:00000001\n"
29896 " \"Default\"=dword:00000001\n"
29897 " \"Failed\"=dword:00000000\n"
29898 " \"LastKnownGood\"=dword:00000002\n"
29903 #: ../tools/virt-win-reg.pl:464
29904 msgid "\"Current\" is the one which Windows will choose when it boots."
29908 #: ../tools/virt-win-reg.pl:466
29910 "Similarly, other C<Current...> keys in the path may need to be replaced."
29914 #: ../tools/virt-win-reg.pl:469
29915 msgid "WINDOWS TIPS"
29919 #: ../tools/virt-win-reg.pl:471
29921 "Note that some of these tips modify the guest disk image. The guest I<must> "
29922 "be shut off, else you will get disk corruption."
29926 #: ../tools/virt-win-reg.pl:474
29927 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29931 #: ../tools/virt-win-reg.pl:476
29933 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29934 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29935 "is uploaded into C<C:\\>:"
29939 #: ../tools/virt-win-reg.pl:480
29942 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29947 #: ../tools/virt-win-reg.pl:482
29948 msgid "Prepare a regedit file containing the registry change:"
29952 #: ../tools/virt-win-reg.pl:484
29955 " cat > test.reg <<'EOF'\n"
29956 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29957 " \"Test\"=\"c:\\\\test.bat\"\n"
29963 #: ../tools/virt-win-reg.pl:489
29965 "In this example we use the key C<RunOnce> which means that the script will "
29966 "run precisely once when the first user logs in. If you want it to run every "
29967 "time a user logs in, replace C<RunOnce> with C<Run>."
29971 #: ../tools/virt-win-reg.pl:493
29972 msgid "Now update the registry:"
29976 #: ../tools/virt-win-reg.pl:495
29979 " virt-win-reg --merge WindowsGuest test.reg\n"
29984 #: ../tools/virt-win-reg.pl:497
29985 msgid "INSTALLING A SERVICE"
29989 #: ../tools/virt-win-reg.pl:499
29991 "This section assumes you are familiar with Windows services, and you either "
29992 "have a program which handles the Windows Service Control Protocol directly "
29993 "or you want to run any program using a service wrapper like SrvAny or the "
29998 #: ../tools/virt-win-reg.pl:504
30000 "First upload the program and optionally the service wrapper. In this case "
30001 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30005 #: ../tools/virt-win-reg.pl:508
30008 " guestfish -i -d WindowsGuest <<EOF\n"
30009 " upload rhsrvany.exe /rhsrvany.exe\n"
30010 " upload test.exe /test.exe\n"
30016 #: ../tools/virt-win-reg.pl:513
30018 "Prepare a regedit file containing the registry changes. In this example, "
30019 "the first registry change is needed for the service itself or the service "
30020 "wrapper (if used). The second registry change is only needed because I am "
30021 "using the RHSrvAny service wrapper."
30025 #: ../tools/virt-win-reg.pl:518
30028 " cat > service.reg <<'EOF'\n"
30029 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30030 " \"Type\"=dword:00000010\n"
30031 " \"Start\"=dword:00000002\n"
30032 " \"ErrorControl\"=dword:00000001\n"
30033 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30034 " \"DisplayName\"=\"RHSrvAny\"\n"
30035 " \"ObjectName\"=\"NetworkService\"\n"
30040 #: ../tools/virt-win-reg.pl:527
30043 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30044 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30045 " \"PWD\"=\"c:\\\\Temp\"\n"
30051 #: ../tools/virt-win-reg.pl:538
30053 "For use of C<ControlSet001> see the section above in this manual page. You "
30054 "may need to adjust this according to the control set that is in use by the "
30059 #: ../tools/virt-win-reg.pl:544
30061 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30062 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30063 "privileged account."
30067 #: ../tools/virt-win-reg.pl:550
30069 "For the meaning of the magic numbers, see this Microsoft KB article: "
30070 "L<http://support.microsoft.com/kb/103000>."
30074 #: ../tools/virt-win-reg.pl:555
30075 msgid "Update the registry:"
30079 #: ../tools/virt-win-reg.pl:557
30082 " virt-win-reg --merge WindowsGuest service.reg\n"
30087 #: ../tools/virt-win-reg.pl:561
30089 "Be careful when passing parameters containing C<\\> (backslash) in the "
30090 "shell. Usually you will have to use 'single quotes' or double backslashes "
30091 "(but not both) to protect them from the shell."
30095 #: ../tools/virt-win-reg.pl:565
30096 msgid "Paths and value names are case-insensitive."
30100 #: ../tools/virt-win-reg.pl:574
30102 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30103 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30104 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30108 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
30110 "When reporting bugs, please enable debugging and capture the I<complete> "
30115 #: ../tools/virt-win-reg.pl:592
30118 " export LIBGUESTFS_DEBUG=1\n"
30119 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30124 #: ../tools/virt-win-reg.pl:595
30126 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30131 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
30132 msgid "Copyright (C) 2010 Red Hat Inc."
30136 #: ../tools/virt-list-filesystems.pl:32
30138 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30142 #: ../tools/virt-list-filesystems.pl:36
30145 " virt-list-filesystems [--options] domname\n"
30150 #: ../tools/virt-list-filesystems.pl:38
30153 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30158 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30160 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30165 #: ../tools/virt-list-filesystems.pl:45
30167 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30168 "are contained in a virtual machine or disk image."
30172 #: ../tools/virt-list-filesystems.pl:49
30174 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30175 "functionality. For more complex cases you should look at the L<guestfish(1)"
30180 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30181 msgid "B<-l> | B<--long>"
30185 #: ../tools/virt-list-filesystems.pl:108
30187 "With this option, C<virt-list-filesystems> displays the type of each "
30188 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30192 #: ../tools/virt-list-filesystems.pl:115
30193 msgid "B<-a> | B<--all>"
30197 #: ../tools/virt-list-filesystems.pl:117
30199 "Normally we only show mountable filesystems. If this option is given then "
30200 "swap devices are shown too."
30204 #: ../tools/virt-list-filesystems.pl:191
30206 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30207 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30208 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30212 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30213 msgid "Copyright (C) 2009 Red Hat Inc."
30217 #: ../tools/virt-tar.pl:33
30218 msgid "virt-tar - Extract or upload files to a virtual machine"
30222 #: ../tools/virt-tar.pl:37
30225 " virt-tar [--options] -x domname directory tarball\n"
30230 #: ../tools/virt-tar.pl:39
30233 " virt-tar [--options] -u domname tarball directory\n"
30238 #: ../tools/virt-tar.pl:41
30241 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30246 #: ../tools/virt-tar.pl:43
30249 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30254 #: ../tools/virt-tar.pl:47
30256 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30257 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30261 #: ../tools/virt-tar.pl:52
30262 msgid "Download C</home> from the VM into a local tarball:"
30266 #: ../tools/virt-tar.pl:54
30269 " virt-tar -x domname /home home.tar\n"
30274 #: ../tools/virt-tar.pl:56
30277 " virt-tar -zx domname /home home.tar.gz\n"
30282 #: ../tools/virt-tar.pl:58
30283 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30287 #: ../tools/virt-tar.pl:60
30290 " virt-tar -u domname uploadstuff.tar /tmp\n"
30295 #: ../tools/virt-tar.pl:62
30298 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30303 #: ../tools/virt-tar.pl:66
30305 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30306 "virtual machines. If you do this, you risk disk corruption in the VM. "
30307 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30311 #: ../tools/virt-tar.pl:71
30313 "You can use I<-x> (extract) on live virtual machines, but you might get "
30314 "inconsistent results or errors if there is filesystem activity inside the "
30315 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30316 "work, but the only way to guarantee consistent results is if the virtual "
30317 "machine is shut down."
30321 #: ../tools/virt-tar.pl:79
30323 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30324 "parts of a guest filesystem. There are many possibilities: making backups, "
30325 "uploading data files, snooping on guest activity, fixing or customizing "
30330 #: ../tools/virt-tar.pl:84
30332 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30333 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30334 "should look at the L<guestfish(1)> tool."
30338 #: ../tools/virt-tar.pl:88
30340 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30341 "its contents (recursively) from the virtual machine into a local tarball. "
30342 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30343 "virtual machine. You cannot use these two options together."
30347 #: ../tools/virt-tar.pl:94
30349 "In addition, you may need to use the I<-z> (gZip) option to enable "
30350 "compression. When uploading, you have to specify I<-z> if the upload file "
30351 "is compressed because virt-tar won't detect this on its own."
30355 #: ../tools/virt-tar.pl:98
30357 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30358 "example it cannot do PKZip files or bzip2 compression. If you want that "
30359 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30360 "the L<libguestfs(3)> API)."
30364 #: ../tools/virt-tar.pl:156
30365 msgid "B<-x> | B<--extract> | B<--download>"
30369 #: ../tools/virt-tar.pl:158
30370 msgid "B<-u> | B<--upload>"
30374 #: ../tools/virt-tar.pl:160
30376 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30381 #: ../tools/virt-tar.pl:163
30383 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30384 "Please read the L</WARNING> section above before using this option."
30388 #: ../tools/virt-tar.pl:167
30389 msgid "You must specify exactly one of these options."
30393 #: ../tools/virt-tar.pl:173
30394 msgid "B<-z> | B<--gzip>"
30398 #: ../tools/virt-tar.pl:175
30399 msgid "Specify that the input or output tarball is gzip-compressed."
30403 #: ../tools/virt-tar.pl:288
30405 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30406 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30407 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30412 #: ../tools/virt-make-fs.pl:37
30413 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30417 #: ../tools/virt-make-fs.pl:41
30420 " virt-make-fs [--options] input.tar output.img\n"
30425 #: ../tools/virt-make-fs.pl:43
30428 " virt-make-fs [--options] input.tar.gz output.img\n"
30433 #: ../tools/virt-make-fs.pl:45
30436 " virt-make-fs [--options] directory output.img\n"
30441 #: ../tools/virt-make-fs.pl:49
30443 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30444 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30445 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30446 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30447 "you want to attach these filesystems to existing virtual machines (eg. to "
30448 "import large amounts of read-only data to a VM)."
30452 #: ../tools/virt-make-fs.pl:57
30453 msgid "Basic usage is:"
30457 #: ../tools/virt-make-fs.pl:59
30460 " virt-make-fs input output\n"
30465 #: ../tools/virt-make-fs.pl:61
30467 "where C<input> is either a directory containing files that you want to add, "
30468 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30469 "C<output> is a disk image. The input type is detected automatically. The "
30470 "output disk image defaults to a raw ext2 image unless you specify extra "
30471 "flags (see L</OPTIONS> below)."
30475 #: ../tools/virt-make-fs.pl:67
30476 msgid "EXTRA SPACE"
30480 #: ../tools/virt-make-fs.pl:69
30482 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30483 "the files that it contains, but might have extra space. Depending on how "
30484 "you are going to use the output, you might think this extra space is wasted "
30485 "and want to minimize it, or you might want to leave space so that more files "
30486 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30487 "but you can use the I<--size> flag to leave space in the filesystem if you "
30492 #: ../tools/virt-make-fs.pl:77
30494 "An alternative way to leave extra space but not make the output image any "
30495 "bigger is to use an alternative disk image format (instead of the default "
30496 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30497 "image format (check your hypervisor supports this before using it). This "
30498 "allows you to choose a large I<--size> but the extra space won't actually be "
30499 "allocated in the image until you try to store something in it."
30503 #: ../tools/virt-make-fs.pl:85
30505 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30506 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30507 "to build another image from scratch."
30511 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30512 #: ../tools/virt-make-fs.pl:142
30517 #: ../tools/virt-make-fs.pl:91
30520 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30525 #: ../tools/virt-make-fs.pl:93
30526 msgid "FILESYSTEM TYPE"
30530 #: ../tools/virt-make-fs.pl:95
30532 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30533 "libguestfs supports can be used (but I<not> read-only formats like "
30534 "ISO9660). Here are some of the more common choices:"
30538 #: ../tools/virt-make-fs.pl:101
30543 #: ../tools/virt-make-fs.pl:103
30545 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30546 "you are not going to use the filesystem in a way that requires the journal, "
30547 "then this is just wasted overhead."
30551 #: ../tools/virt-make-fs.pl:107
30552 msgid "I<ntfs> or I<vfat>"
30556 #: ../tools/virt-make-fs.pl:109
30557 msgid "Useful if exporting data to a Windows guest."
30561 #: ../tools/virt-make-fs.pl:111
30563 "I<Note for vfat>: The tar archive or local directory must only contain files "
30564 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30565 "program running within libguestfs is unable to change the ownership of non-"
30566 "root files, since vfat itself does not support this."
30570 #: ../tools/virt-make-fs.pl:116
30575 #: ../tools/virt-make-fs.pl:118
30577 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30578 "total filesystem size."
30582 #: ../tools/virt-make-fs.pl:125
30585 " virt-make-fs --type=minix input minixfs.img\n"
30590 #: ../tools/virt-make-fs.pl:127
30591 msgid "TO PARTITION OR NOT TO PARTITION"
30595 #: ../tools/virt-make-fs.pl:129
30596 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30600 #: ../tools/virt-make-fs.pl:131
30602 "Adding a partition can make the disk image more compatible with certain "
30603 "virtualized operating systems which don't expect to see a filesystem "
30604 "directly located on a block device (Linux doesn't care and will happily "
30605 "handle both types)."
30609 #: ../tools/virt-make-fs.pl:136
30611 "On the other hand, if you have a partition table then the output image is no "
30612 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30613 "directly on a partitioned disk image. (However libguestfs tools such as "
30614 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30618 #: ../tools/virt-make-fs.pl:144
30619 msgid "Add an MBR partition:"
30623 #: ../tools/virt-make-fs.pl:146
30626 " virt-make-fs --partition -- input disk.img\n"
30631 #: ../tools/virt-make-fs.pl:148
30633 "If the output disk image could be terabyte-sized or larger, it's better to "
30634 "use an EFI/GPT-compatible partition table:"
30638 #: ../tools/virt-make-fs.pl:151
30641 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30646 #: ../tools/virt-make-fs.pl:179
30647 msgid "Enable debugging information."
30651 #: ../tools/virt-make-fs.pl:185
30652 msgid "B<--size=E<lt>NE<gt>>"
30656 #: ../tools/virt-make-fs.pl:187
30657 msgid "B<--size=+E<lt>NE<gt>>"
30661 #: ../tools/virt-make-fs.pl:189
30662 msgid "B<-s E<lt>NE<gt>>"
30666 #: ../tools/virt-make-fs.pl:191
30667 msgid "B<-s +E<lt>NE<gt>>"
30671 #: ../tools/virt-make-fs.pl:193
30673 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30677 #: ../tools/virt-make-fs.pl:196
30679 "If this option is I<not> given, then the output image will be just large "
30680 "enough to contain all the files, with not much wasted space."
30684 #: ../tools/virt-make-fs.pl:199
30686 "To choose a fixed size output disk, specify an absolute number followed by b/"
30687 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30688 "Petabytes or Exabytes. This must be large enough to contain all the input "
30689 "files, else you will get an error."
30693 #: ../tools/virt-make-fs.pl:204
30695 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30696 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30697 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30698 "the input files, and (approximately) an extra 200 MB free space."
30702 #: ../tools/virt-make-fs.pl:210
30704 "Note that virt-make-fs estimates free space, and therefore will not produce "
30705 "filesystems containing precisely the free space requested. (It is much more "
30706 "expensive and time-consuming to produce a filesystem which has precisely the "
30707 "desired free space)."
30711 #: ../tools/virt-make-fs.pl:219
30712 msgid "B<--format=E<lt>fmtE<gt>>"
30716 #: ../tools/virt-make-fs.pl:221
30717 msgid "B<-F E<lt>fmtE<gt>>"
30721 #: ../tools/virt-make-fs.pl:223
30722 msgid "Choose the output disk image format."
30726 #: ../tools/virt-make-fs.pl:225
30727 msgid "The default is C<raw> (raw disk image)."
30731 #: ../tools/virt-make-fs.pl:227
30733 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30734 "that would really make sense here is C<qcow2>."
30738 #: ../tools/virt-make-fs.pl:234
30739 msgid "B<--type=E<lt>fsE<gt>>"
30743 #: ../tools/virt-make-fs.pl:236
30744 msgid "B<-t E<lt>fsE<gt>>"
30748 #: ../tools/virt-make-fs.pl:238
30749 msgid "Choose the output filesystem type."
30753 #: ../tools/virt-make-fs.pl:240
30754 msgid "The default is C<ext2>."
30758 #: ../tools/virt-make-fs.pl:242
30760 "Any filesystem which is supported read-write by libguestfs can be used here."
30764 #: ../tools/virt-make-fs.pl:249
30765 msgid "B<--partition>"
30769 #: ../tools/virt-make-fs.pl:251
30770 msgid "B<--partition=E<lt>parttypeE<gt>>"
30774 #: ../tools/virt-make-fs.pl:253
30776 "If specified, this flag adds an MBR partition table to the output disk image."
30780 #: ../tools/virt-make-fs.pl:256
30782 "You can change the partition table type, eg. I<--partition=gpt> for large "
30787 #: ../tools/virt-make-fs.pl:259
30789 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30790 "might consider the next parameter to be the partition type. For example:"
30794 #: ../tools/virt-make-fs.pl:263
30797 " virt-make-fs --partition input.tar ...\n"
30802 #: ../tools/virt-make-fs.pl:265
30804 "would cause virt-make-fs to think you wanted to use a partition type of "
30805 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30806 "dash) between options and the input file argument:"
30810 #: ../tools/virt-make-fs.pl:269
30813 " virt-make-fs --partition -- input.tar ...\n"
30818 #: ../tools/virt-make-fs.pl:541
30820 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30821 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30822 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30826 #: ../tools/virt-make-fs.pl:558
30829 " export LIBGUESTFS_DEBUG=1\n"
30830 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30835 #: ../tools/virt-make-fs.pl:561
30837 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30842 #: ../tools/virt-list-partitions.pl:32
30844 "virt-list-partitions - List partitions in a virtual machine or disk image"
30848 #: ../tools/virt-list-partitions.pl:36
30851 " virt-list-partitions [--options] domname\n"
30856 #: ../tools/virt-list-partitions.pl:38
30859 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30864 #: ../tools/virt-list-partitions.pl:45
30866 "C<virt-list-partitions> is a command line tool to list the partitions that "
30867 "are contained in a virtual machine or disk image. It is mainly useful as a "
30868 "first step to using L<virt-resize(1)>."
30872 #: ../tools/virt-list-partitions.pl:50
30874 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30875 "functionality. For more complex cases you should look at the L<guestfish(1)"
30880 #: ../tools/virt-list-partitions.pl:107
30881 msgid "B<-h> | B<--human-readable>"
30885 #: ../tools/virt-list-partitions.pl:109
30886 msgid "Show sizes in human-readable form (eg. \"1G\")."
30890 #: ../tools/virt-list-partitions.pl:117
30892 "With this option, C<virt-list-partitions> displays the type and size of each "
30893 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30897 #: ../tools/virt-list-partitions.pl:124
30898 msgid "B<-t> | B<--total>"
30902 #: ../tools/virt-list-partitions.pl:126
30904 "Display the total size of each block device (as a separate row or rows)."
30908 #: ../tools/virt-list-partitions.pl:259
30910 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30911 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30912 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30916 #: ../tools/virt-list-partitions.pl:275
30917 msgid "Copyright (C) 2009-2010 Red Hat Inc."