1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-05-08 12:57+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:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
864 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
865 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
866 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
867 #: ../src/guestfs.pod:2963 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971
868 #: ../src/guestfs.pod:2975 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
870 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
871 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1606
872 #: ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1614
873 #: ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1626
874 #: ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1634
875 #: ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1648
876 #: ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1790
877 #: ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1799
878 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1865
879 #: ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1874
880 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
881 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
884 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
885 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081
886 #: ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089
887 #: ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1101
888 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1115
889 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
890 #: ../fish/guestfish-actions.pod:1213 ../fish/guestfish-actions.pod:1217
891 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1227
892 #: ../fish/guestfish-actions.pod:1269 ../fish/guestfish-actions.pod:1273
893 #: ../fish/guestfish-actions.pod:1278 ../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:2426
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:2451
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:767
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:1010
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:1861 ../fish/guestfish-actions.pod:9
3310 #: ../fish/guestfish-actions.pod:1265 ../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 "
3363 "page. Because of the ABI guarantee, the old functions continue to work."
3367 #: ../src/guestfs.pod:1678
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:1686
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:1691
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:1695
3396 msgid "CLASSES OF EVENTS"
3400 #: ../src/guestfs.pod:1699
3401 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3405 #: ../src/guestfs.pod:1702
3407 "The callback function will be called while the handle is being closed "
3408 "(synchronously from L</guestfs_close>)."
3412 #: ../src/guestfs.pod:1705
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:1712
3425 "If no callback is registered: the handle is closed without any callback "
3430 #: ../src/guestfs.pod:1715
3431 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3435 #: ../src/guestfs.pod:1718
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:1722 ../src/guestfs.pod:1731
3444 msgid "If no callback is registered: the event is ignored."
3448 #: ../src/guestfs.pod:1724
3449 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3453 #: ../src/guestfs.pod:1727
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:1733
3462 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3466 #: ../src/guestfs.pod:1736
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:1742
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:1745
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:1750
3492 msgid "The only defined and stable parts of the API are:"
3496 #: ../src/guestfs.pod:1756
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:1761
3504 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3508 #: ../src/guestfs.pod:1765
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:1769
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:1775
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:1780
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:1784
3543 "As noted above, if the call fails with an error then the final message may "
3548 #: ../src/guestfs.pod:1789
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:1795
3558 msgid "If no callback is registered: progress messages are discarded."
3562 #: ../src/guestfs.pod:1797
3563 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3567 #: ../src/guestfs.pod:1800
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:1803
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:1806 ../src/guestfs.pod:1820
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:1811
3590 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3594 #: ../src/guestfs.pod:1814
3596 "The callback function is called whenever a log message is generated by the "
3597 "library part of libguestfs."
3601 #: ../src/guestfs.pod:1817
3603 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3604 "messages are generated."
3608 #: ../src/guestfs.pod:1825
3609 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3613 #: ../src/guestfs.pod:1828
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:1831
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:1837
3628 msgid "guestfs_set_event_callback"
3632 #: ../src/guestfs.pod:1839
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:1845
3646 "This function registers a callback (C<cb>) for all event classes in the "
3651 #: ../src/guestfs.pod:1848
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:1854
3661 msgid "C<flags> should always be passed as 0."
3665 #: ../src/guestfs.pod:1856
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:1859
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:1862
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:1865
3688 "Callbacks remain in effect until they are deleted, or until the handle is "
3693 #: ../src/guestfs.pod:1868
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:1872
3702 msgid "guestfs_delete_event_callback"
3706 #: ../src/guestfs.pod:1874
3709 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3714 #: ../src/guestfs.pod:1876
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:1880
3723 msgid "guestfs_event_callback"
3727 #: ../src/guestfs.pod:1882
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:1891
3744 "This is the type of the event callback function that you have to provide."
3748 #: ../src/guestfs.pod:1894
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:1898
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:1903
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:1907
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:1910
3781 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3785 #: ../src/guestfs.pod:1912
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:1916
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:1921
3803 "Programs have to set up a callback to capture the classes of events of "
3808 #: ../src/guestfs.pod:1924
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:1934
3826 "The callback can then direct messages to the appropriate place. In this "
3827 "example, messages are directed to syslog:"
3831 #: ../src/guestfs.pod:1937
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:1952
3853 msgid "PRIVATE DATA AREA"
3857 #: ../src/guestfs.pod:1954
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:1959
3866 msgid "To attach a named piece of data, use the following call:"
3870 #: ../src/guestfs.pod:1961
3873 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3878 #: ../src/guestfs.pod:1963
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:1967
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:1973
3897 msgid "To retrieve the pointer, use:"
3901 #: ../src/guestfs.pod:1975
3904 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3909 #: ../src/guestfs.pod:1977
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:1981
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:1988
3929 msgid "To walk over all entries, use these two functions:"
3933 #: ../src/guestfs.pod:1990
3936 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3941 #: ../src/guestfs.pod:1992
3944 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3949 #: ../src/guestfs.pod:1994
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:2000
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:2004
3968 msgid "Notes about walking over entries:"
3972 #: ../src/guestfs.pod:2010
3974 "You must not call C<guestfs_set_private> while walking over the entries."
3978 #: ../src/guestfs.pod:2015
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:2021
3987 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3991 #: ../src/guestfs.pod:2023
3994 " guestfs_set_private (g, key, NULL);\n"
3999 #: ../src/guestfs.pod:2025
4000 msgid "then that C<key> is not returned when walking."
4004 #: ../src/guestfs.pod:2029
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:2035
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:2038
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:2046
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:2049
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:2058
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:2062
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:2078
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:2083 ../src/guestfs.pod:2088
4098 #: ../src/guestfs.pod:2085
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:2090
4108 msgid "ARCHITECTURE"
4109 msgstr "АРХІТЕКТУРА"
4112 #: ../src/guestfs.pod:2092
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:2096
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:2116
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:2119
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:2128
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:2135
4177 msgid "STATE MACHINE"
4178 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4181 #: ../src/guestfs.pod:2137
4182 msgid "libguestfs uses a state machine to model the child process:"
4186 #: ../src/guestfs.pod:2139
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:2161
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:2166
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:2170
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:2173
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:2179
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:2185
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:2189
4270 #: ../src/guestfs.pod:2191
4271 msgid "COMMUNICATION PROTOCOL"
4275 #: ../src/guestfs.pod:2193
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:2196
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:2200
4292 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4293 "this file is automatically generated)."
4297 #: ../src/guestfs.pod:2203
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:2210
4308 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4312 #: ../src/guestfs.pod:2212
4313 msgid "For ordinary functions, the request message is:"
4317 #: ../src/guestfs.pod:2214
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:2219
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:2225
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:2228
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:2232
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:2240
4364 msgid "The reply message for ordinary functions is:"
4368 #: ../src/guestfs.pod:2242
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:2247
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:2250
4388 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4392 #: ../src/guestfs.pod:2253
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:2256
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:2261
4412 "The C<guestfs_message_error> structure contains the error message as a "
4417 #: ../src/guestfs.pod:2264
4418 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4422 #: ../src/guestfs.pod:2266
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:2270
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:2278
4445 msgid "The \"sequence of chunks\" is:"
4449 #: ../src/guestfs.pod:2280
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:2288
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:2292
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:2297
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:2303
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:2312
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:2318
4512 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4516 #: ../src/guestfs.pod:2320
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:2323
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:2331
4538 msgid "INITIAL MESSAGE"
4542 #: ../src/guestfs.pod:2333
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:2337
4551 msgid "PROGRESS NOTIFICATION MESSAGES"
4555 #: ../src/guestfs.pod:2339
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:2343
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:2347
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:2351
4580 msgid "LIBGUESTFS VERSION NUMBERS"
4584 #: ../src/guestfs.pod:2353
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:2358
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:2369
4610 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4614 #: ../src/guestfs.pod:2371
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:2377
4625 msgid "Our criteria for backporting changes are:"
4629 #: ../src/guestfs.pod:2383
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:2389
4638 "Bug fixes which are not controversial, fix obvious problems, and have been "
4639 "well tested are backported."
4643 #: ../src/guestfs.pod:2394
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:2400
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:2406
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:2414
4671 msgid "EXTENDING LIBGUESTFS"
4675 #: ../src/guestfs.pod:2416
4676 msgid "ADDING A NEW API ACTION"
4680 #: ../src/guestfs.pod:2418
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:2422
4689 msgid "To add a new API action there are two changes:"
4693 #: ../src/guestfs.pod:2428
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:2431
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:2439
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:2445
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:2453
4732 msgid "Implement the action (in C):"
4736 #: ../src/guestfs.pod:2455
4738 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4739 "C<daemon/> directory."
4743 #: ../src/guestfs.pod:2458
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:2461
4751 msgid "In either case, use another function as an example of what to do."
4755 #: ../src/guestfs.pod:2465
4756 msgid "After making these changes, use C<make> to compile."
4760 #: ../src/guestfs.pod:2467
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:2471
4769 msgid "ADDING TESTS FOR AN API ACTION"
4773 #: ../src/guestfs.pod:2473
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:2479
4785 "The following describes the test environment used when you add an API test "
4786 "in C<generator_actions.ml>."
4790 #: ../src/guestfs.pod:2482
4791 msgid "The test environment has 4 block devices:"
4795 #: ../src/guestfs.pod:2486
4796 msgid "C</dev/sda> 500MB"
4800 #: ../src/guestfs.pod:2488
4801 msgid "General block device for testing."
4805 #: ../src/guestfs.pod:2490
4806 msgid "C</dev/sdb> 50MB"
4810 #: ../src/guestfs.pod:2492
4812 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4817 #: ../src/guestfs.pod:2495
4818 msgid "C</dev/sdc> 10MB"
4822 #: ../src/guestfs.pod:2497
4823 msgid "Used in a few tests where two block devices are needed."
4827 #: ../src/guestfs.pod:2499
4829 msgstr "C</dev/sdd>"
4832 #: ../src/guestfs.pod:2501
4833 msgid "ISO with fixed content (see C<images/test.iso>)."
4837 #: ../src/guestfs.pod:2505
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:2509
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:2515
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:2521
4867 "In addition, packagers can skip individual tests by setting environment "
4868 "variables before running C<make check>."
4872 #: ../src/guestfs.pod:2524
4875 " SKIP_TEST_<CMD>_<NUM>=1\n"
4880 #: ../src/guestfs.pod:2526
4881 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4885 #: ../src/guestfs.pod:2528
4890 #: ../src/guestfs.pod:2530
4893 " SKIP_TEST_<CMD>=1\n"
4898 #: ../src/guestfs.pod:2532
4899 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4903 #: ../src/guestfs.pod:2534
4904 msgid "Packagers can run only certain tests by setting for example:"
4908 #: ../src/guestfs.pod:2536
4911 " TEST_ONLY=\"vfs_type zerofree\"\n"
4916 #: ../src/guestfs.pod:2538
4918 "See C<capitests/tests.c> for more details of how these environment variables "
4923 #: ../src/guestfs.pod:2541
4924 msgid "DEBUGGING NEW API ACTIONS"
4928 #: ../src/guestfs.pod:2543
4929 msgid "Test new actions work before submitting them."
4933 #: ../src/guestfs.pod:2545
4934 msgid "You can use guestfish to try out new commands."
4938 #: ../src/guestfs.pod:2547
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:2551
4947 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4951 #: ../src/guestfs.pod:2553
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:2559
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:2562
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:2572
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:2584
5003 msgid "Enable warnings when compiling (and fix any problems this finds):"
5007 #: ../src/guestfs.pod:2587
5010 " ./configure --enable-gcc-warnings\n"
5015 #: ../src/guestfs.pod:2589
5016 msgid "Useful targets are:"
5020 #: ../src/guestfs.pod:2591
5023 " make syntax-check # checks the syntax of the C code\n"
5024 " make check # runs the test suite\n"
5029 #: ../src/guestfs.pod:2594
5030 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5034 #: ../src/guestfs.pod:2596
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:2601
5046 #: ../src/guestfs.pod:2603
5048 "Simple shell quoted string. Any spaces or other shell characters are "
5053 #: ../src/guestfs.pod:2606
5058 #: ../src/guestfs.pod:2608
5060 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5065 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5066 msgid "For example:"
5070 #: ../src/guestfs.pod:2615
5073 " asprintf (&cmd, \"cat %R\", path);\n"
5078 #: ../src/guestfs.pod:2617
5079 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5083 #: ../src/guestfs.pod:2619
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:2625
5093 msgid "SUBMITTING YOUR NEW API ACTIONS"
5097 #: ../src/guestfs.pod:2627
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:2631
5105 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5109 #: ../src/guestfs.pod:2633
5110 msgid "We support i18n (gettext anyhow) in the library."
5114 #: ../src/guestfs.pod:2635
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:2641
5125 "Debugging messages are never translated, since they are intended for the "
5130 #: ../src/guestfs.pod:2644
5131 msgid "SOURCE CODE SUBDIRECTORIES"
5135 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5820
5136 #: ../fish/guestfish-actions.pod:3913
5137 msgid "C<appliance>"
5138 msgstr "C<appliance>"
5141 #: ../src/guestfs.pod:2650
5142 msgid "The libguestfs appliance, build scripts and so on."
5146 #: ../src/guestfs.pod:2652
5147 msgid "C<capitests>"
5148 msgstr "C<capitests>"
5151 #: ../src/guestfs.pod:2654
5152 msgid "Automated tests of the C API."
5156 #: ../src/guestfs.pod:2656
5161 #: ../src/guestfs.pod:2658
5163 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5168 #: ../src/guestfs.pod:2661
5173 #: ../src/guestfs.pod:2663
5174 msgid "Outside contributions, experimental parts."
5178 #: ../src/guestfs.pod:2665
5183 #: ../src/guestfs.pod:2667
5185 "The daemon that runs inside the libguestfs appliance and carries out actions."
5189 #: ../src/guestfs.pod:2670
5194 #: ../src/guestfs.pod:2672
5195 msgid "L<virt-df(1)> command and documentation."
5199 #: ../src/guestfs.pod:2674
5201 msgstr "C<examples>"
5204 #: ../src/guestfs.pod:2676
5205 msgid "C API example code."
5206 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5209 #: ../src/guestfs.pod:2678
5214 #: ../src/guestfs.pod:2680
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:2684
5227 #: ../src/guestfs.pod:2686
5229 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5233 #: ../src/guestfs.pod:2688
5234 msgid "C<generator>"
5235 msgstr "C<generator>"
5238 #: ../src/guestfs.pod:2690
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:2693
5250 #: ../src/guestfs.pod:2695
5251 msgid "Files used by the test suite."
5255 #: ../src/guestfs.pod:2697
5256 msgid "Some \"phony\" guest images which we test against."
5260 #: ../src/guestfs.pod:2699
5261 msgid "C<inspector>"
5262 msgstr "C<inspector>"
5265 #: ../src/guestfs.pod:2701
5266 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5270 #: ../src/guestfs.pod:2703
5275 #: ../src/guestfs.pod:2705
5276 msgid "Logo used on the website. The fish is called Arthur by the way."
5280 #: ../src/guestfs.pod:2707
5285 #: ../src/guestfs.pod:2709
5286 msgid "M4 macros used by autoconf."
5290 #: ../src/guestfs.pod:2711
5295 #: ../src/guestfs.pod:2713
5296 msgid "Translations of simple gettext strings."
5297 msgstr "Переклади простих рядків gettext."
5300 #: ../src/guestfs.pod:2715
5305 #: ../src/guestfs.pod:2717
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:2721
5314 msgid "C<regressions>"
5315 msgstr "C<regressions>"
5318 #: ../src/guestfs.pod:2723
5319 msgid "Regression tests."
5320 msgstr "Тести на регресії."
5323 #: ../src/guestfs.pod:2725
5328 #: ../src/guestfs.pod:2727
5329 msgid "L<virt-rescue(1)> command and documentation."
5333 #: ../src/guestfs.pod:2729
5338 #: ../src/guestfs.pod:2731
5339 msgid "Source code to the C library."
5343 #: ../src/guestfs.pod:2733
5348 #: ../src/guestfs.pod:2735
5349 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5353 #: ../src/guestfs.pod:2737
5354 msgid "C<test-tool>"
5355 msgstr "C<test-tool>"
5358 #: ../src/guestfs.pod:2739
5360 "Test tool for end users to test if their qemu/kernel combination will work "
5365 #: ../src/guestfs.pod:2742
5370 #: ../src/guestfs.pod:2744
5375 #: ../src/guestfs.pod:2746
5380 #: ../src/guestfs.pod:2748
5385 #: ../src/guestfs.pod:2750
5390 #: ../src/guestfs.pod:2752
5395 #: ../src/guestfs.pod:2754
5400 #: ../src/guestfs.pod:2756
5405 #: ../src/guestfs.pod:2758
5406 msgid "Language bindings."
5407 msgstr "Прив’язки до мов програмування."
5410 #: ../src/guestfs.pod:2762
5415 #: ../src/guestfs.pod:2764
5416 msgid "PROTOCOL LIMITS"
5420 #: ../src/guestfs.pod:2766
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:2774
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:2780
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:2784
5450 "You might also consider mounting the disk image using our FUSE filesystem "
5451 "support (L<guestmount(1)>)."
5455 #: ../src/guestfs.pod:2787
5456 msgid "MAXIMUM NUMBER OF DISKS"
5460 #: ../src/guestfs.pod:2789
5461 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5465 #: ../src/guestfs.pod:2792
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:2797
5476 "We are working to substantially raise this limit in future versions but it "
5477 "requires complex changes to qemu."
5481 #: ../src/guestfs.pod:2800
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:2804
5490 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5494 #: ../src/guestfs.pod:2806
5495 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5499 #: ../src/guestfs.pod:2808
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:2811
5508 "If you attach a disk with more than 15 partitions, the extra partitions are "
5509 "ignored by libguestfs."
5513 #: ../src/guestfs.pod:2814
5514 msgid "MAXIMUM SIZE OF A DISK"
5518 #: ../src/guestfs.pod:2816
5519 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5523 #: ../src/guestfs.pod:2818
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:2822
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:2828
5543 "For the hugest disk image files, we recommend using XFS on the host for "
5548 #: ../src/guestfs.pod:2831
5549 msgid "MAXIMUM SIZE OF A PARTITION"
5553 #: ../src/guestfs.pod:2833
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:2837
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:2842
5570 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5574 #: ../src/guestfs.pod:2844
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:2848
5583 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5587 #: ../src/guestfs.pod:2850
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:2854
5597 #| msgid "INSPECTION"
5598 msgid "INSPECTION LIMITS"
5602 #: ../src/guestfs.pod:2856
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:2862 ../fish/guestfish.pod:1017
5613 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5614 msgid "ENVIRONMENT VARIABLES"
5615 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5618 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1043
5619 msgid "LIBGUESTFS_APPEND"
5623 #: ../src/guestfs.pod:2868 ../fish/guestfish.pod:1045
5624 msgid "Pass additional options to the guest kernel."
5628 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1047
5629 msgid "LIBGUESTFS_DEBUG"
5633 #: ../src/guestfs.pod:2872
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:2875 ../fish/guestfish.pod:1052
5641 msgid "LIBGUESTFS_MEMSIZE"
5645 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1054
5647 "Set the memory allocated to the qemu process, in megabytes. For example:"
5651 #: ../src/guestfs.pod:2880 ../fish/guestfish.pod:1057
5654 " LIBGUESTFS_MEMSIZE=700\n"
5659 #: ../src/guestfs.pod:2882 ../fish/guestfish.pod:1059
5660 msgid "LIBGUESTFS_PATH"
5664 #: ../src/guestfs.pod:2884
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:2887 ../fish/guestfish.pod:1064
5672 msgid "LIBGUESTFS_QEMU"
5676 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1066
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:2893
5684 msgid "See also L</QEMU WRAPPERS> above."
5688 #: ../src/guestfs.pod:2895 ../fish/guestfish.pod:1070
5689 msgid "LIBGUESTFS_TRACE"
5693 #: ../src/guestfs.pod:2897
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:2900 ../fish/guestfish.pod:1079
5705 #: ../src/guestfs.pod:2902 ../fish/guestfish.pod:1081
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:2905 ../fish/guestfish.pod:1084
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:2913 ../fish/guestfish.pod:1151
5722 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:269
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:2915
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:2942
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:2949 ../tools/virt-win-reg.pl:587
5750 #: ../tools/virt-make-fs.pl:553
5755 #: ../src/guestfs.pod:2951
5756 msgid "To get a list of bugs against libguestfs use this link:"
5758 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5762 #: ../src/guestfs.pod:2953
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:2955
5772 msgid "To report a new bug against libguestfs use this link:"
5773 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5776 #: ../src/guestfs.pod:2957
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:2959
5786 msgid "When reporting a bug, please check:"
5790 #: ../src/guestfs.pod:2965
5791 msgid "That the bug hasn't been reported already."
5795 #: ../src/guestfs.pod:2969
5796 msgid "That you are testing a recent version."
5800 #: ../src/guestfs.pod:2973
5801 msgid "Describe the bug accurately, and give a way to reproduce it."
5805 #: ../src/guestfs.pod:2977
5807 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5812 #: ../src/guestfs.pod:2982 ../fish/guestfish.pod:1174
5813 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:280
5818 #: ../src/guestfs.pod:2984 ../fish/guestfish.pod:1176
5819 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:282
5820 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5824 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1178
5825 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:284
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:2988 ../fish/guestfish.pod:1180
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:2991
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:2996
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:3001
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:140
5908 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5909 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5910 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5911 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5912 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5913 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5914 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5915 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
5916 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
5917 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
5918 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
5919 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
5920 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
5921 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
5922 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
5923 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
5924 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
5925 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1723
5926 #: ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:2272
5927 #: ../src/guestfs-actions.pod:2416 ../src/guestfs-actions.pod:2477
5928 #: ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:3465
5929 #: ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3505
5930 #: ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3674
5931 #: ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3701
5932 #: ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3752
5933 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3844
5934 #: ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3884
5935 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:3939
5936 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977
5937 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4024
5938 #: ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4076
5939 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104
5940 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4214
5941 #: ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4247
5942 #: ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4316
5943 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4350
5944 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4378
5945 #: ../src/guestfs-actions.pod:4395 ../src/guestfs-actions.pod:4410
5946 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4488
5947 #: ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4592
5948 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4630
5949 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4659
5950 #: ../src/guestfs-actions.pod:4672 ../src/guestfs-actions.pod:4687
5951 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4737
5952 #: ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4772
5953 #: ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4803
5954 #: ../src/guestfs-actions.pod:4852 ../src/guestfs-actions.pod:4889
5955 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4931
5956 #: ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4966
5957 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5157
5958 #: ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:5197
5959 #: ../src/guestfs-actions.pod:5229 ../src/guestfs-actions.pod:5295
5960 #: ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5325
5961 #: ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5628
5962 #: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5666
5963 #: ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5690
5964 #: ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5716
5965 #: ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:5746
5966 #: ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:5786
5967 #: ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5835
5968 #: ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:5874
5969 #: ../src/guestfs-actions.pod:5892 ../src/guestfs-actions.pod:5911
5970 #: ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5951
5971 #: ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:5996
5972 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6039
5973 #: ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6082
5974 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6116
5975 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6176
5976 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6310
5977 #: ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6443
5978 #: ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6469
5979 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504
5980 #: ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6530
5981 #: ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6604
5982 #: ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:6637
5983 #: ../src/guestfs-actions.pod:6653 ../src/guestfs-actions.pod:6670
5984 #: ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6703
5985 #: ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6753
5986 #: ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6807
5987 #: ../src/guestfs-actions.pod:6825 ../src/guestfs-actions.pod:6859
5988 #: ../src/guestfs-actions.pod:6895 ../src/guestfs-actions.pod:7014
5989 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7046
5990 #: ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7114
5991 #: ../src/guestfs-actions.pod:7159 ../src/guestfs-actions.pod:7192
5992 #: ../src/guestfs-actions.pod:7246 ../src/guestfs-actions.pod:7272
5993 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7357
5994 #: ../src/guestfs-actions.pod:7386
5995 msgid "This function returns 0 on success or -1 on error."
5999 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6000 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6001 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
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:257
6009 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6010 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
6011 #: ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:7280
6012 #: ../src/guestfs-actions.pod:7449 ../fish/guestfish-actions.pod:31
6013 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6014 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1324
6015 #: ../fish/guestfish-actions.pod:1338 ../fish/guestfish-actions.pod:3013
6016 #: ../fish/guestfish-actions.pod:4871 ../fish/guestfish-actions.pod:4968
6018 "Deprecated functions will not be removed from the API, but the fact that "
6019 "they are deprecated indicates that there are problems with correct use of "
6024 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6025 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1922
6026 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:2123
6027 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3487
6028 #: ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:5853
6029 #: ../src/guestfs-actions.pod:5970 ../src/guestfs-actions.pod:6084
6030 #: ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6672
6031 #: ../src/guestfs-actions.pod:7194
6032 msgid "(Added in 0.3)"
6036 #: ../src/guestfs-actions.pod:41
6037 msgid "guestfs_add_domain"
6041 #: ../src/guestfs-actions.pod:43
6045 " guestfs_add_domain (guestfs_h *g,\n"
6046 " const char *dom,\n"
6052 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6053 #: ../src/guestfs-actions.pod:4449
6055 "You may supply a list of optional arguments to this call. Use zero or more "
6056 "of the following pairs of parameters, and terminate the list with C<-1> on "
6057 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6061 #: ../src/guestfs-actions.pod:53
6064 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6065 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6066 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6067 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6068 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6073 #: ../src/guestfs-actions.pod:59
6075 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6076 "It works by connecting to libvirt, requesting the domain and domain XML from "
6077 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6082 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6084 "The number of disks added is returned. This operation is atomic: if an "
6085 "error is returned, then no disks are added."
6089 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6091 "This function does some minimal checks to make sure the libvirt domain is "
6092 "not running (unless C<readonly> is true). In a future version we will try "
6093 "to acquire the libvirt lock on each disk."
6097 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6099 "Disks must be accessible locally. This often means that adding disks from a "
6100 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6101 "unless those disks are accessible via the same device path locally too."
6105 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6107 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6108 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6109 "libvirt URI (or one set through an environment variable, see the libvirt "
6110 "documentation for full details)."
6114 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6116 "The optional C<live> flag controls whether this call will try to connect to "
6117 "a running virtual machine C<guestfsd> process if it sees a suitable "
6118 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6119 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6120 "DAEMONS> for more information."
6124 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6126 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6127 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6128 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6133 #: ../src/guestfs-actions.pod:94
6135 "The other optional parameters are passed directly through to "
6136 "C<guestfs_add_drive_opts>."
6140 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6141 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6142 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6143 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6144 #: ../src/guestfs-actions.pod:1680 ../src/guestfs-actions.pod:1883
6145 #: ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2032
6146 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
6147 #: ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:2786
6148 #: ../src/guestfs-actions.pod:2807 ../src/guestfs-actions.pod:4875
6149 #: ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5409
6150 #: ../src/guestfs-actions.pod:5435 ../src/guestfs-actions.pod:6780
6151 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218
6152 #: ../src/guestfs-actions.pod:7231
6153 msgid "On error this function returns -1."
6157 #: ../src/guestfs-actions.pod:99
6158 msgid "(Added in 1.7.4)"
6162 #: ../src/guestfs-actions.pod:101
6163 msgid "guestfs_add_domain_va"
6167 #: ../src/guestfs-actions.pod:103
6171 " guestfs_add_domain_va (guestfs_h *g,\n"
6172 " const char *dom,\n"
6178 #: ../src/guestfs-actions.pod:108
6179 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6183 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6184 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6185 #: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4514
6186 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6190 #: ../src/guestfs-actions.pod:112
6191 msgid "guestfs_add_domain_argv"
6195 #: ../src/guestfs-actions.pod:114
6199 " guestfs_add_domain_argv (guestfs_h *g,\n"
6200 " const char *dom,\n"
6201 " const struct guestfs_add_domain_argv *optargs);\n"
6206 #: ../src/guestfs-actions.pod:119
6207 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6211 #: ../src/guestfs-actions.pod:123
6212 msgid "guestfs_add_drive"
6216 #: ../src/guestfs-actions.pod:125
6220 " guestfs_add_drive (guestfs_h *g,\n"
6221 " const char *filename);\n"
6226 #: ../src/guestfs-actions.pod:129
6228 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6229 "optional parameters, so the disk is added writable, with the format being "
6230 "detected automatically."
6234 #: ../src/guestfs-actions.pod:133
6236 "Automatic detection of the format opens you up to a potential security hole "
6237 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6238 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6239 "you should think about replacing calls to this function with calls to "
6240 "C<guestfs_add_drive_opts>, and specifying the format."
6244 #: ../src/guestfs-actions.pod:144
6245 msgid "guestfs_add_drive_opts"
6249 #: ../src/guestfs-actions.pod:146
6253 " guestfs_add_drive_opts (guestfs_h *g,\n"
6254 " const char *filename,\n"
6260 #: ../src/guestfs-actions.pod:156
6263 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6264 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6265 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6270 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6272 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6273 "The first time you call this function, the disk appears as C</dev/sda>, the "
6274 "second time as C</dev/sdb>, and so on."
6278 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6280 "You don't necessarily need to be root when using libguestfs. However you "
6281 "obviously do need sufficient permissions to access the filename for whatever "
6282 "operations you want to perform (ie. read access if you just want to read the "
6283 "image or write access if you want to modify the image)."
6287 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6288 msgid "This call checks that C<filename> exists."
6292 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4460
6293 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3024
6294 msgid "The optional arguments are:"
6298 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6300 msgstr "C<readonly>"
6303 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6305 "If true then the image is treated as read-only. Writes are still allowed, "
6306 "but they are stored in a temporary snapshot overlay which is discarded at "
6307 "the end. The disk that you add is not modified."
6311 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6316 #: ../src/guestfs-actions.pod:185
6318 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6319 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6320 "Possible formats include C<raw> and C<qcow2>."
6324 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6326 "Automatic detection of the format opens you up to a potential security hole "
6327 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6328 "RHBZ#642934. Specifying the format closes this security hole."
6332 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6337 #: ../src/guestfs-actions.pod:196
6339 "This rarely-used option lets you emulate the behaviour of the deprecated "
6340 "C<guestfs_add_drive_with_if> call (q.v.)"
6344 #: ../src/guestfs-actions.pod:203
6345 msgid "(Added in 1.5.23)"
6349 #: ../src/guestfs-actions.pod:205
6350 msgid "guestfs_add_drive_opts_va"
6354 #: ../src/guestfs-actions.pod:207
6358 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6359 " const char *filename,\n"
6365 #: ../src/guestfs-actions.pod:212
6366 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6370 #: ../src/guestfs-actions.pod:216
6371 msgid "guestfs_add_drive_opts_argv"
6375 #: ../src/guestfs-actions.pod:218
6379 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6380 " const char *filename,\n"
6381 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6386 #: ../src/guestfs-actions.pod:223
6387 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6391 #: ../src/guestfs-actions.pod:227
6392 msgid "guestfs_add_drive_ro"
6396 #: ../src/guestfs-actions.pod:229
6400 " guestfs_add_drive_ro (guestfs_h *g,\n"
6401 " const char *filename);\n"
6406 #: ../src/guestfs-actions.pod:233
6408 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6409 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6410 "disk is added read-only, with the format being detected automatically."
6414 #: ../src/guestfs-actions.pod:240
6415 msgid "(Added in 1.0.38)"
6419 #: ../src/guestfs-actions.pod:242
6420 msgid "guestfs_add_drive_ro_with_if"
6424 #: ../src/guestfs-actions.pod:244
6428 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6429 " const char *filename,\n"
6430 " const char *iface);\n"
6435 #: ../src/guestfs-actions.pod:249
6437 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6438 "QEMU interface emulation to use at run time."
6442 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6443 #: ../src/guestfs-actions.pod:2362
6444 msgid "(Added in 1.0.84)"
6448 #: ../src/guestfs-actions.pod:263
6449 msgid "guestfs_add_drive_with_if"
6453 #: ../src/guestfs-actions.pod:265
6457 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6458 " const char *filename,\n"
6459 " const char *iface);\n"
6464 #: ../src/guestfs-actions.pod:270
6466 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6467 "QEMU interface emulation to use at run time."
6471 #: ../src/guestfs-actions.pod:284
6472 msgid "guestfs_aug_clear"
6476 #: ../src/guestfs-actions.pod:286
6480 " guestfs_aug_clear (guestfs_h *g,\n"
6481 " const char *augpath);\n"
6486 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6488 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6489 "L<augtool(1)> C<clear> command."
6493 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2112
6494 msgid "(Added in 1.3.4)"
6498 #: ../src/guestfs-actions.pod:297
6499 msgid "guestfs_aug_close"
6503 #: ../src/guestfs-actions.pod:299
6507 " guestfs_aug_close (guestfs_h *g);\n"
6512 #: ../src/guestfs-actions.pod:302
6514 "Close the current Augeas handle and free up any resources used by it. After "
6515 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6516 "any other Augeas functions."
6520 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6521 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6522 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6523 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6524 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6525 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6526 #: ../src/guestfs-actions.pod:5486
6527 msgid "(Added in 0.7)"
6531 #: ../src/guestfs-actions.pod:311
6532 msgid "guestfs_aug_defnode"
6536 #: ../src/guestfs-actions.pod:313
6539 " struct guestfs_int_bool *\n"
6540 " guestfs_aug_defnode (guestfs_h *g,\n"
6541 " const char *name,\n"
6542 " const char *expr,\n"
6543 " const char *val);\n"
6548 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6550 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6554 #: ../src/guestfs-actions.pod:322
6556 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6557 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6558 "containing that single node."
6562 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6564 "On success this returns a pair containing the number of nodes in the "
6565 "nodeset, and a boolean flag if a node was created."
6569 #: ../src/guestfs-actions.pod:330
6571 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6572 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6576 #: ../src/guestfs-actions.pod:336
6577 msgid "guestfs_aug_defvar"
6581 #: ../src/guestfs-actions.pod:338
6585 " guestfs_aug_defvar (guestfs_h *g,\n"
6586 " const char *name,\n"
6587 " const char *expr);\n"
6592 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6594 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6595 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6599 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6601 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6602 "evaluates to something which is not a nodeset."
6606 #: ../src/guestfs-actions.pod:354
6607 msgid "guestfs_aug_get"
6611 #: ../src/guestfs-actions.pod:356
6615 " guestfs_aug_get (guestfs_h *g,\n"
6616 " const char *augpath);\n"
6621 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6623 "Look up the value associated with C<path>. If C<path> matches exactly one "
6624 "node, the C<value> is returned."
6628 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
6629 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
6630 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
6631 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
6632 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
6633 #: ../src/guestfs-actions.pod:1551 ../src/guestfs-actions.pod:1663
6634 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843
6635 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:1944
6636 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2135
6637 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2534
6638 #: ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2738
6639 #: ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2878
6640 #: ../src/guestfs-actions.pod:2909 ../src/guestfs-actions.pod:2933
6641 #: ../src/guestfs-actions.pod:2970 ../src/guestfs-actions.pod:3030
6642 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
6643 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3996
6644 #: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4276
6645 #: ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5214
6646 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5562
6647 #: ../src/guestfs-actions.pod:5611 ../src/guestfs-actions.pod:6223
6648 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6256
6649 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6954
6650 #: ../src/guestfs-actions.pod:6973 ../src/guestfs-actions.pod:6991
6651 #: ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7443
6653 "This function returns a string, or NULL on error. I<The caller must free "
6654 "the returned string after use>."
6658 #: ../src/guestfs-actions.pod:368
6659 msgid "guestfs_aug_init"
6663 #: ../src/guestfs-actions.pod:370
6667 " guestfs_aug_init (guestfs_h *g,\n"
6668 " const char *root,\n"
6674 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6676 "Create a new Augeas handle for editing configuration files. If there was "
6677 "any previous Augeas handle associated with this guestfs session, then it is "
6682 #: ../src/guestfs-actions.pod:379
6683 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6687 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6689 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6693 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6695 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6696 "logical I<or> of the following integers:"
6700 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6701 msgid "C<AUG_SAVE_BACKUP> = 1"
6702 msgstr "C<AUG_SAVE_BACKUP> = 1"
6705 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6706 msgid "Keep the original file with a C<.augsave> extension."
6710 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6711 msgid "C<AUG_SAVE_NEWFILE> = 2"
6712 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6715 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6717 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6718 "original. Overrides C<AUG_SAVE_BACKUP>."
6722 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6723 msgid "C<AUG_TYPE_CHECK> = 4"
6724 msgstr "C<AUG_TYPE_CHECK> = 4"
6727 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6728 msgid "Typecheck lenses (can be expensive)."
6732 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6733 msgid "C<AUG_NO_STDINC> = 8"
6734 msgstr "C<AUG_NO_STDINC> = 8"
6737 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6738 msgid "Do not use standard load path for modules."
6742 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6743 msgid "C<AUG_SAVE_NOOP> = 16"
6744 msgstr "C<AUG_SAVE_NOOP> = 16"
6747 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6748 msgid "Make save a no-op, just record what would have been changed."
6752 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6753 msgid "C<AUG_NO_LOAD> = 32"
6754 msgstr "C<AUG_NO_LOAD> = 32"
6757 #: ../src/guestfs-actions.pod:414
6758 msgid "Do not load the tree in C<guestfs_aug_init>."
6762 #: ../src/guestfs-actions.pod:418
6763 msgid "To close the handle, you can call C<guestfs_aug_close>."
6767 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6768 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6772 #: ../src/guestfs-actions.pod:426
6773 msgid "guestfs_aug_insert"
6777 #: ../src/guestfs-actions.pod:428
6781 " guestfs_aug_insert (guestfs_h *g,\n"
6782 " const char *augpath,\n"
6783 " const char *label,\n"
6789 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6791 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6792 "or after C<path> (depending on the boolean flag C<before>)."
6796 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6798 "C<path> must match exactly one existing node in the tree, and C<label> must "
6799 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6803 #: ../src/guestfs-actions.pod:446
6804 msgid "guestfs_aug_load"
6808 #: ../src/guestfs-actions.pod:448
6812 " guestfs_aug_load (guestfs_h *g);\n"
6817 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6818 msgid "Load files into the tree."
6819 msgstr "Завантажити файли до ієрархії."
6822 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6823 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6827 #: ../src/guestfs-actions.pod:460
6828 msgid "guestfs_aug_ls"
6832 #: ../src/guestfs-actions.pod:462
6836 " guestfs_aug_ls (guestfs_h *g,\n"
6837 " const char *augpath);\n"
6842 #: ../src/guestfs-actions.pod:466
6844 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6845 "sorting the resulting nodes into alphabetical order."
6849 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6850 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
6851 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
6852 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
6853 #: ../src/guestfs-actions.pod:1765 ../src/guestfs-actions.pod:2207
6854 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
6855 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309
6856 #: ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:2429
6857 #: ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2987
6858 #: ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3566
6859 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3733
6860 #: ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4836
6861 #: ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5482
6862 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:6296
6863 #: ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6412
6864 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6582
6865 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7084
6866 #: ../src/guestfs-actions.pod:7131 ../src/guestfs-actions.pod:7296
6867 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-actions.pod:7400
6868 #: ../src/guestfs-actions.pod:7419 ../src/guestfs-actions.pod:7465
6869 #: ../src/guestfs-actions.pod:7484
6871 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6872 ">), or NULL if there was an error. I<The caller must free the strings and "
6873 "the array after use>."
6877 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
6878 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
6879 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3385
6880 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4029
6881 #: ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4249
6882 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4840
6883 #: ../src/guestfs-actions.pod:5297 ../src/guestfs-actions.pod:5692
6884 #: ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5718
6885 #: ../src/guestfs-actions.pod:6158 ../src/guestfs-actions.pod:6796
6886 #: ../src/guestfs-actions.pod:6809 ../src/guestfs-actions.pod:7048
6887 #: ../src/guestfs-actions.pod:7284
6888 msgid "(Added in 0.8)"
6892 #: ../src/guestfs-actions.pod:475
6893 msgid "guestfs_aug_match"
6897 #: ../src/guestfs-actions.pod:477
6901 " guestfs_aug_match (guestfs_h *g,\n"
6902 " const char *augpath);\n"
6907 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6909 "Returns a list of paths which match the path expression C<path>. The "
6910 "returned paths are sufficiently qualified so that they match exactly one "
6911 "node in the current tree."
6915 #: ../src/guestfs-actions.pod:491
6916 msgid "guestfs_aug_mv"
6920 #: ../src/guestfs-actions.pod:493
6924 " guestfs_aug_mv (guestfs_h *g,\n"
6925 " const char *src,\n"
6926 " const char *dest);\n"
6931 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6933 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6934 "C<dest> is overwritten if it exists."
6938 #: ../src/guestfs-actions.pod:505
6939 msgid "guestfs_aug_rm"
6943 #: ../src/guestfs-actions.pod:507
6947 " guestfs_aug_rm (guestfs_h *g,\n"
6948 " const char *augpath);\n"
6953 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6954 msgid "Remove C<path> and all of its children."
6958 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6959 msgid "On success this returns the number of entries which were removed."
6963 #: ../src/guestfs-actions.pod:519
6964 msgid "guestfs_aug_save"
6968 #: ../src/guestfs-actions.pod:521
6972 " guestfs_aug_save (guestfs_h *g);\n"
6977 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6978 msgid "This writes all pending changes to disk."
6982 #: ../src/guestfs-actions.pod:526
6984 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6989 #: ../src/guestfs-actions.pod:533
6990 msgid "guestfs_aug_set"
6994 #: ../src/guestfs-actions.pod:535
6998 " guestfs_aug_set (guestfs_h *g,\n"
6999 " const char *augpath,\n"
7000 " const char *val);\n"
7005 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7006 msgid "Set the value associated with C<path> to C<val>."
7010 #: ../src/guestfs-actions.pod:542
7012 "In the Augeas API, it is possible to clear a node by setting the value to "
7013 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7014 "this call. Instead you must use the C<guestfs_aug_clear> call."
7018 #: ../src/guestfs-actions.pod:551
7019 msgid "guestfs_available"
7023 #: ../src/guestfs-actions.pod:553
7027 " guestfs_available (guestfs_h *g,\n"
7028 " char *const *groups);\n"
7033 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7035 "This command is used to check the availability of some groups of "
7036 "functionality in the appliance, which not all builds of the libguestfs "
7037 "appliance will be able to provide."
7041 #: ../src/guestfs-actions.pod:561
7043 "The libguestfs groups, and the functions that those groups correspond to, "
7044 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7045 "runtime by calling C<guestfs_available_all_groups>."
7049 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7051 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7052 "\"]> would check for the availability of the Linux inotify functions and "
7053 "Augeas (configuration file editing) functions."
7057 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7058 msgid "The command returns no error if I<all> requested groups are available."
7062 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7064 "It fails with an error if one or more of the requested groups is unavailable "
7069 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7071 "If an unknown group name is included in the list of groups then an error is "
7076 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7078 msgstr "I<Нотатки:>"
7081 #: ../src/guestfs-actions.pod:585
7082 msgid "You must call C<guestfs_launch> before calling this function."
7086 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7088 "The reason is because we don't know what groups are supported by the "
7089 "appliance/daemon until it is running and can be queried."
7093 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7095 "If a group of functions is available, this does not necessarily mean that "
7096 "they will work. You still have to check for errors when calling individual "
7097 "API functions even if they are available."
7101 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7103 "It is usually the job of distro packagers to build complete functionality "
7104 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7105 "with all requirements satisfied, will support everything."
7109 #: ../src/guestfs-actions.pod:607
7111 "This call was added in version C<1.0.80>. In previous versions of "
7112 "libguestfs all you could do would be to speculatively execute a command to "
7113 "find out if the daemon implemented it. See also C<guestfs_version>."
7117 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7118 msgid "(Added in 1.0.80)"
7122 #: ../src/guestfs-actions.pod:618
7123 msgid "guestfs_available_all_groups"
7127 #: ../src/guestfs-actions.pod:620
7131 " guestfs_available_all_groups (guestfs_h *g);\n"
7136 #: ../src/guestfs-actions.pod:623
7138 "This command returns a list of all optional groups that this daemon knows "
7139 "about. Note this returns both supported and unsupported groups. To find "
7140 "out which ones the daemon can actually support you have to call "
7141 "C<guestfs_available> on each member of the returned list."
7145 #: ../src/guestfs-actions.pod:629
7146 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7150 #: ../src/guestfs-actions.pod:635
7151 msgid "(Added in 1.3.15)"
7155 #: ../src/guestfs-actions.pod:637
7156 msgid "guestfs_base64_in"
7160 #: ../src/guestfs-actions.pod:639
7164 " guestfs_base64_in (guestfs_h *g,\n"
7165 " const char *base64file,\n"
7166 " const char *filename);\n"
7171 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7173 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7177 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7178 msgid "(Added in 1.3.5)"
7182 #: ../src/guestfs-actions.pod:651
7183 msgid "guestfs_base64_out"
7187 #: ../src/guestfs-actions.pod:653
7191 " guestfs_base64_out (guestfs_h *g,\n"
7192 " const char *filename,\n"
7193 " const char *base64file);\n"
7198 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7200 "This command downloads the contents of C<filename>, writing it out to local "
7201 "file C<base64file> encoded as base64."
7205 #: ../src/guestfs-actions.pod:665
7206 msgid "guestfs_blockdev_flushbufs"
7210 #: ../src/guestfs-actions.pod:667
7214 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7215 " const char *device);\n"
7220 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7222 "This tells the kernel to flush internal buffers associated with C<device>."
7226 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7227 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7228 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7229 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7230 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7231 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7232 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7233 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7234 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7235 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7236 msgid "This uses the L<blockdev(8)> command."
7240 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7241 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7242 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7243 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7244 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7245 msgid "(Added in 0.9.3)"
7249 #: ../src/guestfs-actions.pod:680
7250 msgid "guestfs_blockdev_getbsz"
7254 #: ../src/guestfs-actions.pod:682
7258 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7259 " const char *device);\n"
7264 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7265 msgid "This returns the block size of a device."
7269 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7270 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7272 "(Note this is different from both I<size in blocks> and I<filesystem block "
7277 #: ../src/guestfs-actions.pod:697
7278 msgid "guestfs_blockdev_getro"
7282 #: ../src/guestfs-actions.pod:699
7286 " guestfs_blockdev_getro (guestfs_h *g,\n"
7287 " const char *device);\n"
7292 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7294 "Returns a boolean indicating if the block device is read-only (true if read-"
7295 "only, false if not)."
7299 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7300 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1920
7301 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2003
7302 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2073
7303 #: ../src/guestfs-actions.pod:2098 ../src/guestfs-actions.pod:2121
7304 #: ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111
7305 #: ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3293
7306 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3322
7307 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3352
7308 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3383
7309 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3410
7310 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3439
7311 #: ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:4985
7312 msgid "This function returns a C truth value on success or -1 on error."
7316 #: ../src/guestfs-actions.pod:712
7317 msgid "guestfs_blockdev_getsize64"
7321 #: ../src/guestfs-actions.pod:714
7325 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7326 " const char *device);\n"
7331 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7332 msgid "This returns the size of the device in bytes."
7336 #: ../src/guestfs-actions.pod:720
7337 msgid "See also C<guestfs_blockdev_getsz>."
7341 #: ../src/guestfs-actions.pod:728
7342 msgid "guestfs_blockdev_getss"
7346 #: ../src/guestfs-actions.pod:730
7350 " guestfs_blockdev_getss (guestfs_h *g,\n"
7351 " const char *device);\n"
7356 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7358 "This returns the size of sectors on a block device. Usually 512, but can be "
7359 "larger for modern devices."
7363 #: ../src/guestfs-actions.pod:737
7365 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7370 #: ../src/guestfs-actions.pod:746
7371 msgid "guestfs_blockdev_getsz"
7375 #: ../src/guestfs-actions.pod:748
7379 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7380 " const char *device);\n"
7385 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7387 "This returns the size of the device in units of 512-byte sectors (even if "
7388 "the sectorsize isn't 512 bytes ... weird)."
7392 #: ../src/guestfs-actions.pod:755
7394 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7395 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7399 #: ../src/guestfs-actions.pod:765
7400 msgid "guestfs_blockdev_rereadpt"
7404 #: ../src/guestfs-actions.pod:767
7408 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7409 " const char *device);\n"
7414 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7415 msgid "Reread the partition table on C<device>."
7419 #: ../src/guestfs-actions.pod:779
7420 msgid "guestfs_blockdev_setbsz"
7424 #: ../src/guestfs-actions.pod:781
7428 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7429 " const char *device,\n"
7430 " int blocksize);\n"
7435 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7436 msgid "This sets the block size of a device."
7440 #: ../src/guestfs-actions.pod:797
7441 msgid "guestfs_blockdev_setro"
7445 #: ../src/guestfs-actions.pod:799
7449 " guestfs_blockdev_setro (guestfs_h *g,\n"
7450 " const char *device);\n"
7455 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7456 msgid "Sets the block device named C<device> to read-only."
7460 #: ../src/guestfs-actions.pod:811
7461 msgid "guestfs_blockdev_setrw"
7465 #: ../src/guestfs-actions.pod:813
7469 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7470 " const char *device);\n"
7475 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7476 msgid "Sets the block device named C<device> to read-write."
7480 #: ../src/guestfs-actions.pod:825
7481 msgid "guestfs_case_sensitive_path"
7485 #: ../src/guestfs-actions.pod:827
7489 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7490 " const char *path);\n"
7495 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7497 "This can be used to resolve case insensitive paths on a filesystem which is "
7498 "case sensitive. The use case is to resolve paths which you have read from "
7499 "Windows configuration files or the Windows Registry, to the true path."
7503 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7505 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7506 "(and probably others), which is that although the underlying filesystem is "
7507 "case-insensitive, the driver exports the filesystem to Linux as case-"
7512 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7514 "One consequence of this is that special directories such as C<c:\\windows> "
7515 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7516 "precise details of how they were created. In Windows itself this would not "
7521 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7523 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7528 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7530 "This function resolves the true case of each element in the path and returns "
7531 "the case-sensitive path."
7535 #: ../src/guestfs-actions.pod:853
7537 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7538 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7539 "how the directories were originally created under Windows)."
7543 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7544 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7548 #: ../src/guestfs-actions.pod:861
7549 msgid "See also C<guestfs_realpath>."
7553 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:6976
7554 msgid "(Added in 1.0.75)"
7558 #: ../src/guestfs-actions.pod:868
7563 #: ../src/guestfs-actions.pod:870
7567 " guestfs_cat (guestfs_h *g,\n"
7568 " const char *path);\n"
7573 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5472
7574 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3672
7575 msgid "Return the contents of the file named C<path>."
7579 #: ../src/guestfs-actions.pod:876
7581 "Note that this function cannot correctly handle binary files (specifically, "
7582 "files containing C<\\0> character which is treated as end of string). For "
7583 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7584 "functions which have a more complex interface."
7588 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
7589 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
7590 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
7591 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1769
7592 #: ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246
7593 #: ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313
7594 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2359
7595 #: ../src/guestfs-actions.pod:5254 ../src/guestfs-actions.pod:5280
7596 #: ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5437
7597 #: ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:6361
7598 #: ../src/guestfs-actions.pod:6416 ../src/guestfs-actions.pod:6562
7599 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:7248
7600 #: ../src/guestfs-actions.pod:7274 ../src/guestfs-actions.pod:7300
7601 #: ../src/guestfs-actions.pod:7319 ../src/guestfs-actions.pod:7404
7602 #: ../src/guestfs-actions.pod:7423 ../src/guestfs-actions.pod:7469
7603 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:592
7604 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7605 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7606 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7607 #: ../fish/guestfish-actions.pod:1197 ../fish/guestfish-actions.pod:1498
7608 #: ../fish/guestfish-actions.pod:1508 ../fish/guestfish-actions.pod:1536
7609 #: ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1561
7610 #: ../fish/guestfish-actions.pod:1580 ../fish/guestfish-actions.pod:3542
7611 #: ../fish/guestfish-actions.pod:3557 ../fish/guestfish-actions.pod:3633
7612 #: ../fish/guestfish-actions.pod:3650 ../fish/guestfish-actions.pod:3665
7613 #: ../fish/guestfish-actions.pod:4291 ../fish/guestfish-actions.pod:4337
7614 #: ../fish/guestfish-actions.pod:4422 ../fish/guestfish-actions.pod:4437
7615 #: ../fish/guestfish-actions.pod:4847 ../fish/guestfish-actions.pod:4865
7616 #: ../fish/guestfish-actions.pod:4882 ../fish/guestfish-actions.pod:4892
7617 #: ../fish/guestfish-actions.pod:4940 ../fish/guestfish-actions.pod:4950
7618 #: ../fish/guestfish-actions.pod:4979 ../fish/guestfish-actions.pod:4989
7620 "Because of the message protocol, there is a transfer limit of somewhere "
7621 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7625 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3570
7626 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3649
7627 #: ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:4142
7628 #: ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:5360
7629 #: ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:7135
7630 #: ../src/guestfs-actions.pod:7149
7631 msgid "(Added in 0.4)"
7635 #: ../src/guestfs-actions.pod:889
7636 msgid "guestfs_checksum"
7640 #: ../src/guestfs-actions.pod:891
7644 " guestfs_checksum (guestfs_h *g,\n"
7645 " const char *csumtype,\n"
7646 " const char *path);\n"
7651 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7653 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7657 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7659 "The type of checksum to compute is given by the C<csumtype> parameter which "
7660 "must have one of the following values:"
7664 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7669 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7671 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7676 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7681 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7682 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7686 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7691 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7692 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7696 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7701 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7702 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7706 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7711 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7712 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7716 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7721 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7722 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7726 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7731 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7732 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7736 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7737 msgid "The checksum is returned as a printable string."
7741 #: ../src/guestfs-actions.pod:937
7742 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7746 #: ../src/guestfs-actions.pod:939
7747 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7751 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
7752 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3309
7753 #: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3399
7754 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:6832
7755 msgid "(Added in 1.0.2)"
7759 #: ../src/guestfs-actions.pod:946
7760 msgid "guestfs_checksum_device"
7764 #: ../src/guestfs-actions.pod:948
7768 " guestfs_checksum_device (guestfs_h *g,\n"
7769 " const char *csumtype,\n"
7770 " const char *device);\n"
7775 #: ../src/guestfs-actions.pod:953
7777 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7778 "device named C<device>. For the types of checksums supported see the "
7779 "C<guestfs_checksum> command."
7783 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:4891
7784 #: ../src/guestfs-actions.pod:4950 ../src/guestfs-actions.pod:4987
7785 #: ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5181
7786 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:6755
7787 #: ../src/guestfs-actions.pod:7161
7788 msgid "(Added in 1.3.2)"
7792 #: ../src/guestfs-actions.pod:962
7793 msgid "guestfs_checksums_out"
7797 #: ../src/guestfs-actions.pod:964
7801 " guestfs_checksums_out (guestfs_h *g,\n"
7802 " const char *csumtype,\n"
7803 " const char *directory,\n"
7804 " const char *sumsfile);\n"
7809 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7811 "This command computes the checksums of all regular files in C<directory> and "
7812 "then emits a list of those checksums to the local output file C<sumsfile>."
7816 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7818 "This can be used for verifying the integrity of a virtual machine. However "
7819 "to be properly secure you should pay attention to the output of the checksum "
7820 "command (it uses the ones from GNU coreutils). In particular when the "
7821 "filename is not printable, coreutils uses a special backslash syntax. For "
7822 "more information, see the GNU coreutils info file."
7826 #: ../src/guestfs-actions.pod:984
7827 msgid "(Added in 1.3.7)"
7831 #: ../src/guestfs-actions.pod:986
7832 msgid "guestfs_chmod"
7836 #: ../src/guestfs-actions.pod:988
7840 " guestfs_chmod (guestfs_h *g,\n"
7842 " const char *path);\n"
7847 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7849 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7854 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7856 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7857 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7862 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4393
7863 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609
7864 #: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:681
7865 #: ../fish/guestfish-actions.pod:2988 ../fish/guestfish-actions.pod:3117
7866 #: ../fish/guestfish-actions.pod:3127 ../fish/guestfish-actions.pod:3137
7867 msgid "The mode actually set is affected by the umask."
7871 #: ../src/guestfs-actions.pod:1006
7872 msgid "guestfs_chown"
7876 #: ../src/guestfs-actions.pod:1008
7880 " guestfs_chown (guestfs_h *g,\n"
7883 " const char *path);\n"
7888 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7889 msgid "Change the file owner to C<owner> and group to C<group>."
7893 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3501
7894 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2446
7896 "Only numeric uid and gid are supported. If you want to use names, you will "
7897 "need to locate and parse the password file yourself (Augeas support makes "
7898 "this relatively easy)."
7902 #: ../src/guestfs-actions.pod:1024
7903 msgid "guestfs_command"
7907 #: ../src/guestfs-actions.pod:1026
7911 " guestfs_command (guestfs_h *g,\n"
7912 " char *const *arguments);\n"
7917 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7919 "This call runs a command from the guest filesystem. The filesystem must be "
7920 "mounted, and must contain a compatible operating system (ie. something "
7921 "Linux, with the same or compatible processor architecture)."
7925 #: ../src/guestfs-actions.pod:1035
7927 "The single parameter is an argv-style list of arguments. The first element "
7928 "is the name of the program to run. Subsequent elements are parameters. The "
7929 "list must be non-empty (ie. must contain a program name). Note that the "
7930 "command runs directly, and is I<not> invoked via the shell (see "
7935 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7936 msgid "The return value is anything printed to I<stdout> by the command."
7940 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7942 "If the command returns a non-zero exit status, then this function returns an "
7943 "error message. The error message string is the content of I<stderr> from "
7948 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7950 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7951 "bin>. If you require a program from another location, you should provide "
7952 "the full path in the first parameter."
7956 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7958 "Shared libraries and data files required by the program must be available on "
7959 "filesystems which are mounted in the correct places. It is the caller's "
7960 "responsibility to ensure all filesystems that are needed are mounted at the "
7965 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
7966 #: ../src/guestfs-actions.pod:1554
7967 msgid "(Added in 0.9.1)"
7971 #: ../src/guestfs-actions.pod:1068
7972 msgid "guestfs_command_lines"
7976 #: ../src/guestfs-actions.pod:1070
7980 " guestfs_command_lines (guestfs_h *g,\n"
7981 " char *const *arguments);\n"
7986 #: ../src/guestfs-actions.pod:1074
7988 "This is the same as C<guestfs_command>, but splits the result into a list of "
7993 #: ../src/guestfs-actions.pod:1077
7994 msgid "See also: C<guestfs_sh_lines>"
7998 #: ../src/guestfs-actions.pod:1088
7999 msgid "guestfs_config"
8003 #: ../src/guestfs-actions.pod:1090
8007 " guestfs_config (guestfs_h *g,\n"
8008 " const char *qemuparam,\n"
8009 " const char *qemuvalue);\n"
8014 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8016 "This can be used to add arbitrary qemu command line parameters of the form "
8017 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8018 "setting some parameters which would interfere with parameters that we use."
8022 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8023 msgid "The first character of C<param> string must be a C<-> (dash)."
8027 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8028 msgid "C<value> can be NULL."
8032 #: ../src/guestfs-actions.pod:1108
8033 msgid "guestfs_copy_size"
8037 #: ../src/guestfs-actions.pod:1110
8041 " guestfs_copy_size (guestfs_h *g,\n"
8042 " const char *src,\n"
8043 " const char *dest,\n"
8049 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8051 "This command copies exactly C<size> bytes from one source device or file "
8052 "C<src> to another destination device or file C<dest>."
8056 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8058 "Note this will fail if the source is too short or if the destination is not "
8063 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8064 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8065 #: ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:1725
8066 #: ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:6827
8067 #: ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:7340
8068 #: ../src/guestfs-actions.pod:7359
8070 "This long-running command can generate progress notification messages so "
8071 "that the caller can display a progress bar or indicator. To receive these "
8072 "messages, the caller must register a progress event callback. See L<guestfs"
8073 "(3)/GUESTFS_EVENT_PROGRESS>."
8077 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4169
8078 #: ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:7068
8079 #: ../src/guestfs-actions.pod:7088 ../src/guestfs-actions.pod:7174
8080 msgid "(Added in 1.0.87)"
8084 #: ../src/guestfs-actions.pod:1131
8089 #: ../src/guestfs-actions.pod:1133
8093 " guestfs_cp (guestfs_h *g,\n"
8094 " const char *src,\n"
8095 " const char *dest);\n"
8100 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8102 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8103 "destination filename or destination directory."
8107 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8108 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8109 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4854
8110 #: ../src/guestfs-actions.pod:5231
8111 msgid "(Added in 1.0.18)"
8115 #: ../src/guestfs-actions.pod:1145
8116 msgid "guestfs_cp_a"
8120 #: ../src/guestfs-actions.pod:1147
8124 " guestfs_cp_a (guestfs_h *g,\n"
8125 " const char *src,\n"
8126 " const char *dest);\n"
8131 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8133 "This copies a file or directory from C<src> to C<dest> recursively using the "
8138 #: ../src/guestfs-actions.pod:1159
8143 #: ../src/guestfs-actions.pod:1161
8147 " guestfs_dd (guestfs_h *g,\n"
8148 " const char *src,\n"
8149 " const char *dest);\n"
8154 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8156 "This command copies from one source device or file C<src> to another "
8157 "destination device or file C<dest>. Normally you would use this to copy to "
8158 "or from a device or partition, for example to duplicate a filesystem."
8162 #: ../src/guestfs-actions.pod:1171
8164 "If the destination is a device, it must be as large or larger than the "
8165 "source file or device, otherwise the copy will fail. This command cannot do "
8166 "partial copies (see C<guestfs_copy_size>)."
8170 #: ../src/guestfs-actions.pod:1179
8175 #: ../src/guestfs-actions.pod:1181
8179 " guestfs_df (guestfs_h *g);\n"
8184 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8185 msgid "This command runs the C<df> command to report disk space used."
8189 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8191 "This command is mostly useful for interactive sessions. It is I<not> "
8192 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8197 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8198 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2292
8199 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2384
8200 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4754
8201 #: ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6589
8202 #: ../src/guestfs-actions.pod:7207 ../src/guestfs-actions.pod:7220
8203 #: ../src/guestfs-actions.pod:7233
8204 msgid "(Added in 1.0.54)"
8208 #: ../src/guestfs-actions.pod:1195
8209 msgid "guestfs_df_h"
8213 #: ../src/guestfs-actions.pod:1197
8217 " guestfs_df_h (guestfs_h *g);\n"
8222 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
8224 "This command runs the C<df -h> command to report disk space used in human-"
8229 #: ../src/guestfs-actions.pod:1212
8230 msgid "guestfs_dmesg"
8234 #: ../src/guestfs-actions.pod:1214
8238 " guestfs_dmesg (guestfs_h *g);\n"
8243 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
8245 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8246 "This is sometimes useful for extended debugging of problems."
8250 #: ../src/guestfs-actions.pod:1221
8252 "Another way to get the same information is to enable verbose messages with "
8253 "C<guestfs_set_verbose> or by setting the environment variable "
8254 "C<LIBGUESTFS_DEBUG=1> before running the program."
8258 #: ../src/guestfs-actions.pod:1231
8259 msgid "guestfs_download"
8263 #: ../src/guestfs-actions.pod:1233
8267 " guestfs_download (guestfs_h *g,\n"
8268 " const char *remotefilename,\n"
8269 " const char *filename);\n"
8274 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
8275 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8277 "Download file C<remotefilename> and save it as C<filename> on the local "
8282 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6821
8283 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4595
8284 msgid "C<filename> can also be a named pipe."
8288 #: ../src/guestfs-actions.pod:1243
8289 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8293 #: ../src/guestfs-actions.pod:1254
8294 msgid "guestfs_download_offset"
8298 #: ../src/guestfs-actions.pod:1256
8302 " guestfs_download_offset (guestfs_h *g,\n"
8303 " const char *remotefilename,\n"
8304 " const char *filename,\n"
8305 " int64_t offset,\n"
8311 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
8313 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8314 "region must be within the file or device)."
8318 #: ../src/guestfs-actions.pod:1269
8320 "Note that there is no limit on the amount of data that can be downloaded "
8321 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8322 "full amount unless an error occurs."
8326 #: ../src/guestfs-actions.pod:1274
8327 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8331 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:6866
8332 msgid "(Added in 1.5.17)"
8336 #: ../src/guestfs-actions.pod:1285
8337 msgid "guestfs_drop_caches"
8341 #: ../src/guestfs-actions.pod:1287
8345 " guestfs_drop_caches (guestfs_h *g,\n"
8346 " int whattodrop);\n"
8351 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
8353 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8354 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8355 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8359 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
8360 msgid "Setting C<whattodrop> to 3 should drop everything."
8364 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
8366 "This automatically calls L<sync(2)> before the operation, so that the "
8367 "maximum guest memory is freed."
8371 #: ../src/guestfs-actions.pod:1305
8376 #: ../src/guestfs-actions.pod:1307
8380 " guestfs_du (guestfs_h *g,\n"
8381 " const char *path);\n"
8386 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
8388 "This command runs the C<du -s> command to estimate file space usage for "
8393 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8395 "C<path> can be a file or a directory. If C<path> is a directory then the "
8396 "estimate includes the contents of the directory and all subdirectories "
8401 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8403 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8407 #: ../src/guestfs-actions.pod:1330
8408 msgid "guestfs_e2fsck_f"
8412 #: ../src/guestfs-actions.pod:1332
8416 " guestfs_e2fsck_f (guestfs_h *g,\n"
8417 " const char *device);\n"
8422 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8424 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8425 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8430 #: ../src/guestfs-actions.pod:1340
8432 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8433 "Normally you should use C<guestfs_fsck>."
8437 #: ../src/guestfs-actions.pod:1345
8438 msgid "(Added in 1.0.29)"
8442 #: ../src/guestfs-actions.pod:1347
8443 msgid "guestfs_echo_daemon"
8447 #: ../src/guestfs-actions.pod:1349
8451 " guestfs_echo_daemon (guestfs_h *g,\n"
8452 " char *const *words);\n"
8457 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8459 "This command concatenates the list of C<words> passed with single spaces "
8460 "between them and returns the resulting string."
8464 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8465 msgid "You can use this command to test the connection through to the daemon."
8469 #: ../src/guestfs-actions.pod:1358
8470 msgid "See also C<guestfs_ping_daemon>."
8474 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2100
8475 #: ../src/guestfs-actions.pod:6065
8476 msgid "(Added in 1.0.69)"
8480 #: ../src/guestfs-actions.pod:1365
8481 msgid "guestfs_egrep"
8485 #: ../src/guestfs-actions.pod:1367
8489 " guestfs_egrep (guestfs_h *g,\n"
8490 " const char *regex,\n"
8491 " const char *path);\n"
8496 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8498 "This calls the external C<egrep> program and returns the matching lines."
8502 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
8503 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
8504 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2230
8505 #: ../src/guestfs-actions.pod:2249 ../src/guestfs-actions.pod:2405
8506 #: ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2433
8507 #: ../src/guestfs-actions.pod:2479 ../src/guestfs-actions.pod:2501
8508 #: ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:3662
8509 #: ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:3689
8510 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:4689
8511 #: ../src/guestfs-actions.pod:5565 ../src/guestfs-actions.pod:5614
8512 #: ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6445
8513 #: ../src/guestfs-actions.pod:6458 ../src/guestfs-actions.pod:6471
8514 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506
8515 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6532
8516 #: ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7322
8517 #: ../src/guestfs-actions.pod:7407 ../src/guestfs-actions.pod:7426
8518 #: ../src/guestfs-actions.pod:7472 ../src/guestfs-actions.pod:7491
8519 msgid "(Added in 1.0.66)"
8523 #: ../src/guestfs-actions.pod:1384
8524 msgid "guestfs_egrepi"
8528 #: ../src/guestfs-actions.pod:1386
8532 " guestfs_egrepi (guestfs_h *g,\n"
8533 " const char *regex,\n"
8534 " const char *path);\n"
8539 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8541 "This calls the external C<egrep -i> program and returns the matching lines."
8545 #: ../src/guestfs-actions.pod:1403
8546 msgid "guestfs_equal"
8550 #: ../src/guestfs-actions.pod:1405
8554 " guestfs_equal (guestfs_h *g,\n"
8555 " const char *file1,\n"
8556 " const char *file2);\n"
8561 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8563 "This compares the two files C<file1> and C<file2> and returns true if their "
8564 "content is exactly equal, or false otherwise."
8568 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8569 msgid "The external L<cmp(1)> program is used for the comparison."
8573 #: ../src/guestfs-actions.pod:1419
8574 msgid "guestfs_exists"
8578 #: ../src/guestfs-actions.pod:1421
8582 " guestfs_exists (guestfs_h *g,\n"
8583 " const char *path);\n"
8588 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8590 "This returns C<true> if and only if there is a file, directory (or anything) "
8591 "with the given C<path> name."
8595 #: ../src/guestfs-actions.pod:1428
8596 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8600 #: ../src/guestfs-actions.pod:1434
8601 msgid "guestfs_fallocate"
8605 #: ../src/guestfs-actions.pod:1436
8609 " guestfs_fallocate (guestfs_h *g,\n"
8610 " const char *path,\n"
8616 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
8617 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8619 "This command preallocates a file (containing zero bytes) named C<path> of "
8620 "size C<len> bytes. If the file exists already, it is overwritten."
8624 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8626 "Do not confuse this with the guestfish-specific C<alloc> command which "
8627 "allocates a file in the host and attaches it as a device."
8631 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8633 "This function is deprecated. In new code, use the C<fallocate64> call "
8638 #: ../src/guestfs-actions.pod:1460
8639 msgid "guestfs_fallocate64"
8643 #: ../src/guestfs-actions.pod:1462
8647 " guestfs_fallocate64 (guestfs_h *g,\n"
8648 " const char *path,\n"
8654 #: ../src/guestfs-actions.pod:1471
8656 "Note that this call allocates disk blocks for the file. To create a sparse "
8657 "file use C<guestfs_truncate_size> instead."
8661 #: ../src/guestfs-actions.pod:1474
8663 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8664 "oversight it only allowed 30 bit lengths to be specified, effectively "
8665 "limiting the maximum size of files created through that call to 1GB."
8669 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8671 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8672 "commands which create a file in the host and attach it as a device."
8676 #: ../src/guestfs-actions.pod:1485
8677 msgid "(Added in 1.3.17)"
8681 #: ../src/guestfs-actions.pod:1487
8682 msgid "guestfs_fgrep"
8686 #: ../src/guestfs-actions.pod:1489
8690 " guestfs_fgrep (guestfs_h *g,\n"
8691 " const char *pattern,\n"
8692 " const char *path);\n"
8697 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8699 "This calls the external C<fgrep> program and returns the matching lines."
8703 #: ../src/guestfs-actions.pod:1506
8704 msgid "guestfs_fgrepi"
8708 #: ../src/guestfs-actions.pod:1508
8712 " guestfs_fgrepi (guestfs_h *g,\n"
8713 " const char *pattern,\n"
8714 " const char *path);\n"
8719 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8721 "This calls the external C<fgrep -i> program and returns the matching lines."
8725 #: ../src/guestfs-actions.pod:1525
8726 msgid "guestfs_file"
8730 #: ../src/guestfs-actions.pod:1527
8734 " guestfs_file (guestfs_h *g,\n"
8735 " const char *path);\n"
8740 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8742 "This call uses the standard L<file(1)> command to determine the type or "
8743 "contents of the file."
8747 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8749 "This call will also transparently look inside various types of compressed "
8754 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8756 "The exact command which runs is C<file -zb path>. Note in particular that "
8757 "the filename is not prepended to the output (the I<-b> option)."
8761 #: ../src/guestfs-actions.pod:1541
8763 "This command can also be used on C</dev/> devices (and partitions, LV "
8764 "names). You can for example use this to determine if a device contains a "
8765 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8769 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
8771 "If the C<path> does not begin with C</dev/> then this command only works for "
8772 "the content of regular files. For other file types (directory, symbolic "
8773 "link etc) it will just return the string C<directory> etc."
8777 #: ../src/guestfs-actions.pod:1556
8778 msgid "guestfs_file_architecture"
8782 #: ../src/guestfs-actions.pod:1558
8786 " guestfs_file_architecture (guestfs_h *g,\n"
8787 " const char *filename);\n"
8792 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8794 "This detects the architecture of the binary C<filename>, and returns it if "
8799 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1036
8800 msgid "Currently defined architectures are:"
8804 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1040
8809 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8811 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8812 "irrespective of the precise processor requirements of the binary."
8816 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1045
8821 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1047
8822 msgid "64 bit x86-64."
8826 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1049
8831 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1051
8832 msgid "32 bit SPARC."
8836 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1053
8841 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1055
8842 msgid "64 bit SPARC V9 and above."
8846 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1057
8851 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1059
8852 msgid "Intel Itanium."
8853 msgstr "Intel Itanium."
8856 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1061
8861 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1063
8862 msgid "32 bit Power PC."
8866 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1065
8871 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1067
8872 msgid "64 bit Power PC."
8876 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1071
8877 msgid "Libguestfs may return other architecture strings in future."
8881 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1073
8882 msgid "The function works on at least the following types of files:"
8886 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1079
8887 msgid "many types of Un*x and Linux binary"
8891 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1083
8892 msgid "many types of Un*x and Linux shared library"
8896 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1087
8897 msgid "Windows Win32 and Win64 binaries"
8901 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1091
8902 msgid "Windows Win32 and Win64 DLLs"
8906 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1093
8907 msgid "Win32 binaries and DLLs return C<i386>."
8911 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1095
8912 msgid "Win64 binaries and DLLs return C<x86_64>."
8916 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1099
8917 msgid "Linux kernel modules"
8921 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1103
8922 msgid "Linux new-style initrd images"
8926 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1107
8927 msgid "some non-x86 Linux vmlinuz kernels"
8931 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1111
8932 msgid "What it can't do currently:"
8936 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1117
8937 msgid "static libraries (libfoo.a)"
8941 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1121
8942 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8946 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1125
8947 msgid "x86 Linux vmlinuz kernels"
8951 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1127
8953 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8954 "compressed code, and are horribly hard to unpack. If you want to find the "
8955 "architecture of a kernel, use the architecture of the associated initrd or "
8956 "kernel module(s) instead."
8960 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1829
8961 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:2537
8962 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2700
8963 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2809
8964 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:2936
8965 #: ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3280
8966 #: ../src/guestfs-actions.pod:3412
8967 msgid "(Added in 1.5.3)"
8971 #: ../src/guestfs-actions.pod:1668
8972 msgid "guestfs_filesize"
8976 #: ../src/guestfs-actions.pod:1670
8980 " guestfs_filesize (guestfs_h *g,\n"
8981 " const char *file);\n"
8986 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1138
8987 msgid "This command returns the size of C<file> in bytes."
8991 #: ../src/guestfs-actions.pod:1676
8993 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8994 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8995 "devices, use C<guestfs_blockdev_getsize64>."
8999 #: ../src/guestfs-actions.pod:1682
9000 msgid "(Added in 1.0.82)"
9004 #: ../src/guestfs-actions.pod:1684
9005 msgid "guestfs_fill"
9009 #: ../src/guestfs-actions.pod:1686
9013 " guestfs_fill (guestfs_h *g,\n"
9016 " const char *path);\n"
9021 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1148
9023 "This command creates a new file called C<path>. The initial content of the "
9024 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9029 #: ../src/guestfs-actions.pod:1696
9031 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9032 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9033 "bytes use C<guestfs_fill_pattern>."
9037 #: ../src/guestfs-actions.pod:1708
9038 msgid "(Added in 1.0.79)"
9042 #: ../src/guestfs-actions.pod:1710
9043 msgid "guestfs_fill_pattern"
9047 #: ../src/guestfs-actions.pod:1712
9051 " guestfs_fill_pattern (guestfs_h *g,\n"
9052 " const char *pattern,\n"
9054 " const char *path);\n"
9059 #: ../src/guestfs-actions.pod:1718
9061 "This function is like C<guestfs_fill> except that it creates a new file of "
9062 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9063 "pattern is truncated if necessary to ensure the length of the file is "
9064 "exactly C<len> bytes."
9068 #: ../src/guestfs-actions.pod:1730
9069 msgid "(Added in 1.3.12)"
9073 #: ../src/guestfs-actions.pod:1732
9074 msgid "guestfs_find"
9078 #: ../src/guestfs-actions.pod:1734
9082 " guestfs_find (guestfs_h *g,\n"
9083 " const char *directory);\n"
9088 #: ../src/guestfs-actions.pod:1738 ../fish/guestfish-actions.pod:1170
9090 "This command lists out all files and directories, recursively, starting at "
9091 "C<directory>. It is essentially equivalent to running the shell command "
9092 "C<find directory -print> but some post-processing happens on the output, "
9097 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
9099 "This returns a list of strings I<without any prefix>. Thus if the directory "
9104 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1178
9114 #: ../src/guestfs-actions.pod:1750
9116 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9120 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1185
9131 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
9132 msgid "If C<directory> is not a directory, then this command returns an error."
9136 #: ../src/guestfs-actions.pod:1761 ../fish/guestfish-actions.pod:1193
9137 msgid "The returned list is sorted."
9141 #: ../src/guestfs-actions.pod:1763
9142 msgid "See also C<guestfs_find0>."
9146 #: ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:4106
9147 #: ../src/guestfs-actions.pod:5649
9148 msgid "(Added in 1.0.27)"
9152 #: ../src/guestfs-actions.pod:1774
9153 msgid "guestfs_find0"
9157 #: ../src/guestfs-actions.pod:1776
9161 " guestfs_find0 (guestfs_h *g,\n"
9162 " const char *directory,\n"
9163 " const char *files);\n"
9168 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1204
9170 "This command lists out all files and directories, recursively, starting at "
9171 "C<directory>, placing the resulting list in the external file called "
9176 #: ../src/guestfs-actions.pod:1785
9178 "This command works the same way as C<guestfs_find> with the following "
9183 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1215
9184 msgid "The resulting list is written to an external file."
9188 #: ../src/guestfs-actions.pod:1796 ../fish/guestfish-actions.pod:1219
9190 "Items (filenames) in the result are separated by C<\\0> characters. See "
9191 "L<find(1)> option I<-print0>."
9195 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1224
9196 msgid "This command is not limited in the number of names that it can return."
9200 #: ../src/guestfs-actions.pod:1806 ../fish/guestfish-actions.pod:1229
9201 msgid "The result list is not sorted."
9205 #: ../src/guestfs-actions.pod:1812
9206 msgid "(Added in 1.0.74)"
9210 #: ../src/guestfs-actions.pod:1814
9211 msgid "guestfs_findfs_label"
9215 #: ../src/guestfs-actions.pod:1816
9219 " guestfs_findfs_label (guestfs_h *g,\n"
9220 " const char *label);\n"
9225 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
9227 "This command searches the filesystems and returns the one which has the "
9228 "given label. An error is returned if no such filesystem can be found."
9232 #: ../src/guestfs-actions.pod:1824
9233 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9237 #: ../src/guestfs-actions.pod:1831
9238 msgid "guestfs_findfs_uuid"
9242 #: ../src/guestfs-actions.pod:1833
9246 " guestfs_findfs_uuid (guestfs_h *g,\n"
9247 " const char *uuid);\n"
9252 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1249
9254 "This command searches the filesystems and returns the one which has the "
9255 "given UUID. An error is returned if no such filesystem can be found."
9259 #: ../src/guestfs-actions.pod:1841
9260 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9264 #: ../src/guestfs-actions.pod:1848
9265 msgid "guestfs_fsck"
9269 #: ../src/guestfs-actions.pod:1850
9273 " guestfs_fsck (guestfs_h *g,\n"
9274 " const char *fstype,\n"
9275 " const char *device);\n"
9280 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
9282 "This runs the filesystem checker (fsck) on C<device> which should have "
9283 "filesystem type C<fstype>."
9287 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1262
9289 "The returned integer is the status. See L<fsck(8)> for the list of status "
9290 "codes from C<fsck>."
9294 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1271
9295 msgid "Multiple status codes can be summed together."
9299 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1275
9301 "A non-zero return code can mean \"success\", for example if errors have been "
9302 "corrected on the filesystem."
9306 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1280
9307 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9311 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1285
9313 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9317 #: ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:7345
9318 msgid "(Added in 1.0.16)"
9322 #: ../src/guestfs-actions.pod:1887
9323 msgid "guestfs_get_append"
9327 #: ../src/guestfs-actions.pod:1889
9331 " guestfs_get_append (guestfs_h *g);\n"
9336 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
9338 "Return the additional kernel options which are added to the guest kernel "
9343 #: ../src/guestfs-actions.pod:1895 ../fish/guestfish-actions.pod:1294
9344 msgid "If C<NULL> then no options are added."
9348 #: ../src/guestfs-actions.pod:1897
9350 "This function returns a string which may be NULL. There is no way to return "
9351 "an error from this function. The string is owned by the guest handle and "
9352 "must I<not> be freed."
9356 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5327
9357 #: ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:6207
9358 #: ../src/guestfs-actions.pod:6226 ../src/guestfs-actions.pod:6242
9359 #: ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:7016
9360 #: ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7388
9361 msgid "(Added in 1.0.26)"
9365 #: ../src/guestfs-actions.pod:1903
9366 msgid "guestfs_get_attach_method"
9370 #: ../src/guestfs-actions.pod:1905
9374 " guestfs_get_attach_method (guestfs_h *g);\n"
9379 #: ../src/guestfs-actions.pod:1908
9380 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9384 #: ../src/guestfs-actions.pod:1913
9385 msgid "guestfs_get_autosync"
9389 #: ../src/guestfs-actions.pod:1915
9393 " guestfs_get_autosync (guestfs_h *g);\n"
9398 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1306
9399 msgid "Get the autosync flag."
9403 #: ../src/guestfs-actions.pod:1924
9404 msgid "guestfs_get_direct"
9408 #: ../src/guestfs-actions.pod:1926
9412 " guestfs_get_direct (guestfs_h *g);\n"
9417 #: ../src/guestfs-actions.pod:1929 ../fish/guestfish-actions.pod:1312
9418 msgid "Return the direct appliance mode flag."
9422 #: ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:5876
9423 msgid "(Added in 1.0.72)"
9427 #: ../src/guestfs-actions.pod:1935
9428 msgid "guestfs_get_e2label"
9432 #: ../src/guestfs-actions.pod:1937
9436 " guestfs_get_e2label (guestfs_h *g,\n"
9437 " const char *device);\n"
9442 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1318
9444 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9448 #: ../src/guestfs-actions.pod:1947 ../fish/guestfish-actions.pod:1321
9450 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9454 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:1975
9455 #: ../src/guestfs-actions.pod:5894 ../src/guestfs-actions.pod:5913
9456 msgid "(Added in 1.0.15)"
9460 #: ../src/guestfs-actions.pod:1956
9461 msgid "guestfs_get_e2uuid"
9465 #: ../src/guestfs-actions.pod:1958
9469 " guestfs_get_e2uuid (guestfs_h *g,\n"
9470 " const char *device);\n"
9475 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1332
9477 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9481 #: ../src/guestfs-actions.pod:1968 ../fish/guestfish-actions.pod:1335
9483 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9487 #: ../src/guestfs-actions.pod:1977
9488 msgid "guestfs_get_memsize"
9492 #: ../src/guestfs-actions.pod:1979
9496 " guestfs_get_memsize (guestfs_h *g);\n"
9501 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1346
9503 "This gets the memory size in megabytes allocated to the qemu subprocess."
9507 #: ../src/guestfs-actions.pod:1985
9509 "If C<guestfs_set_memsize> was not called on this handle, and if "
9510 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9511 "value for memsize."
9515 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2070
9516 #: ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:6036
9517 #: ../fish/guestfish-actions.pod:1353 ../fish/guestfish-actions.pod:1404
9518 #: ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4085
9520 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9524 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:4397
9525 #: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4613
9526 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4644
9527 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4674
9528 #: ../src/guestfs-actions.pod:5552 ../src/guestfs-actions.pod:5934
9529 #: ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6782
9530 msgid "(Added in 1.0.55)"
9534 #: ../src/guestfs-actions.pod:1996
9535 msgid "guestfs_get_network"
9539 #: ../src/guestfs-actions.pod:1998
9543 " guestfs_get_network (guestfs_h *g);\n"
9548 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1360
9549 msgid "This returns the enable network flag."
9553 #: ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:5953
9554 msgid "(Added in 1.5.4)"
9558 #: ../src/guestfs-actions.pod:2007
9559 msgid "guestfs_get_path"
9563 #: ../src/guestfs-actions.pod:2009
9567 " guestfs_get_path (guestfs_h *g);\n"
9572 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1366
9573 msgid "Return the current search path."
9577 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1368
9579 "This is always non-NULL. If it wasn't set already, then this will return "
9584 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2046
9586 "This function returns a string, or NULL on error. The string is owned by "
9587 "the guest handle and must I<not> be freed."
9591 #: ../src/guestfs-actions.pod:2022
9592 msgid "guestfs_get_pid"
9596 #: ../src/guestfs-actions.pod:2024
9600 " guestfs_get_pid (guestfs_h *g);\n"
9605 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9607 "Return the process ID of the qemu subprocess. If there is no qemu "
9608 "subprocess, then this will return an error."
9612 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1380
9613 msgid "This is an internal call used for debugging and testing."
9617 #: ../src/guestfs-actions.pod:2034
9618 msgid "(Added in 1.0.56)"
9622 #: ../src/guestfs-actions.pod:2036
9623 msgid "guestfs_get_qemu"
9627 #: ../src/guestfs-actions.pod:2038
9631 " guestfs_get_qemu (guestfs_h *g);\n"
9636 #: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1386
9637 msgid "Return the current qemu binary."
9641 #: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1388
9643 "This is always non-NULL. If it wasn't set already, then this will return "
9644 "the default qemu binary name."
9648 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:5998
9649 msgid "(Added in 1.0.6)"
9653 #: ../src/guestfs-actions.pod:2051
9654 msgid "guestfs_get_recovery_proc"
9658 #: ../src/guestfs-actions.pod:2053
9662 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9667 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1395
9668 msgid "Return the recovery process enabled flag."
9672 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3507
9673 #: ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:4204
9674 #: ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:5257
9675 #: ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6022
9676 #: ../src/guestfs-actions.pod:6685 ../src/guestfs-actions.pod:6705
9677 #: ../src/guestfs-actions.pod:6897
9678 msgid "(Added in 1.0.77)"
9682 #: ../src/guestfs-actions.pod:2062
9683 msgid "guestfs_get_selinux"
9687 #: ../src/guestfs-actions.pod:2064
9691 " guestfs_get_selinux (guestfs_h *g);\n"
9696 #: ../src/guestfs-actions.pod:2067
9698 "This returns the current setting of the selinux flag which is passed to the "
9699 "appliance at boot time. See C<guestfs_set_selinux>."
9703 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2138
9704 #: ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6099
9705 msgid "(Added in 1.0.67)"
9709 #: ../src/guestfs-actions.pod:2077
9710 msgid "guestfs_get_state"
9714 #: ../src/guestfs-actions.pod:2079
9718 " guestfs_get_state (guestfs_h *g);\n"
9723 #: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1411
9725 "This returns the current state as an opaque integer. This is only useful "
9726 "for printing debug and internal error messages."
9730 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305
9731 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395
9732 #: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:1414
9733 #: ../fish/guestfish-actions.pod:2328 ../fish/guestfish-actions.pod:2346
9734 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2400
9735 msgid "For more information on states, see L<guestfs(3)>."
9739 #: ../src/guestfs-actions.pod:2091
9740 msgid "guestfs_get_trace"
9744 #: ../src/guestfs-actions.pod:2093
9748 " guestfs_get_trace (guestfs_h *g);\n"
9753 #: ../src/guestfs-actions.pod:2096 ../fish/guestfish-actions.pod:1420
9754 msgid "Return the command trace flag."
9758 #: ../src/guestfs-actions.pod:2102
9759 msgid "guestfs_get_umask"
9763 #: ../src/guestfs-actions.pod:2104
9767 " guestfs_get_umask (guestfs_h *g);\n"
9772 #: ../src/guestfs-actions.pod:2107
9774 "Return the current umask. By default the umask is C<022> unless it has been "
9775 "set by calling C<guestfs_umask>."
9779 #: ../src/guestfs-actions.pod:2114
9780 msgid "guestfs_get_verbose"
9784 #: ../src/guestfs-actions.pod:2116
9788 " guestfs_get_verbose (guestfs_h *g);\n"
9793 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1433
9794 msgid "This returns the verbose messages flag."
9798 #: ../src/guestfs-actions.pod:2125
9799 msgid "guestfs_getcon"
9803 #: ../src/guestfs-actions.pod:2127
9807 " guestfs_getcon (guestfs_h *g);\n"
9812 #: ../src/guestfs-actions.pod:2130 ../fish/guestfish-actions.pod:1439
9813 msgid "This gets the SELinux security context of the daemon."
9817 #: ../src/guestfs-actions.pod:2132
9819 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9823 #: ../src/guestfs-actions.pod:2140
9824 msgid "guestfs_getxattr"
9828 #: ../src/guestfs-actions.pod:2142
9832 " guestfs_getxattr (guestfs_h *g,\n"
9833 " const char *path,\n"
9834 " const char *name,\n"
9835 " size_t *size_r);\n"
9840 #: ../src/guestfs-actions.pod:2148
9842 "Get a single extended attribute from file C<path> named C<name>. This call "
9843 "follows symlinks. If you want to lookup an extended attribute for the "
9844 "symlink itself, use C<guestfs_lgetxattr>."
9848 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3521
9850 "Normally it is better to get all extended attributes from a file in one go "
9851 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9852 "implementations are buggy and do not provide a way to list out attributes. "
9853 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9854 "extended attributes you want in advance and call this function."
9858 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
9859 #: ../fish/guestfish-actions.pod:1459 ../fish/guestfish-actions.pod:2465
9861 "Extended attribute values are blobs of binary data. If there is no extended "
9862 "attribute named C<name>, this returns an error."
9866 #: ../src/guestfs-actions.pod:2162
9867 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9871 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2355
9872 #: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:5250
9873 #: ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5457
9875 "This function returns a buffer, or NULL on error. The size of the returned "
9876 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9881 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:3537
9882 msgid "(Added in 1.7.24)"
9886 #: ../src/guestfs-actions.pod:2170
9887 msgid "guestfs_getxattrs"
9891 #: ../src/guestfs-actions.pod:2172
9894 " struct guestfs_xattr_list *\n"
9895 " guestfs_getxattrs (guestfs_h *g,\n"
9896 " const char *path);\n"
9901 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
9903 "This call lists the extended attributes of the file or directory C<path>."
9907 #: ../src/guestfs-actions.pod:2179 ../fish/guestfish-actions.pod:1471
9909 "At the system call level, this is a combination of the L<listxattr(2)> and "
9910 "L<getxattr(2)> calls."
9914 #: ../src/guestfs-actions.pod:2182
9915 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9919 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549
9920 #: ../src/guestfs-actions.pod:4200
9922 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9923 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9927 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3553
9928 #: ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754
9929 #: ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:6118
9930 #: ../src/guestfs-actions.pod:7453
9931 msgid "(Added in 1.0.59)"
9935 #: ../src/guestfs-actions.pod:2190
9936 msgid "guestfs_glob_expand"
9940 #: ../src/guestfs-actions.pod:2192
9944 " guestfs_glob_expand (guestfs_h *g,\n"
9945 " const char *pattern);\n"
9950 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1480
9952 "This command searches for all the pathnames matching C<pattern> according to "
9953 "the wildcard expansion rules used by the shell."
9957 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
9959 "If no paths match, then this returns an empty list (note: not an error)."
9963 #: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1487
9965 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9966 "GLOB_BRACE>. See that manual page for more details."
9970 #: ../src/guestfs-actions.pod:2211 ../src/guestfs-actions.pod:6283
9971 #: ../src/guestfs-actions.pod:6300
9972 msgid "(Added in 1.0.50)"
9976 #: ../src/guestfs-actions.pod:2213
9977 msgid "guestfs_grep"
9981 #: ../src/guestfs-actions.pod:2215
9985 " guestfs_grep (guestfs_h *g,\n"
9986 " const char *regex,\n"
9987 " const char *path);\n"
9992 #: ../src/guestfs-actions.pod:2220 ../fish/guestfish-actions.pod:1495
9993 msgid "This calls the external C<grep> program and returns the matching lines."
9997 #: ../src/guestfs-actions.pod:2232
9998 msgid "guestfs_grepi"
10002 #: ../src/guestfs-actions.pod:2234
10006 " guestfs_grepi (guestfs_h *g,\n"
10007 " const char *regex,\n"
10008 " const char *path);\n"
10013 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1505
10015 "This calls the external C<grep -i> program and returns the matching lines."
10019 #: ../src/guestfs-actions.pod:2251
10020 msgid "guestfs_grub_install"
10024 #: ../src/guestfs-actions.pod:2253
10028 " guestfs_grub_install (guestfs_h *g,\n"
10029 " const char *root,\n"
10030 " const char *device);\n"
10035 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
10037 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10038 "the root directory being C<root>."
10042 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1518
10044 "Note: If grub-install reports the error \"No suitable drive was found in the "
10045 "generated device map.\" it may be that you need to create a C</boot/grub/"
10046 "device.map> file first that contains the mapping between grub device names "
10047 "and Linux device names. It is usually sufficient to create a file "
10052 #: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1525
10055 " (hd0) /dev/vda\n"
10060 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1527
10061 msgid "replacing C</dev/vda> with the name of the installation device."
10065 #: ../src/guestfs-actions.pod:2274
10066 msgid "(Added in 1.0.17)"
10070 #: ../src/guestfs-actions.pod:2276
10071 msgid "guestfs_head"
10075 #: ../src/guestfs-actions.pod:2278
10079 " guestfs_head (guestfs_h *g,\n"
10080 " const char *path);\n"
10085 #: ../src/guestfs-actions.pod:2282 ../fish/guestfish-actions.pod:1533
10087 "This command returns up to the first 10 lines of a file as a list of strings."
10091 #: ../src/guestfs-actions.pod:2294
10092 msgid "guestfs_head_n"
10096 #: ../src/guestfs-actions.pod:2296
10100 " guestfs_head_n (guestfs_h *g,\n"
10102 " const char *path);\n"
10107 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
10109 "If the parameter C<nrlines> is a positive number, this returns the first "
10110 "C<nrlines> lines of the file C<path>."
10114 #: ../src/guestfs-actions.pod:2304 ../fish/guestfish-actions.pod:1546
10116 "If the parameter C<nrlines> is a negative number, this returns lines from "
10117 "the file C<path>, excluding the last C<nrlines> lines."
10121 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:6580
10122 #: ../fish/guestfish-actions.pod:1549 ../fish/guestfish-actions.pod:4435
10123 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10127 #: ../src/guestfs-actions.pod:2318
10128 msgid "guestfs_hexdump"
10132 #: ../src/guestfs-actions.pod:2320
10136 " guestfs_hexdump (guestfs_h *g,\n"
10137 " const char *path);\n"
10142 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1558
10144 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10145 "readable, canonical hex dump of the file."
10149 #: ../src/guestfs-actions.pod:2333 ../src/guestfs-actions.pod:6364
10150 #: ../src/guestfs-actions.pod:6419
10151 msgid "(Added in 1.0.22)"
10155 #: ../src/guestfs-actions.pod:2335
10156 msgid "guestfs_initrd_cat"
10160 #: ../src/guestfs-actions.pod:2337
10164 " guestfs_initrd_cat (guestfs_h *g,\n"
10165 " const char *initrdpath,\n"
10166 " const char *filename,\n"
10167 " size_t *size_r);\n"
10172 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1568
10174 "This command unpacks the file C<filename> from the initrd file called "
10175 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10180 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1572
10182 "For example, in guestfish you could use the following command to examine the "
10183 "boot script (usually called C</init>) contained in a Linux initrd or "
10188 #: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1576
10191 " initrd-cat /boot/initrd-<version>.img init\n"
10196 #: ../src/guestfs-actions.pod:2353
10197 msgid "See also C<guestfs_initrd_list>."
10201 #: ../src/guestfs-actions.pod:2364
10202 msgid "guestfs_initrd_list"
10206 #: ../src/guestfs-actions.pod:2366
10210 " guestfs_initrd_list (guestfs_h *g,\n"
10211 " const char *path);\n"
10216 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1587
10217 msgid "This command lists out files contained in an initrd."
10221 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1589
10223 "The files are listed without any initial C</> character. The files are "
10224 "listed in the order they appear (not necessarily alphabetical). Directory "
10225 "names are listed as separate items."
10229 #: ../src/guestfs-actions.pod:2376 ../fish/guestfish-actions.pod:1593
10231 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10232 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10237 #: ../src/guestfs-actions.pod:2386
10238 msgid "guestfs_inotify_add_watch"
10242 #: ../src/guestfs-actions.pod:2388
10246 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10247 " const char *path,\n"
10253 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1601
10254 msgid "Watch C<path> for the events listed in C<mask>."
10258 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1603
10260 "Note that if C<path> is a directory then events within that directory are "
10261 "watched, but this does I<not> happen recursively (in subdirectories)."
10265 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1607
10267 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10268 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10272 #: ../src/guestfs-actions.pod:2407
10273 msgid "guestfs_inotify_close"
10277 #: ../src/guestfs-actions.pod:2409
10281 " guestfs_inotify_close (guestfs_h *g);\n"
10286 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1615
10288 "This closes the inotify handle which was previously opened by inotify_init. "
10289 "It removes all watches, throws away any pending events, and deallocates all "
10294 #: ../src/guestfs-actions.pod:2420
10295 msgid "guestfs_inotify_files"
10299 #: ../src/guestfs-actions.pod:2422
10303 " guestfs_inotify_files (guestfs_h *g);\n"
10308 #: ../src/guestfs-actions.pod:2425
10310 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10311 "returns a list of pathnames of objects that were touched. The returned "
10312 "pathnames are sorted and deduplicated."
10316 #: ../src/guestfs-actions.pod:2435
10317 msgid "guestfs_inotify_init"
10321 #: ../src/guestfs-actions.pod:2437
10325 " guestfs_inotify_init (guestfs_h *g,\n"
10326 " int maxevents);\n"
10331 #: ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1631
10333 "This command creates a new inotify handle. The inotify subsystem can be "
10334 "used to notify events which happen to objects in the guest filesystem."
10338 #: ../src/guestfs-actions.pod:2445
10340 "C<maxevents> is the maximum number of events which will be queued up between "
10341 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10342 "passed as C<0>, then the kernel (or previously set) default is used. For "
10343 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10344 "throws away events, but records the fact that it threw them away by setting "
10345 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10346 "C<guestfs_inotify_read>)."
10350 #: ../src/guestfs-actions.pod:2455
10352 "Before any events are generated, you have to add some watches to the "
10353 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10354 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10358 #: ../src/guestfs-actions.pod:2461
10360 "Queued up events should be read periodically by calling "
10361 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10362 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10363 "often enough then you risk the internal queue overflowing."
10367 #: ../src/guestfs-actions.pod:2468
10369 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10370 "This also removes any watches automatically."
10374 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1662
10376 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10377 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10378 "that there is one global inotify handle per libguestfs instance."
10382 #: ../src/guestfs-actions.pod:2481
10383 msgid "guestfs_inotify_read"
10387 #: ../src/guestfs-actions.pod:2483
10390 " struct guestfs_inotify_event_list *\n"
10391 " guestfs_inotify_read (guestfs_h *g);\n"
10396 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
10398 "Return the complete queue of events that have happened since the previous "
10403 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1674
10404 msgid "If no events have happened, this returns an empty list."
10408 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
10410 "I<Note>: In order to make sure that all events have been read, you must call "
10411 "this function repeatedly until it returns an empty list. The reason is that "
10412 "the call will read events up to the maximum appliance-to-host message size "
10413 "and leave remaining events in the queue."
10417 #: ../src/guestfs-actions.pod:2497
10419 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10420 "there was an error. I<The caller must call "
10421 "C<guestfs_free_inotify_event_list> after use>."
10425 #: ../src/guestfs-actions.pod:2503
10426 msgid "guestfs_inotify_rm_watch"
10430 #: ../src/guestfs-actions.pod:2505
10434 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10440 #: ../src/guestfs-actions.pod:2509
10442 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10446 #: ../src/guestfs-actions.pod:2516
10447 msgid "guestfs_inspect_get_arch"
10451 #: ../src/guestfs-actions.pod:2518
10455 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10456 " const char *root);\n"
10461 #: ../src/guestfs-actions.pod:2522 ../src/guestfs-actions.pod:2545
10462 #: ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2682
10463 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2747
10464 #: ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2796
10465 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860
10466 #: ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2920
10467 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2999
10468 #: ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3062
10469 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
10470 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3138
10472 "This function should only be called with a root device string as returned by "
10473 "C<guestfs_inspect_os>."
10477 #: ../src/guestfs-actions.pod:2525
10479 "This returns the architecture of the inspected operating system. The "
10480 "possible return values are listed under C<guestfs_file_architecture>."
10484 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1700
10486 "If the architecture could not be determined, then the string C<unknown> is "
10491 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2625
10492 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:2756
10493 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2876
10494 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2931
10495 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3028
10496 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
10497 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3109
10498 #: ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3231
10499 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:1703
10500 #: ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1877
10501 #: ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1913
10502 #: ../fish/guestfish-actions.pod:1983 ../fish/guestfish-actions.pod:2007
10503 #: ../fish/guestfish-actions.pod:2024 ../fish/guestfish-actions.pod:2067
10504 #: ../fish/guestfish-actions.pod:2102 ../fish/guestfish-actions.pod:2118
10505 #: ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147
10506 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2175
10507 #: ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2308
10508 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10512 #: ../src/guestfs-actions.pod:2539
10513 msgid "guestfs_inspect_get_distro"
10517 #: ../src/guestfs-actions.pod:2541
10521 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10522 " const char *root);\n"
10527 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
10529 "This returns the distro (distribution) of the inspected operating system."
10533 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1715
10534 msgid "Currently defined distros are:"
10538 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1719
10539 msgid "\"archlinux\""
10540 msgstr "\"archlinux\""
10543 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1721
10544 msgid "Arch Linux."
10545 msgstr "Arch Linux."
10548 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1723
10550 #| msgid "\"gentoo\""
10552 msgstr "\"gentoo\""
10555 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1725
10560 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1727
10562 msgstr "\"debian\""
10565 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1729
10570 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1731
10572 msgstr "\"fedora\""
10575 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1733
10580 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1735
10582 msgstr "\"gentoo\""
10585 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1737
10590 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1739
10591 msgid "\"linuxmint\""
10592 msgstr "\"linuxmint\""
10595 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1741
10596 msgid "Linux Mint."
10597 msgstr "Linux Mint."
10600 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1743
10601 msgid "\"mandriva\""
10602 msgstr "\"mandriva\""
10605 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1745
10610 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1747
10615 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1749
10620 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1751
10622 msgstr "\"pardus\""
10625 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1753
10630 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1755
10631 msgid "\"redhat-based\""
10632 msgstr "\"redhat-based\""
10635 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1757
10636 msgid "Some Red Hat-derived distro."
10637 msgstr "Дистрибутив, що походить від Red Hat."
10640 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1759
10645 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1761
10647 #| msgid "Red Hat Enterprise Linux and some derivatives."
10648 msgid "Red Hat Enterprise Linux."
10649 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10652 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1763
10653 msgid "\"scientificlinux\""
10657 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1765
10658 msgid "Scientific Linux."
10662 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1767
10663 msgid "\"slackware\""
10667 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1769
10672 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1771
10674 msgstr "\"ubuntu\""
10677 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1773
10682 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2727
10683 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1775
10684 #: ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:2093
10685 msgid "\"unknown\""
10686 msgstr "\"unknown\""
10689 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1777
10690 msgid "The distro could not be determined."
10691 msgstr "Дистрибутив, тип якого не вдалося визначити."
10694 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3011
10695 #: ../fish/guestfish-actions.pod:1779 ../fish/guestfish-actions.pod:2085
10696 msgid "\"windows\""
10697 msgstr "\"windows\""
10700 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1781
10702 "Windows does not have distributions. This string is returned if the OS type "
10707 #: ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2733
10708 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:1786
10709 #: ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:2099
10711 "Future versions of libguestfs may return other strings here. The caller "
10712 "should be prepared to handle any string."
10716 #: ../src/guestfs-actions.pod:2632
10717 msgid "guestfs_inspect_get_drive_mappings"
10721 #: ../src/guestfs-actions.pod:2634
10725 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10726 " const char *root);\n"
10731 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1798
10733 "This call is useful for Windows which uses a primitive system of assigning "
10734 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10735 "Windows Registry to find out how disks/partitions are mapped to drive "
10736 "letters, and returns a hash table as in the example below:"
10740 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
10743 " C => /dev/vda2\n"
10744 " E => /dev/vdb1\n"
10745 " F => /dev/vdc1\n"
10750 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
10752 "Note that keys are drive letters. For Windows, the key is case insensitive "
10753 "and just contains the drive letter, without the customary colon separator "
10758 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1812
10760 "In future we may support other operating systems that also used drive "
10761 "letters, but the keys for those might not be case insensitive and might be "
10762 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10767 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1817
10769 "For Windows guests, currently only hard drive mappings are returned. "
10770 "Removable disks (eg. DVD-ROMs) are ignored."
10774 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1820
10776 "For guests that do not use drive mappings, or if the drive mappings could "
10777 "not be determined, this returns an empty hash table."
10781 #: ../src/guestfs-actions.pod:2666
10783 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10784 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10788 #: ../src/guestfs-actions.pod:2670 ../src/guestfs-actions.pod:2846
10789 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:4816
10790 #: ../src/guestfs-actions.pod:6721
10792 "This function returns a NULL-terminated array of strings, or NULL if there "
10793 "was an error. The array of strings will always have length C<2n+1>, where "
10794 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10795 "caller must free the strings and the array after use>."
10799 #: ../src/guestfs-actions.pod:2676
10800 msgid "guestfs_inspect_get_filesystems"
10804 #: ../src/guestfs-actions.pod:2678
10808 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10809 " const char *root);\n"
10814 #: ../src/guestfs-actions.pod:2685 ../fish/guestfish-actions.pod:1834
10816 "This returns a list of all the filesystems that we think are associated with "
10817 "this operating system. This includes the root filesystem, other ordinary "
10818 "filesystems, and non-mounted devices like swap partitions."
10822 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1839
10824 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10825 "to be shared between operating systems."
10829 #: ../src/guestfs-actions.pod:2693
10831 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10832 "C<guestfs_inspect_get_mountpoints>."
10836 #: ../src/guestfs-actions.pod:2702
10837 msgid "guestfs_inspect_get_format"
10841 #: ../src/guestfs-actions.pod:2704
10845 " guestfs_inspect_get_format (guestfs_h *g,\n"
10846 " const char *root);\n"
10851 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
10853 "This returns the format of the inspected operating system. You can use it "
10854 "to detect install images, live CDs and similar."
10858 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1855
10859 msgid "Currently defined formats are:"
10863 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1859
10864 msgid "\"installed\""
10865 msgstr "\"installed\""
10868 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1861
10869 msgid "This is an installed operating system."
10870 msgstr "Це встановлена операційна система."
10873 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1863
10874 msgid "\"installer\""
10878 #: ../src/guestfs-actions.pod:2724 ../fish/guestfish-actions.pod:1865
10880 "The disk image being inspected is not an installed operating system, but a "
10881 "I<bootable> install disk, live CD, or similar."
10885 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1870
10886 msgid "The format of this disk image is not known."
10890 #: ../src/guestfs-actions.pod:2741
10891 msgid "guestfs_inspect_get_hostname"
10895 #: ../src/guestfs-actions.pod:2743
10899 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10900 " const char *root);\n"
10905 #: ../src/guestfs-actions.pod:2750 ../fish/guestfish-actions.pod:1886
10907 "This function returns the hostname of the operating system as found by "
10908 "inspection of the guest's configuration files."
10912 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1889
10914 "If the hostname could not be determined, then the string C<unknown> is "
10919 #: ../src/guestfs-actions.pod:2761
10920 msgid "(Added in 1.7.9)"
10924 #: ../src/guestfs-actions.pod:2763
10925 msgid "guestfs_inspect_get_major_version"
10929 #: ../src/guestfs-actions.pod:2765
10933 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10934 " const char *root);\n"
10939 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1901
10941 "This returns the major version number of the inspected operating system."
10945 #: ../src/guestfs-actions.pod:2775 ../fish/guestfish-actions.pod:1904
10947 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10948 "popular public names used by the operating system. Notably the operating "
10949 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10950 "1). You can find out the real versions corresponding to releases of Windows "
10951 "by consulting Wikipedia or MSDN."
10955 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2802
10956 #: ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1925
10957 msgid "If the version could not be determined, then C<0> is returned."
10961 #: ../src/guestfs-actions.pod:2790
10962 msgid "guestfs_inspect_get_minor_version"
10966 #: ../src/guestfs-actions.pod:2792
10970 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10971 " const char *root);\n"
10976 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1922
10978 "This returns the minor version number of the inspected operating system."
10982 #: ../src/guestfs-actions.pod:2804
10984 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10985 "C<guestfs_inspect_get_major_version>."
10989 #: ../src/guestfs-actions.pod:2811
10990 msgid "guestfs_inspect_get_mountpoints"
10994 #: ../src/guestfs-actions.pod:2813
10998 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10999 " const char *root);\n"
11004 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1937
11006 "This returns a hash of where we think the filesystems associated with this "
11007 "operating system should be mounted. Callers should note that this is at "
11008 "best an educated guess made by reading configuration files such as C</etc/"
11009 "fstab>. I<In particular note> that this may return filesystems which are "
11010 "non-existent or not mountable and callers should be prepared to handle or "
11011 "ignore failures if they try to mount them."
11015 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1946
11017 "Each element in the returned hashtable has a key which is the path of the "
11018 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11019 "mounted there (eg. C</dev/sda1>)."
11023 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1951
11025 "Non-mounted devices such as swap devices are I<not> returned in this list."
11029 #: ../src/guestfs-actions.pod:2837
11031 "For operating systems like Windows which still use drive letters, this call "
11032 "will only return an entry for the first drive \"mounted on\" C</>. For "
11033 "information about the mapping of drive letters to partitions, see "
11034 "C<guestfs_inspect_get_drive_mappings>."
11038 #: ../src/guestfs-actions.pod:2843
11040 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11041 "C<guestfs_inspect_get_filesystems>."
11045 #: ../src/guestfs-actions.pod:2854
11046 msgid "guestfs_inspect_get_package_format"
11050 #: ../src/guestfs-actions.pod:2856
11054 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11055 " const char *root);\n"
11060 #: ../src/guestfs-actions.pod:2863
11062 "This function and C<guestfs_inspect_get_package_management> return the "
11063 "package format and package management tool used by the inspected operating "
11064 "system. For example for Fedora these functions would return C<rpm> (package "
11065 "format) and C<yum> (package management)."
11069 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1976
11071 "This returns the string C<unknown> if we could not determine the package "
11072 "format I<or> if the operating system does not have a real packaging system "
11077 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1980
11079 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11080 "Future versions of libguestfs may return other strings."
11084 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:2912
11085 msgid "(Added in 1.7.5)"
11089 #: ../src/guestfs-actions.pod:2883
11090 msgid "guestfs_inspect_get_package_management"
11094 #: ../src/guestfs-actions.pod:2885
11098 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11099 " const char *root);\n"
11104 #: ../src/guestfs-actions.pod:2892
11106 "C<guestfs_inspect_get_package_format> and this function return the package "
11107 "format and package management tool used by the inspected operating system. "
11108 "For example for Fedora these functions would return C<rpm> (package format) "
11109 "and C<yum> (package management)."
11113 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1998
11115 "This returns the string C<unknown> if we could not determine the package "
11116 "management tool I<or> if the operating system does not have a real packaging "
11117 "system (eg. Windows)."
11121 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2002
11123 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11124 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11125 "libguestfs may return other strings."
11129 #: ../src/guestfs-actions.pod:2914
11130 msgid "guestfs_inspect_get_product_name"
11134 #: ../src/guestfs-actions.pod:2916
11138 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11139 " const char *root);\n"
11144 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2016
11146 "This returns the product name of the inspected operating system. The "
11147 "product name is generally some freeform string which can be displayed to the "
11148 "user, but should not be parsed by programs."
11152 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2021
11154 "If the product name could not be determined, then the string C<unknown> is "
11159 #: ../src/guestfs-actions.pod:2938
11160 msgid "guestfs_inspect_get_product_variant"
11164 #: ../src/guestfs-actions.pod:2940
11168 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11169 " const char *root);\n"
11174 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2033
11176 #| msgid "This is an installed operating system."
11177 msgid "This returns the product variant of the inspected operating system."
11178 msgstr "Це встановлена операційна система."
11181 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2036
11183 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11184 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11185 "is usually a string such as C<Client> or C<Server> (other values are "
11186 "possible). This can be used to distinguish consumer and enterprise versions "
11187 "of Windows that have the same version number (for example, Windows 7 and "
11188 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11189 "the latter is C<Server>)."
11193 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2045
11195 "For enterprise Linux guests, in future we intend this to return the product "
11196 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11197 "implemented at present."
11201 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2049
11203 "If the product variant could not be determined, then the string C<unknown> "
11208 #: ../src/guestfs-actions.pod:2966
11210 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11211 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11215 #: ../src/guestfs-actions.pod:2973
11216 msgid "guestfs_inspect_get_roots"
11220 #: ../src/guestfs-actions.pod:2975
11224 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11229 #: ../src/guestfs-actions.pod:2978
11231 "This function is a convenient way to get the list of root devices, as "
11232 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11233 "the whole inspection process."
11237 #: ../src/guestfs-actions.pod:2982
11239 "This returns an empty list if either no root devices were found or the "
11240 "caller has not called C<guestfs_inspect_os>."
11244 #: ../src/guestfs-actions.pod:2991
11245 msgid "(Added in 1.7.3)"
11249 #: ../src/guestfs-actions.pod:2993
11250 msgid "guestfs_inspect_get_type"
11254 #: ../src/guestfs-actions.pod:2995
11258 " guestfs_inspect_get_type (guestfs_h *g,\n"
11259 " const char *root);\n"
11264 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2076
11266 "This returns the type of the inspected operating system. Currently defined "
11271 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2081
11276 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2083
11277 msgid "Any Linux-based operating system."
11281 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2087
11282 msgid "Any Microsoft Windows operating system."
11286 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2089
11287 msgid "\"freebsd\""
11288 msgstr "\"freebsd\""
11291 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2091
11296 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2095
11297 msgid "The operating system type could not be determined."
11301 #: ../src/guestfs-actions.pod:3035
11302 msgid "guestfs_inspect_get_windows_current_control_set"
11306 #: ../src/guestfs-actions.pod:3037
11310 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11311 " const char *root);\n"
11316 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
11318 "This returns the Windows CurrentControlSet of the inspected guest. The "
11319 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11323 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2114
11325 "This call assumes that the guest is Windows and that the Registry could be "
11326 "examined by inspection. If this is not the case then an error is returned."
11330 #: ../src/guestfs-actions.pod:3056
11331 msgid "guestfs_inspect_get_windows_systemroot"
11335 #: ../src/guestfs-actions.pod:3058
11339 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11340 " const char *root);\n"
11345 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2127
11347 "This returns the Windows systemroot of the inspected guest. The systemroot "
11348 "is a directory path such as C</WINDOWS>."
11352 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
11354 "This call assumes that the guest is Windows and that the systemroot could be "
11355 "determined by inspection. If this is not the case then an error is returned."
11359 #: ../src/guestfs-actions.pod:3077
11360 msgid "(Added in 1.5.25)"
11364 #: ../src/guestfs-actions.pod:3079
11365 msgid "guestfs_inspect_is_live"
11369 #: ../src/guestfs-actions.pod:3081
11373 " guestfs_inspect_is_live (guestfs_h *g,\n"
11374 " const char *root);\n"
11379 #: ../src/guestfs-actions.pod:3088
11381 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11382 "disk), then this returns true if a live image was detected on the disk."
11386 #: ../src/guestfs-actions.pod:3096
11387 msgid "guestfs_inspect_is_multipart"
11391 #: ../src/guestfs-actions.pod:3098
11395 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11396 " const char *root);\n"
11401 #: ../src/guestfs-actions.pod:3105
11403 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11404 "disk), then this returns true if the disk is part of a set."
11408 #: ../src/guestfs-actions.pod:3113
11409 msgid "guestfs_inspect_is_netinst"
11413 #: ../src/guestfs-actions.pod:3115
11417 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11418 " const char *root);\n"
11423 #: ../src/guestfs-actions.pod:3122
11425 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11426 "disk), then this returns true if the disk is a network installer, ie. not a "
11427 "self-contained install CD but one which is likely to require network access "
11428 "to complete the install."
11432 #: ../src/guestfs-actions.pod:3132
11433 msgid "guestfs_inspect_list_applications"
11437 #: ../src/guestfs-actions.pod:3134
11440 " struct guestfs_application_list *\n"
11441 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11442 " const char *root);\n"
11447 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2184
11448 msgid "Return the list of applications installed in the operating system."
11452 #: ../src/guestfs-actions.pod:3143
11454 "I<Note:> This call works differently from other parts of the inspection "
11455 "API. You have to call C<guestfs_inspect_os>, then "
11456 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11457 "this. Listing applications is a significantly more difficult operation "
11458 "which requires access to the full filesystem. Also note that unlike the "
11459 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11460 "the libguestfs handle, this call actually reads parts of the mounted "
11461 "filesystems during the call."
11465 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2196
11467 "This returns an empty list if the inspection code was not able to determine "
11468 "the list of applications."
11472 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2199
11473 msgid "The application structure contains the following fields:"
11477 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2203
11478 msgid "C<app_name>"
11479 msgstr "C<app_name>"
11482 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2205
11484 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11485 "guests, this is the package name."
11489 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2208
11490 msgid "C<app_display_name>"
11491 msgstr "C<app_display_name>"
11494 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2210
11496 "The display name of the application, sometimes localized to the install "
11497 "language of the guest operating system."
11501 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2213
11503 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11504 "to display something can use C<app_name> instead."
11508 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2216
11509 msgid "C<app_epoch>"
11510 msgstr "C<app_epoch>"
11513 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2218
11515 "For package managers which use epochs, this contains the epoch of the "
11516 "package (an integer). If unavailable, this is returned as C<0>."
11520 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2221
11521 msgid "C<app_version>"
11522 msgstr "C<app_version>"
11525 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2223
11527 "The version string of the application or package. If unavailable this is "
11528 "returned as an empty string C<\"\">."
11532 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2226
11533 msgid "C<app_release>"
11534 msgstr "C<app_release>"
11537 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2228
11539 "The release string of the application or package, for package managers that "
11540 "use this. If unavailable this is returned as an empty string C<\"\">."
11544 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2232
11545 msgid "C<app_install_path>"
11546 msgstr "C<app_install_path>"
11549 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2234
11551 "The installation path of the application (on operating systems such as "
11552 "Windows which use installation paths). This path is in the format used by "
11553 "the guest operating system, it is not a libguestfs path."
11557 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2239
11558 msgid "If unavailable this is returned as an empty string C<\"\">."
11562 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2241
11563 msgid "C<app_trans_path>"
11564 msgstr "C<app_trans_path>"
11567 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2243
11569 "The install path translated into a libguestfs path. If unavailable this is "
11570 "returned as an empty string C<\"\">."
11574 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2246
11575 msgid "C<app_publisher>"
11576 msgstr "C<app_publisher>"
11579 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2248
11581 "The name of the publisher of the application, for package managers that use "
11582 "this. If unavailable this is returned as an empty string C<\"\">."
11586 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2252
11588 msgstr "C<app_url>"
11591 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2254
11593 "The URL (eg. upstream URL) of the application. If unavailable this is "
11594 "returned as an empty string C<\"\">."
11598 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2257
11599 msgid "C<app_source_package>"
11603 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2259
11605 "For packaging systems which support this, the name of the source package. "
11606 "If unavailable this is returned as an empty string C<\"\">."
11610 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2262
11611 msgid "C<app_summary>"
11615 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2264
11617 "A short (usually one line) description of the application or package. If "
11618 "unavailable this is returned as an empty string C<\"\">."
11622 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2267
11623 msgid "C<app_description>"
11627 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2269
11629 "A longer description of the application or package. If unavailable this is "
11630 "returned as an empty string C<\"\">."
11634 #: ../src/guestfs-actions.pod:3233
11636 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11637 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11642 #: ../src/guestfs-actions.pod:3237
11643 msgid "(Added in 1.7.8)"
11647 #: ../src/guestfs-actions.pod:3239
11648 msgid "guestfs_inspect_os"
11652 #: ../src/guestfs-actions.pod:3241
11656 " guestfs_inspect_os (guestfs_h *g);\n"
11661 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2280
11663 "This function uses other libguestfs functions and certain heuristics to "
11664 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11665 "for operating systems."
11669 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2284
11670 msgid "The list returned is empty if no operating systems were found."
11674 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2286
11676 "If one operating system was found, then this returns a list with a single "
11677 "element, which is the name of the root filesystem of this operating system. "
11678 "It is also possible for this function to return a list containing more than "
11679 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11680 "element being the root filesystem of one of the operating systems."
11684 #: ../src/guestfs-actions.pod:3257
11686 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11687 "functions in order to query further information about each operating system, "
11688 "such as the name and version."
11692 #: ../src/guestfs-actions.pod:3262
11694 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11695 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11696 "the contents. This should be called with no disks currently mounted. The "
11697 "function may also use Augeas, so any existing Augeas handle will be closed."
11701 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2304
11703 "This function cannot decrypt encrypted disks. The caller must do that first "
11704 "(supplying the necessary keys) if the disk is encrypted."
11708 #: ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3564
11709 #: ../src/guestfs-actions.pod:3626
11710 msgid "See also C<guestfs_list_filesystems>."
11714 #: ../src/guestfs-actions.pod:3282
11715 msgid "guestfs_is_blockdev"
11719 #: ../src/guestfs-actions.pod:3284
11723 " guestfs_is_blockdev (guestfs_h *g,\n"
11724 " const char *path);\n"
11729 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2316
11731 "This returns C<true> if and only if there is a block device with the given "
11736 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320
11737 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3365
11738 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3437
11739 #: ../src/guestfs-actions.pod:3452
11740 msgid "See also C<guestfs_stat>."
11744 #: ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324
11745 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3441
11746 #: ../src/guestfs-actions.pod:3456
11747 msgid "(Added in 1.5.10)"
11751 #: ../src/guestfs-actions.pod:3297
11752 msgid "guestfs_is_busy"
11756 #: ../src/guestfs-actions.pod:3299
11760 " guestfs_is_busy (guestfs_h *g);\n"
11765 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2325
11767 "This returns true iff this handle is busy processing a command (in the "
11772 #: ../src/guestfs-actions.pod:3311
11773 msgid "guestfs_is_chardev"
11777 #: ../src/guestfs-actions.pod:3313
11781 " guestfs_is_chardev (guestfs_h *g,\n"
11782 " const char *path);\n"
11787 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2334
11789 "This returns C<true> if and only if there is a character device with the "
11790 "given C<path> name."
11794 #: ../src/guestfs-actions.pod:3326
11795 msgid "guestfs_is_config"
11799 #: ../src/guestfs-actions.pod:3328
11803 " guestfs_is_config (guestfs_h *g);\n"
11808 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2343
11810 "This returns true iff this handle is being configured (in the C<CONFIG> "
11815 #: ../src/guestfs-actions.pod:3340
11816 msgid "guestfs_is_dir"
11820 #: ../src/guestfs-actions.pod:3342
11824 " guestfs_is_dir (guestfs_h *g,\n"
11825 " const char *path);\n"
11830 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2352
11832 "This returns C<true> if and only if there is a directory with the given "
11833 "C<path> name. Note that it returns false for other objects like files."
11837 #: ../src/guestfs-actions.pod:3356
11838 msgid "guestfs_is_fifo"
11842 #: ../src/guestfs-actions.pod:3358
11846 " guestfs_is_fifo (guestfs_h *g,\n"
11847 " const char *path);\n"
11852 #: ../src/guestfs-actions.pod:3362 ../fish/guestfish-actions.pod:2362
11854 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11855 "given C<path> name."
11859 #: ../src/guestfs-actions.pod:3371
11860 msgid "guestfs_is_file"
11864 #: ../src/guestfs-actions.pod:3373
11868 " guestfs_is_file (guestfs_h *g,\n"
11869 " const char *path);\n"
11874 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2371
11876 "This returns C<true> if and only if there is a regular file with the given "
11877 "C<path> name. Note that it returns false for other objects like directories."
11881 #: ../src/guestfs-actions.pod:3387
11882 msgid "guestfs_is_launching"
11886 #: ../src/guestfs-actions.pod:3389
11890 " guestfs_is_launching (guestfs_h *g);\n"
11895 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2381
11897 "This returns true iff this handle is launching the subprocess (in the "
11898 "C<LAUNCHING> state)."
11902 #: ../src/guestfs-actions.pod:3401
11903 msgid "guestfs_is_lv"
11907 #: ../src/guestfs-actions.pod:3403
11911 " guestfs_is_lv (guestfs_h *g,\n"
11912 " const char *device);\n"
11917 #: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2390
11919 "This command tests whether C<device> is a logical volume, and returns true "
11920 "iff this is the case."
11924 #: ../src/guestfs-actions.pod:3414
11925 msgid "guestfs_is_ready"
11929 #: ../src/guestfs-actions.pod:3416
11933 " guestfs_is_ready (guestfs_h *g);\n"
11938 #: ../src/guestfs-actions.pod:3419 ../fish/guestfish-actions.pod:2397
11940 "This returns true iff this handle is ready to accept commands (in the "
11945 #: ../src/guestfs-actions.pod:3428
11946 msgid "guestfs_is_socket"
11950 #: ../src/guestfs-actions.pod:3430
11954 " guestfs_is_socket (guestfs_h *g,\n"
11955 " const char *path);\n"
11960 #: ../src/guestfs-actions.pod:3434 ../fish/guestfish-actions.pod:2406
11962 "This returns C<true> if and only if there is a Unix domain socket with the "
11963 "given C<path> name."
11967 #: ../src/guestfs-actions.pod:3443
11968 msgid "guestfs_is_symlink"
11972 #: ../src/guestfs-actions.pod:3445
11976 " guestfs_is_symlink (guestfs_h *g,\n"
11977 " const char *path);\n"
11982 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2415
11984 "This returns C<true> if and only if there is a symbolic link with the given "
11989 #: ../src/guestfs-actions.pod:3458
11990 msgid "guestfs_kill_subprocess"
11994 #: ../src/guestfs-actions.pod:3460
11998 " guestfs_kill_subprocess (guestfs_h *g);\n"
12003 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2424
12004 msgid "This kills the qemu subprocess. You should never need to call this."
12008 #: ../src/guestfs-actions.pod:3469
12009 msgid "guestfs_launch"
12013 #: ../src/guestfs-actions.pod:3471
12017 " guestfs_launch (guestfs_h *g);\n"
12022 #: ../src/guestfs-actions.pod:3474 ../fish/guestfish-actions.pod:2432
12024 "Internally libguestfs is implemented by running a virtual machine using "
12029 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2435
12031 "You should call this after configuring the handle (eg. adding drives) but "
12032 "before performing any actions."
12036 #: ../src/guestfs-actions.pod:3489
12037 msgid "guestfs_lchown"
12041 #: ../src/guestfs-actions.pod:3491
12045 " guestfs_lchown (guestfs_h *g,\n"
12048 " const char *path);\n"
12053 #: ../src/guestfs-actions.pod:3497
12055 "Change the file owner to C<owner> and group to C<group>. This is like "
12056 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12057 "changed, not the target."
12061 #: ../src/guestfs-actions.pod:3509
12062 msgid "guestfs_lgetxattr"
12066 #: ../src/guestfs-actions.pod:3511
12070 " guestfs_lgetxattr (guestfs_h *g,\n"
12071 " const char *path,\n"
12072 " const char *name,\n"
12073 " size_t *size_r);\n"
12078 #: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2454
12080 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12081 "is a symlink, then this call returns an extended attribute from the symlink."
12085 #: ../src/guestfs-actions.pod:3531
12086 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12090 #: ../src/guestfs-actions.pod:3539
12091 msgid "guestfs_lgetxattrs"
12095 #: ../src/guestfs-actions.pod:3541
12098 " struct guestfs_xattr_list *\n"
12099 " guestfs_lgetxattrs (guestfs_h *g,\n"
12100 " const char *path);\n"
12105 #: ../src/guestfs-actions.pod:3545
12107 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12108 "then it returns the extended attributes of the link itself."
12112 #: ../src/guestfs-actions.pod:3555
12113 msgid "guestfs_list_devices"
12117 #: ../src/guestfs-actions.pod:3557
12121 " guestfs_list_devices (guestfs_h *g);\n"
12126 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2482
12127 msgid "List all the block devices."
12131 #: ../src/guestfs-actions.pod:3562 ../fish/guestfish-actions.pod:2484
12132 msgid "The full block device names are returned, eg. C</dev/sda>."
12136 #: ../src/guestfs-actions.pod:3572
12137 msgid "guestfs_list_filesystems"
12141 #: ../src/guestfs-actions.pod:3574
12145 " guestfs_list_filesystems (guestfs_h *g);\n"
12150 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2492
12152 "This inspection command looks for filesystems on partitions, block devices "
12153 "and logical volumes, returning a list of devices containing filesystems and "
12158 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2496
12160 "The return value is a hash, where the keys are the devices containing "
12161 "filesystems, and the values are the filesystem types. For example:"
12165 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2500
12168 " \"/dev/sda1\" => \"ntfs\"\n"
12169 " \"/dev/sda2\" => \"ext2\"\n"
12170 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12171 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12176 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2505
12178 "The value can have the special value \"unknown\", meaning the content of the "
12179 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12183 #: ../src/guestfs-actions.pod:3594
12185 "This command runs other libguestfs commands, which might include "
12186 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12187 "soon after launch and only when nothing is mounted."
12191 #: ../src/guestfs-actions.pod:3598
12193 "Not all of the filesystems returned will be mountable. In particular, swap "
12194 "partitions are returned in the list. Also this command does not check that "
12195 "each filesystem found is valid and mountable, and some filesystems might be "
12196 "mountable but require special options. Filesystems may not all belong to a "
12197 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12201 #: ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:5217
12202 msgid "(Added in 1.5.15)"
12206 #: ../src/guestfs-actions.pod:3614
12207 msgid "guestfs_list_partitions"
12211 #: ../src/guestfs-actions.pod:3616
12215 " guestfs_list_partitions (guestfs_h *g);\n"
12220 #: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2525
12221 msgid "List all the partitions detected on all block devices."
12225 #: ../src/guestfs-actions.pod:3621 ../fish/guestfish-actions.pod:2527
12226 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12230 #: ../src/guestfs-actions.pod:3623
12232 "This does not return logical volumes. For that you will need to call "
12237 #: ../src/guestfs-actions.pod:3634
12242 #: ../src/guestfs-actions.pod:3636
12246 " guestfs_ll (guestfs_h *g,\n"
12247 " const char *directory);\n"
12252 #: ../src/guestfs-actions.pod:3640 ../fish/guestfish-actions.pod:2538
12254 "List the files in C<directory> (relative to the root directory, there is no "
12255 "cwd) in the format of 'ls -la'."
12259 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2541
12261 "This command is mostly useful for interactive sessions. It is I<not> "
12262 "intended that you try to parse the output string."
12266 #: ../src/guestfs-actions.pod:3651
12271 #: ../src/guestfs-actions.pod:3653
12275 " guestfs_ln (guestfs_h *g,\n"
12276 " const char *target,\n"
12277 " const char *linkname);\n"
12282 #: ../src/guestfs-actions.pod:3658 ../fish/guestfish-actions.pod:2548
12283 msgid "This command creates a hard link using the C<ln> command."
12287 #: ../src/guestfs-actions.pod:3664
12288 msgid "guestfs_ln_f"
12292 #: ../src/guestfs-actions.pod:3666
12296 " guestfs_ln_f (guestfs_h *g,\n"
12297 " const char *target,\n"
12298 " const char *linkname);\n"
12303 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2554
12305 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12306 "option removes the link (C<linkname>) if it exists already."
12310 #: ../src/guestfs-actions.pod:3678
12311 msgid "guestfs_ln_s"
12315 #: ../src/guestfs-actions.pod:3680
12319 " guestfs_ln_s (guestfs_h *g,\n"
12320 " const char *target,\n"
12321 " const char *linkname);\n"
12326 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2561
12327 msgid "This command creates a symbolic link using the C<ln -s> command."
12331 #: ../src/guestfs-actions.pod:3691
12332 msgid "guestfs_ln_sf"
12336 #: ../src/guestfs-actions.pod:3693
12340 " guestfs_ln_sf (guestfs_h *g,\n"
12341 " const char *target,\n"
12342 " const char *linkname);\n"
12347 #: ../src/guestfs-actions.pod:3698 ../fish/guestfish-actions.pod:2567
12349 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12350 "option removes the link (C<linkname>) if it exists already."
12354 #: ../src/guestfs-actions.pod:3705
12355 msgid "guestfs_lremovexattr"
12359 #: ../src/guestfs-actions.pod:3707
12363 " guestfs_lremovexattr (guestfs_h *g,\n"
12364 " const char *xattr,\n"
12365 " const char *path);\n"
12370 #: ../src/guestfs-actions.pod:3712
12372 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12373 "link, then it removes an extended attribute of the link itself."
12377 #: ../src/guestfs-actions.pod:3720
12382 #: ../src/guestfs-actions.pod:3722
12386 " guestfs_ls (guestfs_h *g,\n"
12387 " const char *directory);\n"
12392 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2582
12394 "List the files in C<directory> (relative to the root directory, there is no "
12395 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12399 #: ../src/guestfs-actions.pod:3730
12401 "This command is mostly useful for interactive sessions. Programs should "
12402 "probably use C<guestfs_readdir> instead."
12406 #: ../src/guestfs-actions.pod:3739
12407 msgid "guestfs_lsetxattr"
12411 #: ../src/guestfs-actions.pod:3741
12415 " guestfs_lsetxattr (guestfs_h *g,\n"
12416 " const char *xattr,\n"
12417 " const char *val,\n"
12419 " const char *path);\n"
12424 #: ../src/guestfs-actions.pod:3748
12426 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12427 "then it sets an extended attribute of the link itself."
12431 #: ../src/guestfs-actions.pod:3756
12432 msgid "guestfs_lstat"
12436 #: ../src/guestfs-actions.pod:3758
12439 " struct guestfs_stat *\n"
12440 " guestfs_lstat (guestfs_h *g,\n"
12441 " const char *path);\n"
12446 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:6320
12447 #: ../fish/guestfish-actions.pod:2601 ../fish/guestfish-actions.pod:4270
12448 msgid "Returns file information for the given C<path>."
12452 #: ../src/guestfs-actions.pod:3764
12454 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12455 "link, then the link is stat-ed, not the file it refers to."
12459 #: ../src/guestfs-actions.pod:3768 ../fish/guestfish-actions.pod:2607
12460 msgid "This is the same as the C<lstat(2)> system call."
12464 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6324
12466 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12467 "error. I<The caller must call C<guestfs_free_stat> after use>."
12471 #: ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:6328
12472 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6727
12473 msgid "(Added in 0.9.2)"
12477 #: ../src/guestfs-actions.pod:3776
12478 msgid "guestfs_lstatlist"
12482 #: ../src/guestfs-actions.pod:3778
12485 " struct guestfs_stat_list *\n"
12486 " guestfs_lstatlist (guestfs_h *g,\n"
12487 " const char *path,\n"
12488 " char *const *names);\n"
12493 #: ../src/guestfs-actions.pod:3783
12495 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12496 "files, where all files are in the directory C<path>. C<names> is the list "
12497 "of files from this directory."
12501 #: ../src/guestfs-actions.pod:3787 ../fish/guestfish-actions.pod:2617
12503 "On return you get a list of stat structs, with a one-to-one correspondence "
12504 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12505 "then the C<ino> field of that structure is set to C<-1>."
12509 #: ../src/guestfs-actions.pod:3792
12511 "This call is intended for programs that want to efficiently list a directory "
12512 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12513 "for a similarly efficient call for getting extended attributes. Very long "
12514 "directory listings might cause the protocol message size to be exceeded, "
12515 "causing this call to fail. The caller must split up such requests into "
12516 "smaller groups of names."
12520 #: ../src/guestfs-actions.pod:3800
12522 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12523 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12527 #: ../src/guestfs-actions.pod:3806
12528 msgid "guestfs_luks_add_key"
12532 #: ../src/guestfs-actions.pod:3808
12536 " guestfs_luks_add_key (guestfs_h *g,\n"
12537 " const char *device,\n"
12538 " const char *key,\n"
12539 " const char *newkey,\n"
12545 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2634
12547 "This command adds a new key on LUKS device C<device>. C<key> is any "
12548 "existing key, and is used to access the device. C<newkey> is the new key to "
12549 "add. C<keyslot> is the key slot that will be replaced."
12553 #: ../src/guestfs-actions.pod:3820
12555 "Note that if C<keyslot> already contains a key, then this command will "
12556 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12560 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866
12561 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
12562 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3960
12564 "This function takes a key or passphrase parameter which could contain "
12565 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12570 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3870
12571 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3913
12572 msgid "(Added in 1.5.2)"
12576 #: ../src/guestfs-actions.pod:3832
12577 msgid "guestfs_luks_close"
12581 #: ../src/guestfs-actions.pod:3834
12585 " guestfs_luks_close (guestfs_h *g,\n"
12586 " const char *device);\n"
12591 #: ../src/guestfs-actions.pod:3838
12593 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12594 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12595 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12596 "underlying block device."
12600 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3945
12601 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:4014
12602 #: ../src/guestfs-actions.pod:4062
12603 msgid "(Added in 1.5.1)"
12607 #: ../src/guestfs-actions.pod:3848
12608 msgid "guestfs_luks_format"
12612 #: ../src/guestfs-actions.pod:3850
12616 " guestfs_luks_format (guestfs_h *g,\n"
12617 " const char *device,\n"
12618 " const char *key,\n"
12624 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2660
12626 "This command erases existing data on C<device> and formats the device as a "
12627 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12628 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12632 #: ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3886
12633 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4968
12634 #: ../src/guestfs-actions.pod:5748 ../src/guestfs-actions.pod:6155
12635 #: ../src/guestfs-actions.pod:6178 ../src/guestfs-actions.pod:6204
12636 #: ../src/guestfs-actions.pod:7364 ../fish/guestfish-actions.pod:2668
12637 #: ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2765
12638 #: ../fish/guestfish-actions.pod:3339 ../fish/guestfish-actions.pod:3859
12639 #: ../fish/guestfish-actions.pod:4169 ../fish/guestfish-actions.pod:4185
12640 #: ../fish/guestfish-actions.pod:4200 ../fish/guestfish-actions.pod:4915
12642 "B<This command is dangerous. Without careful use you can easily destroy all "
12647 #: ../src/guestfs-actions.pod:3872
12648 msgid "guestfs_luks_format_cipher"
12652 #: ../src/guestfs-actions.pod:3874
12656 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12657 " const char *device,\n"
12658 " const char *key,\n"
12660 " const char *cipher);\n"
12665 #: ../src/guestfs-actions.pod:3881
12667 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12668 "set the C<cipher> used."
12672 #: ../src/guestfs-actions.pod:3895
12673 msgid "guestfs_luks_kill_slot"
12677 #: ../src/guestfs-actions.pod:3897
12681 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12682 " const char *device,\n"
12683 " const char *key,\n"
12689 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2688
12691 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12692 "device C<device>. C<key> must be one of the I<other> keys."
12696 #: ../src/guestfs-actions.pod:3915
12697 msgid "guestfs_luks_open"
12701 #: ../src/guestfs-actions.pod:3917
12705 " guestfs_luks_open (guestfs_h *g,\n"
12706 " const char *device,\n"
12707 " const char *key,\n"
12708 " const char *mapname);\n"
12713 #: ../src/guestfs-actions.pod:3923 ../fish/guestfish-actions.pod:2699
12715 "This command opens a block device which has been encrypted according to the "
12716 "Linux Unified Key Setup (LUKS) standard."
12720 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2702
12721 msgid "C<device> is the encrypted block device or partition."
12725 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2704
12727 "The caller must supply one of the keys associated with the LUKS block "
12728 "device, in the C<key> parameter."
12732 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2707
12734 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12735 "writes to this block device are decrypted from and encrypted to the "
12736 "underlying C<device> respectively."
12740 #: ../src/guestfs-actions.pod:3935
12742 "If this block device contains LVM volume groups, then calling "
12743 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12748 #: ../src/guestfs-actions.pod:3947
12749 msgid "guestfs_luks_open_ro"
12753 #: ../src/guestfs-actions.pod:3949
12757 " guestfs_luks_open_ro (guestfs_h *g,\n"
12758 " const char *device,\n"
12759 " const char *key,\n"
12760 " const char *mapname);\n"
12765 #: ../src/guestfs-actions.pod:3955
12767 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12772 #: ../src/guestfs-actions.pod:3966
12773 msgid "guestfs_lvcreate"
12777 #: ../src/guestfs-actions.pod:3968
12781 " guestfs_lvcreate (guestfs_h *g,\n"
12782 " const char *logvol,\n"
12783 " const char *volgroup,\n"
12789 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2732
12791 "This creates an LVM logical volume called C<logvol> on the volume group "
12792 "C<volgroup>, with C<size> megabytes."
12796 #: ../src/guestfs-actions.pod:3981
12797 msgid "guestfs_lvm_canonical_lv_name"
12801 #: ../src/guestfs-actions.pod:3983
12805 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12806 " const char *lvname);\n"
12811 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2739
12813 "This converts alternative naming schemes for LVs that you might find to the "
12814 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12819 #: ../src/guestfs-actions.pod:3991 ../fish/guestfish-actions.pod:2743
12821 "This command returns an error if the C<lvname> parameter does not refer to a "
12826 #: ../src/guestfs-actions.pod:3994
12827 msgid "See also C<guestfs_is_lv>."
12831 #: ../src/guestfs-actions.pod:3999
12832 msgid "(Added in 1.5.24)"
12836 #: ../src/guestfs-actions.pod:4001
12837 msgid "guestfs_lvm_clear_filter"
12841 #: ../src/guestfs-actions.pod:4003
12845 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12850 #: ../src/guestfs-actions.pod:4006
12852 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12853 "see every block device."
12857 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4051
12858 #: ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2786
12860 "This command also clears the LVM cache and performs a volume group scan."
12864 #: ../src/guestfs-actions.pod:4016
12865 msgid "guestfs_lvm_remove_all"
12869 #: ../src/guestfs-actions.pod:4018
12873 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12878 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2762
12880 "This command removes all LVM logical volumes, volume groups and physical "
12885 #: ../src/guestfs-actions.pod:4031
12886 msgid "guestfs_lvm_set_filter"
12890 #: ../src/guestfs-actions.pod:4033
12894 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12895 " char *const *devices);\n"
12900 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2772
12902 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12903 "block devices in the list C<devices>, and will ignore all other attached "
12908 #: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2776
12910 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12911 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12912 "there are two types of duplication possible: either cloned PVs/VGs which "
12913 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12914 "same name. In normal operation you cannot create this situation, but you "
12915 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12916 "inside the LVM metadata."
12920 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2789
12921 msgid "You can filter whole block devices or individual partitions."
12925 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2791
12927 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12928 "filesystem), even if you are not filtering out that VG."
12932 #: ../src/guestfs-actions.pod:4064
12933 msgid "guestfs_lvremove"
12937 #: ../src/guestfs-actions.pod:4066
12941 " guestfs_lvremove (guestfs_h *g,\n"
12942 " const char *device);\n"
12947 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2799
12949 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12950 "LV, such as C</dev/VG/LV>."
12954 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2802
12956 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12961 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:5314
12962 #: ../src/guestfs-actions.pod:7103
12963 msgid "(Added in 1.0.13)"
12967 #: ../src/guestfs-actions.pod:4080
12968 msgid "guestfs_lvrename"
12972 #: ../src/guestfs-actions.pod:4082
12976 " guestfs_lvrename (guestfs_h *g,\n"
12977 " const char *logvol,\n"
12978 " const char *newlogvol);\n"
12983 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2809
12984 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12988 #: ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:7116
12989 msgid "(Added in 1.0.83)"
12993 #: ../src/guestfs-actions.pod:4093
12994 msgid "guestfs_lvresize"
12998 #: ../src/guestfs-actions.pod:4095
13002 " guestfs_lvresize (guestfs_h *g,\n"
13003 " const char *device,\n"
13009 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2815
13011 "This resizes (expands or shrinks) an existing LVM logical volume to "
13012 "C<mbytes>. When reducing, data in the reduced part is lost."
13016 #: ../src/guestfs-actions.pod:4108
13017 msgid "guestfs_lvresize_free"
13021 #: ../src/guestfs-actions.pod:4110
13025 " guestfs_lvresize_free (guestfs_h *g,\n"
13026 " const char *lv,\n"
13032 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2823
13034 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13035 "remaining free space in the volume group. Commonly you would call this with "
13036 "pc = 100 which expands the logical volume as much as possible, using all "
13037 "remaining free space in the volume group."
13041 #: ../src/guestfs-actions.pod:4123
13042 msgid "(Added in 1.3.3)"
13046 #: ../src/guestfs-actions.pod:4125
13047 msgid "guestfs_lvs"
13051 #: ../src/guestfs-actions.pod:4127
13055 " guestfs_lvs (guestfs_h *g);\n"
13060 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2833
13062 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13067 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2836
13069 "This returns a list of the logical volume device names (eg. C</dev/"
13070 "VolGroup00/LogVol00>)."
13074 #: ../src/guestfs-actions.pod:4136
13075 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13079 #: ../src/guestfs-actions.pod:4144
13080 msgid "guestfs_lvs_full"
13084 #: ../src/guestfs-actions.pod:4146
13087 " struct guestfs_lvm_lv_list *\n"
13088 " guestfs_lvs_full (guestfs_h *g);\n"
13093 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2845
13095 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13096 "(8)> command. The \"full\" version includes all fields."
13100 #: ../src/guestfs-actions.pod:4152
13102 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13103 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13107 #: ../src/guestfs-actions.pod:4158
13108 msgid "guestfs_lvuuid"
13112 #: ../src/guestfs-actions.pod:4160
13116 " guestfs_lvuuid (guestfs_h *g,\n"
13117 " const char *device);\n"
13122 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2852
13123 msgid "This command returns the UUID of the LVM LV C<device>."
13127 #: ../src/guestfs-actions.pod:4171
13128 msgid "guestfs_lxattrlist"
13132 #: ../src/guestfs-actions.pod:4173
13135 " struct guestfs_xattr_list *\n"
13136 " guestfs_lxattrlist (guestfs_h *g,\n"
13137 " const char *path,\n"
13138 " char *const *names);\n"
13143 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2858
13145 "This call allows you to get the extended attributes of multiple files, where "
13146 "all files are in the directory C<path>. C<names> is the list of files from "
13151 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2862
13153 "On return you get a flat list of xattr structs which must be interpreted "
13154 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13155 "C<attrval> in this struct is zero-length to indicate there was an error "
13156 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13157 "number (the number of following attributes for this file, which could be C<"
13158 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13159 "for the first named file. This repeats for the second and subsequent files."
13163 #: ../src/guestfs-actions.pod:4192
13165 "This call is intended for programs that want to efficiently list a directory "
13166 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13167 "a similarly efficient call for getting standard stats. Very long directory "
13168 "listings might cause the protocol message size to be exceeded, causing this "
13169 "call to fail. The caller must split up such requests into smaller groups of "
13174 #: ../src/guestfs-actions.pod:4206
13175 msgid "guestfs_mkdir"
13179 #: ../src/guestfs-actions.pod:4208
13183 " guestfs_mkdir (guestfs_h *g,\n"
13184 " const char *path);\n"
13189 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2884
13190 msgid "Create a directory named C<path>."
13194 #: ../src/guestfs-actions.pod:4218
13195 msgid "guestfs_mkdir_mode"
13199 #: ../src/guestfs-actions.pod:4220
13203 " guestfs_mkdir_mode (guestfs_h *g,\n"
13204 " const char *path,\n"
13210 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2890
13212 "This command creates a directory, setting the initial permissions of the "
13213 "directory to C<mode>."
13217 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2893
13219 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13220 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13225 #: ../src/guestfs-actions.pod:4232
13226 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13230 #: ../src/guestfs-actions.pod:4238
13231 msgid "guestfs_mkdir_p"
13235 #: ../src/guestfs-actions.pod:4240
13239 " guestfs_mkdir_p (guestfs_h *g,\n"
13240 " const char *path);\n"
13245 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2903
13247 "Create a directory named C<path>, creating any parent directories as "
13248 "necessary. This is like the C<mkdir -p> shell command."
13252 #: ../src/guestfs-actions.pod:4251
13253 msgid "guestfs_mkdtemp"
13257 #: ../src/guestfs-actions.pod:4253
13261 " guestfs_mkdtemp (guestfs_h *g,\n"
13262 " const char *template);\n"
13267 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2910
13269 "This command creates a temporary directory. The C<template> parameter "
13270 "should be a full pathname for the temporary directory name with the final "
13271 "six characters being \"XXXXXX\"."
13275 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2915
13277 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13278 "being suitable for Windows filesystems."
13282 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2918
13283 msgid "The name of the temporary directory that was created is returned."
13287 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2921
13288 msgid "The temporary directory is created with mode 0700 and is owned by root."
13292 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2924
13294 "The caller is responsible for deleting the temporary directory and its "
13295 "contents after use."
13299 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2927
13300 msgid "See also: L<mkdtemp(3)>"
13304 #: ../src/guestfs-actions.pod:4281
13305 msgid "guestfs_mke2fs_J"
13309 #: ../src/guestfs-actions.pod:4283
13313 " guestfs_mke2fs_J (guestfs_h *g,\n"
13314 " const char *fstype,\n"
13315 " int blocksize,\n"
13316 " const char *device,\n"
13317 " const char *journal);\n"
13322 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2933
13324 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13325 "C<journal>. It is equivalent to the command:"
13329 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2937
13332 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13337 #: ../src/guestfs-actions.pod:4296
13338 msgid "See also C<guestfs_mke2journal>."
13342 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4318
13343 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4352
13344 #: ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4380
13345 #: ../src/guestfs-actions.pod:4439 ../src/guestfs-actions.pod:4704
13346 msgid "(Added in 1.0.68)"
13350 #: ../src/guestfs-actions.pod:4302
13351 msgid "guestfs_mke2fs_JL"
13355 #: ../src/guestfs-actions.pod:4304
13359 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13360 " const char *fstype,\n"
13361 " int blocksize,\n"
13362 " const char *device,\n"
13363 " const char *label);\n"
13368 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2945
13370 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13371 "the journal labeled C<label>."
13375 #: ../src/guestfs-actions.pod:4314
13376 msgid "See also C<guestfs_mke2journal_L>."
13380 #: ../src/guestfs-actions.pod:4320
13381 msgid "guestfs_mke2fs_JU"
13385 #: ../src/guestfs-actions.pod:4322
13389 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13390 " const char *fstype,\n"
13391 " int blocksize,\n"
13392 " const char *device,\n"
13393 " const char *uuid);\n"
13398 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2954
13400 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13401 "the journal with UUID C<uuid>."
13405 #: ../src/guestfs-actions.pod:4332
13406 msgid "See also C<guestfs_mke2journal_U>."
13410 #: ../src/guestfs-actions.pod:4338
13411 msgid "guestfs_mke2journal"
13415 #: ../src/guestfs-actions.pod:4340
13419 " guestfs_mke2journal (guestfs_h *g,\n"
13420 " int blocksize,\n"
13421 " const char *device);\n"
13426 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2963
13428 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13433 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2966
13436 " mke2fs -O journal_dev -b blocksize device\n"
13441 #: ../src/guestfs-actions.pod:4354
13442 msgid "guestfs_mke2journal_L"
13446 #: ../src/guestfs-actions.pod:4356
13450 " guestfs_mke2journal_L (guestfs_h *g,\n"
13451 " int blocksize,\n"
13452 " const char *label,\n"
13453 " const char *device);\n"
13458 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2972
13459 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13463 #: ../src/guestfs-actions.pod:4368
13464 msgid "guestfs_mke2journal_U"
13468 #: ../src/guestfs-actions.pod:4370
13472 " guestfs_mke2journal_U (guestfs_h *g,\n"
13473 " int blocksize,\n"
13474 " const char *uuid,\n"
13475 " const char *device);\n"
13480 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2978
13481 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13485 #: ../src/guestfs-actions.pod:4382
13486 msgid "guestfs_mkfifo"
13490 #: ../src/guestfs-actions.pod:4384
13494 " guestfs_mkfifo (guestfs_h *g,\n"
13496 " const char *path);\n"
13501 #: ../src/guestfs-actions.pod:4389
13503 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13504 "is just a convenient wrapper around C<guestfs_mknod>."
13508 #: ../src/guestfs-actions.pod:4399
13509 msgid "guestfs_mkfs"
13513 #: ../src/guestfs-actions.pod:4401
13517 " guestfs_mkfs (guestfs_h *g,\n"
13518 " const char *fstype,\n"
13519 " const char *device);\n"
13524 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:2994
13526 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13527 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13531 #: ../src/guestfs-actions.pod:4414
13532 msgid "guestfs_mkfs_b"
13536 #: ../src/guestfs-actions.pod:4416
13540 " guestfs_mkfs_b (guestfs_h *g,\n"
13541 " const char *fstype,\n"
13542 " int blocksize,\n"
13543 " const char *device);\n"
13548 #: ../src/guestfs-actions.pod:4422
13550 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13551 "block size of the resulting filesystem. Supported block sizes depend on the "
13552 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13556 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4470
13557 #: ../fish/guestfish-actions.pod:3007 ../fish/guestfish-actions.pod:3034
13559 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13564 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:3010
13566 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13570 #: ../src/guestfs-actions.pod:4441
13571 msgid "guestfs_mkfs_opts"
13575 #: ../src/guestfs-actions.pod:4443
13579 " guestfs_mkfs_opts (guestfs_h *g,\n"
13580 " const char *fstype,\n"
13581 " const char *device,\n"
13587 #: ../src/guestfs-actions.pod:4454
13590 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13591 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13596 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3021
13598 "This function creates a filesystem on C<device>. The filesystem type is "
13599 "C<fstype>, for example C<ext3>."
13603 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3028
13604 msgid "C<blocksize>"
13608 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3030
13610 "The filesystem block size. Supported block sizes depend on the filesystem "
13611 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13616 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3037
13617 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13621 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3039
13622 msgid "C<features>"
13626 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3041
13627 msgid "This passes the I<-O> parameter to the external mkfs program."
13631 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3043
13633 "For certain filesystem types, this allows extra filesystem features to be "
13634 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13638 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3047
13640 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13645 #: ../src/guestfs-actions.pod:4490
13646 msgid "(Added in 1.7.19)"
13650 #: ../src/guestfs-actions.pod:4492
13651 msgid "guestfs_mkfs_opts_va"
13655 #: ../src/guestfs-actions.pod:4494
13659 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13660 " const char *fstype,\n"
13661 " const char *device,\n"
13662 " va_list args);\n"
13667 #: ../src/guestfs-actions.pod:4500
13668 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13672 #: ../src/guestfs-actions.pod:4504
13673 msgid "guestfs_mkfs_opts_argv"
13677 #: ../src/guestfs-actions.pod:4506
13681 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13682 " const char *fstype,\n"
13683 " const char *device,\n"
13684 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13689 #: ../src/guestfs-actions.pod:4512
13690 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13694 #: ../src/guestfs-actions.pod:4516
13695 msgid "guestfs_mkmountpoint"
13699 #: ../src/guestfs-actions.pod:4518
13703 " guestfs_mkmountpoint (guestfs_h *g,\n"
13704 " const char *exemptpath);\n"
13709 #: ../src/guestfs-actions.pod:4522
13711 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13712 "that can be used to create extra mountpoints before mounting the first "
13717 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3062
13719 "These calls are I<only> necessary in some very limited circumstances, mainly "
13720 "the case where you want to mount a mix of unrelated and/or read-only "
13721 "filesystems together."
13725 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3066
13727 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13728 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13729 "inside that. You can unpack this as follows in guestfish:"
13733 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3071
13736 " add-ro Fedora-11-i686-Live.iso\n"
13738 " mkmountpoint /cd\n"
13739 " mkmountpoint /sqsh\n"
13740 " mkmountpoint /ext3fs\n"
13741 " mount /dev/sda /cd\n"
13742 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13743 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13748 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3080
13749 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13753 #: ../src/guestfs-actions.pod:4546
13755 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13756 "may get unexpected errors if you try to mix these calls. It is safest to "
13757 "manually unmount filesystems and remove mountpoints after use."
13761 #: ../src/guestfs-actions.pod:4550
13763 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13764 "first, so for this to work for manual mountpoints, you must ensure that the "
13765 "innermost mountpoints have the longest pathnames, as in the example code "
13770 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3091
13772 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13776 #: ../src/guestfs-actions.pod:4557
13778 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13779 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13780 "can also trigger these issues."
13784 #: ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4822
13785 #: ../src/guestfs-actions.pod:5732
13786 msgid "(Added in 1.0.62)"
13790 #: ../src/guestfs-actions.pod:4565
13791 msgid "guestfs_mknod"
13795 #: ../src/guestfs-actions.pod:4567
13799 " guestfs_mknod (guestfs_h *g,\n"
13803 " const char *path);\n"
13808 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3101
13810 "This call creates block or character special devices, or named pipes (FIFOs)."
13814 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3104
13816 "The C<mode> parameter should be the mode, using the standard constants. "
13817 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13818 "used when creating block and character special devices."
13822 #: ../src/guestfs-actions.pod:4582
13824 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13825 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13826 "regular file). These constants are available in the standard Linux header "
13827 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13828 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13829 "the appropriate constant for you."
13833 #: ../src/guestfs-actions.pod:4596
13834 msgid "guestfs_mknod_b"
13838 #: ../src/guestfs-actions.pod:4598
13842 " guestfs_mknod_b (guestfs_h *g,\n"
13846 " const char *path);\n"
13851 #: ../src/guestfs-actions.pod:4605
13853 "This call creates a block device node called C<path> with mode C<mode> and "
13854 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13855 "wrapper around C<guestfs_mknod>."
13859 #: ../src/guestfs-actions.pod:4615
13860 msgid "guestfs_mknod_c"
13864 #: ../src/guestfs-actions.pod:4617
13868 " guestfs_mknod_c (guestfs_h *g,\n"
13872 " const char *path);\n"
13877 #: ../src/guestfs-actions.pod:4624
13879 "This call creates a char device node called C<path> with mode C<mode> and "
13880 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13881 "wrapper around C<guestfs_mknod>."
13885 #: ../src/guestfs-actions.pod:4634
13886 msgid "guestfs_mkswap"
13890 #: ../src/guestfs-actions.pod:4636
13894 " guestfs_mkswap (guestfs_h *g,\n"
13895 " const char *device);\n"
13900 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3143
13901 msgid "Create a swap partition on C<device>."
13905 #: ../src/guestfs-actions.pod:4646
13906 msgid "guestfs_mkswap_L"
13910 #: ../src/guestfs-actions.pod:4648
13914 " guestfs_mkswap_L (guestfs_h *g,\n"
13915 " const char *label,\n"
13916 " const char *device);\n"
13921 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3149
13922 msgid "Create a swap partition on C<device> with label C<label>."
13926 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3151
13928 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13929 "sda>), just to a partition. This appears to be a limitation of the kernel "
13934 #: ../src/guestfs-actions.pod:4663
13935 msgid "guestfs_mkswap_U"
13939 #: ../src/guestfs-actions.pod:4665
13943 " guestfs_mkswap_U (guestfs_h *g,\n"
13944 " const char *uuid,\n"
13945 " const char *device);\n"
13950 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3159
13951 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13955 #: ../src/guestfs-actions.pod:4676
13956 msgid "guestfs_mkswap_file"
13960 #: ../src/guestfs-actions.pod:4678
13964 " guestfs_mkswap_file (guestfs_h *g,\n"
13965 " const char *path);\n"
13970 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3165
13971 msgid "Create a swap file."
13975 #: ../src/guestfs-actions.pod:4684
13977 "This command just writes a swap file signature to an existing file. To "
13978 "create the file itself, use something like C<guestfs_fallocate>."
13982 #: ../src/guestfs-actions.pod:4691
13983 msgid "guestfs_modprobe"
13987 #: ../src/guestfs-actions.pod:4693
13991 " guestfs_modprobe (guestfs_h *g,\n"
13992 " const char *modulename);\n"
13997 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3174
13998 msgid "This loads a kernel module in the appliance."
14002 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3176
14004 "The kernel module must have been whitelisted when libguestfs was built (see "
14005 "C<appliance/kmod.whitelist.in> in the source)."
14009 #: ../src/guestfs-actions.pod:4706
14010 msgid "guestfs_mount"
14014 #: ../src/guestfs-actions.pod:4708
14018 " guestfs_mount (guestfs_h *g,\n"
14019 " const char *device,\n"
14020 " const char *mountpoint);\n"
14025 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3183
14027 "Mount a guest disk at a position in the filesystem. Block devices are named "
14028 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14029 "those block devices contain partitions, they will have the usual names (eg. "
14030 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14034 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3189
14036 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14037 "mounted on C</> before others can be mounted. Other filesystems can only be "
14038 "mounted on directories which already exist."
14042 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3194
14044 "The mounted filesystem is writable, if we have sufficient permissions on the "
14045 "underlying device."
14049 #: ../src/guestfs-actions.pod:4727
14051 "B<Important note:> When you use this call, the filesystem options C<sync> "
14052 "and C<noatime> are set implicitly. This was originally done because we "
14053 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14054 "very large negative performance impact and negligible effect on "
14055 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14056 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14057 "(use an empty string for the first parameter if you don't want any options)."
14061 #: ../src/guestfs-actions.pod:4741
14062 msgid "guestfs_mount_loop"
14066 #: ../src/guestfs-actions.pod:4743
14070 " guestfs_mount_loop (guestfs_h *g,\n"
14071 " const char *file,\n"
14072 " const char *mountpoint);\n"
14077 #: ../src/guestfs-actions.pod:4748 ../fish/guestfish-actions.pod:3211
14079 "This command lets you mount C<file> (a filesystem image in a file) on a "
14080 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14085 #: ../src/guestfs-actions.pod:4756
14086 msgid "guestfs_mount_options"
14090 #: ../src/guestfs-actions.pod:4758
14094 " guestfs_mount_options (guestfs_h *g,\n"
14095 " const char *options,\n"
14096 " const char *device,\n"
14097 " const char *mountpoint);\n"
14102 #: ../src/guestfs-actions.pod:4764
14104 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14105 "the mount options as for the L<mount(8)> I<-o> flag."
14109 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3223
14111 "If the C<options> parameter is an empty string, then no options are passed "
14112 "(all options default to whatever the filesystem uses)."
14116 #: ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4788
14117 #: ../src/guestfs-actions.pod:4805
14118 msgid "(Added in 1.0.10)"
14122 #: ../src/guestfs-actions.pod:4776
14123 msgid "guestfs_mount_ro"
14127 #: ../src/guestfs-actions.pod:4778
14131 " guestfs_mount_ro (guestfs_h *g,\n"
14132 " const char *device,\n"
14133 " const char *mountpoint);\n"
14138 #: ../src/guestfs-actions.pod:4783
14140 "This is the same as the C<guestfs_mount> command, but it mounts the "
14141 "filesystem with the read-only (I<-o ro>) flag."
14145 #: ../src/guestfs-actions.pod:4790
14146 msgid "guestfs_mount_vfs"
14150 #: ../src/guestfs-actions.pod:4792
14154 " guestfs_mount_vfs (guestfs_h *g,\n"
14155 " const char *options,\n"
14156 " const char *vfstype,\n"
14157 " const char *device,\n"
14158 " const char *mountpoint);\n"
14163 #: ../src/guestfs-actions.pod:4799
14165 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14166 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14171 #: ../src/guestfs-actions.pod:4807
14172 msgid "guestfs_mountpoints"
14176 #: ../src/guestfs-actions.pod:4809
14180 " guestfs_mountpoints (guestfs_h *g);\n"
14185 #: ../src/guestfs-actions.pod:4812
14187 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14188 "devices. This one returns a hash table (map) of device name to directory "
14189 "where the device is mounted."
14193 #: ../src/guestfs-actions.pod:4824
14194 msgid "guestfs_mounts"
14198 #: ../src/guestfs-actions.pod:4826
14202 " guestfs_mounts (guestfs_h *g);\n"
14207 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3254
14209 "This returns the list of currently mounted filesystems. It returns the list "
14210 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14214 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3257
14215 msgid "Some internal mounts are not shown."
14219 #: ../src/guestfs-actions.pod:4834
14220 msgid "See also: C<guestfs_mountpoints>"
14224 #: ../src/guestfs-actions.pod:4842
14229 #: ../src/guestfs-actions.pod:4844
14233 " guestfs_mv (guestfs_h *g,\n"
14234 " const char *src,\n"
14235 " const char *dest);\n"
14240 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3265
14242 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14243 "destination filename or destination directory."
14247 #: ../src/guestfs-actions.pod:4856
14248 msgid "guestfs_ntfs_3g_probe"
14252 #: ../src/guestfs-actions.pod:4858
14256 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14258 " const char *device);\n"
14263 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3272
14265 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14266 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14267 "write, and some cannot be mounted at all)."
14271 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3276
14273 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14274 "can be mounted read-write. Set it to false if you want to test if the "
14275 "volume can be mounted read-only."
14279 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3280
14281 "The return value is an integer which C<0> if the operation would succeed, or "
14282 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14286 #: ../src/guestfs-actions.pod:4877
14287 msgid "(Added in 1.0.43)"
14291 #: ../src/guestfs-actions.pod:4879
14292 msgid "guestfs_ntfsresize"
14296 #: ../src/guestfs-actions.pod:4881
14300 " guestfs_ntfsresize (guestfs_h *g,\n"
14301 " const char *device);\n"
14306 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3288
14308 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14309 "size of the underlying device. See also L<ntfsresize(8)>."
14313 #: ../src/guestfs-actions.pod:4893
14314 msgid "guestfs_ntfsresize_size"
14318 #: ../src/guestfs-actions.pod:4895
14322 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14323 " const char *device,\n"
14324 " int64_t size);\n"
14329 #: ../src/guestfs-actions.pod:4900
14331 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14332 "to specify the new size (in bytes) explicitly."
14336 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:5341
14337 #: ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5680
14338 #: ../src/guestfs-actions.pod:7251
14339 msgid "(Added in 1.3.14)"
14343 #: ../src/guestfs-actions.pod:4907
14344 msgid "guestfs_part_add"
14348 #: ../src/guestfs-actions.pod:4909
14352 " guestfs_part_add (guestfs_h *g,\n"
14353 " const char *device,\n"
14354 " const char *prlogex,\n"
14355 " int64_t startsect,\n"
14356 " int64_t endsect);\n"
14361 #: ../src/guestfs-actions.pod:4916
14363 "This command adds a partition to C<device>. If there is no partition table "
14364 "on the device, call C<guestfs_part_init> first."
14368 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3306
14370 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14371 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14372 "C<logical>) and C<e> (or C<extended>) partition types."
14376 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3311
14378 "C<startsect> and C<endsect> are the start and end of the partition in "
14379 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14380 "from the end of the disk (C<-1> is the last sector)."
14384 #: ../src/guestfs-actions.pod:4928
14386 "Creating a partition which covers the whole disk is not so easy. Use "
14387 "C<guestfs_part_disk> to do that."
14391 #: ../src/guestfs-actions.pod:4933 ../src/guestfs-actions.pod:4971
14392 #: ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5102
14393 #: ../src/guestfs-actions.pod:5140 ../src/guestfs-actions.pod:5159
14394 #: ../src/guestfs-actions.pod:5199
14395 msgid "(Added in 1.0.78)"
14399 #: ../src/guestfs-actions.pod:4935
14400 msgid "guestfs_part_del"
14404 #: ../src/guestfs-actions.pod:4937
14408 " guestfs_part_del (guestfs_h *g,\n"
14409 " const char *device,\n"
14415 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3322
14416 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14420 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3324
14422 "Note that in the case of MBR partitioning, deleting an extended partition "
14423 "also deletes any logical partitions it contains."
14427 #: ../src/guestfs-actions.pod:4952
14428 msgid "guestfs_part_disk"
14432 #: ../src/guestfs-actions.pod:4954
14436 " guestfs_part_disk (guestfs_h *g,\n"
14437 " const char *device,\n"
14438 " const char *parttype);\n"
14443 #: ../src/guestfs-actions.pod:4959
14445 "This command is simply a combination of C<guestfs_part_init> followed by "
14446 "C<guestfs_part_add> to create a single primary partition covering the whole "
14451 #: ../src/guestfs-actions.pod:4963
14453 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14454 "possible values are described in C<guestfs_part_init>."
14458 #: ../src/guestfs-actions.pod:4973
14459 msgid "guestfs_part_get_bootable"
14463 #: ../src/guestfs-actions.pod:4975
14467 " guestfs_part_get_bootable (guestfs_h *g,\n"
14468 " const char *device,\n"
14474 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3346
14476 "This command returns true if the partition C<partnum> on C<device> has the "
14477 "bootable flag set."
14481 #: ../src/guestfs-actions.pod:4983
14482 msgid "See also C<guestfs_part_set_bootable>."
14486 #: ../src/guestfs-actions.pod:4989
14487 msgid "guestfs_part_get_mbr_id"
14491 #: ../src/guestfs-actions.pod:4991
14495 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14496 " const char *device,\n"
14502 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3355
14504 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14505 "partition C<partnum>."
14509 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
14511 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14512 "undefined results for other partition table types (see "
14513 "C<guestfs_part_get_parttype>)."
14517 #: ../src/guestfs-actions.pod:5007
14518 msgid "guestfs_part_get_parttype"
14522 #: ../src/guestfs-actions.pod:5009
14526 " guestfs_part_get_parttype (guestfs_h *g,\n"
14527 " const char *device);\n"
14532 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3366
14534 "This command examines the partition table on C<device> and returns the "
14535 "partition table type (format) being used."
14539 #: ../src/guestfs-actions.pod:5016
14541 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14542 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14543 "possible, although unusual. See C<guestfs_part_init> for a full list."
14547 #: ../src/guestfs-actions.pod:5026
14548 msgid "guestfs_part_init"
14552 #: ../src/guestfs-actions.pod:5028
14556 " guestfs_part_init (guestfs_h *g,\n"
14557 " const char *device,\n"
14558 " const char *parttype);\n"
14563 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3378
14565 "This creates an empty partition table on C<device> of one of the partition "
14566 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14567 "(for large disks)."
14571 #: ../src/guestfs-actions.pod:5037
14573 "Initially there are no partitions. Following this, you should call "
14574 "C<guestfs_part_add> for each partition required."
14578 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3385
14579 msgid "Possible values for C<parttype> are:"
14583 #: ../src/guestfs-actions.pod:5044 ../fish/guestfish-actions.pod:3389
14584 msgid "B<efi> | B<gpt>"
14588 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3391
14589 msgid "Intel EFI / GPT partition table."
14593 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3393
14595 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14596 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14597 "the C<mbr> format."
14601 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3397
14602 msgid "B<mbr> | B<msdos>"
14606 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3399
14608 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14609 "Windows. This partition type will B<only> work for device sizes up to 2 "
14610 "TB. For large disks we recommend using C<gpt>."
14614 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3406
14616 "Other partition table types that may work but are not supported include:"
14620 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3411
14625 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3413
14626 msgid "AIX disk labels."
14630 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3415
14631 msgid "B<amiga> | B<rdb>"
14635 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3417
14636 msgid "Amiga \"Rigid Disk Block\" format."
14640 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3419
14645 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3421
14646 msgid "BSD disk labels."
14650 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3423
14655 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3425
14656 msgid "DASD, used on IBM mainframes."
14660 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3427
14665 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3429
14666 msgid "MIPS/SGI volumes."
14670 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3431
14675 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3433
14676 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14680 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3435
14685 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3437
14686 msgid "NEC PC-98 format, common in Japan apparently."
14690 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3439
14695 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3441
14696 msgid "Sun disk labels."
14700 #: ../src/guestfs-actions.pod:5104
14701 msgid "guestfs_part_list"
14705 #: ../src/guestfs-actions.pod:5106
14708 " struct guestfs_partition_list *\n"
14709 " guestfs_part_list (guestfs_h *g,\n"
14710 " const char *device);\n"
14715 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3449
14717 "This command parses the partition table on C<device> and returns the list of "
14718 "partitions found."
14722 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3452
14723 msgid "The fields in the returned structure are:"
14727 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3456
14728 msgid "B<part_num>"
14732 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3458
14733 msgid "Partition number, counting from 1."
14737 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3460
14738 msgid "B<part_start>"
14742 #: ../src/guestfs-actions.pod:5123
14744 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14745 "the device's sector size, see C<guestfs_blockdev_getss>."
14749 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3465
14750 msgid "B<part_end>"
14754 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3467
14755 msgid "End of the partition in bytes."
14759 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3469
14760 msgid "B<part_size>"
14764 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3471
14765 msgid "Size of the partition in bytes."
14769 #: ../src/guestfs-actions.pod:5136
14771 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14772 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14777 #: ../src/guestfs-actions.pod:5142
14778 msgid "guestfs_part_set_bootable"
14782 #: ../src/guestfs-actions.pod:5144
14786 " guestfs_part_set_bootable (guestfs_h *g,\n"
14787 " const char *device,\n"
14789 " int bootable);\n"
14794 #: ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:3479
14796 "This sets the bootable flag on partition numbered C<partnum> on device "
14797 "C<device>. Note that partitions are numbered from 1."
14801 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3482
14803 "The bootable flag is used by some operating systems (notably Windows) to "
14804 "determine which partition to boot from. It is by no means universally "
14809 #: ../src/guestfs-actions.pod:5161
14810 msgid "guestfs_part_set_mbr_id"
14814 #: ../src/guestfs-actions.pod:5163
14818 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14819 " const char *device,\n"
14826 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3490
14828 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14829 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14830 "documentation are in fact hexadecimal numbers, but usually documented "
14831 "without any leading \"0x\" which might be confusing."
14835 #: ../src/guestfs-actions.pod:5183
14836 msgid "guestfs_part_set_name"
14840 #: ../src/guestfs-actions.pod:5185
14844 " guestfs_part_set_name (guestfs_h *g,\n"
14845 " const char *device,\n"
14847 " const char *name);\n"
14852 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:3504
14854 "This sets the partition name on partition numbered C<partnum> on device "
14855 "C<device>. Note that partitions are numbered from 1."
14859 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:3507
14861 "The partition name can only be set on certain types of partition table. "
14862 "This works on C<gpt> but not on C<mbr> partitions."
14866 #: ../src/guestfs-actions.pod:5201
14867 msgid "guestfs_part_to_dev"
14871 #: ../src/guestfs-actions.pod:5203
14875 " guestfs_part_to_dev (guestfs_h *g,\n"
14876 " const char *partition);\n"
14881 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3514
14883 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14884 "partition number, returning the device name (eg. \"/dev/sdb\")."
14888 #: ../src/guestfs-actions.pod:5211
14890 "The named partition must exist, for example as a string returned from "
14891 "C<guestfs_list_partitions>."
14895 #: ../src/guestfs-actions.pod:5219
14896 msgid "guestfs_ping_daemon"
14900 #: ../src/guestfs-actions.pod:5221
14904 " guestfs_ping_daemon (guestfs_h *g);\n"
14909 #: ../src/guestfs-actions.pod:5224 ../fish/guestfish-actions.pod:3525
14911 "This is a test probe into the guestfs daemon running inside the qemu "
14912 "subprocess. Calling this function checks that the daemon responds to the "
14913 "ping message, without affecting the daemon or attached block device(s) in "
14918 #: ../src/guestfs-actions.pod:5233
14919 msgid "guestfs_pread"
14923 #: ../src/guestfs-actions.pod:5235
14927 " guestfs_pread (guestfs_h *g,\n"
14928 " const char *path,\n"
14930 " int64_t offset,\n"
14931 " size_t *size_r);\n"
14936 #: ../src/guestfs-actions.pod:5242 ../fish/guestfish-actions.pod:3534
14938 "This command lets you read part of a file. It reads C<count> bytes of the "
14939 "file, starting at C<offset>, from file C<path>."
14943 #: ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5271
14944 #: ../fish/guestfish-actions.pod:3537 ../fish/guestfish-actions.pod:3552
14946 "This may read fewer bytes than requested. For further details see the "
14947 "L<pread(2)> system call."
14951 #: ../src/guestfs-actions.pod:5248
14952 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14956 #: ../src/guestfs-actions.pod:5259
14957 msgid "guestfs_pread_device"
14961 #: ../src/guestfs-actions.pod:5261
14965 " guestfs_pread_device (guestfs_h *g,\n"
14966 " const char *device,\n"
14968 " int64_t offset,\n"
14969 " size_t *size_r);\n"
14974 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3549
14976 "This command lets you read part of a file. It reads C<count> bytes of "
14977 "C<device>, starting at C<offset>."
14981 #: ../src/guestfs-actions.pod:5274
14982 msgid "See also C<guestfs_pread>."
14986 #: ../src/guestfs-actions.pod:5283
14987 msgid "(Added in 1.5.21)"
14991 #: ../src/guestfs-actions.pod:5285
14992 msgid "guestfs_pvcreate"
14996 #: ../src/guestfs-actions.pod:5287
15000 " guestfs_pvcreate (guestfs_h *g,\n"
15001 " const char *device);\n"
15006 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3564
15008 "This creates an LVM physical volume on the named C<device>, where C<device> "
15009 "should usually be a partition name such as C</dev/sda1>."
15013 #: ../src/guestfs-actions.pod:5299
15014 msgid "guestfs_pvremove"
15018 #: ../src/guestfs-actions.pod:5301
15022 " guestfs_pvremove (guestfs_h *g,\n"
15023 " const char *device);\n"
15028 #: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:3572
15030 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15035 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3575
15037 "The implementation uses the C<pvremove> command which refuses to wipe "
15038 "physical volumes that contain any volume groups, so you have to remove those "
15043 #: ../src/guestfs-actions.pod:5316
15044 msgid "guestfs_pvresize"
15048 #: ../src/guestfs-actions.pod:5318
15052 " guestfs_pvresize (guestfs_h *g,\n"
15053 " const char *device);\n"
15058 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3583
15060 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15061 "the new size of the underlying device."
15065 #: ../src/guestfs-actions.pod:5329
15066 msgid "guestfs_pvresize_size"
15070 #: ../src/guestfs-actions.pod:5331
15074 " guestfs_pvresize_size (guestfs_h *g,\n"
15075 " const char *device,\n"
15076 " int64_t size);\n"
15081 #: ../src/guestfs-actions.pod:5336
15083 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15084 "specify the new size (in bytes) explicitly."
15088 #: ../src/guestfs-actions.pod:5343
15089 msgid "guestfs_pvs"
15093 #: ../src/guestfs-actions.pod:5345
15097 " guestfs_pvs (guestfs_h *g);\n"
15102 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3597
15104 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15109 #: ../src/guestfs-actions.pod:5351 ../fish/guestfish-actions.pod:3600
15111 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15116 #: ../src/guestfs-actions.pod:5354
15117 msgid "See also C<guestfs_pvs_full>."
15121 #: ../src/guestfs-actions.pod:5362
15122 msgid "guestfs_pvs_full"
15126 #: ../src/guestfs-actions.pod:5364
15129 " struct guestfs_lvm_pv_list *\n"
15130 " guestfs_pvs_full (guestfs_h *g);\n"
15135 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3609
15137 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15138 "(8)> command. The \"full\" version includes all fields."
15142 #: ../src/guestfs-actions.pod:5370
15144 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15145 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15149 #: ../src/guestfs-actions.pod:5376
15150 msgid "guestfs_pvuuid"
15154 #: ../src/guestfs-actions.pod:5378
15158 " guestfs_pvuuid (guestfs_h *g,\n"
15159 " const char *device);\n"
15164 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3616
15165 msgid "This command returns the UUID of the LVM PV C<device>."
15169 #: ../src/guestfs-actions.pod:5389
15170 msgid "guestfs_pwrite"
15174 #: ../src/guestfs-actions.pod:5391
15178 " guestfs_pwrite (guestfs_h *g,\n"
15179 " const char *path,\n"
15180 " const char *content,\n"
15181 " size_t content_size,\n"
15182 " int64_t offset);\n"
15187 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3622
15189 "This command writes to part of a file. It writes the data buffer C<content> "
15190 "to the file C<path> starting at offset C<offset>."
15194 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3625
15196 "This command implements the L<pwrite(2)> system call, and like that system "
15197 "call it may not write the full data requested. The return value is the "
15198 "number of bytes that were actually written to the file. This could even be "
15199 "0, although short writes are unlikely for regular files in ordinary "
15204 #: ../src/guestfs-actions.pod:5407
15205 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15209 #: ../src/guestfs-actions.pod:5416
15210 msgid "guestfs_pwrite_device"
15214 #: ../src/guestfs-actions.pod:5418
15218 " guestfs_pwrite_device (guestfs_h *g,\n"
15219 " const char *device,\n"
15220 " const char *content,\n"
15221 " size_t content_size,\n"
15222 " int64_t offset);\n"
15227 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3640
15229 "This command writes to part of a device. It writes the data buffer "
15230 "C<content> to C<device> starting at offset C<offset>."
15234 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3643
15236 "This command implements the L<pwrite(2)> system call, and like that system "
15237 "call it may not write the full data requested (although short writes to disk "
15238 "devices and partitions are probably impossible with standard Linux kernels)."
15242 #: ../src/guestfs-actions.pod:5433
15243 msgid "See also C<guestfs_pwrite>."
15247 #: ../src/guestfs-actions.pod:5440
15248 msgid "(Added in 1.5.20)"
15252 #: ../src/guestfs-actions.pod:5442
15253 msgid "guestfs_read_file"
15257 #: ../src/guestfs-actions.pod:5444
15261 " guestfs_read_file (guestfs_h *g,\n"
15262 " const char *path,\n"
15263 " size_t *size_r);\n"
15268 #: ../src/guestfs-actions.pod:5449 ../fish/guestfish-actions.pod:3657
15269 msgid "This calls returns the contents of the file C<path> as a buffer."
15273 #: ../src/guestfs-actions.pod:5452
15275 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15276 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15277 "function is limited in the total size of file that can be handled."
15281 #: ../src/guestfs-actions.pod:5464
15282 msgid "(Added in 1.0.63)"
15286 #: ../src/guestfs-actions.pod:5466
15287 msgid "guestfs_read_lines"
15291 #: ../src/guestfs-actions.pod:5468
15295 " guestfs_read_lines (guestfs_h *g,\n"
15296 " const char *path);\n"
15301 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3674
15303 "The file contents are returned as a list of lines. Trailing C<LF> and "
15304 "C<CRLF> character sequences are I<not> returned."
15308 #: ../src/guestfs-actions.pod:5477
15310 "Note that this function cannot correctly handle binary files (specifically, "
15311 "files containing C<\\0> character which is treated as end of line). For "
15312 "those you need to use the C<guestfs_read_file> function which has a more "
15313 "complex interface."
15317 #: ../src/guestfs-actions.pod:5488
15318 msgid "guestfs_readdir"
15322 #: ../src/guestfs-actions.pod:5490
15325 " struct guestfs_dirent_list *\n"
15326 " guestfs_readdir (guestfs_h *g,\n"
15327 " const char *dir);\n"
15332 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3686
15333 msgid "This returns the list of directory entries in directory C<dir>."
15337 #: ../src/guestfs-actions.pod:5496 ../fish/guestfish-actions.pod:3688
15339 "All entries in the directory are returned, including C<.> and C<..>. The "
15340 "entries are I<not> sorted, but returned in the same order as the underlying "
15345 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
15347 "Also this call returns basic file type information about each file. The "
15348 "C<ftyp> field will contain one of the following characters:"
15352 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3697
15357 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3699
15358 msgid "Block special"
15362 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3701
15367 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3703
15368 msgid "Char special"
15372 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3705
15377 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3707
15382 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3709
15387 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3711
15388 msgid "FIFO (named pipe)"
15392 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3713
15397 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3715
15398 msgid "Symbolic link"
15402 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3717
15407 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3719
15408 msgid "Regular file"
15412 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3721
15417 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3723
15422 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3725
15427 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3727
15428 msgid "Unknown file type"
15432 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3729
15437 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3731
15439 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15443 #: ../src/guestfs-actions.pod:5544
15445 "This function is primarily intended for use by programs. To get a simple "
15446 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15447 "consumption, use C<guestfs_ll>."
15451 #: ../src/guestfs-actions.pod:5548
15453 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15454 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15458 #: ../src/guestfs-actions.pod:5554
15459 msgid "guestfs_readlink"
15463 #: ../src/guestfs-actions.pod:5556
15467 " guestfs_readlink (guestfs_h *g,\n"
15468 " const char *path);\n"
15473 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3744
15474 msgid "This command reads the target of a symbolic link."
15478 #: ../src/guestfs-actions.pod:5567
15479 msgid "guestfs_readlinklist"
15483 #: ../src/guestfs-actions.pod:5569
15487 " guestfs_readlinklist (guestfs_h *g,\n"
15488 " const char *path,\n"
15489 " char *const *names);\n"
15494 #: ../src/guestfs-actions.pod:5574 ../fish/guestfish-actions.pod:3750
15496 "This call allows you to do a C<readlink> operation on multiple files, where "
15497 "all files are in the directory C<path>. C<names> is the list of files from "
15502 #: ../src/guestfs-actions.pod:5578 ../fish/guestfish-actions.pod:3754
15504 "On return you get a list of strings, with a one-to-one correspondence to the "
15505 "C<names> list. Each string is the value of the symbolic link."
15509 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3758
15511 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15512 "result string is the empty string C<\"\">. However the whole operation is "
15513 "completed even if there were C<readlink(2)> errors, and so you can call this "
15514 "function with names where you don't know if they are symbolic links already "
15515 "(albeit slightly less efficient)."
15519 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3765
15521 "This call is intended for programs that want to efficiently list a directory "
15522 "contents without making many round-trips. Very long directory listings "
15523 "might cause the protocol message size to be exceeded, causing this call to "
15524 "fail. The caller must split up such requests into smaller groups of names."
15528 #: ../src/guestfs-actions.pod:5602
15529 msgid "guestfs_realpath"
15533 #: ../src/guestfs-actions.pod:5604
15537 " guestfs_realpath (guestfs_h *g,\n"
15538 " const char *path);\n"
15543 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3776
15545 "Return the canonicalized absolute pathname of C<path>. The returned path "
15546 "has no C<.>, C<..> or symbolic link path elements."
15550 #: ../src/guestfs-actions.pod:5616
15551 msgid "guestfs_removexattr"
15555 #: ../src/guestfs-actions.pod:5618
15559 " guestfs_removexattr (guestfs_h *g,\n"
15560 " const char *xattr,\n"
15561 " const char *path);\n"
15566 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3783
15568 "This call removes the extended attribute named C<xattr> of the file C<path>."
15572 #: ../src/guestfs-actions.pod:5626
15573 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15577 #: ../src/guestfs-actions.pod:5632
15578 msgid "guestfs_resize2fs"
15582 #: ../src/guestfs-actions.pod:5634
15586 " guestfs_resize2fs (guestfs_h *g,\n"
15587 " const char *device);\n"
15592 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3792
15594 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15595 "underlying device."
15599 #: ../src/guestfs-actions.pod:5641
15601 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15602 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15603 "sometimes gives an error about this and sometimes not. In any case, it is "
15604 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15608 #: ../src/guestfs-actions.pod:5651
15609 msgid "guestfs_resize2fs_M"
15613 #: ../src/guestfs-actions.pod:5653
15617 " guestfs_resize2fs_M (guestfs_h *g,\n"
15618 " const char *device);\n"
15623 #: ../src/guestfs-actions.pod:5657
15625 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15626 "resized to its minimum size. This works like the I<-M> option to the "
15627 "C<resize2fs> command."
15631 #: ../src/guestfs-actions.pod:5661
15633 "To get the resulting size of the filesystem you should call "
15634 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15635 "These two numbers, multiplied together, give the resulting size of the "
15636 "minimal filesystem in bytes."
15640 #: ../src/guestfs-actions.pod:5668
15641 msgid "guestfs_resize2fs_size"
15645 #: ../src/guestfs-actions.pod:5670
15649 " guestfs_resize2fs_size (guestfs_h *g,\n"
15650 " const char *device,\n"
15651 " int64_t size);\n"
15656 #: ../src/guestfs-actions.pod:5675
15658 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15659 "to specify the new size (in bytes) explicitly."
15663 #: ../src/guestfs-actions.pod:5682
15668 #: ../src/guestfs-actions.pod:5684
15672 " guestfs_rm (guestfs_h *g,\n"
15673 " const char *path);\n"
15678 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3825
15679 msgid "Remove the single file C<path>."
15683 #: ../src/guestfs-actions.pod:5694
15684 msgid "guestfs_rm_rf"
15688 #: ../src/guestfs-actions.pod:5696
15692 " guestfs_rm_rf (guestfs_h *g,\n"
15693 " const char *path);\n"
15698 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3831
15700 "Remove the file or directory C<path>, recursively removing the contents if "
15701 "its a directory. This is like the C<rm -rf> shell command."
15705 #: ../src/guestfs-actions.pod:5708
15706 msgid "guestfs_rmdir"
15710 #: ../src/guestfs-actions.pod:5710
15714 " guestfs_rmdir (guestfs_h *g,\n"
15715 " const char *path);\n"
15720 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3839
15721 msgid "Remove the single directory C<path>."
15725 #: ../src/guestfs-actions.pod:5720
15726 msgid "guestfs_rmmountpoint"
15730 #: ../src/guestfs-actions.pod:5722
15734 " guestfs_rmmountpoint (guestfs_h *g,\n"
15735 " const char *exemptpath);\n"
15740 #: ../src/guestfs-actions.pod:5726
15742 "This calls removes a mountpoint that was previously created with "
15743 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15747 #: ../src/guestfs-actions.pod:5734
15748 msgid "guestfs_scrub_device"
15752 #: ../src/guestfs-actions.pod:5736
15756 " guestfs_scrub_device (guestfs_h *g,\n"
15757 " const char *device);\n"
15762 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3853
15764 "This command writes patterns over C<device> to make data retrieval more "
15769 #: ../src/guestfs-actions.pod:5743 ../src/guestfs-actions.pod:5764
15770 #: ../src/guestfs-actions.pod:5783 ../fish/guestfish-actions.pod:3856
15771 #: ../fish/guestfish-actions.pod:3871 ../fish/guestfish-actions.pod:3884
15773 "It is an interface to the L<scrub(1)> program. See that manual page for "
15778 #: ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5769
15779 #: ../src/guestfs-actions.pod:5788
15780 msgid "(Added in 1.0.52)"
15784 #: ../src/guestfs-actions.pod:5753
15785 msgid "guestfs_scrub_file"
15789 #: ../src/guestfs-actions.pod:5755
15793 " guestfs_scrub_file (guestfs_h *g,\n"
15794 " const char *file);\n"
15799 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3866
15801 "This command writes patterns over a file to make data retrieval more "
15806 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3869
15807 msgid "The file is I<removed> after scrubbing."
15811 #: ../src/guestfs-actions.pod:5771
15812 msgid "guestfs_scrub_freespace"
15816 #: ../src/guestfs-actions.pod:5773
15820 " guestfs_scrub_freespace (guestfs_h *g,\n"
15821 " const char *dir);\n"
15826 #: ../src/guestfs-actions.pod:5777
15828 "This command creates the directory C<dir> and then fills it with files until "
15829 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15830 "and deletes them. The intention is to scrub any free space on the partition "
15831 "containing C<dir>."
15835 #: ../src/guestfs-actions.pod:5790
15836 msgid "guestfs_set_append"
15840 #: ../src/guestfs-actions.pod:5792
15844 " guestfs_set_append (guestfs_h *g,\n"
15845 " const char *append);\n"
15850 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3893
15852 "This function is used to add additional options to the guest kernel command "
15857 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3896
15859 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15860 "environment variable."
15864 #: ../src/guestfs-actions.pod:5802 ../fish/guestfish-actions.pod:3899
15866 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15867 "(libguestfs always adds a few of its own)."
15871 #: ../src/guestfs-actions.pod:5809
15872 msgid "guestfs_set_attach_method"
15876 #: ../src/guestfs-actions.pod:5811
15880 " guestfs_set_attach_method (guestfs_h *g,\n"
15881 " const char *attachmethod);\n"
15886 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3908
15888 "Set the method that libguestfs uses to connect to the back end guestfsd "
15889 "daemon. Possible methods are:"
15893 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3915
15895 "Launch an appliance and connect to it. This is the ordinary method and the "
15900 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3918
15901 msgid "C<unix:I<path>>"
15905 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3920
15906 msgid "Connect to the Unix domain socket I<path>."
15910 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3922
15912 "This method lets you connect to an existing daemon or (using virtio-serial) "
15913 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15914 "RUNNING DAEMONS>."
15918 #: ../src/guestfs-actions.pod:5837
15919 msgid "guestfs_set_autosync"
15923 #: ../src/guestfs-actions.pod:5839
15927 " guestfs_set_autosync (guestfs_h *g,\n"
15928 " int autosync);\n"
15933 #: ../src/guestfs-actions.pod:5843 ../fish/guestfish-actions.pod:3934
15935 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15936 "effort attempt to make filesystems consistent and synchronized when the "
15937 "handle is closed (also if the program exits without closing handles)."
15941 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3939
15943 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15944 "disabled by default)."
15948 #: ../src/guestfs-actions.pod:5855
15949 msgid "guestfs_set_direct"
15953 #: ../src/guestfs-actions.pod:5857
15957 " guestfs_set_direct (guestfs_h *g,\n"
15963 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3948
15965 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15966 "passed directly through to the appliance once it is launched."
15970 #: ../src/guestfs-actions.pod:5865
15972 "One consequence of this is that log messages aren't caught by the library "
15973 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15978 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3956
15979 msgid "You probably don't want to use this unless you know what you are doing."
15983 #: ../src/guestfs-actions.pod:5872 ../fish/guestfish-actions.pod:3959
15984 msgid "The default is disabled."
15988 #: ../src/guestfs-actions.pod:5878
15989 msgid "guestfs_set_e2label"
15993 #: ../src/guestfs-actions.pod:5880
15997 " guestfs_set_e2label (guestfs_h *g,\n"
15998 " const char *device,\n"
15999 " const char *label);\n"
16004 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3965
16006 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16007 "C<label>. Filesystem labels are limited to 16 characters."
16011 #: ../src/guestfs-actions.pod:5889
16013 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16014 "the existing label on a filesystem."
16018 #: ../src/guestfs-actions.pod:5896
16019 msgid "guestfs_set_e2uuid"
16023 #: ../src/guestfs-actions.pod:5898
16027 " guestfs_set_e2uuid (guestfs_h *g,\n"
16028 " const char *device,\n"
16029 " const char *uuid);\n"
16034 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3976
16036 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16037 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16038 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16042 #: ../src/guestfs-actions.pod:5908
16044 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16045 "the existing UUID of a filesystem."
16049 #: ../src/guestfs-actions.pod:5915
16050 msgid "guestfs_set_memsize"
16054 #: ../src/guestfs-actions.pod:5917
16058 " guestfs_set_memsize (guestfs_h *g,\n"
16064 #: ../src/guestfs-actions.pod:5921
16066 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16067 "This only has any effect if called before C<guestfs_launch>."
16071 #: ../src/guestfs-actions.pod:5925 ../fish/guestfish-actions.pod:3994
16073 "You can also change this by setting the environment variable "
16074 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16078 #: ../src/guestfs-actions.pod:5936
16079 msgid "guestfs_set_network"
16083 #: ../src/guestfs-actions.pod:5938
16087 " guestfs_set_network (guestfs_h *g,\n"
16093 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:4007
16095 "If C<network> is true, then the network is enabled in the libguestfs "
16096 "appliance. The default is false."
16100 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:4010
16102 "This affects whether commands are able to access the network (see L<guestfs"
16103 "(3)/RUNNING COMMANDS>)."
16107 #: ../src/guestfs-actions.pod:5948
16109 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16114 #: ../src/guestfs-actions.pod:5955
16115 msgid "guestfs_set_path"
16119 #: ../src/guestfs-actions.pod:5957
16123 " guestfs_set_path (guestfs_h *g,\n"
16124 " const char *searchpath);\n"
16129 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4022
16130 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16134 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:4024
16136 "The default is C<$libdir/guestfs> unless overridden by setting "
16137 "C<LIBGUESTFS_PATH> environment variable."
16141 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4027
16142 msgid "Setting C<path> to C<NULL> restores the default path."
16146 #: ../src/guestfs-actions.pod:5972
16147 msgid "guestfs_set_qemu"
16151 #: ../src/guestfs-actions.pod:5974
16155 " guestfs_set_qemu (guestfs_h *g,\n"
16156 " const char *qemu);\n"
16161 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4035
16162 msgid "Set the qemu binary that we will use."
16166 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4037
16168 "The default is chosen when the library was compiled by the configure script."
16172 #: ../src/guestfs-actions.pod:5983 ../fish/guestfish-actions.pod:4040
16174 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16179 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:4043
16180 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16184 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:4045
16186 "Note that you should call this function as early as possible after creating "
16187 "the handle. This is because some pre-launch operations depend on testing "
16188 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16189 "don't retest features, and so you might see inconsistent results. Using the "
16190 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16191 "the qemu binary at the same time as the handle is created."
16195 #: ../src/guestfs-actions.pod:6000
16196 msgid "guestfs_set_recovery_proc"
16200 #: ../src/guestfs-actions.pod:6002
16204 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16205 " int recoveryproc);\n"
16210 #: ../src/guestfs-actions.pod:6006
16212 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16213 "not create a recovery process. The purpose of the recovery process is to "
16214 "stop runaway qemu processes in the case where the main program aborts "
16219 #: ../src/guestfs-actions.pod:6011
16221 "This only has any effect if called before C<guestfs_launch>, and the default "
16226 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4067
16228 "About the only time when you would want to disable this is if the main "
16229 "process will fork itself into the background (\"daemonize\" itself). In "
16230 "this case the recovery process thinks that the main program has disappeared "
16231 "and so kills qemu, which is not very helpful."
16235 #: ../src/guestfs-actions.pod:6024
16236 msgid "guestfs_set_selinux"
16240 #: ../src/guestfs-actions.pod:6026
16244 " guestfs_set_selinux (guestfs_h *g,\n"
16250 #: ../src/guestfs-actions.pod:6030 ../fish/guestfish-actions.pod:4079
16252 "This sets the selinux flag that is passed to the appliance at boot time. "
16253 "The default is C<selinux=0> (disabled)."
16257 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4082
16259 "Note that if SELinux is enabled, it is always in Permissive mode "
16260 "(C<enforcing=0>)."
16264 #: ../src/guestfs-actions.pod:6043
16265 msgid "guestfs_set_trace"
16269 #: ../src/guestfs-actions.pod:6045
16273 " guestfs_set_trace (guestfs_h *g,\n"
16279 #: ../src/guestfs-actions.pod:6049 ../fish/guestfish-actions.pod:4094
16281 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16282 "return values are traced."
16286 #: ../src/guestfs-actions.pod:6052 ../fish/guestfish-actions.pod:4097
16288 "If you want to trace C API calls into libguestfs (and other libraries) then "
16289 "possibly a better way is to use the external ltrace(1) command."
16293 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4101
16295 "Command traces are disabled unless the environment variable "
16296 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16300 #: ../src/guestfs-actions.pod:6059
16302 "Trace messages are normally sent to C<stderr>, unless you register a "
16303 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16307 #: ../src/guestfs-actions.pod:6067
16308 msgid "guestfs_set_verbose"
16312 #: ../src/guestfs-actions.pod:6069
16316 " guestfs_set_verbose (guestfs_h *g,\n"
16322 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4114
16323 msgid "If C<verbose> is true, this turns on verbose messages."
16327 #: ../src/guestfs-actions.pod:6075 ../fish/guestfish-actions.pod:4116
16329 "Verbose messages are disabled unless the environment variable "
16330 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16334 #: ../src/guestfs-actions.pod:6078
16336 "Verbose messages are normally sent to C<stderr>, unless you register a "
16337 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16341 #: ../src/guestfs-actions.pod:6086
16342 msgid "guestfs_setcon"
16346 #: ../src/guestfs-actions.pod:6088
16350 " guestfs_setcon (guestfs_h *g,\n"
16351 " const char *context);\n"
16356 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4127
16358 "This sets the SELinux security context of the daemon to the string "
16363 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4130
16364 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16368 #: ../src/guestfs-actions.pod:6101
16369 msgid "guestfs_setxattr"
16373 #: ../src/guestfs-actions.pod:6103
16377 " guestfs_setxattr (guestfs_h *g,\n"
16378 " const char *xattr,\n"
16379 " const char *val,\n"
16381 " const char *path);\n"
16386 #: ../src/guestfs-actions.pod:6110 ../fish/guestfish-actions.pod:4136
16388 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16389 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16393 #: ../src/guestfs-actions.pod:6114
16394 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16398 #: ../src/guestfs-actions.pod:6120
16399 msgid "guestfs_sfdisk"
16403 #: ../src/guestfs-actions.pod:6122
16407 " guestfs_sfdisk (guestfs_h *g,\n"
16408 " const char *device,\n"
16412 " char *const *lines);\n"
16417 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4146
16419 "This is a direct interface to the L<sfdisk(8)> program for creating "
16420 "partitions on block devices."
16424 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4149
16425 msgid "C<device> should be a block device, for example C</dev/sda>."
16429 #: ../src/guestfs-actions.pod:6135 ../fish/guestfish-actions.pod:4151
16431 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16432 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16433 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16434 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16435 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16436 "the kernel) cannot work out the right geometry and you will need to tell it."
16440 #: ../src/guestfs-actions.pod:6143 ../fish/guestfish-actions.pod:4159
16442 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16443 "refer to the L<sfdisk(8)> manpage."
16447 #: ../src/guestfs-actions.pod:6146 ../fish/guestfish-actions.pod:4162
16449 "To create a single partition occupying the whole disk, you would pass "
16450 "C<lines> as a single element list, when the single element being the string "
16455 #: ../src/guestfs-actions.pod:6150
16457 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16461 #: ../src/guestfs-actions.pod:6160
16462 msgid "guestfs_sfdiskM"
16466 #: ../src/guestfs-actions.pod:6162
16470 " guestfs_sfdiskM (guestfs_h *g,\n"
16471 " const char *device,\n"
16472 " char *const *lines);\n"
16477 #: ../src/guestfs-actions.pod:6167
16479 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16480 "partition sizes are specified in megabytes only (rounded to the nearest "
16481 "cylinder) and you don't need to specify the cyls, heads and sectors "
16482 "parameters which were rarely if ever used anyway."
16486 #: ../src/guestfs-actions.pod:6173
16488 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16489 "C<guestfs_part_disk>"
16493 #: ../src/guestfs-actions.pod:6183
16494 msgid "guestfs_sfdisk_N"
16498 #: ../src/guestfs-actions.pod:6185
16502 " guestfs_sfdisk_N (guestfs_h *g,\n"
16503 " const char *device,\n"
16508 " const char *line);\n"
16513 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4192
16515 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16516 "(note: C<n> counts from 1)."
16520 #: ../src/guestfs-actions.pod:6197
16522 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16523 "for the cyls/heads/sectors parameters."
16527 #: ../src/guestfs-actions.pod:6200
16528 msgid "See also: C<guestfs_part_add>"
16532 #: ../src/guestfs-actions.pod:6209
16533 msgid "guestfs_sfdisk_disk_geometry"
16537 #: ../src/guestfs-actions.pod:6211
16541 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16542 " const char *device);\n"
16547 #: ../src/guestfs-actions.pod:6215
16549 "This displays the disk geometry of C<device> read from the partition table. "
16550 "Especially in the case where the underlying block device has been resized, "
16551 "this can be different from the kernel's idea of the geometry (see "
16552 "C<guestfs_sfdisk_kernel_geometry>)."
16556 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
16557 #: ../fish/guestfish-actions.pod:4212 ../fish/guestfish-actions.pod:4221
16558 msgid "The result is in human-readable format, and not designed to be parsed."
16562 #: ../src/guestfs-actions.pod:6228
16563 msgid "guestfs_sfdisk_kernel_geometry"
16567 #: ../src/guestfs-actions.pod:6230
16571 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16572 " const char *device);\n"
16577 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4219
16578 msgid "This displays the kernel's idea of the geometry of C<device>."
16582 #: ../src/guestfs-actions.pod:6244
16583 msgid "guestfs_sfdisk_l"
16587 #: ../src/guestfs-actions.pod:6246
16591 " guestfs_sfdisk_l (guestfs_h *g,\n"
16592 " const char *device);\n"
16597 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4228
16599 "This displays the partition table on C<device>, in the human-readable output "
16600 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16604 #: ../src/guestfs-actions.pod:6254
16605 msgid "See also: C<guestfs_part_list>"
16609 #: ../src/guestfs-actions.pod:6261
16614 #: ../src/guestfs-actions.pod:6263
16618 " guestfs_sh (guestfs_h *g,\n"
16619 " const char *command);\n"
16624 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4238
16626 "This call runs a command from the guest filesystem via the guest's C</bin/"
16631 #: ../src/guestfs-actions.pod:6270
16632 msgid "This is like C<guestfs_command>, but passes the command to:"
16636 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4243
16639 " /bin/sh -c \"command\"\n"
16644 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4245
16646 "Depending on the guest's shell, this usually results in wildcards being "
16647 "expanded, shell expressions being interpolated and so on."
16651 #: ../src/guestfs-actions.pod:6278
16652 msgid "All the provisos about C<guestfs_command> apply to this call."
16656 #: ../src/guestfs-actions.pod:6285
16657 msgid "guestfs_sh_lines"
16661 #: ../src/guestfs-actions.pod:6287
16665 " guestfs_sh_lines (guestfs_h *g,\n"
16666 " const char *command);\n"
16671 #: ../src/guestfs-actions.pod:6291
16673 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16678 #: ../src/guestfs-actions.pod:6294
16679 msgid "See also: C<guestfs_command_lines>"
16683 #: ../src/guestfs-actions.pod:6302
16684 msgid "guestfs_sleep"
16688 #: ../src/guestfs-actions.pod:6304
16692 " guestfs_sleep (guestfs_h *g,\n"
16698 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4264
16699 msgid "Sleep for C<secs> seconds."
16703 #: ../src/guestfs-actions.pod:6312
16704 msgid "(Added in 1.0.41)"
16708 #: ../src/guestfs-actions.pod:6314 ../src/guestfs-structs.pod:109
16709 msgid "guestfs_stat"
16713 #: ../src/guestfs-actions.pod:6316
16716 " struct guestfs_stat *\n"
16717 " guestfs_stat (guestfs_h *g,\n"
16718 " const char *path);\n"
16723 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4272
16724 msgid "This is the same as the C<stat(2)> system call."
16728 #: ../src/guestfs-actions.pod:6330 ../src/guestfs-structs.pod:135
16729 msgid "guestfs_statvfs"
16733 #: ../src/guestfs-actions.pod:6332
16736 " struct guestfs_statvfs *\n"
16737 " guestfs_statvfs (guestfs_h *g,\n"
16738 " const char *path);\n"
16743 #: ../src/guestfs-actions.pod:6336 ../fish/guestfish-actions.pod:4278
16745 "Returns file system statistics for any mounted file system. C<path> should "
16746 "be a file or directory in the mounted file system (typically it is the mount "
16747 "point itself, but it doesn't need to be)."
16751 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4282
16752 msgid "This is the same as the C<statvfs(2)> system call."
16756 #: ../src/guestfs-actions.pod:6342
16758 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16759 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16763 #: ../src/guestfs-actions.pod:6348
16764 msgid "guestfs_strings"
16768 #: ../src/guestfs-actions.pod:6350
16772 " guestfs_strings (guestfs_h *g,\n"
16773 " const char *path);\n"
16778 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4288
16780 "This runs the L<strings(1)> command on a file and returns the list of "
16781 "printable strings found."
16785 #: ../src/guestfs-actions.pod:6366
16786 msgid "guestfs_strings_e"
16790 #: ../src/guestfs-actions.pod:6368
16794 " guestfs_strings_e (guestfs_h *g,\n"
16795 " const char *encoding,\n"
16796 " const char *path);\n"
16801 #: ../src/guestfs-actions.pod:6373
16803 "This is like the C<guestfs_strings> command, but allows you to specify the "
16804 "encoding of strings that are looked for in the source file C<path>."
16808 #: ../src/guestfs-actions.pod:6377 ../fish/guestfish-actions.pod:4302
16809 msgid "Allowed encodings are:"
16813 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4306
16818 #: ../src/guestfs-actions.pod:6383
16820 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16821 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16825 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4311
16830 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4313
16831 msgid "Single 8-bit-byte characters."
16835 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4315
16840 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4317
16841 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16845 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4320
16846 msgid "l (lower case letter L)"
16850 #: ../src/guestfs-actions.pod:6397 ../fish/guestfish-actions.pod:4322
16852 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16853 "examining binaries in Windows guests."
16857 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4325
16862 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4327
16863 msgid "32-bit big endian such as UCS-4BE."
16867 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4329
16872 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4331
16873 msgid "32-bit little endian such as UCS-4LE."
16877 #: ../src/guestfs-actions.pod:6410 ../fish/guestfish-actions.pod:4335
16878 msgid "The returned strings are transcoded to UTF-8."
16882 #: ../src/guestfs-actions.pod:6421
16883 msgid "guestfs_swapoff_device"
16887 #: ../src/guestfs-actions.pod:6423
16891 " guestfs_swapoff_device (guestfs_h *g,\n"
16892 " const char *device);\n"
16897 #: ../src/guestfs-actions.pod:6427
16899 "This command disables the libguestfs appliance swap device or partition "
16900 "named C<device>. See C<guestfs_swapon_device>."
16904 #: ../src/guestfs-actions.pod:6435
16905 msgid "guestfs_swapoff_file"
16909 #: ../src/guestfs-actions.pod:6437
16913 " guestfs_swapoff_file (guestfs_h *g,\n"
16914 " const char *file);\n"
16919 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4352
16920 msgid "This command disables the libguestfs appliance swap on file."
16924 #: ../src/guestfs-actions.pod:6447
16925 msgid "guestfs_swapoff_label"
16929 #: ../src/guestfs-actions.pod:6449
16933 " guestfs_swapoff_label (guestfs_h *g,\n"
16934 " const char *label);\n"
16939 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4358
16941 "This command disables the libguestfs appliance swap on labeled swap "
16946 #: ../src/guestfs-actions.pod:6460
16947 msgid "guestfs_swapoff_uuid"
16951 #: ../src/guestfs-actions.pod:6462
16955 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16956 " const char *uuid);\n"
16961 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4365
16963 "This command disables the libguestfs appliance swap partition with the given "
16968 #: ../src/guestfs-actions.pod:6473
16969 msgid "guestfs_swapon_device"
16973 #: ../src/guestfs-actions.pod:6475
16977 " guestfs_swapon_device (guestfs_h *g,\n"
16978 " const char *device);\n"
16983 #: ../src/guestfs-actions.pod:6479
16985 "This command enables the libguestfs appliance to use the swap device or "
16986 "partition named C<device>. The increased memory is made available for all "
16987 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16991 #: ../src/guestfs-actions.pod:6484 ../fish/guestfish-actions.pod:4377
16993 "Note that you should not swap to existing guest swap partitions unless you "
16994 "know what you are doing. They may contain hibernation information, or other "
16995 "information that the guest doesn't want you to trash. You also risk leaking "
16996 "information about the host to the guest this way. Instead, attach a new "
16997 "host device to the guest and swap on that."
17001 #: ../src/guestfs-actions.pod:6495
17002 msgid "guestfs_swapon_file"
17006 #: ../src/guestfs-actions.pod:6497
17010 " guestfs_swapon_file (guestfs_h *g,\n"
17011 " const char *file);\n"
17016 #: ../src/guestfs-actions.pod:6501
17018 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17023 #: ../src/guestfs-actions.pod:6508
17024 msgid "guestfs_swapon_label"
17028 #: ../src/guestfs-actions.pod:6510
17032 " guestfs_swapon_label (guestfs_h *g,\n"
17033 " const char *label);\n"
17038 #: ../src/guestfs-actions.pod:6514
17040 "This command enables swap to a labeled swap partition. See "
17041 "C<guestfs_swapon_device> for other notes."
17045 #: ../src/guestfs-actions.pod:6521
17046 msgid "guestfs_swapon_uuid"
17050 #: ../src/guestfs-actions.pod:6523
17054 " guestfs_swapon_uuid (guestfs_h *g,\n"
17055 " const char *uuid);\n"
17060 #: ../src/guestfs-actions.pod:6527
17062 "This command enables swap to a swap partition with the given UUID. See "
17063 "C<guestfs_swapon_device> for other notes."
17067 #: ../src/guestfs-actions.pod:6534
17068 msgid "guestfs_sync"
17072 #: ../src/guestfs-actions.pod:6536
17076 " guestfs_sync (guestfs_h *g);\n"
17081 #: ../src/guestfs-actions.pod:6539 ../fish/guestfish-actions.pod:4409
17083 "This syncs the disk, so that any writes are flushed through to the "
17084 "underlying disk image."
17088 #: ../src/guestfs-actions.pod:6542 ../fish/guestfish-actions.pod:4412
17090 "You should always call this if you have modified a disk image, before "
17091 "closing the handle."
17095 #: ../src/guestfs-actions.pod:6549
17096 msgid "guestfs_tail"
17100 #: ../src/guestfs-actions.pod:6551
17104 " guestfs_tail (guestfs_h *g,\n"
17105 " const char *path);\n"
17110 #: ../src/guestfs-actions.pod:6555 ../fish/guestfish-actions.pod:4419
17112 "This command returns up to the last 10 lines of a file as a list of strings."
17116 #: ../src/guestfs-actions.pod:6567
17117 msgid "guestfs_tail_n"
17121 #: ../src/guestfs-actions.pod:6569
17125 " guestfs_tail_n (guestfs_h *g,\n"
17127 " const char *path);\n"
17132 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4429
17134 "If the parameter C<nrlines> is a positive number, this returns the last "
17135 "C<nrlines> lines of the file C<path>."
17139 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4432
17141 "If the parameter C<nrlines> is a negative number, this returns lines from "
17142 "the file C<path>, starting with the C<-nrlines>th line."
17146 #: ../src/guestfs-actions.pod:6591
17147 msgid "guestfs_tar_in"
17151 #: ../src/guestfs-actions.pod:6593
17155 " guestfs_tar_in (guestfs_h *g,\n"
17156 " const char *tarfile,\n"
17157 " const char *directory);\n"
17162 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4444
17164 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17165 "tar file) into C<directory>."
17169 #: ../src/guestfs-actions.pod:6601
17171 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17175 #: ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:6623
17176 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6655
17177 msgid "(Added in 1.0.3)"
17181 #: ../src/guestfs-actions.pod:6608
17182 msgid "guestfs_tar_out"
17186 #: ../src/guestfs-actions.pod:6610
17190 " guestfs_tar_out (guestfs_h *g,\n"
17191 " const char *directory,\n"
17192 " const char *tarfile);\n"
17197 #: ../src/guestfs-actions.pod:6615 ../fish/guestfish-actions.pod:4456
17199 "This command packs the contents of C<directory> and downloads it to local "
17204 #: ../src/guestfs-actions.pod:6618
17206 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17207 "C<guestfs_txz_out>."
17211 #: ../src/guestfs-actions.pod:6625
17212 msgid "guestfs_tgz_in"
17216 #: ../src/guestfs-actions.pod:6627
17220 " guestfs_tgz_in (guestfs_h *g,\n"
17221 " const char *tarball,\n"
17222 " const char *directory);\n"
17227 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4468
17229 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17230 "tar file) into C<directory>."
17234 #: ../src/guestfs-actions.pod:6635
17235 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17239 #: ../src/guestfs-actions.pod:6641
17240 msgid "guestfs_tgz_out"
17244 #: ../src/guestfs-actions.pod:6643
17248 " guestfs_tgz_out (guestfs_h *g,\n"
17249 " const char *directory,\n"
17250 " const char *tarball);\n"
17255 #: ../src/guestfs-actions.pod:6648 ../fish/guestfish-actions.pod:4479
17257 "This command packs the contents of C<directory> and downloads it to local "
17262 #: ../src/guestfs-actions.pod:6651
17263 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17267 #: ../src/guestfs-actions.pod:6657
17268 msgid "guestfs_touch"
17272 #: ../src/guestfs-actions.pod:6659
17276 " guestfs_touch (guestfs_h *g,\n"
17277 " const char *path);\n"
17282 #: ../src/guestfs-actions.pod:6663 ../fish/guestfish-actions.pod:4490
17284 "Touch acts like the L<touch(1)> command. It can be used to update the "
17285 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17290 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4494
17292 "This command only works on regular files, and will fail on other file types "
17293 "such as directories, symbolic links, block special etc."
17297 #: ../src/guestfs-actions.pod:6674
17298 msgid "guestfs_truncate"
17302 #: ../src/guestfs-actions.pod:6676
17306 " guestfs_truncate (guestfs_h *g,\n"
17307 " const char *path);\n"
17312 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4501
17314 "This command truncates C<path> to a zero-length file. The file must exist "
17319 #: ../src/guestfs-actions.pod:6687
17320 msgid "guestfs_truncate_size"
17324 #: ../src/guestfs-actions.pod:6689
17328 " guestfs_truncate_size (guestfs_h *g,\n"
17329 " const char *path,\n"
17330 " int64_t size);\n"
17335 #: ../src/guestfs-actions.pod:6694 ../fish/guestfish-actions.pod:4508
17337 "This command truncates C<path> to size C<size> bytes. The file must exist "
17342 #: ../src/guestfs-actions.pod:6697
17344 "If the current file size is less than C<size> then the file is extended to "
17345 "the required size with zero bytes. This creates a sparse file (ie. disk "
17346 "blocks are not allocated for the file until you write to it). To create a "
17347 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17351 #: ../src/guestfs-actions.pod:6707
17352 msgid "guestfs_tune2fs_l"
17356 #: ../src/guestfs-actions.pod:6709
17360 " guestfs_tune2fs_l (guestfs_h *g,\n"
17361 " const char *device);\n"
17366 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4521
17368 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17373 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4524
17375 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17376 "for more details. The list of fields returned isn't clearly defined, and "
17377 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17378 "and the filesystem itself."
17382 #: ../src/guestfs-actions.pod:6729
17383 msgid "guestfs_txz_in"
17387 #: ../src/guestfs-actions.pod:6731
17391 " guestfs_txz_in (guestfs_h *g,\n"
17392 " const char *tarball,\n"
17393 " const char *directory);\n"
17398 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4533
17400 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17401 "tar file) into C<directory>."
17405 #: ../src/guestfs-actions.pod:6743
17406 msgid "guestfs_txz_out"
17410 #: ../src/guestfs-actions.pod:6745
17414 " guestfs_txz_out (guestfs_h *g,\n"
17415 " const char *directory,\n"
17416 " const char *tarball);\n"
17421 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4542
17423 "This command packs the contents of C<directory> and downloads it to local "
17424 "file C<tarball> (as an xz compressed tar archive)."
17428 #: ../src/guestfs-actions.pod:6757
17429 msgid "guestfs_umask"
17433 #: ../src/guestfs-actions.pod:6759
17437 " guestfs_umask (guestfs_h *g,\n"
17443 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4551
17445 "This function sets the mask used for creating new files and device nodes to "
17450 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4554
17452 "Typical umask values would be C<022> which creates new files with "
17453 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17454 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17458 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4559
17460 "The default umask is C<022>. This is important because it means that "
17461 "directories and device nodes will be created with C<0644> or C<0755> mode "
17462 "even if you specify C<0777>."
17466 #: ../src/guestfs-actions.pod:6775
17468 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17469 "C<guestfs_mkdir>."
17473 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4566
17474 msgid "This call returns the previous umask."
17478 #: ../src/guestfs-actions.pod:6784
17479 msgid "guestfs_umount"
17483 #: ../src/guestfs-actions.pod:6786
17487 " guestfs_umount (guestfs_h *g,\n"
17488 " const char *pathordevice);\n"
17493 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4574
17495 "This unmounts the given filesystem. The filesystem may be specified either "
17496 "by its mountpoint (path) or the device which contains the filesystem."
17500 #: ../src/guestfs-actions.pod:6798
17501 msgid "guestfs_umount_all"
17505 #: ../src/guestfs-actions.pod:6800
17509 " guestfs_umount_all (guestfs_h *g);\n"
17514 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4584
17515 msgid "This unmounts all mounted filesystems."
17519 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4586
17520 msgid "Some internal mounts are not unmounted by this call."
17524 #: ../src/guestfs-actions.pod:6811
17525 msgid "guestfs_upload"
17529 #: ../src/guestfs-actions.pod:6813
17533 " guestfs_upload (guestfs_h *g,\n"
17534 " const char *filename,\n"
17535 " const char *remotefilename);\n"
17540 #: ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:6842
17541 #: ../fish/guestfish-actions.pod:4592 ../fish/guestfish-actions.pod:4605
17542 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17546 #: ../src/guestfs-actions.pod:6823
17547 msgid "See also C<guestfs_download>."
17551 #: ../src/guestfs-actions.pod:6834
17552 msgid "guestfs_upload_offset"
17556 #: ../src/guestfs-actions.pod:6836
17560 " guestfs_upload_offset (guestfs_h *g,\n"
17561 " const char *filename,\n"
17562 " const char *remotefilename,\n"
17563 " int64_t offset);\n"
17568 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4608
17570 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17571 "The intention is to overwrite parts of existing files or devices, although "
17572 "if a non-existant file is specified then it is created with a \"hole\" "
17573 "before C<offset>. The size of the data written is implicit in the size of "
17574 "the source C<filename>."
17578 #: ../src/guestfs-actions.pod:6852
17580 "Note that there is no limit on the amount of data that can be uploaded with "
17581 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17582 "full amount unless an error occurs."
17586 #: ../src/guestfs-actions.pod:6857
17587 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17591 #: ../src/guestfs-actions.pod:6868
17592 msgid "guestfs_utimens"
17596 #: ../src/guestfs-actions.pod:6870
17600 " guestfs_utimens (guestfs_h *g,\n"
17601 " const char *path,\n"
17602 " int64_t atsecs,\n"
17603 " int64_t atnsecs,\n"
17604 " int64_t mtsecs,\n"
17605 " int64_t mtnsecs);\n"
17610 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4628
17611 msgid "This command sets the timestamps of a file with nanosecond precision."
17615 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4631
17617 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17622 #: ../src/guestfs-actions.pod:6884 ../fish/guestfish-actions.pod:4634
17624 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17625 "nanoseconds from the epoch."
17629 #: ../src/guestfs-actions.pod:6887 ../fish/guestfish-actions.pod:4637
17631 "If the C<*nsecs> field contains the special value C<-1> then the "
17632 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17633 "ignored in this case)."
17637 #: ../src/guestfs-actions.pod:6891 ../fish/guestfish-actions.pod:4641
17639 "If the C<*nsecs> field contains the special value C<-2> then the "
17640 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17645 #: ../src/guestfs-actions.pod:6899 ../src/guestfs-structs.pod:175
17646 msgid "guestfs_version"
17650 #: ../src/guestfs-actions.pod:6901
17653 " struct guestfs_version *\n"
17654 " guestfs_version (guestfs_h *g);\n"
17659 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4649
17661 "Return the libguestfs version number that the program is linked against."
17665 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4652
17667 "Note that because of dynamic linking this is not necessarily the version of "
17668 "libguestfs that you compiled against. You can compile the program, and then "
17669 "at runtime dynamically link against a completely different C<libguestfs.so> "
17674 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4657
17676 "This call was added in version C<1.0.58>. In previous versions of "
17677 "libguestfs there was no way to get the version number. From C code you can "
17678 "use dynamic linker functions to find out if this symbol exists (if it "
17679 "doesn't, then it's an earlier version)."
17683 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4663
17685 "The call returns a structure with four elements. The first three (C<major>, "
17686 "C<minor> and C<release>) are numbers and correspond to the usual version "
17687 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17688 "but may be used for distro-specific information."
17692 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4669
17694 "To construct the original version string: C<$major.$minor.$release$extra>"
17698 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:4672
17699 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17703 #: ../src/guestfs-actions.pod:6929
17705 "I<Note:> Don't use this call to test for availability of features. In "
17706 "enterprise distributions we backport features from later versions into "
17707 "earlier versions, making this an unreliable way to test for features. Use "
17708 "C<guestfs_available> instead."
17712 #: ../src/guestfs-actions.pod:6935
17714 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17715 "error. I<The caller must call C<guestfs_free_version> after use>."
17719 #: ../src/guestfs-actions.pod:6939
17720 msgid "(Added in 1.0.58)"
17724 #: ../src/guestfs-actions.pod:6941
17725 msgid "guestfs_vfs_label"
17729 #: ../src/guestfs-actions.pod:6943
17733 " guestfs_vfs_label (guestfs_h *g,\n"
17734 " const char *device);\n"
17739 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4684
17740 msgid "This returns the filesystem label of the filesystem on C<device>."
17744 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4687
17745 msgid "If the filesystem is unlabeled, this returns the empty string."
17749 #: ../src/guestfs-actions.pod:6952
17750 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17754 #: ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:6994
17755 msgid "(Added in 1.3.18)"
17759 #: ../src/guestfs-actions.pod:6959
17760 msgid "guestfs_vfs_type"
17764 #: ../src/guestfs-actions.pod:6961
17768 " guestfs_vfs_type (guestfs_h *g,\n"
17769 " const char *device);\n"
17774 #: ../src/guestfs-actions.pod:6965 ../fish/guestfish-actions.pod:4695
17776 "This command gets the filesystem type corresponding to the filesystem on "
17781 #: ../src/guestfs-actions.pod:6968 ../fish/guestfish-actions.pod:4698
17783 "For most filesystems, the result is the name of the Linux VFS module which "
17784 "would be used to mount this filesystem if you mounted it without specifying "
17785 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17789 #: ../src/guestfs-actions.pod:6978
17790 msgid "guestfs_vfs_uuid"
17794 #: ../src/guestfs-actions.pod:6980
17798 " guestfs_vfs_uuid (guestfs_h *g,\n"
17799 " const char *device);\n"
17804 #: ../src/guestfs-actions.pod:6984 ../fish/guestfish-actions.pod:4707
17805 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17809 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4710
17810 msgid "If the filesystem does not have a UUID, this returns the empty string."
17814 #: ../src/guestfs-actions.pod:6989
17815 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17819 #: ../src/guestfs-actions.pod:6996
17820 msgid "guestfs_vg_activate"
17824 #: ../src/guestfs-actions.pod:6998
17828 " guestfs_vg_activate (guestfs_h *g,\n"
17830 " char *const *volgroups);\n"
17835 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4718
17837 "This command activates or (if C<activate> is false) deactivates all logical "
17838 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17839 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17840 "deactivated, then those devices disappear."
17844 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4724
17845 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17849 #: ../src/guestfs-actions.pod:7011 ../fish/guestfish-actions.pod:4726
17851 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17852 "activated or deactivated."
17856 #: ../src/guestfs-actions.pod:7018
17857 msgid "guestfs_vg_activate_all"
17861 #: ../src/guestfs-actions.pod:7020
17865 " guestfs_vg_activate_all (guestfs_h *g,\n"
17866 " int activate);\n"
17871 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4733
17873 "This command activates or (if C<activate> is false) deactivates all logical "
17874 "volumes in all volume groups. If activated, then they are made known to the "
17875 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17876 "those devices disappear."
17880 #: ../src/guestfs-actions.pod:7030 ../fish/guestfish-actions.pod:4739
17881 msgid "This command is the same as running C<vgchange -a y|n>"
17885 #: ../src/guestfs-actions.pod:7036
17886 msgid "guestfs_vgcreate"
17890 #: ../src/guestfs-actions.pod:7038
17894 " guestfs_vgcreate (guestfs_h *g,\n"
17895 " const char *volgroup,\n"
17896 " char *const *physvols);\n"
17901 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4745
17903 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17904 "of physical volumes C<physvols>."
17908 #: ../src/guestfs-actions.pod:7050
17909 msgid "guestfs_vglvuuids"
17913 #: ../src/guestfs-actions.pod:7052
17917 " guestfs_vglvuuids (guestfs_h *g,\n"
17918 " const char *vgname);\n"
17923 #: ../src/guestfs-actions.pod:7056 ../fish/guestfish-actions.pod:4752
17925 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17926 "volumes created in this volume group."
17930 #: ../src/guestfs-actions.pod:7059
17932 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17933 "associate logical volumes and volume groups."
17937 #: ../src/guestfs-actions.pod:7062
17938 msgid "See also C<guestfs_vgpvuuids>."
17942 #: ../src/guestfs-actions.pod:7070
17943 msgid "guestfs_vgpvuuids"
17947 #: ../src/guestfs-actions.pod:7072
17951 " guestfs_vgpvuuids (guestfs_h *g,\n"
17952 " const char *vgname);\n"
17957 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4764
17959 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17960 "volumes that this volume group resides on."
17964 #: ../src/guestfs-actions.pod:7079
17966 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17967 "associate physical volumes and volume groups."
17971 #: ../src/guestfs-actions.pod:7082
17972 msgid "See also C<guestfs_vglvuuids>."
17976 #: ../src/guestfs-actions.pod:7090
17977 msgid "guestfs_vgremove"
17981 #: ../src/guestfs-actions.pod:7092
17985 " guestfs_vgremove (guestfs_h *g,\n"
17986 " const char *vgname);\n"
17991 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4776
17992 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17996 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4778
17998 "This also forcibly removes all logical volumes in the volume group (if any)."
18002 #: ../src/guestfs-actions.pod:7105
18003 msgid "guestfs_vgrename"
18007 #: ../src/guestfs-actions.pod:7107
18011 " guestfs_vgrename (guestfs_h *g,\n"
18012 " const char *volgroup,\n"
18013 " const char *newvolgroup);\n"
18018 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4785
18019 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18023 #: ../src/guestfs-actions.pod:7118
18024 msgid "guestfs_vgs"
18028 #: ../src/guestfs-actions.pod:7120
18032 " guestfs_vgs (guestfs_h *g);\n"
18037 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4791
18039 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18044 #: ../src/guestfs-actions.pod:7126 ../fish/guestfish-actions.pod:4794
18046 "This returns a list of just the volume group names that were detected (eg. "
18051 #: ../src/guestfs-actions.pod:7129
18052 msgid "See also C<guestfs_vgs_full>."
18056 #: ../src/guestfs-actions.pod:7137
18057 msgid "guestfs_vgs_full"
18061 #: ../src/guestfs-actions.pod:7139
18064 " struct guestfs_lvm_vg_list *\n"
18065 " guestfs_vgs_full (guestfs_h *g);\n"
18070 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4803
18072 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18073 "> command. The \"full\" version includes all fields."
18077 #: ../src/guestfs-actions.pod:7145
18079 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18080 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18084 #: ../src/guestfs-actions.pod:7151
18085 msgid "guestfs_vgscan"
18089 #: ../src/guestfs-actions.pod:7153
18093 " guestfs_vgscan (guestfs_h *g);\n"
18098 #: ../src/guestfs-actions.pod:7156 ../fish/guestfish-actions.pod:4810
18100 "This rescans all block devices and rebuilds the list of LVM physical "
18101 "volumes, volume groups and logical volumes."
18105 #: ../src/guestfs-actions.pod:7163
18106 msgid "guestfs_vguuid"
18110 #: ../src/guestfs-actions.pod:7165
18114 " guestfs_vguuid (guestfs_h *g,\n"
18115 " const char *vgname);\n"
18120 #: ../src/guestfs-actions.pod:7169 ../fish/guestfish-actions.pod:4817
18121 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18125 #: ../src/guestfs-actions.pod:7176
18126 msgid "guestfs_wait_ready"
18130 #: ../src/guestfs-actions.pod:7178
18134 " guestfs_wait_ready (guestfs_h *g);\n"
18139 #: ../src/guestfs-actions.pod:7181
18140 msgid "This function is a no op."
18144 #: ../src/guestfs-actions.pod:7183
18146 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18147 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18148 "is no longer necessary because C<guestfs_launch> now does the waiting."
18152 #: ../src/guestfs-actions.pod:7188
18154 "If you see any calls to this function in code then you can just remove them, "
18155 "unless you want to retain compatibility with older versions of the API."
18159 #: ../src/guestfs-actions.pod:7196
18160 msgid "guestfs_wc_c"
18164 #: ../src/guestfs-actions.pod:7198
18168 " guestfs_wc_c (guestfs_h *g,\n"
18169 " const char *path);\n"
18174 #: ../src/guestfs-actions.pod:7202 ../fish/guestfish-actions.pod:4823
18176 "This command counts the characters in a file, using the C<wc -c> external "
18181 #: ../src/guestfs-actions.pod:7209
18182 msgid "guestfs_wc_l"
18186 #: ../src/guestfs-actions.pod:7211
18190 " guestfs_wc_l (guestfs_h *g,\n"
18191 " const char *path);\n"
18196 #: ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4830
18198 "This command counts the lines in a file, using the C<wc -l> external command."
18202 #: ../src/guestfs-actions.pod:7222
18203 msgid "guestfs_wc_w"
18207 #: ../src/guestfs-actions.pod:7224
18211 " guestfs_wc_w (guestfs_h *g,\n"
18212 " const char *path);\n"
18217 #: ../src/guestfs-actions.pod:7228 ../fish/guestfish-actions.pod:4837
18219 "This command counts the words in a file, using the C<wc -w> external command."
18223 #: ../src/guestfs-actions.pod:7235
18224 msgid "guestfs_write"
18228 #: ../src/guestfs-actions.pod:7237
18232 " guestfs_write (guestfs_h *g,\n"
18233 " const char *path,\n"
18234 " const char *content,\n"
18235 " size_t content_size);\n"
18240 #: ../src/guestfs-actions.pod:7243 ../fish/guestfish-actions.pod:4844
18242 "This call creates a file called C<path>. The content of the file is the "
18243 "string C<content> (which can contain any 8 bit data)."
18247 #: ../src/guestfs-actions.pod:7253
18248 msgid "guestfs_write_file"
18252 #: ../src/guestfs-actions.pod:7255
18256 " guestfs_write_file (guestfs_h *g,\n"
18257 " const char *path,\n"
18258 " const char *content,\n"
18264 #: ../src/guestfs-actions.pod:7261 ../fish/guestfish-actions.pod:4854
18266 "This call creates a file called C<path>. The contents of the file is the "
18267 "string C<content> (which can contain any 8 bit data), with length C<size>."
18271 #: ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:4858
18273 "As a special case, if C<size> is C<0> then the length is calculated using "
18274 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18278 #: ../src/guestfs-actions.pod:7269 ../fish/guestfish-actions.pod:4862
18280 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18281 "I<not> work, even if the length is specified."
18285 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4868
18287 "This function is deprecated. In new code, use the C<write> call instead."
18291 #: ../src/guestfs-actions.pod:7286
18292 msgid "guestfs_zegrep"
18296 #: ../src/guestfs-actions.pod:7288
18300 " guestfs_zegrep (guestfs_h *g,\n"
18301 " const char *regex,\n"
18302 " const char *path);\n"
18307 #: ../src/guestfs-actions.pod:7293 ../fish/guestfish-actions.pod:4879
18309 "This calls the external C<zegrep> program and returns the matching lines."
18313 #: ../src/guestfs-actions.pod:7305
18314 msgid "guestfs_zegrepi"
18318 #: ../src/guestfs-actions.pod:7307
18322 " guestfs_zegrepi (guestfs_h *g,\n"
18323 " const char *regex,\n"
18324 " const char *path);\n"
18329 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4889
18331 "This calls the external C<zegrep -i> program and returns the matching lines."
18335 #: ../src/guestfs-actions.pod:7324
18336 msgid "guestfs_zero"
18340 #: ../src/guestfs-actions.pod:7326
18344 " guestfs_zero (guestfs_h *g,\n"
18345 " const char *device);\n"
18350 #: ../src/guestfs-actions.pod:7330 ../fish/guestfish-actions.pod:4899
18351 msgid "This command writes zeroes over the first few blocks of C<device>."
18355 #: ../src/guestfs-actions.pod:7332 ../fish/guestfish-actions.pod:4901
18357 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18358 "securely wipe the device). It should be sufficient to remove any partition "
18359 "tables, filesystem superblocks and so on."
18363 #: ../src/guestfs-actions.pod:7336
18364 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18368 #: ../src/guestfs-actions.pod:7347
18369 msgid "guestfs_zero_device"
18373 #: ../src/guestfs-actions.pod:7349
18377 " guestfs_zero_device (guestfs_h *g,\n"
18378 " const char *device);\n"
18383 #: ../src/guestfs-actions.pod:7353
18385 "This command writes zeroes over the entire C<device>. Compare with "
18386 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18390 #: ../src/guestfs-actions.pod:7367
18391 msgid "(Added in 1.3.1)"
18395 #: ../src/guestfs-actions.pod:7369
18396 msgid "guestfs_zerofree"
18400 #: ../src/guestfs-actions.pod:7371
18404 " guestfs_zerofree (guestfs_h *g,\n"
18405 " const char *device);\n"
18410 #: ../src/guestfs-actions.pod:7375 ../fish/guestfish-actions.pod:4922
18412 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18413 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18414 "possible to compress the filesystem more effectively."
18418 #: ../src/guestfs-actions.pod:7380 ../fish/guestfish-actions.pod:4927
18419 msgid "You should B<not> run this program if the filesystem is mounted."
18423 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4930
18425 "It is possible that using this program can damage the filesystem or data on "
18430 #: ../src/guestfs-actions.pod:7390
18431 msgid "guestfs_zfgrep"
18435 #: ../src/guestfs-actions.pod:7392
18439 " guestfs_zfgrep (guestfs_h *g,\n"
18440 " const char *pattern,\n"
18441 " const char *path);\n"
18446 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:4937
18448 "This calls the external C<zfgrep> program and returns the matching lines."
18452 #: ../src/guestfs-actions.pod:7409
18453 msgid "guestfs_zfgrepi"
18457 #: ../src/guestfs-actions.pod:7411
18461 " guestfs_zfgrepi (guestfs_h *g,\n"
18462 " const char *pattern,\n"
18463 " const char *path);\n"
18468 #: ../src/guestfs-actions.pod:7416 ../fish/guestfish-actions.pod:4947
18470 "This calls the external C<zfgrep -i> program and returns the matching lines."
18474 #: ../src/guestfs-actions.pod:7428
18475 msgid "guestfs_zfile"
18479 #: ../src/guestfs-actions.pod:7430
18483 " guestfs_zfile (guestfs_h *g,\n"
18484 " const char *meth,\n"
18485 " const char *path);\n"
18490 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:4957
18492 "This command runs C<file> after first decompressing C<path> using C<method>."
18496 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4960
18497 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18501 #: ../src/guestfs-actions.pod:7440
18503 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18508 #: ../src/guestfs-actions.pod:7446 ../fish/guestfish-actions.pod:4965
18510 "This function is deprecated. In new code, use the C<file> call instead."
18514 #: ../src/guestfs-actions.pod:7455
18515 msgid "guestfs_zgrep"
18519 #: ../src/guestfs-actions.pod:7457
18523 " guestfs_zgrep (guestfs_h *g,\n"
18524 " const char *regex,\n"
18525 " const char *path);\n"
18530 #: ../src/guestfs-actions.pod:7462 ../fish/guestfish-actions.pod:4976
18532 "This calls the external C<zgrep> program and returns the matching lines."
18536 #: ../src/guestfs-actions.pod:7474
18537 msgid "guestfs_zgrepi"
18541 #: ../src/guestfs-actions.pod:7476
18545 " guestfs_zgrepi (guestfs_h *g,\n"
18546 " const char *regex,\n"
18547 " const char *path);\n"
18552 #: ../src/guestfs-actions.pod:7481 ../fish/guestfish-actions.pod:4986
18554 "This calls the external C<zgrep -i> program and returns the matching lines."
18558 #: ../src/guestfs-availability.pod:3
18563 #: ../src/guestfs-availability.pod:5
18565 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18566 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18567 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18568 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18569 "L</guestfs_aug_save> L</guestfs_aug_set>"
18573 #: ../src/guestfs-availability.pod:21
18578 #: ../src/guestfs-availability.pod:23
18580 "The following functions: L</guestfs_inotify_add_watch> L</"
18581 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18582 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18586 #: ../src/guestfs-availability.pod:31
18587 msgid "B<linuxfsuuid>"
18591 #: ../src/guestfs-availability.pod:33
18593 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18594 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18598 #: ../src/guestfs-availability.pod:40
18599 msgid "B<linuxmodules>"
18603 #: ../src/guestfs-availability.pod:42
18604 msgid "The following functions: L</guestfs_modprobe>"
18608 #: ../src/guestfs-availability.pod:45
18609 msgid "B<linuxxattrs>"
18613 #: ../src/guestfs-availability.pod:47
18615 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18616 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18617 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18618 "guestfs_setxattr>"
18622 #: ../src/guestfs-availability.pod:58
18627 #: ../src/guestfs-availability.pod:60
18629 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18630 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18631 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18635 #: ../src/guestfs-availability.pod:69
18640 #: ../src/guestfs-availability.pod:71
18642 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18643 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18644 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18645 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18646 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18647 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18648 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18652 #: ../src/guestfs-availability.pod:94
18657 #: ../src/guestfs-availability.pod:96
18659 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18660 "guestfs_mknod_b> L</guestfs_mknod_c>"
18664 #: ../src/guestfs-availability.pod:102
18669 #: ../src/guestfs-availability.pod:104
18670 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18674 #: ../src/guestfs-availability.pod:107
18675 msgid "B<ntfsprogs>"
18679 #: ../src/guestfs-availability.pod:109
18681 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18685 #: ../src/guestfs-availability.pod:113
18686 msgid "B<realpath>"
18690 #: ../src/guestfs-availability.pod:115
18691 msgid "The following functions: L</guestfs_realpath>"
18695 #: ../src/guestfs-availability.pod:118
18700 #: ../src/guestfs-availability.pod:120
18702 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18703 "guestfs_scrub_freespace>"
18707 #: ../src/guestfs-availability.pod:125
18712 #: ../src/guestfs-availability.pod:127
18713 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18717 #: ../src/guestfs-availability.pod:131
18722 #: ../src/guestfs-availability.pod:133
18723 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18727 #: ../src/guestfs-availability.pod:137
18728 msgid "B<zerofree>"
18732 #: ../src/guestfs-availability.pod:139
18733 msgid "The following functions: L</guestfs_zerofree>"
18737 #: ../src/guestfs-structs.pod:1
18738 msgid "guestfs_int_bool"
18742 #: ../src/guestfs-structs.pod:3
18745 " struct guestfs_int_bool {\n"
18753 #: ../src/guestfs-structs.pod:8
18756 " struct guestfs_int_bool_list {\n"
18757 " uint32_t len; /* Number of elements in list. */\n"
18758 " struct guestfs_int_bool *val; /* Elements. */\n"
18764 #: ../src/guestfs-structs.pod:13
18767 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18768 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18773 #: ../src/guestfs-structs.pod:16
18774 msgid "guestfs_lvm_pv"
18778 #: ../src/guestfs-structs.pod:18
18781 " struct guestfs_lvm_pv {\n"
18782 " char *pv_name;\n"
18783 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18784 " char pv_uuid[32];\n"
18786 " uint64_t pv_size;\n"
18787 " uint64_t dev_size;\n"
18788 " uint64_t pv_free;\n"
18789 " uint64_t pv_used;\n"
18790 " char *pv_attr;\n"
18791 " int64_t pv_pe_count;\n"
18792 " int64_t pv_pe_alloc_count;\n"
18793 " char *pv_tags;\n"
18794 " uint64_t pe_start;\n"
18795 " int64_t pv_mda_count;\n"
18796 " uint64_t pv_mda_free;\n"
18802 #: ../src/guestfs-structs.pod:36
18805 " struct guestfs_lvm_pv_list {\n"
18806 " uint32_t len; /* Number of elements in list. */\n"
18807 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18813 #: ../src/guestfs-structs.pod:41
18816 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18817 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18822 #: ../src/guestfs-structs.pod:44
18823 msgid "guestfs_lvm_vg"
18827 #: ../src/guestfs-structs.pod:46
18830 " struct guestfs_lvm_vg {\n"
18831 " char *vg_name;\n"
18832 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18833 " char vg_uuid[32];\n"
18835 " char *vg_attr;\n"
18836 " uint64_t vg_size;\n"
18837 " uint64_t vg_free;\n"
18838 " char *vg_sysid;\n"
18839 " uint64_t vg_extent_size;\n"
18840 " int64_t vg_extent_count;\n"
18841 " int64_t vg_free_count;\n"
18842 " int64_t max_lv;\n"
18843 " int64_t max_pv;\n"
18844 " int64_t pv_count;\n"
18845 " int64_t lv_count;\n"
18846 " int64_t snap_count;\n"
18847 " int64_t vg_seqno;\n"
18848 " char *vg_tags;\n"
18849 " int64_t vg_mda_count;\n"
18850 " uint64_t vg_mda_free;\n"
18856 #: ../src/guestfs-structs.pod:69
18859 " struct guestfs_lvm_vg_list {\n"
18860 " uint32_t len; /* Number of elements in list. */\n"
18861 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18867 #: ../src/guestfs-structs.pod:74
18870 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18871 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18876 #: ../src/guestfs-structs.pod:77
18877 msgid "guestfs_lvm_lv"
18881 #: ../src/guestfs-structs.pod:79
18884 " struct guestfs_lvm_lv {\n"
18885 " char *lv_name;\n"
18886 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18887 " char lv_uuid[32];\n"
18888 " char *lv_attr;\n"
18889 " int64_t lv_major;\n"
18890 " int64_t lv_minor;\n"
18891 " int64_t lv_kernel_major;\n"
18892 " int64_t lv_kernel_minor;\n"
18893 " uint64_t lv_size;\n"
18894 " int64_t seg_count;\n"
18896 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18897 " float snap_percent;\n"
18898 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18899 " float copy_percent;\n"
18900 " char *move_pv;\n"
18901 " char *lv_tags;\n"
18902 " char *mirror_log;\n"
18903 " char *modules;\n"
18909 #: ../src/guestfs-structs.pod:101
18912 " struct guestfs_lvm_lv_list {\n"
18913 " uint32_t len; /* Number of elements in list. */\n"
18914 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18920 #: ../src/guestfs-structs.pod:106
18923 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18924 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18929 #: ../src/guestfs-structs.pod:111
18932 " struct guestfs_stat {\n"
18936 " int64_t nlink;\n"
18941 " int64_t blksize;\n"
18942 " int64_t blocks;\n"
18943 " int64_t atime;\n"
18944 " int64_t mtime;\n"
18945 " int64_t ctime;\n"
18951 #: ../src/guestfs-structs.pod:127
18954 " struct guestfs_stat_list {\n"
18955 " uint32_t len; /* Number of elements in list. */\n"
18956 " struct guestfs_stat *val; /* Elements. */\n"
18962 #: ../src/guestfs-structs.pod:132
18965 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18966 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18971 #: ../src/guestfs-structs.pod:137
18974 " struct guestfs_statvfs {\n"
18975 " int64_t bsize;\n"
18976 " int64_t frsize;\n"
18977 " int64_t blocks;\n"
18978 " int64_t bfree;\n"
18979 " int64_t bavail;\n"
18980 " int64_t files;\n"
18981 " int64_t ffree;\n"
18982 " int64_t favail;\n"
18985 " int64_t namemax;\n"
18991 #: ../src/guestfs-structs.pod:151
18994 " struct guestfs_statvfs_list {\n"
18995 " uint32_t len; /* Number of elements in list. */\n"
18996 " struct guestfs_statvfs *val; /* Elements. */\n"
19002 #: ../src/guestfs-structs.pod:156
19005 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19006 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19011 #: ../src/guestfs-structs.pod:159
19012 msgid "guestfs_dirent"
19016 #: ../src/guestfs-structs.pod:161
19019 " struct guestfs_dirent {\n"
19028 #: ../src/guestfs-structs.pod:167
19031 " struct guestfs_dirent_list {\n"
19032 " uint32_t len; /* Number of elements in list. */\n"
19033 " struct guestfs_dirent *val; /* Elements. */\n"
19039 #: ../src/guestfs-structs.pod:172
19042 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19043 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19048 #: ../src/guestfs-structs.pod:177
19051 " struct guestfs_version {\n"
19052 " int64_t major;\n"
19053 " int64_t minor;\n"
19054 " int64_t release;\n"
19061 #: ../src/guestfs-structs.pod:184
19064 " struct guestfs_version_list {\n"
19065 " uint32_t len; /* Number of elements in list. */\n"
19066 " struct guestfs_version *val; /* Elements. */\n"
19072 #: ../src/guestfs-structs.pod:189
19075 " void guestfs_free_version (struct guestfs_free_version *);\n"
19076 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19081 #: ../src/guestfs-structs.pod:192
19082 msgid "guestfs_xattr"
19086 #: ../src/guestfs-structs.pod:194
19089 " struct guestfs_xattr {\n"
19090 " char *attrname;\n"
19091 " /* The next two fields describe a byte array. */\n"
19092 " uint32_t attrval_len;\n"
19093 " char *attrval;\n"
19099 #: ../src/guestfs-structs.pod:201
19102 " struct guestfs_xattr_list {\n"
19103 " uint32_t len; /* Number of elements in list. */\n"
19104 " struct guestfs_xattr *val; /* Elements. */\n"
19110 #: ../src/guestfs-structs.pod:206
19113 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19114 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19119 #: ../src/guestfs-structs.pod:209
19120 msgid "guestfs_inotify_event"
19124 #: ../src/guestfs-structs.pod:211
19127 " struct guestfs_inotify_event {\n"
19128 " int64_t in_wd;\n"
19129 " uint32_t in_mask;\n"
19130 " uint32_t in_cookie;\n"
19131 " char *in_name;\n"
19137 #: ../src/guestfs-structs.pod:218
19140 " struct guestfs_inotify_event_list {\n"
19141 " uint32_t len; /* Number of elements in list. */\n"
19142 " struct guestfs_inotify_event *val; /* Elements. */\n"
19148 #: ../src/guestfs-structs.pod:223
19151 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19152 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19157 #: ../src/guestfs-structs.pod:226
19158 msgid "guestfs_partition"
19162 #: ../src/guestfs-structs.pod:228
19165 " struct guestfs_partition {\n"
19166 " int32_t part_num;\n"
19167 " uint64_t part_start;\n"
19168 " uint64_t part_end;\n"
19169 " uint64_t part_size;\n"
19175 #: ../src/guestfs-structs.pod:235
19178 " struct guestfs_partition_list {\n"
19179 " uint32_t len; /* Number of elements in list. */\n"
19180 " struct guestfs_partition *val; /* Elements. */\n"
19186 #: ../src/guestfs-structs.pod:240
19189 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19190 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19195 #: ../src/guestfs-structs.pod:243
19196 msgid "guestfs_application"
19200 #: ../src/guestfs-structs.pod:245
19203 " struct guestfs_application {\n"
19204 " char *app_name;\n"
19205 " char *app_display_name;\n"
19206 " int32_t app_epoch;\n"
19207 " char *app_version;\n"
19208 " char *app_release;\n"
19209 " char *app_install_path;\n"
19210 " char *app_trans_path;\n"
19211 " char *app_publisher;\n"
19212 " char *app_url;\n"
19213 " char *app_source_package;\n"
19214 " char *app_summary;\n"
19215 " char *app_description;\n"
19221 #: ../src/guestfs-structs.pod:260
19224 " struct guestfs_application_list {\n"
19225 " uint32_t len; /* Number of elements in list. */\n"
19226 " struct guestfs_application *val; /* Elements. */\n"
19232 #: ../src/guestfs-structs.pod:265
19235 " void guestfs_free_application (struct guestfs_free_application *);\n"
19236 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19241 #: ../fish/guestfish.pod:5
19242 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19246 #: ../fish/guestfish.pod:9
19249 " guestfish [--options] [commands]\n"
19254 #: ../fish/guestfish.pod:11
19262 #: ../fish/guestfish.pod:13
19265 " guestfish [--ro|--rw] -a disk.img\n"
19270 #: ../fish/guestfish.pod:15
19273 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19278 #: ../fish/guestfish.pod:17
19281 " guestfish -d libvirt-domain\n"
19286 #: ../fish/guestfish.pod:19
19289 " guestfish [--ro|--rw] -a disk.img -i\n"
19294 #: ../fish/guestfish.pod:21
19297 " guestfish -d libvirt-domain -i\n"
19302 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19303 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19308 #: ../fish/guestfish.pod:25
19310 "Using guestfish in read/write mode on live virtual machines can be "
19311 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19312 "option to use guestfish safely if the disk image or virtual machine might be "
19317 #: ../fish/guestfish.pod:32
19319 "Guestfish is a shell and command-line tool for examining and modifying "
19320 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19321 "functionality of the guestfs API, see L<guestfs(3)>."
19325 #: ../fish/guestfish.pod:36
19327 "Guestfish gives you structured access to the libguestfs API, from shell "
19328 "scripts or the command line or interactively. If you want to rescue a "
19329 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19334 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
19335 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19340 #: ../fish/guestfish.pod:43
19341 msgid "As an interactive shell"
19345 #: ../fish/guestfish.pod:45
19353 #: ../fish/guestfish.pod:47
19356 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19357 " editing virtual machine filesystems.\n"
19362 #: ../fish/guestfish.pod:50
19365 " Type: 'help' for a list of commands\n"
19366 " 'man' to read the manual\n"
19367 " 'quit' to quit the shell\n"
19372 #: ../fish/guestfish.pod:54
19375 " ><fs> add-ro disk.img\n"
19377 " ><fs> list-filesystems\n"
19378 " /dev/sda1: ext4\n"
19379 " /dev/vg_guest/lv_root: ext4\n"
19380 " /dev/vg_guest/lv_swap: swap\n"
19381 " ><fs> mount /dev/vg_guest/lv_root /\n"
19382 " ><fs> cat /etc/fstab\n"
19384 " # Created by anaconda\n"
19391 #: ../fish/guestfish.pod:67
19392 msgid "From shell scripts"
19396 #: ../fish/guestfish.pod:69
19397 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19401 #: ../fish/guestfish.pod:71
19404 " guestfish <<_EOF_\n"
19407 " mount /dev/vg_guest/lv_root /\n"
19408 " write /etc/motd \"Welcome, new users\"\n"
19414 #: ../fish/guestfish.pod:78
19415 msgid "List the LVM logical volumes in a disk image:"
19419 #: ../fish/guestfish.pod:80
19422 " guestfish -a disk.img --ro <<_EOF_\n"
19430 #: ../fish/guestfish.pod:85
19431 msgid "List all the filesystems in a disk image:"
19435 #: ../fish/guestfish.pod:87
19438 " guestfish -a disk.img --ro <<_EOF_\n"
19440 " list-filesystems\n"
19446 #: ../fish/guestfish.pod:92
19447 msgid "On one command line"
19451 #: ../fish/guestfish.pod:94
19452 msgid "Update C</etc/resolv.conf> in a guest:"
19456 #: ../fish/guestfish.pod:96
19460 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19461 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19466 #: ../fish/guestfish.pod:100
19467 msgid "Edit C</boot/grub/grub.conf> interactively:"
19471 #: ../fish/guestfish.pod:102
19474 " guestfish --rw --add disk.img \\\n"
19475 " --mount /dev/vg_guest/lv_root \\\n"
19476 " --mount /dev/sda1:/boot \\\n"
19477 " edit /boot/grub/grub.conf\n"
19482 #: ../fish/guestfish.pod:107
19483 msgid "Mount disks automatically"
19487 #: ../fish/guestfish.pod:109
19489 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19493 #: ../fish/guestfish.pod:112
19496 " guestfish --ro -a disk.img -i cat /etc/group\n"
19501 #: ../fish/guestfish.pod:114
19504 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19509 #: ../fish/guestfish.pod:116
19510 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19514 #: ../fish/guestfish.pod:118
19517 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19522 #: ../fish/guestfish.pod:120
19523 msgid "As a script interpreter"
19527 #: ../fish/guestfish.pod:122
19528 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19532 #: ../fish/guestfish.pod:124
19535 " #!/usr/bin/guestfish -f\n"
19536 " sparse test1.img 100M\n"
19538 " part-disk /dev/sda mbr\n"
19539 " mkfs ext2 /dev/sda1\n"
19544 #: ../fish/guestfish.pod:130
19545 msgid "Start with a prepared disk"
19549 #: ../fish/guestfish.pod:132
19551 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19552 "single ext2-formatted partition:"
19556 #: ../fish/guestfish.pod:135
19559 " guestfish -N fs\n"
19564 #: ../fish/guestfish.pod:137
19565 msgid "To list what is available do:"
19569 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19572 " guestfish -N help | less\n"
19577 #: ../fish/guestfish.pod:141
19578 msgid "Remote control"
19582 #: ../fish/guestfish.pod:143
19585 " eval \"`guestfish --listen`\"\n"
19586 " guestfish --remote add-ro disk.img\n"
19587 " guestfish --remote run\n"
19588 " guestfish --remote lvs\n"
19593 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19594 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
19595 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19596 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19597 #: ../tools/virt-list-partitions.pl:54
19602 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:133
19603 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19604 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19605 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19610 #: ../fish/guestfish.pod:154
19611 msgid "Displays general help on options."
19615 #: ../fish/guestfish.pod:156
19620 #: ../fish/guestfish.pod:158
19621 msgid "B<--cmd-help>"
19625 #: ../fish/guestfish.pod:160
19626 msgid "Lists all available guestfish commands."
19630 #: ../fish/guestfish.pod:162
19635 #: ../fish/guestfish.pod:164
19636 msgid "B<--cmd-help cmd>"
19640 #: ../fish/guestfish.pod:166
19641 msgid "Displays detailed help on a single command C<cmd>."
19645 #: ../fish/guestfish.pod:168
19646 msgid "B<-a image>"
19650 #: ../fish/guestfish.pod:170
19651 msgid "B<--add image>"
19655 #: ../fish/guestfish.pod:172
19656 msgid "Add a block device or virtual machine image to the shell."
19660 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19662 "The format of the disk image is auto-detected. To override this and force a "
19663 "particular format use the I<--format=..> option."
19667 #: ../fish/guestfish.pod:177
19669 "Using this flag is mostly equivalent to using the C<add> command, with "
19670 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19671 "the I<--format=...> flag was given."
19675 #: ../fish/guestfish.pod:181
19680 #: ../fish/guestfish.pod:183
19681 msgid "B<--connect URI>"
19685 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19687 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19688 "URI to use. The default is to use the default libvirt connection."
19692 #: ../fish/guestfish.pod:189
19697 #: ../fish/guestfish.pod:191
19699 "If using the I<--listen> option and a csh-like shell, use this option. See "
19700 "section L</REMOTE CONTROL AND CSH> below."
19704 #: ../fish/guestfish.pod:194
19705 msgid "B<-d libvirt-domain>"
19709 #: ../fish/guestfish.pod:196
19710 msgid "B<--domain libvirt-domain>"
19714 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19716 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19717 "used, then any libvirt domain can be used. However in write mode, only "
19718 "libvirt domains which are shut down can be named here."
19722 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:96
19723 msgid "Domain UUIDs can be used instead of names."
19727 #: ../fish/guestfish.pod:204
19729 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19730 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19731 "if the I<--format:...> flag was given."
19735 #: ../fish/guestfish.pod:208
19740 #: ../fish/guestfish.pod:210
19741 msgid "B<--no-dest-paths>"
19745 #: ../fish/guestfish.pod:212
19747 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19748 "to hit the tab key to complete paths on the guest filesystem, but this "
19749 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19750 "allow this feature to be disabled."
19754 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19755 msgid "B<--echo-keys>"
19759 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:112
19761 "When prompting for keys and passphrases, guestfish normally turns echoing "
19762 "off so you cannot see what you are typing. If you are not worried about "
19763 "Tempest attacks and there is no one else in the room you can specify this "
19764 "flag to see what you are typing."
19768 #: ../fish/guestfish.pod:224
19773 #: ../fish/guestfish.pod:226
19774 msgid "B<--file file>"
19778 #: ../fish/guestfish.pod:228
19779 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19783 #: ../fish/guestfish.pod:231
19786 " #!/usr/bin/guestfish -f\n"
19791 #: ../fish/guestfish.pod:233
19792 msgid "B<--format=raw|qcow2|..>"
19796 #: ../fish/guestfish.pod:235
19797 msgid "B<--format>"
19801 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:119
19803 "The default for the I<-a> option is to auto-detect the format of the disk "
19804 "image. Using this forces the disk format for I<-a> options which follow on "
19805 "the command line. Using I<--format> with no argument switches back to auto-"
19806 "detection for subsequent I<-a> options."
19810 #: ../fish/guestfish.pod:244
19813 " guestfish --format=raw -a disk.img\n"
19818 #: ../fish/guestfish.pod:246
19819 msgid "forces raw format (no auto-detection) for C<disk.img>."
19823 #: ../fish/guestfish.pod:248
19826 " guestfish --format=raw -a disk.img --format -a another.img\n"
19831 #: ../fish/guestfish.pod:250
19833 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19834 "detection for C<another.img>."
19838 #: ../fish/guestfish.pod:253
19840 "If you have untrusted raw-format guest disk images, you should use this "
19841 "option to specify the disk format. This avoids a possible security problem "
19842 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19846 #: ../fish/guestfish.pod:258
19851 #: ../fish/guestfish.pod:260
19852 msgid "B<--inspector>"
19856 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:139
19858 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19859 "system and mount filesystems as they would be mounted on the real virtual "
19864 #: ../fish/guestfish.pod:266
19865 msgid "Typical usage is either:"
19869 #: ../fish/guestfish.pod:268
19872 " guestfish -d myguest -i\n"
19877 #: ../fish/guestfish.pod:270
19878 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19882 #: ../fish/guestfish.pod:272
19885 " guestfish --ro -d myguest -i\n"
19890 #: ../fish/guestfish.pod:274
19891 msgid "(for active domains, readonly), or specify the block device directly:"
19895 #: ../fish/guestfish.pod:276
19898 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19903 #: ../fish/guestfish.pod:278
19905 "Note that the command line syntax changed slightly over older versions of "
19906 "guestfish. You can still use the old syntax:"
19910 #: ../fish/guestfish.pod:281
19913 " guestfish [--ro] -i disk.img\n"
19918 #: ../fish/guestfish.pod:283
19921 " guestfish [--ro] -i libvirt-domain\n"
19926 #: ../fish/guestfish.pod:285
19928 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19929 "then using other commands to mount the filesystems that were found."
19933 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19934 msgid "B<--keys-from-stdin>"
19938 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:145
19940 "Read key or passphrase parameters from stdin. The default is to try to read "
19941 "passphrases from the user by opening C</dev/tty>."
19945 #: ../fish/guestfish.pod:294
19946 msgid "B<--listen>"
19950 #: ../fish/guestfish.pod:296
19952 "Fork into the background and listen for remote commands. See section L</"
19953 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19957 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19962 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:150
19964 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19965 "ATTACHING TO RUNNING DAEMONS>)."
19969 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19970 msgid "B<-m dev[:mountpoint[:options]]>"
19974 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:155
19975 msgid "B<--mount dev[:mountpoint[:options]]>"
19979 #: ../fish/guestfish.pod:308
19980 msgid "Mount the named partition or logical volume on the given mountpoint."
19984 #: ../fish/guestfish.pod:310
19985 msgid "If the mountpoint is omitted, it defaults to C</>."
19989 #: ../fish/guestfish.pod:312
19990 msgid "You have to mount something on C</> before most commands will work."
19994 #: ../fish/guestfish.pod:314
19996 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20001 #: ../fish/guestfish.pod:317
20003 "If you don't know what filesystems a disk image contains, you can either run "
20004 "guestfish without this option, then list the partitions, filesystems and LVs "
20005 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20006 "commands), or you can use the L<virt-filesystems(1)> program."
20010 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:163
20012 "The third (and rarely used) part of the mount parameter is the list of mount "
20013 "options used to mount the underlying filesystem. If this is not given, then "
20014 "the mount options are either the empty string or C<ro> (the latter if the "
20015 "I<--ro> flag is used). By specifying the mount options, you override this "
20016 "default choice. Probably the only time you would use this is to enable ACLs "
20017 "and/or extended attributes if the filesystem can support them:"
20021 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:171
20024 " -m /dev/sda1:/:acl,user_xattr\n"
20029 #: ../fish/guestfish.pod:333
20030 msgid "Using this flag is equivalent to using the C<mount-options> command."
20034 #: ../fish/guestfish.pod:335
20039 #: ../fish/guestfish.pod:337
20040 msgid "B<--no-sync>"
20044 #: ../fish/guestfish.pod:339
20046 "Disable autosync. This is enabled by default. See the discussion of "
20047 "autosync in the L<guestfs(3)> manpage."
20051 #: ../fish/guestfish.pod:342
20056 #: ../fish/guestfish.pod:344
20057 msgid "B<--new type>"
20061 #: ../fish/guestfish.pod:346
20066 #: ../fish/guestfish.pod:348
20068 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20069 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20070 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20075 #: ../fish/guestfish.pod:353
20076 msgid "B<--progress-bars>"
20080 #: ../fish/guestfish.pod:355
20081 msgid "Enable progress bars, even when guestfish is used non-interactively."
20085 #: ../fish/guestfish.pod:357
20087 "Progress bars are enabled by default when guestfish is used as an "
20088 "interactive shell."
20092 #: ../fish/guestfish.pod:360
20093 msgid "B<--no-progress-bars>"
20097 #: ../fish/guestfish.pod:362
20098 msgid "Disable progress bars."
20102 #: ../fish/guestfish.pod:364
20103 msgid "B<--remote[=pid]>"
20107 #: ../fish/guestfish.pod:366
20109 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20110 "CONTROL GUESTFISH OVER A SOCKET> below."
20114 #: ../fish/guestfish.pod:369
20119 #: ../fish/guestfish.pod:371
20124 #: ../fish/guestfish.pod:373
20126 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20127 "mounts are done read-only."
20131 #: ../fish/guestfish.pod:376
20133 "The option must always be used if the disk image or virtual machine might be "
20134 "running, and is generally recommended in cases where you don't need write "
20135 "access to the disk."
20139 #: ../fish/guestfish.pod:380
20141 "Note that prepared disk images created with I<-N> are not affected by this "
20142 "option. Also commands like C<add> are not affected - you have to specify "
20143 "the C<readonly:true> option explicitly if you need it."
20147 #: ../fish/guestfish.pod:384
20148 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20152 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:227
20153 msgid "B<--selinux>"
20157 #: ../fish/guestfish.pod:388
20158 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20162 #: ../fish/guestfish.pod:390
20167 #: ../fish/guestfish.pod:392
20168 msgid "B<--verbose>"
20172 #: ../fish/guestfish.pod:394
20174 "Enable very verbose messages. This is particularly useful if you find a bug."
20178 #: ../fish/guestfish.pod:397
20183 #: ../fish/guestfish.pod:399 ../tools/virt-edit.pl:97
20184 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
20185 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
20186 #: ../tools/virt-list-partitions.pl:70
20187 msgid "B<--version>"
20191 #: ../fish/guestfish.pod:401
20192 msgid "Display the guestfish / libguestfs version number and exit."
20196 #: ../fish/guestfish.pod:403
20201 #: ../fish/guestfish.pod:405
20206 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:241
20208 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20209 "mounts are done read-write."
20213 #: ../fish/guestfish.pod:410
20214 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20218 #: ../fish/guestfish.pod:412
20223 #: ../fish/guestfish.pod:414
20224 msgid "Echo each command before executing it."
20228 #: ../fish/guestfish.pod:418
20229 msgid "COMMANDS ON COMMAND LINE"
20233 #: ../fish/guestfish.pod:420
20235 "Any additional (non-option) arguments are treated as commands to execute."
20239 #: ../fish/guestfish.pod:423
20241 "Commands to execute should be separated by a colon (C<:>), where the colon "
20242 "is a separate parameter. Thus:"
20246 #: ../fish/guestfish.pod:426
20249 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20254 #: ../fish/guestfish.pod:428
20256 "If there are no additional arguments, then we enter a shell, either an "
20257 "interactive shell with a prompt (if the input is a terminal) or a non-"
20258 "interactive shell."
20262 #: ../fish/guestfish.pod:432
20264 "In either command line mode or non-interactive shell, the first command that "
20265 "gives an error causes the whole shell to exit. In interactive mode (with a "
20266 "prompt) if a command fails, you can continue to enter commands."
20270 #: ../fish/guestfish.pod:437
20271 msgid "USING launch (OR run)"
20275 #: ../fish/guestfish.pod:439
20277 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20278 "then launch it, then mount any disks you need, and finally issue actions/"
20279 "commands. So the general order of the day is:"
20283 #: ../fish/guestfish.pod:447
20284 msgid "add or -a/--add"
20288 #: ../fish/guestfish.pod:451
20289 msgid "launch (aka run)"
20293 #: ../fish/guestfish.pod:455
20294 msgid "mount or -m/--mount"
20298 #: ../fish/guestfish.pod:459
20299 msgid "any other commands"
20303 #: ../fish/guestfish.pod:463
20305 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20306 "guest before mounting or performing any other commands."
20310 #: ../fish/guestfish.pod:466
20312 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20313 "I<--new> options were given then C<run> is done automatically, simply "
20314 "because guestfish can't perform the action you asked for without doing this."
20318 #: ../fish/guestfish.pod:471
20319 msgid "OPENING DISKS FOR READ AND WRITE"
20323 #: ../fish/guestfish.pod:473
20325 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20326 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20327 "I<-i> and I<-m> open disk images read-only or for writing."
20331 #: ../fish/guestfish.pod:478
20333 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20334 "opening disk images supplied on the command line for write. To open a disk "
20335 "image read-only you have to do I<-a image --ro>."
20339 #: ../fish/guestfish.pod:482
20341 "This matters: If you accidentally open a live VM disk image writable then "
20342 "you will cause irreversible disk corruption."
20346 #: ../fish/guestfish.pod:485
20348 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20349 "images will be opened read-only. You will have to either specify "
20350 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20351 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20352 "access for disk images specified by those other command line options."
20356 #: ../fish/guestfish.pod:492
20358 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20359 "which does nothing (it is already the default). However it is highly "
20360 "recommended that you use this option to indicate that you need write access, "
20361 "and prepare your scripts for the day when this option will be required for "
20366 #: ../fish/guestfish.pod:498
20368 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20369 "other libguestfs program apart from guestfish and guestmount."
20373 #: ../fish/guestfish.pod:501
20378 #: ../fish/guestfish.pod:503
20380 "You can quote ordinary parameters using either single or double quotes. For "
20385 #: ../fish/guestfish.pod:506
20388 " add \"file with a space.img\"\n"
20393 #: ../fish/guestfish.pod:508
20396 " rm '/file name'\n"
20401 #: ../fish/guestfish.pod:510
20409 #: ../fish/guestfish.pod:512
20411 "A few commands require a list of strings to be passed. For these, use a "
20412 "whitespace-separated list, enclosed in quotes. Strings containing "
20413 "whitespace to be passed through must be enclosed in single quotes. A "
20414 "literal single quote must be escaped with a backslash."
20418 #: ../fish/guestfish.pod:517
20421 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20422 " command \"/bin/echo 'foo bar'\"\n"
20423 " command \"/bin/echo \\'foo\\'\"\n"
20428 #: ../fish/guestfish.pod:521
20429 msgid "OPTIONAL ARGUMENTS"
20433 #: ../fish/guestfish.pod:523
20435 "Some commands take optional arguments. These arguments appear in this "
20436 "documentation as C<[argname:..]>. You can use them as in these examples:"
20440 #: ../fish/guestfish.pod:527
20443 " add-drive-opts filename\n"
20448 #: ../fish/guestfish.pod:529
20451 " add-drive-opts filename readonly:true\n"
20456 #: ../fish/guestfish.pod:531
20459 " add-drive-opts filename format:qcow2 readonly:false\n"
20464 #: ../fish/guestfish.pod:533
20466 "Each optional argument can appear at most once. All optional arguments must "
20467 "appear after the required ones."
20471 #: ../fish/guestfish.pod:536
20476 #: ../fish/guestfish.pod:538
20478 "This section applies to all commands which can take integers as parameters."
20482 #: ../fish/guestfish.pod:541
20483 msgid "SIZE SUFFIX"
20487 #: ../fish/guestfish.pod:543
20489 "When the command takes a parameter measured in bytes, you can use one of the "
20490 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20494 #: ../fish/guestfish.pod:549
20495 msgid "B<k> or B<K> or B<KiB>"
20499 #: ../fish/guestfish.pod:551
20500 msgid "The size in kilobytes (multiplied by 1024)."
20504 #: ../fish/guestfish.pod:553
20509 #: ../fish/guestfish.pod:555
20510 msgid "The size in SI 1000 byte units."
20514 #: ../fish/guestfish.pod:557
20515 msgid "B<M> or B<MiB>"
20519 #: ../fish/guestfish.pod:559
20520 msgid "The size in megabytes (multiplied by 1048576)."
20524 #: ../fish/guestfish.pod:561
20529 #: ../fish/guestfish.pod:563
20530 msgid "The size in SI 1000000 byte units."
20534 #: ../fish/guestfish.pod:565
20535 msgid "B<G> or B<GiB>"
20539 #: ../fish/guestfish.pod:567
20540 msgid "The size in gigabytes (multiplied by 2**30)."
20544 #: ../fish/guestfish.pod:569
20549 #: ../fish/guestfish.pod:571
20550 msgid "The size in SI 10**9 byte units."
20554 #: ../fish/guestfish.pod:573
20555 msgid "B<T> or B<TiB>"
20559 #: ../fish/guestfish.pod:575
20560 msgid "The size in terabytes (multiplied by 2**40)."
20564 #: ../fish/guestfish.pod:577
20569 #: ../fish/guestfish.pod:579
20570 msgid "The size in SI 10**12 byte units."
20574 #: ../fish/guestfish.pod:581
20575 msgid "B<P> or B<PiB>"
20579 #: ../fish/guestfish.pod:583
20580 msgid "The size in petabytes (multiplied by 2**50)."
20584 #: ../fish/guestfish.pod:585
20589 #: ../fish/guestfish.pod:587
20590 msgid "The size in SI 10**15 byte units."
20594 #: ../fish/guestfish.pod:589
20595 msgid "B<E> or B<EiB>"
20599 #: ../fish/guestfish.pod:591
20600 msgid "The size in exabytes (multiplied by 2**60)."
20604 #: ../fish/guestfish.pod:593
20609 #: ../fish/guestfish.pod:595
20610 msgid "The size in SI 10**18 byte units."
20614 #: ../fish/guestfish.pod:597
20615 msgid "B<Z> or B<ZiB>"
20619 #: ../fish/guestfish.pod:599
20620 msgid "The size in zettabytes (multiplied by 2**70)."
20624 #: ../fish/guestfish.pod:601
20629 #: ../fish/guestfish.pod:603
20630 msgid "The size in SI 10**21 byte units."
20634 #: ../fish/guestfish.pod:605
20635 msgid "B<Y> or B<YiB>"
20639 #: ../fish/guestfish.pod:607
20640 msgid "The size in yottabytes (multiplied by 2**80)."
20644 #: ../fish/guestfish.pod:609
20649 #: ../fish/guestfish.pod:611
20650 msgid "The size in SI 10**24 byte units."
20654 #: ../fish/guestfish.pod:617
20657 " truncate-size /file 1G\n"
20662 #: ../fish/guestfish.pod:619
20663 msgid "would truncate the file to 1 gigabyte."
20667 #: ../fish/guestfish.pod:621
20669 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20670 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20671 "suffix will probably not do what you expect."
20675 #: ../fish/guestfish.pod:625
20676 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20680 #: ../fish/guestfish.pod:627
20682 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20683 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20687 #: ../fish/guestfish.pod:630
20690 " 1234 decimal number 1234\n"
20691 " 02322 octal number, equivalent to decimal 1234\n"
20692 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20697 #: ../fish/guestfish.pod:634
20699 "When using the C<chmod> command, you almost always want to specify an octal "
20700 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20701 "L<chmod(1)> program):"
20705 #: ../fish/guestfish.pod:638
20708 " chmod 0777 /public # OK\n"
20709 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20714 #: ../fish/guestfish.pod:641
20716 "Commands that return numbers usually print them in decimal, but some "
20717 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20718 "octal, preceeded by C<0>)."
20722 #: ../fish/guestfish.pod:645
20723 msgid "WILDCARDS AND GLOBBING"
20727 #: ../fish/guestfish.pod:647
20729 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20730 "(globbing) by default. So for example the following will not do what you "
20735 #: ../fish/guestfish.pod:651
20743 #: ../fish/guestfish.pod:653
20745 "Assuming you don't have a directory called literally C</home/*> then the "
20746 "above command will return an error."
20750 #: ../fish/guestfish.pod:656
20751 msgid "To perform wildcard expansion, use the C<glob> command."
20755 #: ../fish/guestfish.pod:658
20758 " glob rm-rf /home/*\n"
20763 #: ../fish/guestfish.pod:660
20765 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20766 "many times), equivalent to:"
20770 #: ../fish/guestfish.pod:663
20773 " rm-rf /home/jim\n"
20774 " rm-rf /home/joe\n"
20775 " rm-rf /home/mary\n"
20780 #: ../fish/guestfish.pod:667
20781 msgid "C<glob> only works on simple guest paths and not on device names."
20785 #: ../fish/guestfish.pod:669
20787 "If you have several parameters, each containing a wildcard, then glob will "
20788 "perform a Cartesian product."
20792 #: ../fish/guestfish.pod:672
20797 #: ../fish/guestfish.pod:674
20799 "Any line which starts with a I<#> character is treated as a comment and "
20800 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20801 "a command. For example:"
20805 #: ../fish/guestfish.pod:678
20808 " # this is a comment\n"
20809 " # this is a comment\n"
20810 " foo # NOT a comment\n"
20815 #: ../fish/guestfish.pod:682
20816 msgid "Blank lines are also ignored."
20820 #: ../fish/guestfish.pod:684
20821 msgid "RUNNING COMMANDS LOCALLY"
20825 #: ../fish/guestfish.pod:686
20827 "Any line which starts with a I<!> character is treated as a command sent to "
20828 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20832 #: ../fish/guestfish.pod:690
20836 " tgz-out /remote local/remote-data.tar.gz\n"
20841 #: ../fish/guestfish.pod:693
20843 "will create a directory C<local> on the host, and then export the contents "
20844 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20845 "(See C<tgz-out>)."
20849 #: ../fish/guestfish.pod:697
20851 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20852 "effect, due to the way that subprocesses work in Unix."
20856 #: ../fish/guestfish.pod:700
20857 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20861 #: ../fish/guestfish.pod:702
20863 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20864 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20865 "and executed as guestfish commands."
20869 #: ../fish/guestfish.pod:706
20871 "Thus you can use shell script to construct arbitrary guestfish commands "
20872 "which are then parsed by guestfish."
20876 #: ../fish/guestfish.pod:709
20878 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20879 "through C</foo.100>) using guestfish commands alone. However this is simple "
20880 "if we use a shell script to create the guestfish commands for us:"
20884 #: ../fish/guestfish.pod:714
20887 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20892 #: ../fish/guestfish.pod:716
20893 msgid "or with names like C</foo.001>:"
20897 #: ../fish/guestfish.pod:718
20900 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20905 #: ../fish/guestfish.pod:720
20907 "When using guestfish interactively it can be helpful to just run the shell "
20908 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20909 "ordinary I<!> local command), see what guestfish commands it would run, and "
20910 "when you are happy with those prepend the C<E<lt>> character to run the "
20911 "guestfish commands for real."
20915 #: ../fish/guestfish.pod:726
20920 #: ../fish/guestfish.pod:728
20922 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20923 "command (a guestfish command) to the second command (any host command). For "
20928 #: ../fish/guestfish.pod:732
20931 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20936 #: ../fish/guestfish.pod:734
20938 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20939 "program). The above command would list all accounts in the guest filesystem "
20940 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20944 #: ../fish/guestfish.pod:739
20947 " hexdump /bin/ls | head\n"
20948 " list-devices | tail -1\n"
20949 " tgz-out / - | tar ztf -\n"
20954 #: ../fish/guestfish.pod:743
20956 "The space before the pipe symbol is required, any space after the pipe "
20957 "symbol is optional. Everything after the pipe symbol is just passed "
20958 "straight to the host shell, so it can contain redirections, globs and "
20959 "anything else that makes sense on the host side."
20963 #: ../fish/guestfish.pod:748
20965 "To use a literal argument which begins with a pipe symbol, you have to quote "
20970 #: ../fish/guestfish.pod:751
20978 #: ../fish/guestfish.pod:753
20979 msgid "HOME DIRECTORIES"
20983 #: ../fish/guestfish.pod:755
20985 "If a parameter starts with the character C<~> then the tilde may be expanded "
20986 "as a home directory path (either C<~> for the current user's home directory, "
20987 "or C<~user> for another user)."
20991 #: ../fish/guestfish.pod:759
20993 "Note that home directory expansion happens for users known I<on the host>, "
20994 "not in the guest filesystem."
20998 #: ../fish/guestfish.pod:762
21000 "To use a literal argument which begins with a tilde, you have to quote it, "
21005 #: ../fish/guestfish.pod:765
21013 #: ../fish/guestfish.pod:769
21015 "Libguestfs has some support for Linux guests encrypted according to the "
21016 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21017 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21018 "LUKS is supported."
21022 #: ../fish/guestfish.pod:774
21023 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21027 #: ../fish/guestfish.pod:776
21030 " ><fs> vfs-type /dev/sda2\n"
21036 #: ../fish/guestfish.pod:779
21038 "Then open those devices using L</luks-open>. This creates a device-mapper "
21039 "device called C</dev/mapper/luksdev>."
21043 #: ../fish/guestfish.pod:782
21046 " ><fs> luks-open /dev/sda2 luksdev\n"
21047 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21052 #: ../fish/guestfish.pod:785
21054 "Finally you have to tell LVM to scan for volume groups on the newly created "
21059 #: ../fish/guestfish.pod:788
21063 " vg-activate-all true\n"
21068 #: ../fish/guestfish.pod:791
21069 msgid "The logical volume(s) can now be mounted in the usual way."
21073 #: ../fish/guestfish.pod:793
21075 "Before closing a LUKS device you must unmount any logical volumes on it and "
21076 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21077 "one. Then you can close the mapper device:"
21081 #: ../fish/guestfish.pod:797
21084 " vg-activate false /dev/VG\n"
21085 " luks-close /dev/mapper/luksdev\n"
21090 #: ../fish/guestfish.pod:800 ../tools/virt-edit.pl:342
21091 msgid "WINDOWS PATHS"
21095 #: ../fish/guestfish.pod:802
21097 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21098 "letters and paths (with some limitations). The following commands are "
21103 #: ../fish/guestfish.pod:806
21106 " file /WINDOWS/system32/config/system.LOG\n"
21111 #: ../fish/guestfish.pod:808
21114 " file win:\\windows\\system32\\config\\system.log\n"
21119 #: ../fish/guestfish.pod:810
21122 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21127 #: ../fish/guestfish.pod:812
21129 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21130 "where the drive is mounted, prepending that to the path, changing all "
21131 "backslash characters to forward slash, then resolving the result using L</"
21132 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21133 "the parameter might be rewritten like this:"
21137 #: ../fish/guestfish.pod:818
21140 " win:e:\\foo\\bar => /e/FOO/bar\n"
21145 #: ../fish/guestfish.pod:820
21146 msgid "This only works in argument positions that expect a path."
21150 #: ../fish/guestfish.pod:822
21151 msgid "UPLOADING AND DOWNLOADING FILES"
21155 #: ../fish/guestfish.pod:824
21157 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21158 "others which upload from or download to a local file, you can use the "
21159 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21163 #: ../fish/guestfish.pod:828
21171 #: ../fish/guestfish.pod:830
21173 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21177 #: ../fish/guestfish.pod:833
21180 " tar-out /etc - | tar tf -\n"
21185 #: ../fish/guestfish.pod:835
21187 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21188 "command (see L</PIPES>)."
21192 #: ../fish/guestfish.pod:838
21194 "When using C<-> to read from stdin, the input is read up to the end of "
21195 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21196 "some arbitrary end marker:"
21200 #: ../fish/guestfish.pod:842
21203 " upload -<<END /foo\n"
21212 #: ../fish/guestfish.pod:848
21214 "Any string of characters can be used instead of C<END>. The end marker must "
21215 "appear on a line of its own, without any preceeding or following characters "
21216 "(not even spaces)."
21220 #: ../fish/guestfish.pod:852
21222 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21223 "upload local files (so-called \"FileIn\" parameters in the generator)."
21227 #: ../fish/guestfish.pod:855
21228 msgid "EXIT ON ERROR BEHAVIOUR"
21232 #: ../fish/guestfish.pod:857
21234 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21235 "taking commands from a human over a tty), and will exit on the first error "
21236 "in non-interactive mode (scripts, commands given on the command line)."
21240 #: ../fish/guestfish.pod:862
21242 "If you prefix a command with a I<-> character, then that command will not "
21243 "cause guestfish to exit, even if that (one) command returns an error."
21247 #: ../fish/guestfish.pod:866
21248 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21252 #: ../fish/guestfish.pod:868
21254 "Guestfish can be remote-controlled over a socket. This is useful "
21255 "particularly in shell scripts where you want to make several different "
21256 "changes to a filesystem, but you don't want the overhead of starting up a "
21257 "guestfish process each time."
21261 #: ../fish/guestfish.pod:873
21262 msgid "Start a guestfish server process using:"
21266 #: ../fish/guestfish.pod:875
21269 " eval \"`guestfish --listen`\"\n"
21274 #: ../fish/guestfish.pod:877
21275 msgid "and then send it commands by doing:"
21279 #: ../fish/guestfish.pod:879
21282 " guestfish --remote cmd [...]\n"
21287 #: ../fish/guestfish.pod:881
21288 msgid "To cause the server to exit, send it the exit command:"
21292 #: ../fish/guestfish.pod:883
21295 " guestfish --remote exit\n"
21300 #: ../fish/guestfish.pod:885
21302 "Note that the server will normally exit if there is an error in a command. "
21303 "You can change this in the usual way. See section L</EXIT ON ERROR "
21308 #: ../fish/guestfish.pod:889
21309 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21313 #: ../fish/guestfish.pod:891
21315 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21316 "is how the I<--remote> option knows where to send the commands. You can "
21317 "have several guestfish listener processes running using:"
21321 #: ../fish/guestfish.pod:895
21324 " eval \"`guestfish --listen`\"\n"
21325 " pid1=$GUESTFISH_PID\n"
21326 " eval \"`guestfish --listen`\"\n"
21327 " pid2=$GUESTFISH_PID\n"
21329 " guestfish --remote=$pid1 cmd\n"
21330 " guestfish --remote=$pid2 cmd\n"
21335 #: ../fish/guestfish.pod:903
21336 msgid "REMOTE CONTROL AND CSH"
21340 #: ../fish/guestfish.pod:905
21342 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21347 #: ../fish/guestfish.pod:908
21350 " eval \"`guestfish --listen --csh`\"\n"
21355 #: ../fish/guestfish.pod:910
21356 msgid "REMOTE CONTROL DETAILS"
21360 #: ../fish/guestfish.pod:912
21362 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21363 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21364 "and C<$PID> is the process ID of the server."
21368 #: ../fish/guestfish.pod:916
21369 msgid "Guestfish client and server versions must match exactly."
21373 #: ../fish/guestfish.pod:918
21374 msgid "PREPARED DISK IMAGES"
21378 #: ../fish/guestfish.pod:920
21380 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21381 "preformatted disk images that guestfish can make for you to save typing. "
21382 "This is particularly useful for testing purposes. This option is used "
21383 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21384 "can be mixed with I<-a>)."
21388 #: ../fish/guestfish.pod:926
21390 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21391 "the second and so on. Existing files in the current directory are "
21396 #: ../fish/guestfish.pod:930
21398 "The type briefly describes how the disk should be sized, partitioned, how "
21399 "filesystem(s) should be created, and how content should be added. "
21400 "Optionally the type can be followed by extra parameters, separated by C<:> "
21401 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21402 "allocated disk, containing a single partition, with the partition formatted "
21403 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21408 #: ../fish/guestfish.pod:938
21409 msgid "To list the available types and any extra parameters they take, run:"
21413 #: ../fish/guestfish.pod:942
21415 "Note that the prepared filesystem is not mounted. You would usually have to "
21416 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21420 #: ../fish/guestfish.pod:946
21422 "If any I<-N> or I<--new> options are given, the guest is automatically "
21427 #: ../fish/guestfish.pod:951
21428 msgid "Create a 100MB disk with an ext4-formatted partition:"
21432 #: ../fish/guestfish.pod:953
21435 " guestfish -N fs:ext4\n"
21440 #: ../fish/guestfish.pod:955
21441 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21445 #: ../fish/guestfish.pod:957
21448 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21453 #: ../fish/guestfish.pod:959
21454 msgid "Create a blank 200MB disk:"
21458 #: ../fish/guestfish.pod:961
21461 " guestfish -N disk:200M\n"
21466 #: ../fish/guestfish.pod:963
21467 msgid "PROGRESS BARS"
21471 #: ../fish/guestfish.pod:965
21473 "Some (not all) long-running commands send progress notification messages as "
21474 "they are running. Guestfish turns these messages into progress bars."
21478 #: ../fish/guestfish.pod:969
21480 "When a command that supports progress bars takes longer than two seconds to "
21481 "run, and if progress bars are enabled, then you will see one appearing below "
21486 #: ../fish/guestfish.pod:973
21489 " ><fs> copy-size /large-file /another-file 2048M\n"
21490 " / 10% [#####-----------------------------------------] 00:30\n"
21495 #: ../fish/guestfish.pod:976
21497 "The spinner on the left hand side moves round once for every progress "
21498 "notification received from the backend. This is a (reasonably) golden "
21499 "assurance that the command is \"doing something\" even if the progress bar "
21500 "is not moving, because the command is able to send the progress "
21501 "notifications. When the bar reaches 100% and the command finishes, the "
21502 "spinner disappears."
21506 #: ../fish/guestfish.pod:983
21508 "Progress bars are enabled by default when guestfish is used interactively. "
21509 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21510 "and you can disable them completely using I<--no-progress-bars>."
21514 #: ../fish/guestfish.pod:988
21515 msgid "GUESTFISH COMMANDS"
21519 #: ../fish/guestfish.pod:990
21521 "The commands in this section are guestfish convenience commands, in other "
21522 "words, they are not part of the L<guestfs(3)> API."
21526 #: ../fish/guestfish.pod:993
21531 #: ../fish/guestfish.pod:995
21540 #: ../fish/guestfish.pod:998
21541 msgid "Without any parameter, this provides general help."
21545 #: ../fish/guestfish.pod:1000
21546 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21550 #: ../fish/guestfish.pod:1002
21551 msgid "quit | exit"
21555 #: ../fish/guestfish.pod:1004
21556 msgid "This exits guestfish. You can also use C<^D> key."
21560 #: ../fish/guestfish.pod:1006
21561 msgid "@FISH_COMMANDS@"
21565 #: ../fish/guestfish.pod:1008
21570 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21575 #: ../fish/guestfish.pod:1014
21577 "guestfish returns 0 if the commands completed without error, or 1 if there "
21582 #: ../fish/guestfish.pod:1021
21587 #: ../fish/guestfish.pod:1023
21589 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21594 #: ../fish/guestfish.pod:1026
21595 msgid "GUESTFISH_PID"
21599 #: ../fish/guestfish.pod:1028
21601 "Used with the I<--remote> option to specify the remote guestfish process to "
21602 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21606 #: ../fish/guestfish.pod:1032
21611 #: ../fish/guestfish.pod:1034
21613 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21614 "not specified, the external L<hexedit(1)> program is used."
21618 #: ../fish/guestfish.pod:1038
21623 #: ../fish/guestfish.pod:1040
21625 "If compiled with GNU readline support, various files in the home directory "
21626 "can be used. See L</FILES>."
21630 #: ../fish/guestfish.pod:1049
21632 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21633 "effect as using the B<-v> option."
21637 #: ../fish/guestfish.pod:1061
21639 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21640 "the discussion of paths in L<guestfs(3)>."
21644 #: ../fish/guestfish.pod:1072
21645 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21649 #: ../fish/guestfish.pod:1074
21654 #: ../fish/guestfish.pod:1076
21656 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21661 #: ../fish/guestfish.pod:1092 ../fuse/guestmount.pod:254
21666 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21667 msgid "$HOME/.libguestfs-tools.rc"
21671 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21672 msgid "/etc/libguestfs-tools.conf"
21676 #: ../fish/guestfish.pod:1100 ../fuse/guestmount.pod:262
21678 "This configuration file controls the default read-only or read-write mode "
21679 "(I<--ro> or I<--rw>)."
21683 #: ../fish/guestfish.pod:1103
21684 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21688 #: ../fish/guestfish.pod:1105
21689 msgid "$HOME/.guestfish"
21693 #: ../fish/guestfish.pod:1107
21695 "If compiled with GNU readline support, then the command history is saved in "
21700 #: ../fish/guestfish.pod:1110
21701 msgid "$HOME/.inputrc"
21705 #: ../fish/guestfish.pod:1112
21706 msgid "/etc/inputrc"
21710 #: ../fish/guestfish.pod:1114
21712 "If compiled with GNU readline support, then these files can be used to "
21713 "configure readline. For further information, please see L<readline(3)/"
21714 "INITIALIZATION FILE>."
21718 #: ../fish/guestfish.pod:1118
21719 msgid "To write rules which only apply to guestfish, use:"
21723 #: ../fish/guestfish.pod:1120
21733 #: ../fish/guestfish.pod:1124
21735 "Variables that you can set in inputrc that change the behaviour of guestfish "
21736 "in useful ways include:"
21740 #: ../fish/guestfish.pod:1129
21741 msgid "completion-ignore-case (default: on)"
21745 #: ../fish/guestfish.pod:1131
21747 "By default, guestfish will ignore case when tab-completing paths on the "
21752 #: ../fish/guestfish.pod:1134
21755 " set completion-ignore-case off\n"
21760 #: ../fish/guestfish.pod:1136
21761 msgid "to make guestfish case sensitive."
21765 #: ../fish/guestfish.pod:1140
21770 #: ../fish/guestfish.pod:1142
21771 msgid "test2.img (etc)"
21775 #: ../fish/guestfish.pod:1144
21777 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21778 "will be created in the file C<test1.img> in the current directory. The "
21779 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21780 "the same name will be overwritten."
21784 #: ../fish/guestfish.pod:1153
21786 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21787 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21788 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21789 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21790 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21791 ">, L<hexedit(1)>."
21795 #: ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:102
21796 #: ../fuse/guestmount.pod:289 ../tools/virt-edit.pl:518
21797 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21798 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21799 #: ../tools/virt-list-partitions.pl:277
21801 "This program is free software; you can redistribute it and/or modify it "
21802 "under the terms of the GNU General Public License as published by the Free "
21803 "Software Foundation; either version 2 of the License, or (at your option) "
21804 "any later version."
21808 #: ../fish/guestfish.pod:1188 ../test-tool/libguestfs-test-tool.pod:107
21809 #: ../fuse/guestmount.pod:294 ../tools/virt-edit.pl:523
21810 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21811 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21812 #: ../tools/virt-list-partitions.pl:282
21814 "This program is distributed in the hope that it will be useful, but WITHOUT "
21815 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21816 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21821 #: ../fish/guestfish.pod:1193 ../test-tool/libguestfs-test-tool.pod:112
21822 #: ../fuse/guestmount.pod:299 ../tools/virt-edit.pl:528
21823 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21824 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21825 #: ../tools/virt-list-partitions.pl:287
21827 "You should have received a copy of the GNU General Public License along with "
21828 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21829 "Ave, Cambridge, MA 02139, USA."
21833 #: ../fish/guestfish-actions.pod:1
21838 #: ../fish/guestfish-actions.pod:3
21841 " add-cdrom filename\n"
21846 #: ../fish/guestfish-actions.pod:15
21848 "This call checks for the existence of C<filename>. This stops you from "
21849 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21850 "and C<http:> URLs. To specify those, use the general L</config> call "
21855 #: ../fish/guestfish-actions.pod:22
21857 "If you just want to add an ISO file (often you use this as an efficient way "
21858 "to transfer large files into the guest), then you should probably use L</add-"
21859 "drive-ro> instead."
21863 #: ../fish/guestfish-actions.pod:35
21868 #: ../fish/guestfish-actions.pod:37
21873 #: ../fish/guestfish-actions.pod:39
21876 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
21881 #: ../fish/guestfish-actions.pod:41
21883 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21884 "It works by connecting to libvirt, requesting the domain and domain XML from "
21885 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21889 #: ../fish/guestfish-actions.pod:76
21891 "The other optional parameters are passed directly through to L</add-drive-"
21896 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
21897 #: ../fish/guestfish-actions.pod:3052
21899 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21903 #: ../fish/guestfish-actions.pod:81
21908 #: ../fish/guestfish-actions.pod:83
21911 " add-drive filename\n"
21916 #: ../fish/guestfish-actions.pod:85
21918 "This function is the equivalent of calling L</add-drive-opts> with no "
21919 "optional parameters, so the disk is added writable, with the format being "
21920 "detected automatically."
21924 #: ../fish/guestfish-actions.pod:89
21926 "Automatic detection of the format opens you up to a potential security hole "
21927 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21928 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21929 "you should think about replacing calls to this function with calls to L</add-"
21930 "drive-opts>, and specifying the format."
21934 #: ../fish/guestfish-actions.pod:96
21935 msgid "add-drive-opts"
21939 #: ../fish/guestfish-actions.pod:98
21944 #: ../fish/guestfish-actions.pod:100
21947 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21952 #: ../fish/guestfish-actions.pod:127
21954 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21955 "add-drive-ro>) then the format is automatically detected. Possible formats "
21956 "include C<raw> and C<qcow2>."
21960 #: ../fish/guestfish-actions.pod:138
21962 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21963 "add-drive-with-if> call (q.v.)"
21967 #: ../fish/guestfish-actions.pod:145
21968 msgid "add-drive-ro"
21972 #: ../fish/guestfish-actions.pod:147
21977 #: ../fish/guestfish-actions.pod:149
21980 " add-drive-ro filename\n"
21985 #: ../fish/guestfish-actions.pod:151
21987 "This function is the equivalent of calling L</add-drive-opts> with the "
21988 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21989 "is added read-only, with the format being detected automatically."
21993 #: ../fish/guestfish-actions.pod:156
21994 msgid "add-drive-ro-with-if"
21998 #: ../fish/guestfish-actions.pod:158
22001 " add-drive-ro-with-if filename iface\n"
22006 #: ../fish/guestfish-actions.pod:160
22008 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22009 "interface emulation to use at run time."
22013 #: ../fish/guestfish-actions.pod:170
22014 msgid "add-drive-with-if"
22018 #: ../fish/guestfish-actions.pod:172
22021 " add-drive-with-if filename iface\n"
22026 #: ../fish/guestfish-actions.pod:174
22028 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22029 "interface emulation to use at run time."
22033 #: ../fish/guestfish-actions.pod:184
22038 #: ../fish/guestfish-actions.pod:186
22041 " aug-clear augpath\n"
22046 #: ../fish/guestfish-actions.pod:191
22051 #: ../fish/guestfish-actions.pod:193
22059 #: ../fish/guestfish-actions.pod:195
22061 "Close the current Augeas handle and free up any resources used by it. After "
22062 "calling this, you have to call L</aug-init> again before you can use any "
22063 "other Augeas functions."
22067 #: ../fish/guestfish-actions.pod:200
22068 msgid "aug-defnode"
22072 #: ../fish/guestfish-actions.pod:202
22075 " aug-defnode name expr val\n"
22080 #: ../fish/guestfish-actions.pod:207
22082 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22083 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22084 "containing that single node."
22088 #: ../fish/guestfish-actions.pod:215
22093 #: ../fish/guestfish-actions.pod:217
22096 " aug-defvar name expr\n"
22101 #: ../fish/guestfish-actions.pod:226
22106 #: ../fish/guestfish-actions.pod:228
22109 " aug-get augpath\n"
22114 #: ../fish/guestfish-actions.pod:233
22119 #: ../fish/guestfish-actions.pod:235
22122 " aug-init root flags\n"
22127 #: ../fish/guestfish-actions.pod:241
22128 msgid "You must call this before using any other L</aug-*> commands."
22132 #: ../fish/guestfish-actions.pod:276
22133 msgid "Do not load the tree in L</aug-init>."
22137 #: ../fish/guestfish-actions.pod:280
22138 msgid "To close the handle, you can call L</aug-close>."
22142 #: ../fish/guestfish-actions.pod:284
22147 #: ../fish/guestfish-actions.pod:286
22150 " aug-insert augpath label true|false\n"
22155 #: ../fish/guestfish-actions.pod:296
22160 #: ../fish/guestfish-actions.pod:298
22168 #: ../fish/guestfish-actions.pod:305
22173 #: ../fish/guestfish-actions.pod:307
22176 " aug-ls augpath\n"
22181 #: ../fish/guestfish-actions.pod:309
22183 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22184 "resulting nodes into alphabetical order."
22188 #: ../fish/guestfish-actions.pod:312
22193 #: ../fish/guestfish-actions.pod:314
22196 " aug-match augpath\n"
22201 #: ../fish/guestfish-actions.pod:320
22206 #: ../fish/guestfish-actions.pod:322
22209 " aug-mv src dest\n"
22214 #: ../fish/guestfish-actions.pod:327
22219 #: ../fish/guestfish-actions.pod:329
22222 " aug-rm augpath\n"
22227 #: ../fish/guestfish-actions.pod:335
22232 #: ../fish/guestfish-actions.pod:337
22240 #: ../fish/guestfish-actions.pod:341
22242 "The flags which were passed to L</aug-init> affect exactly how files are "
22247 #: ../fish/guestfish-actions.pod:344
22252 #: ../fish/guestfish-actions.pod:346
22255 " aug-set augpath val\n"
22260 #: ../fish/guestfish-actions.pod:350
22262 "In the Augeas API, it is possible to clear a node by setting the value to "
22263 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22264 "this call. Instead you must use the L</aug-clear> call."
22268 #: ../fish/guestfish-actions.pod:355
22273 #: ../fish/guestfish-actions.pod:357
22276 " available 'groups ...'\n"
22281 #: ../fish/guestfish-actions.pod:363
22283 "The libguestfs groups, and the functions that those groups correspond to, "
22284 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22285 "runtime by calling L</available-all-groups>."
22289 #: ../fish/guestfish-actions.pod:387
22290 msgid "You must call L</launch> before calling this function."
22294 #: ../fish/guestfish-actions.pod:409
22296 "This call was added in version C<1.0.80>. In previous versions of "
22297 "libguestfs all you could do would be to speculatively execute a command to "
22298 "find out if the daemon implemented it. See also L</version>."
22302 #: ../fish/guestfish-actions.pod:416
22303 msgid "available-all-groups"
22307 #: ../fish/guestfish-actions.pod:418
22310 " available-all-groups\n"
22315 #: ../fish/guestfish-actions.pod:420
22317 "This command returns a list of all optional groups that this daemon knows "
22318 "about. Note this returns both supported and unsupported groups. To find "
22319 "out which ones the daemon can actually support you have to call L</"
22320 "available> on each member of the returned list."
22324 #: ../fish/guestfish-actions.pod:426
22325 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22329 #: ../fish/guestfish-actions.pod:428
22334 #: ../fish/guestfish-actions.pod:430
22337 " base64-in (base64file|-) filename\n"
22342 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22343 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22344 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1233
22345 #: ../fish/guestfish-actions.pod:4450 ../fish/guestfish-actions.pod:4462
22346 #: ../fish/guestfish-actions.pod:4473 ../fish/guestfish-actions.pod:4484
22347 #: ../fish/guestfish-actions.pod:4536 ../fish/guestfish-actions.pod:4545
22348 #: ../fish/guestfish-actions.pod:4599 ../fish/guestfish-actions.pod:4622
22349 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22353 #: ../fish/guestfish-actions.pod:437
22358 #: ../fish/guestfish-actions.pod:439
22361 " base64-out filename (base64file|-)\n"
22366 #: ../fish/guestfish-actions.pod:446
22367 msgid "blockdev-flushbufs"
22371 #: ../fish/guestfish-actions.pod:448
22374 " blockdev-flushbufs device\n"
22379 #: ../fish/guestfish-actions.pod:455
22380 msgid "blockdev-getbsz"
22384 #: ../fish/guestfish-actions.pod:457
22387 " blockdev-getbsz device\n"
22392 #: ../fish/guestfish-actions.pod:466
22393 msgid "blockdev-getro"
22397 #: ../fish/guestfish-actions.pod:468
22400 " blockdev-getro device\n"
22405 #: ../fish/guestfish-actions.pod:475
22406 msgid "blockdev-getsize64"
22410 #: ../fish/guestfish-actions.pod:477
22413 " blockdev-getsize64 device\n"
22418 #: ../fish/guestfish-actions.pod:481
22419 msgid "See also L</blockdev-getsz>."
22423 #: ../fish/guestfish-actions.pod:485
22424 msgid "blockdev-getss"
22428 #: ../fish/guestfish-actions.pod:487
22431 " blockdev-getss device\n"
22436 #: ../fish/guestfish-actions.pod:492
22438 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22442 #: ../fish/guestfish-actions.pod:497
22443 msgid "blockdev-getsz"
22447 #: ../fish/guestfish-actions.pod:499
22450 " blockdev-getsz device\n"
22455 #: ../fish/guestfish-actions.pod:504
22457 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22458 "blockdev-getsize64> for the more useful I<size in bytes>."
22462 #: ../fish/guestfish-actions.pod:510
22463 msgid "blockdev-rereadpt"
22467 #: ../fish/guestfish-actions.pod:512
22470 " blockdev-rereadpt device\n"
22475 #: ../fish/guestfish-actions.pod:518
22476 msgid "blockdev-setbsz"
22480 #: ../fish/guestfish-actions.pod:520
22483 " blockdev-setbsz device blocksize\n"
22488 #: ../fish/guestfish-actions.pod:529
22489 msgid "blockdev-setro"
22493 #: ../fish/guestfish-actions.pod:531
22496 " blockdev-setro device\n"
22501 #: ../fish/guestfish-actions.pod:537
22502 msgid "blockdev-setrw"
22506 #: ../fish/guestfish-actions.pod:539
22509 " blockdev-setrw device\n"
22514 #: ../fish/guestfish-actions.pod:545
22515 msgid "case-sensitive-path"
22519 #: ../fish/guestfish-actions.pod:547
22522 " case-sensitive-path path\n"
22527 #: ../fish/guestfish-actions.pod:571
22529 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22530 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22531 "the directories were originally created under Windows)."
22535 #: ../fish/guestfish-actions.pod:579
22536 msgid "See also L</realpath>."
22540 #: ../fish/guestfish-actions.pod:581
22545 #: ../fish/guestfish-actions.pod:583
22553 #: ../fish/guestfish-actions.pod:587
22555 "Note that this function cannot correctly handle binary files (specifically, "
22556 "files containing C<\\0> character which is treated as end of string). For "
22557 "those you need to use the L</read-file> or L</download> functions which have "
22558 "a more complex interface."
22562 #: ../fish/guestfish-actions.pod:595
22567 #: ../fish/guestfish-actions.pod:597
22570 " checksum csumtype path\n"
22575 #: ../fish/guestfish-actions.pod:640
22576 msgid "To get the checksum for a device, use L</checksum-device>."
22580 #: ../fish/guestfish-actions.pod:642
22581 msgid "To get the checksums for many files, use L</checksums-out>."
22585 #: ../fish/guestfish-actions.pod:644
22586 msgid "checksum-device"
22590 #: ../fish/guestfish-actions.pod:646
22593 " checksum-device csumtype device\n"
22598 #: ../fish/guestfish-actions.pod:648
22600 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22601 "device named C<device>. For the types of checksums supported see the L</"
22602 "checksum> command."
22606 #: ../fish/guestfish-actions.pod:652
22607 msgid "checksums-out"
22611 #: ../fish/guestfish-actions.pod:654
22614 " checksums-out csumtype directory (sumsfile|-)\n"
22619 #: ../fish/guestfish-actions.pod:670
22624 #: ../fish/guestfish-actions.pod:672
22627 " chmod mode path\n"
22632 #: ../fish/guestfish-actions.pod:683
22637 #: ../fish/guestfish-actions.pod:685
22640 " chown owner group path\n"
22645 #: ../fish/guestfish-actions.pod:693
22650 #: ../fish/guestfish-actions.pod:695
22653 " command 'arguments ...'\n"
22658 #: ../fish/guestfish-actions.pod:702
22660 "The single parameter is an argv-style list of arguments. The first element "
22661 "is the name of the program to run. Subsequent elements are parameters. The "
22662 "list must be non-empty (ie. must contain a program name). Note that the "
22663 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22667 #: ../fish/guestfish-actions.pod:730
22668 msgid "command-lines"
22672 #: ../fish/guestfish-actions.pod:732
22675 " command-lines 'arguments ...'\n"
22680 #: ../fish/guestfish-actions.pod:734
22682 "This is the same as L</command>, but splits the result into a list of lines."
22686 #: ../fish/guestfish-actions.pod:737
22687 msgid "See also: L</sh-lines>"
22691 #: ../fish/guestfish-actions.pod:742
22696 #: ../fish/guestfish-actions.pod:744
22699 " config qemuparam qemuvalue\n"
22704 #: ../fish/guestfish-actions.pod:755
22709 #: ../fish/guestfish-actions.pod:757
22712 " copy-size src dest size\n"
22717 #: ../fish/guestfish-actions.pod:765
22722 #: ../fish/guestfish-actions.pod:767
22730 #: ../fish/guestfish-actions.pod:772
22735 #: ../fish/guestfish-actions.pod:774
22743 #: ../fish/guestfish-actions.pod:779
22748 #: ../fish/guestfish-actions.pod:781
22756 #: ../fish/guestfish-actions.pod:788
22758 "If the destination is a device, it must be as large or larger than the "
22759 "source file or device, otherwise the copy will fail. This command cannot do "
22760 "partial copies (see L</copy-size>)."
22764 #: ../fish/guestfish-actions.pod:792
22769 #: ../fish/guestfish-actions.pod:794
22777 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22779 "This command is mostly useful for interactive sessions. It is I<not> "
22780 "intended that you try to parse the output string. Use L</statvfs> from "
22785 #: ../fish/guestfish-actions.pod:802
22790 #: ../fish/guestfish-actions.pod:804
22798 #: ../fish/guestfish-actions.pod:813
22803 #: ../fish/guestfish-actions.pod:815
22811 #: ../fish/guestfish-actions.pod:821
22813 "Another way to get the same information is to enable verbose messages with "
22814 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22815 "before running the program."
22819 #: ../fish/guestfish-actions.pod:826
22824 #: ../fish/guestfish-actions.pod:828
22827 " download remotefilename (filename|-)\n"
22832 #: ../fish/guestfish-actions.pod:835
22833 msgid "See also L</upload>, L</cat>."
22837 #: ../fish/guestfish-actions.pod:839
22838 msgid "download-offset"
22842 #: ../fish/guestfish-actions.pod:841
22845 " download-offset remotefilename (filename|-) offset size\n"
22850 #: ../fish/guestfish-actions.pod:849
22852 "Note that there is no limit on the amount of data that can be downloaded "
22853 "with this call, unlike with L</pread>, and this call always reads the full "
22854 "amount unless an error occurs."
22858 #: ../fish/guestfish-actions.pod:854
22859 msgid "See also L</download>, L</pread>."
22863 #: ../fish/guestfish-actions.pod:858
22864 msgid "drop-caches"
22868 #: ../fish/guestfish-actions.pod:860
22871 " drop-caches whattodrop\n"
22876 #: ../fish/guestfish-actions.pod:872
22881 #: ../fish/guestfish-actions.pod:874
22889 #: ../fish/guestfish-actions.pod:886
22894 #: ../fish/guestfish-actions.pod:888
22897 " e2fsck-f device\n"
22902 #: ../fish/guestfish-actions.pod:894
22904 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22905 "should use L</fsck>."
22909 #: ../fish/guestfish-actions.pod:897
22910 msgid "echo-daemon"
22914 #: ../fish/guestfish-actions.pod:899
22917 " echo-daemon 'words ...'\n"
22922 #: ../fish/guestfish-actions.pod:906
22923 msgid "See also L</ping-daemon>."
22927 #: ../fish/guestfish-actions.pod:908
22932 #: ../fish/guestfish-actions.pod:910
22935 " egrep regex path\n"
22940 #: ../fish/guestfish-actions.pod:918
22945 #: ../fish/guestfish-actions.pod:920
22948 " egrepi regex path\n"
22953 #: ../fish/guestfish-actions.pod:928
22958 #: ../fish/guestfish-actions.pod:930
22961 " equal file1 file2\n"
22966 #: ../fish/guestfish-actions.pod:937
22971 #: ../fish/guestfish-actions.pod:939
22979 #: ../fish/guestfish-actions.pod:944
22980 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22984 #: ../fish/guestfish-actions.pod:946
22989 #: ../fish/guestfish-actions.pod:948
22992 " fallocate path len\n"
22997 #: ../fish/guestfish-actions.pod:965
22998 msgid "fallocate64"
23002 #: ../fish/guestfish-actions.pod:967
23005 " fallocate64 path len\n"
23010 #: ../fish/guestfish-actions.pod:973
23012 "Note that this call allocates disk blocks for the file. To create a sparse "
23013 "file use L</truncate-size> instead."
23017 #: ../fish/guestfish-actions.pod:976
23019 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23020 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23021 "maximum size of files created through that call to 1GB."
23025 #: ../fish/guestfish-actions.pod:985
23030 #: ../fish/guestfish-actions.pod:987
23033 " fgrep pattern path\n"
23038 #: ../fish/guestfish-actions.pod:995
23043 #: ../fish/guestfish-actions.pod:997
23046 " fgrepi pattern path\n"
23051 #: ../fish/guestfish-actions.pod:1005
23056 #: ../fish/guestfish-actions.pod:1007
23064 #: ../fish/guestfish-actions.pod:1019
23066 "This command can also be used on C</dev/> devices (and partitions, LV "
23067 "names). You can for example use this to determine if a device contains a "
23068 "filesystem, although it's usually better to use L</vfs-type>."
23072 #: ../fish/guestfish-actions.pod:1029
23073 msgid "file-architecture"
23077 #: ../fish/guestfish-actions.pod:1031
23080 " file-architecture filename\n"
23085 #: ../fish/guestfish-actions.pod:1134
23090 #: ../fish/guestfish-actions.pod:1136
23098 #: ../fish/guestfish-actions.pod:1140
23100 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23101 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23105 #: ../fish/guestfish-actions.pod:1144
23110 #: ../fish/guestfish-actions.pod:1146
23113 " fill c len path\n"
23118 #: ../fish/guestfish-actions.pod:1152
23120 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23121 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23122 "L</fill-pattern>."
23126 #: ../fish/guestfish-actions.pod:1157
23127 msgid "fill-pattern"
23131 #: ../fish/guestfish-actions.pod:1159
23134 " fill-pattern pattern len path\n"
23139 #: ../fish/guestfish-actions.pod:1161
23141 "This function is like L</fill> except that it creates a new file of length "
23142 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23143 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23148 #: ../fish/guestfish-actions.pod:1166
23153 #: ../fish/guestfish-actions.pod:1168
23156 " find directory\n"
23161 #: ../fish/guestfish-actions.pod:1182
23162 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23166 #: ../fish/guestfish-actions.pod:1195
23167 msgid "See also L</find0>."
23171 #: ../fish/guestfish-actions.pod:1200
23176 #: ../fish/guestfish-actions.pod:1202
23179 " find0 directory (files|-)\n"
23184 #: ../fish/guestfish-actions.pod:1208
23186 "This command works the same way as L</find> with the following exceptions:"
23190 #: ../fish/guestfish-actions.pod:1235
23191 msgid "findfs-label"
23195 #: ../fish/guestfish-actions.pod:1237
23198 " findfs-label label\n"
23203 #: ../fish/guestfish-actions.pod:1243
23204 msgid "To find the label of a filesystem, use L</vfs-label>."
23208 #: ../fish/guestfish-actions.pod:1245
23209 msgid "findfs-uuid"
23213 #: ../fish/guestfish-actions.pod:1247
23216 " findfs-uuid uuid\n"
23221 #: ../fish/guestfish-actions.pod:1253
23222 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23226 #: ../fish/guestfish-actions.pod:1255
23231 #: ../fish/guestfish-actions.pod:1257
23234 " fsck fstype device\n"
23239 #: ../fish/guestfish-actions.pod:1287
23244 #: ../fish/guestfish-actions.pod:1289
23252 #: ../fish/guestfish-actions.pod:1296
23253 msgid "get-attach-method"
23257 #: ../fish/guestfish-actions.pod:1298
23260 " get-attach-method\n"
23265 #: ../fish/guestfish-actions.pod:1300
23266 msgid "Return the current attach method. See L</set-attach-method>."
23270 #: ../fish/guestfish-actions.pod:1302
23271 msgid "get-autosync"
23275 #: ../fish/guestfish-actions.pod:1304
23283 #: ../fish/guestfish-actions.pod:1308
23288 #: ../fish/guestfish-actions.pod:1310
23296 #: ../fish/guestfish-actions.pod:1314
23297 msgid "get-e2label"
23301 #: ../fish/guestfish-actions.pod:1316
23304 " get-e2label device\n"
23309 #: ../fish/guestfish-actions.pod:1328
23314 #: ../fish/guestfish-actions.pod:1330
23317 " get-e2uuid device\n"
23322 #: ../fish/guestfish-actions.pod:1342
23323 msgid "get-memsize"
23327 #: ../fish/guestfish-actions.pod:1344
23335 #: ../fish/guestfish-actions.pod:1349
23337 "If L</set-memsize> was not called on this handle, and if "
23338 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23339 "value for memsize."
23343 #: ../fish/guestfish-actions.pod:1356
23344 msgid "get-network"
23348 #: ../fish/guestfish-actions.pod:1358
23356 #: ../fish/guestfish-actions.pod:1362
23361 #: ../fish/guestfish-actions.pod:1364
23369 #: ../fish/guestfish-actions.pod:1371
23374 #: ../fish/guestfish-actions.pod:1373
23379 #: ../fish/guestfish-actions.pod:1375
23387 #: ../fish/guestfish-actions.pod:1382
23392 #: ../fish/guestfish-actions.pod:1384
23400 #: ../fish/guestfish-actions.pod:1391
23401 msgid "get-recovery-proc"
23405 #: ../fish/guestfish-actions.pod:1393
23408 " get-recovery-proc\n"
23413 #: ../fish/guestfish-actions.pod:1397
23414 msgid "get-selinux"
23418 #: ../fish/guestfish-actions.pod:1399
23426 #: ../fish/guestfish-actions.pod:1401
23428 "This returns the current setting of the selinux flag which is passed to the "
23429 "appliance at boot time. See L</set-selinux>."
23433 #: ../fish/guestfish-actions.pod:1407
23438 #: ../fish/guestfish-actions.pod:1409
23446 #: ../fish/guestfish-actions.pod:1416
23451 #: ../fish/guestfish-actions.pod:1418
23459 #: ../fish/guestfish-actions.pod:1422
23464 #: ../fish/guestfish-actions.pod:1424
23472 #: ../fish/guestfish-actions.pod:1426
23474 "Return the current umask. By default the umask is C<022> unless it has been "
23475 "set by calling L</umask>."
23479 #: ../fish/guestfish-actions.pod:1429
23480 msgid "get-verbose"
23484 #: ../fish/guestfish-actions.pod:1431
23492 #: ../fish/guestfish-actions.pod:1435
23497 #: ../fish/guestfish-actions.pod:1437
23505 #: ../fish/guestfish-actions.pod:1441
23506 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23510 #: ../fish/guestfish-actions.pod:1444
23515 #: ../fish/guestfish-actions.pod:1446
23518 " getxattr path name\n"
23523 #: ../fish/guestfish-actions.pod:1448
23525 "Get a single extended attribute from file C<path> named C<name>. This call "
23526 "follows symlinks. If you want to lookup an extended attribute for the "
23527 "symlink itself, use L</lgetxattr>."
23531 #: ../fish/guestfish-actions.pod:1452 ../fish/guestfish-actions.pod:2458
23533 "Normally it is better to get all extended attributes from a file in one go "
23534 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23535 "buggy and do not provide a way to list out attributes. For these "
23536 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23537 "attributes you want in advance and call this function."
23541 #: ../fish/guestfish-actions.pod:1462
23542 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23546 #: ../fish/guestfish-actions.pod:1464
23551 #: ../fish/guestfish-actions.pod:1466
23554 " getxattrs path\n"
23559 #: ../fish/guestfish-actions.pod:1474
23560 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23564 #: ../fish/guestfish-actions.pod:1476
23565 msgid "glob-expand"
23569 #: ../fish/guestfish-actions.pod:1478
23572 " glob-expand pattern\n"
23577 #: ../fish/guestfish-actions.pod:1491
23582 #: ../fish/guestfish-actions.pod:1493
23585 " grep regex path\n"
23590 #: ../fish/guestfish-actions.pod:1501
23595 #: ../fish/guestfish-actions.pod:1503
23598 " grepi regex path\n"
23603 #: ../fish/guestfish-actions.pod:1511
23604 msgid "grub-install"
23608 #: ../fish/guestfish-actions.pod:1513
23611 " grub-install root device\n"
23616 #: ../fish/guestfish-actions.pod:1529
23621 #: ../fish/guestfish-actions.pod:1531
23629 #: ../fish/guestfish-actions.pod:1539
23634 #: ../fish/guestfish-actions.pod:1541
23637 " head-n nrlines path\n"
23642 #: ../fish/guestfish-actions.pod:1554
23647 #: ../fish/guestfish-actions.pod:1556
23655 #: ../fish/guestfish-actions.pod:1564
23660 #: ../fish/guestfish-actions.pod:1566
23663 " initrd-cat initrdpath filename\n"
23668 #: ../fish/guestfish-actions.pod:1578
23669 msgid "See also L</initrd-list>."
23673 #: ../fish/guestfish-actions.pod:1583
23674 msgid "initrd-list"
23678 #: ../fish/guestfish-actions.pod:1585
23681 " initrd-list path\n"
23686 #: ../fish/guestfish-actions.pod:1597
23687 msgid "inotify-add-watch"
23691 #: ../fish/guestfish-actions.pod:1599
23694 " inotify-add-watch path mask\n"
23699 #: ../fish/guestfish-actions.pod:1611
23700 msgid "inotify-close"
23704 #: ../fish/guestfish-actions.pod:1613
23712 #: ../fish/guestfish-actions.pod:1619
23713 msgid "inotify-files"
23717 #: ../fish/guestfish-actions.pod:1621
23725 #: ../fish/guestfish-actions.pod:1623
23727 "This function is a helpful wrapper around L</inotify-read> which just "
23728 "returns a list of pathnames of objects that were touched. The returned "
23729 "pathnames are sorted and deduplicated."
23733 #: ../fish/guestfish-actions.pod:1627
23734 msgid "inotify-init"
23738 #: ../fish/guestfish-actions.pod:1629
23741 " inotify-init maxevents\n"
23746 #: ../fish/guestfish-actions.pod:1635
23748 "C<maxevents> is the maximum number of events which will be queued up between "
23749 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23750 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23751 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23752 "but records the fact that it threw them away by setting a flag "
23753 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23757 #: ../fish/guestfish-actions.pod:1645
23759 "Before any events are generated, you have to add some watches to the "
23760 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23761 "L</inotify-watch-all>."
23765 #: ../fish/guestfish-actions.pod:1651
23767 "Queued up events should be read periodically by calling L</inotify-read> (or "
23768 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23769 "If you don't read the events out often enough then you risk the internal "
23770 "queue overflowing."
23774 #: ../fish/guestfish-actions.pod:1658
23776 "The handle should be closed after use by calling L</inotify-close>. This "
23777 "also removes any watches automatically."
23781 #: ../fish/guestfish-actions.pod:1667
23782 msgid "inotify-read"
23786 #: ../fish/guestfish-actions.pod:1669
23794 #: ../fish/guestfish-actions.pod:1682
23795 msgid "inotify-rm-watch"
23799 #: ../fish/guestfish-actions.pod:1684
23802 " inotify-rm-watch wd\n"
23807 #: ../fish/guestfish-actions.pod:1686
23808 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23812 #: ../fish/guestfish-actions.pod:1689
23813 msgid "inspect-get-arch"
23817 #: ../fish/guestfish-actions.pod:1691
23820 " inspect-get-arch root\n"
23825 #: ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1709
23826 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1831
23827 #: ../fish/guestfish-actions.pod:1849 ../fish/guestfish-actions.pod:1883
23828 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1919
23829 #: ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1967
23830 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2013
23831 #: ../fish/guestfish-actions.pod:2030 ../fish/guestfish-actions.pod:2073
23832 #: ../fish/guestfish-actions.pod:2108 ../fish/guestfish-actions.pod:2124
23833 #: ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153
23834 #: ../fish/guestfish-actions.pod:2166 ../fish/guestfish-actions.pod:2181
23836 "This function should only be called with a root device string as returned by "
23841 #: ../fish/guestfish-actions.pod:1696
23843 "This returns the architecture of the inspected operating system. The "
23844 "possible return values are listed under L</file-architecture>."
23848 #: ../fish/guestfish-actions.pod:1705
23849 msgid "inspect-get-distro"
23853 #: ../fish/guestfish-actions.pod:1707
23856 " inspect-get-distro root\n"
23861 #: ../fish/guestfish-actions.pod:1791
23862 msgid "inspect-get-drive-mappings"
23866 #: ../fish/guestfish-actions.pod:1793
23869 " inspect-get-drive-mappings root\n"
23874 #: ../fish/guestfish-actions.pod:1823
23876 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23877 "get-mountpoints>, L</inspect-get-filesystems>."
23881 #: ../fish/guestfish-actions.pod:1827
23882 msgid "inspect-get-filesystems"
23886 #: ../fish/guestfish-actions.pod:1829
23889 " inspect-get-filesystems root\n"
23894 #: ../fish/guestfish-actions.pod:1842
23896 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23897 "get-mountpoints>."
23901 #: ../fish/guestfish-actions.pod:1845
23902 msgid "inspect-get-format"
23906 #: ../fish/guestfish-actions.pod:1847
23909 " inspect-get-format root\n"
23914 #: ../fish/guestfish-actions.pod:1879
23915 msgid "inspect-get-hostname"
23919 #: ../fish/guestfish-actions.pod:1881
23922 " inspect-get-hostname root\n"
23927 #: ../fish/guestfish-actions.pod:1894
23928 msgid "inspect-get-major-version"
23932 #: ../fish/guestfish-actions.pod:1896
23935 " inspect-get-major-version root\n"
23940 #: ../fish/guestfish-actions.pod:1915
23941 msgid "inspect-get-minor-version"
23945 #: ../fish/guestfish-actions.pod:1917
23948 " inspect-get-minor-version root\n"
23953 #: ../fish/guestfish-actions.pod:1927
23955 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23956 "get-major-version>."
23960 #: ../fish/guestfish-actions.pod:1930
23961 msgid "inspect-get-mountpoints"
23965 #: ../fish/guestfish-actions.pod:1932
23968 " inspect-get-mountpoints root\n"
23973 #: ../fish/guestfish-actions.pod:1954
23975 "For operating systems like Windows which still use drive letters, this call "
23976 "will only return an entry for the first drive \"mounted on\" C</>. For "
23977 "information about the mapping of drive letters to partitions, see L</inspect-"
23978 "get-drive-mappings>."
23982 #: ../fish/guestfish-actions.pod:1960
23984 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23985 "get-filesystems>."
23989 #: ../fish/guestfish-actions.pod:1963
23990 msgid "inspect-get-package-format"
23994 #: ../fish/guestfish-actions.pod:1965
23997 " inspect-get-package-format root\n"
24002 #: ../fish/guestfish-actions.pod:1970
24004 "This function and L</inspect-get-package-management> return the package "
24005 "format and package management tool used by the inspected operating system. "
24006 "For example for Fedora these functions would return C<rpm> (package format) "
24007 "and C<yum> (package management)."
24011 #: ../fish/guestfish-actions.pod:1985
24012 msgid "inspect-get-package-management"
24016 #: ../fish/guestfish-actions.pod:1987
24019 " inspect-get-package-management root\n"
24024 #: ../fish/guestfish-actions.pod:1992
24026 "L</inspect-get-package-format> and this function return the package format "
24027 "and package management tool used by the inspected operating system. For "
24028 "example for Fedora these functions would return C<rpm> (package format) and "
24029 "C<yum> (package management)."
24033 #: ../fish/guestfish-actions.pod:2009
24034 msgid "inspect-get-product-name"
24038 #: ../fish/guestfish-actions.pod:2011
24041 " inspect-get-product-name root\n"
24046 #: ../fish/guestfish-actions.pod:2026
24047 msgid "inspect-get-product-variant"
24051 #: ../fish/guestfish-actions.pod:2028
24054 " inspect-get-product-variant root\n"
24059 #: ../fish/guestfish-actions.pod:2052
24061 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24062 "get-product-name>, L</inspect-get-major-version>."
24066 #: ../fish/guestfish-actions.pod:2056
24067 msgid "inspect-get-roots"
24071 #: ../fish/guestfish-actions.pod:2058
24074 " inspect-get-roots\n"
24079 #: ../fish/guestfish-actions.pod:2060
24081 "This function is a convenient way to get the list of root devices, as "
24082 "returned from a previous call to L</inspect-os>, but without redoing the "
24083 "whole inspection process."
24087 #: ../fish/guestfish-actions.pod:2064
24089 "This returns an empty list if either no root devices were found or the "
24090 "caller has not called L</inspect-os>."
24094 #: ../fish/guestfish-actions.pod:2069
24095 msgid "inspect-get-type"
24099 #: ../fish/guestfish-actions.pod:2071
24102 " inspect-get-type root\n"
24107 #: ../fish/guestfish-actions.pod:2104
24108 msgid "inspect-get-windows-current-control-set"
24112 #: ../fish/guestfish-actions.pod:2106
24115 " inspect-get-windows-current-control-set root\n"
24120 #: ../fish/guestfish-actions.pod:2120
24121 msgid "inspect-get-windows-systemroot"
24125 #: ../fish/guestfish-actions.pod:2122
24128 " inspect-get-windows-systemroot root\n"
24133 #: ../fish/guestfish-actions.pod:2136
24134 msgid "inspect-is-live"
24138 #: ../fish/guestfish-actions.pod:2138
24141 " inspect-is-live root\n"
24146 #: ../fish/guestfish-actions.pod:2143
24148 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24149 "then this returns true if a live image was detected on the disk."
24153 #: ../fish/guestfish-actions.pod:2149
24154 msgid "inspect-is-multipart"
24158 #: ../fish/guestfish-actions.pod:2151
24161 " inspect-is-multipart root\n"
24166 #: ../fish/guestfish-actions.pod:2156
24168 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24169 "then this returns true if the disk is part of a set."
24173 #: ../fish/guestfish-actions.pod:2162
24174 msgid "inspect-is-netinst"
24178 #: ../fish/guestfish-actions.pod:2164
24181 " inspect-is-netinst root\n"
24186 #: ../fish/guestfish-actions.pod:2169
24188 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24189 "then this returns true if the disk is a network installer, ie. not a self-"
24190 "contained install CD but one which is likely to require network access to "
24191 "complete the install."
24195 #: ../fish/guestfish-actions.pod:2177
24196 msgid "inspect-list-applications"
24200 #: ../fish/guestfish-actions.pod:2179
24203 " inspect-list-applications root\n"
24208 #: ../fish/guestfish-actions.pod:2186
24210 "I<Note:> This call works differently from other parts of the inspection "
24211 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24212 "then mount up the disks, before calling this. Listing applications is a "
24213 "significantly more difficult operation which requires access to the full "
24214 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24215 "are just returning data cached in the libguestfs handle, this call actually "
24216 "reads parts of the mounted filesystems during the call."
24220 #: ../fish/guestfish-actions.pod:2276
24225 #: ../fish/guestfish-actions.pod:2278
24233 #: ../fish/guestfish-actions.pod:2293
24235 "You can pass the root string(s) returned to other L</inspect-get-*> "
24236 "functions in order to query further information about each operating system, "
24237 "such as the name and version."
24241 #: ../fish/guestfish-actions.pod:2298
24243 "This function uses other libguestfs features such as L</mount-ro> and L</"
24244 "umount-all> in order to mount and unmount filesystems and look at the "
24245 "contents. This should be called with no disks currently mounted. The "
24246 "function may also use Augeas, so any existing Augeas handle will be closed."
24250 #: ../fish/guestfish-actions.pod:2310 ../fish/guestfish-actions.pod:2486
24251 #: ../fish/guestfish-actions.pod:2532
24252 msgid "See also L</list-filesystems>."
24256 #: ../fish/guestfish-actions.pod:2312
24257 msgid "is-blockdev"
24261 #: ../fish/guestfish-actions.pod:2314
24264 " is-blockdev path\n"
24269 #: ../fish/guestfish-actions.pod:2319 ../fish/guestfish-actions.pod:2337
24270 #: ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2365
24271 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2409
24272 #: ../fish/guestfish-actions.pod:2418
24273 msgid "See also L</stat>."
24277 #: ../fish/guestfish-actions.pod:2321
24282 #: ../fish/guestfish-actions.pod:2323
24290 #: ../fish/guestfish-actions.pod:2330
24295 #: ../fish/guestfish-actions.pod:2332
24298 " is-chardev path\n"
24303 #: ../fish/guestfish-actions.pod:2339
24308 #: ../fish/guestfish-actions.pod:2341
24316 #: ../fish/guestfish-actions.pod:2348
24321 #: ../fish/guestfish-actions.pod:2350
24329 #: ../fish/guestfish-actions.pod:2358
24334 #: ../fish/guestfish-actions.pod:2360
24342 #: ../fish/guestfish-actions.pod:2367
24347 #: ../fish/guestfish-actions.pod:2369
24355 #: ../fish/guestfish-actions.pod:2377
24356 msgid "is-launching"
24360 #: ../fish/guestfish-actions.pod:2379
24368 #: ../fish/guestfish-actions.pod:2386
24373 #: ../fish/guestfish-actions.pod:2388
24381 #: ../fish/guestfish-actions.pod:2393
24386 #: ../fish/guestfish-actions.pod:2395
24394 #: ../fish/guestfish-actions.pod:2402
24399 #: ../fish/guestfish-actions.pod:2404
24402 " is-socket path\n"
24407 #: ../fish/guestfish-actions.pod:2411
24412 #: ../fish/guestfish-actions.pod:2413
24415 " is-symlink path\n"
24420 #: ../fish/guestfish-actions.pod:2420
24421 msgid "kill-subprocess"
24425 #: ../fish/guestfish-actions.pod:2422
24428 " kill-subprocess\n"
24433 #: ../fish/guestfish-actions.pod:2426
24438 #: ../fish/guestfish-actions.pod:2428
24443 #: ../fish/guestfish-actions.pod:2430
24451 #: ../fish/guestfish-actions.pod:2438
24456 #: ../fish/guestfish-actions.pod:2440
24459 " lchown owner group path\n"
24464 #: ../fish/guestfish-actions.pod:2442
24466 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24467 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24472 #: ../fish/guestfish-actions.pod:2450
24477 #: ../fish/guestfish-actions.pod:2452
24480 " lgetxattr path name\n"
24485 #: ../fish/guestfish-actions.pod:2468
24486 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24490 #: ../fish/guestfish-actions.pod:2470
24495 #: ../fish/guestfish-actions.pod:2472
24498 " lgetxattrs path\n"
24503 #: ../fish/guestfish-actions.pod:2474
24505 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24506 "it returns the extended attributes of the link itself."
24510 #: ../fish/guestfish-actions.pod:2478
24511 msgid "list-devices"
24515 #: ../fish/guestfish-actions.pod:2480
24523 #: ../fish/guestfish-actions.pod:2488
24524 msgid "list-filesystems"
24528 #: ../fish/guestfish-actions.pod:2490
24531 " list-filesystems\n"
24536 #: ../fish/guestfish-actions.pod:2509
24538 "This command runs other libguestfs commands, which might include L</mount> "
24539 "and L</umount>, and therefore you should use this soon after launch and only "
24540 "when nothing is mounted."
24544 #: ../fish/guestfish-actions.pod:2513
24546 "Not all of the filesystems returned will be mountable. In particular, swap "
24547 "partitions are returned in the list. Also this command does not check that "
24548 "each filesystem found is valid and mountable, and some filesystems might be "
24549 "mountable but require special options. Filesystems may not all belong to a "
24550 "single logical operating system (use L</inspect-os> to look for OSes)."
24554 #: ../fish/guestfish-actions.pod:2521
24555 msgid "list-partitions"
24559 #: ../fish/guestfish-actions.pod:2523
24562 " list-partitions\n"
24567 #: ../fish/guestfish-actions.pod:2529
24569 "This does not return logical volumes. For that you will need to call L</"
24574 #: ../fish/guestfish-actions.pod:2534
24579 #: ../fish/guestfish-actions.pod:2536
24587 #: ../fish/guestfish-actions.pod:2544
24592 #: ../fish/guestfish-actions.pod:2546
24595 " ln target linkname\n"
24600 #: ../fish/guestfish-actions.pod:2550
24605 #: ../fish/guestfish-actions.pod:2552
24608 " ln-f target linkname\n"
24613 #: ../fish/guestfish-actions.pod:2557
24618 #: ../fish/guestfish-actions.pod:2559
24621 " ln-s target linkname\n"
24626 #: ../fish/guestfish-actions.pod:2563
24631 #: ../fish/guestfish-actions.pod:2565
24634 " ln-sf target linkname\n"
24639 #: ../fish/guestfish-actions.pod:2570
24640 msgid "lremovexattr"
24644 #: ../fish/guestfish-actions.pod:2572
24647 " lremovexattr xattr path\n"
24652 #: ../fish/guestfish-actions.pod:2574
24654 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24655 "it removes an extended attribute of the link itself."
24659 #: ../fish/guestfish-actions.pod:2578
24664 #: ../fish/guestfish-actions.pod:2580
24672 #: ../fish/guestfish-actions.pod:2586
24674 "This command is mostly useful for interactive sessions. Programs should "
24675 "probably use L</readdir> instead."
24679 #: ../fish/guestfish-actions.pod:2589
24684 #: ../fish/guestfish-actions.pod:2591
24687 " lsetxattr xattr val vallen path\n"
24692 #: ../fish/guestfish-actions.pod:2593
24694 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24695 "sets an extended attribute of the link itself."
24699 #: ../fish/guestfish-actions.pod:2597
24704 #: ../fish/guestfish-actions.pod:2599
24712 #: ../fish/guestfish-actions.pod:2603
24714 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24715 "the link is stat-ed, not the file it refers to."
24719 #: ../fish/guestfish-actions.pod:2609
24724 #: ../fish/guestfish-actions.pod:2611
24727 " lstatlist path 'names ...'\n"
24732 #: ../fish/guestfish-actions.pod:2613
24734 "This call allows you to perform the L</lstat> operation on multiple files, "
24735 "where all files are in the directory C<path>. C<names> is the list of files "
24736 "from this directory."
24740 #: ../fish/guestfish-actions.pod:2622
24742 "This call is intended for programs that want to efficiently list a directory "
24743 "contents without making many round-trips. See also L</lxattrlist> for a "
24744 "similarly efficient call for getting extended attributes. Very long "
24745 "directory listings might cause the protocol message size to be exceeded, "
24746 "causing this call to fail. The caller must split up such requests into "
24747 "smaller groups of names."
24751 #: ../fish/guestfish-actions.pod:2630
24752 msgid "luks-add-key"
24756 #: ../fish/guestfish-actions.pod:2632
24759 " luks-add-key device keyslot\n"
24764 #: ../fish/guestfish-actions.pod:2639
24766 "Note that if C<keyslot> already contains a key, then this command will "
24767 "fail. You have to use L</luks-kill-slot> first to remove that key."
24771 #: ../fish/guestfish-actions.pod:2643 ../fish/guestfish-actions.pod:2665
24772 #: ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2692
24773 #: ../fish/guestfish-actions.pod:2715 ../fish/guestfish-actions.pod:2725
24775 "This command has one or more key or passphrase parameters. Guestfish will "
24776 "prompt for these separately."
24780 #: ../fish/guestfish-actions.pod:2646
24785 #: ../fish/guestfish-actions.pod:2648
24788 " luks-close device\n"
24793 #: ../fish/guestfish-actions.pod:2650
24795 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24796 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24797 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24802 #: ../fish/guestfish-actions.pod:2656
24803 msgid "luks-format"
24807 #: ../fish/guestfish-actions.pod:2658
24810 " luks-format device keyslot\n"
24815 #: ../fish/guestfish-actions.pod:2671
24816 msgid "luks-format-cipher"
24820 #: ../fish/guestfish-actions.pod:2673
24823 " luks-format-cipher device keyslot cipher\n"
24828 #: ../fish/guestfish-actions.pod:2675
24830 "This command is the same as L</luks-format> but it also allows you to set "
24831 "the C<cipher> used."
24835 #: ../fish/guestfish-actions.pod:2684
24836 msgid "luks-kill-slot"
24840 #: ../fish/guestfish-actions.pod:2686
24843 " luks-kill-slot device keyslot\n"
24848 #: ../fish/guestfish-actions.pod:2695
24853 #: ../fish/guestfish-actions.pod:2697
24856 " luks-open device mapname\n"
24861 #: ../fish/guestfish-actions.pod:2711
24863 "If this block device contains LVM volume groups, then calling L</vgscan> "
24864 "followed by L</vg-activate-all> will make them visible."
24868 #: ../fish/guestfish-actions.pod:2718
24869 msgid "luks-open-ro"
24873 #: ../fish/guestfish-actions.pod:2720
24876 " luks-open-ro device mapname\n"
24881 #: ../fish/guestfish-actions.pod:2722
24883 "This is the same as L</luks-open> except that a read-only mapping is created."
24887 #: ../fish/guestfish-actions.pod:2728
24892 #: ../fish/guestfish-actions.pod:2730
24895 " lvcreate logvol volgroup mbytes\n"
24900 #: ../fish/guestfish-actions.pod:2735
24901 msgid "lvm-canonical-lv-name"
24905 #: ../fish/guestfish-actions.pod:2737
24908 " lvm-canonical-lv-name lvname\n"
24913 #: ../fish/guestfish-actions.pod:2746
24914 msgid "See also L</is-lv>."
24918 #: ../fish/guestfish-actions.pod:2748
24919 msgid "lvm-clear-filter"
24923 #: ../fish/guestfish-actions.pod:2750
24926 " lvm-clear-filter\n"
24931 #: ../fish/guestfish-actions.pod:2752
24933 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24938 #: ../fish/guestfish-actions.pod:2758
24939 msgid "lvm-remove-all"
24943 #: ../fish/guestfish-actions.pod:2760
24946 " lvm-remove-all\n"
24951 #: ../fish/guestfish-actions.pod:2768
24952 msgid "lvm-set-filter"
24956 #: ../fish/guestfish-actions.pod:2770
24959 " lvm-set-filter 'devices ...'\n"
24964 #: ../fish/guestfish-actions.pod:2795
24969 #: ../fish/guestfish-actions.pod:2797
24972 " lvremove device\n"
24977 #: ../fish/guestfish-actions.pod:2805
24982 #: ../fish/guestfish-actions.pod:2807
24985 " lvrename logvol newlogvol\n"
24990 #: ../fish/guestfish-actions.pod:2811
24995 #: ../fish/guestfish-actions.pod:2813
24998 " lvresize device mbytes\n"
25003 #: ../fish/guestfish-actions.pod:2819
25004 msgid "lvresize-free"
25008 #: ../fish/guestfish-actions.pod:2821
25011 " lvresize-free lv percent\n"
25016 #: ../fish/guestfish-actions.pod:2829
25021 #: ../fish/guestfish-actions.pod:2831
25029 #: ../fish/guestfish-actions.pod:2839
25030 msgid "See also L</lvs-full>, L</list-filesystems>."
25034 #: ../fish/guestfish-actions.pod:2841
25039 #: ../fish/guestfish-actions.pod:2843
25047 #: ../fish/guestfish-actions.pod:2848
25052 #: ../fish/guestfish-actions.pod:2850
25060 #: ../fish/guestfish-actions.pod:2854
25065 #: ../fish/guestfish-actions.pod:2856
25068 " lxattrlist path 'names ...'\n"
25073 #: ../fish/guestfish-actions.pod:2872
25075 "This call is intended for programs that want to efficiently list a directory "
25076 "contents without making many round-trips. See also L</lstatlist> for a "
25077 "similarly efficient call for getting standard stats. Very long directory "
25078 "listings might cause the protocol message size to be exceeded, causing this "
25079 "call to fail. The caller must split up such requests into smaller groups of "
25084 #: ../fish/guestfish-actions.pod:2880
25089 #: ../fish/guestfish-actions.pod:2882
25097 #: ../fish/guestfish-actions.pod:2886
25102 #: ../fish/guestfish-actions.pod:2888
25105 " mkdir-mode path mode\n"
25110 #: ../fish/guestfish-actions.pod:2897
25111 msgid "See also L</mkdir>, L</umask>"
25115 #: ../fish/guestfish-actions.pod:2899
25120 #: ../fish/guestfish-actions.pod:2901
25128 #: ../fish/guestfish-actions.pod:2906
25133 #: ../fish/guestfish-actions.pod:2908
25136 " mkdtemp template\n"
25141 #: ../fish/guestfish-actions.pod:2929
25146 #: ../fish/guestfish-actions.pod:2931
25149 " mke2fs-J fstype blocksize device journal\n"
25154 #: ../fish/guestfish-actions.pod:2939
25155 msgid "See also L</mke2journal>."
25159 #: ../fish/guestfish-actions.pod:2941
25164 #: ../fish/guestfish-actions.pod:2943
25167 " mke2fs-JL fstype blocksize device label\n"
25172 #: ../fish/guestfish-actions.pod:2948
25173 msgid "See also L</mke2journal-L>."
25177 #: ../fish/guestfish-actions.pod:2950
25182 #: ../fish/guestfish-actions.pod:2952
25185 " mke2fs-JU fstype blocksize device uuid\n"
25190 #: ../fish/guestfish-actions.pod:2957
25191 msgid "See also L</mke2journal-U>."
25195 #: ../fish/guestfish-actions.pod:2959
25196 msgid "mke2journal"
25200 #: ../fish/guestfish-actions.pod:2961
25203 " mke2journal blocksize device\n"
25208 #: ../fish/guestfish-actions.pod:2968
25209 msgid "mke2journal-L"
25213 #: ../fish/guestfish-actions.pod:2970
25216 " mke2journal-L blocksize label device\n"
25221 #: ../fish/guestfish-actions.pod:2974
25222 msgid "mke2journal-U"
25226 #: ../fish/guestfish-actions.pod:2976
25229 " mke2journal-U blocksize uuid device\n"
25234 #: ../fish/guestfish-actions.pod:2980
25239 #: ../fish/guestfish-actions.pod:2982
25242 " mkfifo mode path\n"
25247 #: ../fish/guestfish-actions.pod:2984
25249 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25250 "is just a convenient wrapper around L</mknod>."
25254 #: ../fish/guestfish-actions.pod:2990
25259 #: ../fish/guestfish-actions.pod:2992
25262 " mkfs fstype device\n"
25267 #: ../fish/guestfish-actions.pod:2998
25272 #: ../fish/guestfish-actions.pod:3000
25275 " mkfs-b fstype blocksize device\n"
25280 #: ../fish/guestfish-actions.pod:3002
25282 "This call is similar to L</mkfs>, but it allows you to control the block "
25283 "size of the resulting filesystem. Supported block sizes depend on the "
25284 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25288 #: ../fish/guestfish-actions.pod:3017
25293 #: ../fish/guestfish-actions.pod:3019
25296 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25301 #: ../fish/guestfish-actions.pod:3054
25302 msgid "mkmountpoint"
25306 #: ../fish/guestfish-actions.pod:3056
25309 " mkmountpoint exemptpath\n"
25314 #: ../fish/guestfish-actions.pod:3058
25316 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25317 "to create extra mountpoints before mounting the first filesystem."
25321 #: ../fish/guestfish-actions.pod:3082
25323 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25324 "unexpected errors if you try to mix these calls. It is safest to manually "
25325 "unmount filesystems and remove mountpoints after use."
25329 #: ../fish/guestfish-actions.pod:3086
25331 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25332 "for this to work for manual mountpoints, you must ensure that the innermost "
25333 "mountpoints have the longest pathnames, as in the example code above."
25337 #: ../fish/guestfish-actions.pod:3093
25339 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25340 "L</umount-all> to be called when the handle is closed which can also trigger "
25345 #: ../fish/guestfish-actions.pod:3097
25350 #: ../fish/guestfish-actions.pod:3099
25353 " mknod mode devmajor devminor path\n"
25358 #: ../fish/guestfish-actions.pod:3109
25360 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25361 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25362 "regular file). These constants are available in the standard Linux header "
25363 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25364 "wrappers around this command which bitwise OR in the appropriate constant "
25369 #: ../fish/guestfish-actions.pod:3119
25374 #: ../fish/guestfish-actions.pod:3121
25377 " mknod-b mode devmajor devminor path\n"
25382 #: ../fish/guestfish-actions.pod:3123
25384 "This call creates a block device node called C<path> with mode C<mode> and "
25385 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25386 "wrapper around L</mknod>."
25390 #: ../fish/guestfish-actions.pod:3129
25395 #: ../fish/guestfish-actions.pod:3131
25398 " mknod-c mode devmajor devminor path\n"
25403 #: ../fish/guestfish-actions.pod:3133
25405 "This call creates a char device node called C<path> with mode C<mode> and "
25406 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25407 "wrapper around L</mknod>."
25411 #: ../fish/guestfish-actions.pod:3139
25416 #: ../fish/guestfish-actions.pod:3141
25424 #: ../fish/guestfish-actions.pod:3145
25429 #: ../fish/guestfish-actions.pod:3147
25432 " mkswap-L label device\n"
25437 #: ../fish/guestfish-actions.pod:3155
25442 #: ../fish/guestfish-actions.pod:3157
25445 " mkswap-U uuid device\n"
25450 #: ../fish/guestfish-actions.pod:3161
25451 msgid "mkswap-file"
25455 #: ../fish/guestfish-actions.pod:3163
25458 " mkswap-file path\n"
25463 #: ../fish/guestfish-actions.pod:3167
25465 "This command just writes a swap file signature to an existing file. To "
25466 "create the file itself, use something like L</fallocate>."
25470 #: ../fish/guestfish-actions.pod:3170
25475 #: ../fish/guestfish-actions.pod:3172
25478 " modprobe modulename\n"
25483 #: ../fish/guestfish-actions.pod:3179
25488 #: ../fish/guestfish-actions.pod:3181
25491 " mount device mountpoint\n"
25496 #: ../fish/guestfish-actions.pod:3197
25498 "B<Important note:> When you use this call, the filesystem options C<sync> "
25499 "and C<noatime> are set implicitly. This was originally done because we "
25500 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25501 "very large negative performance impact and negligible effect on "
25502 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25503 "code that needs performance, and instead use L</mount-options> (use an empty "
25504 "string for the first parameter if you don't want any options)."
25508 #: ../fish/guestfish-actions.pod:3207
25513 #: ../fish/guestfish-actions.pod:3209
25516 " mount-loop file mountpoint\n"
25521 #: ../fish/guestfish-actions.pod:3215
25522 msgid "mount-options"
25526 #: ../fish/guestfish-actions.pod:3217
25529 " mount-options options device mountpoint\n"
25534 #: ../fish/guestfish-actions.pod:3219
25536 "This is the same as the L</mount> command, but it allows you to set the "
25537 "mount options as for the L<mount(8)> I<-o> flag."
25541 #: ../fish/guestfish-actions.pod:3227
25546 #: ../fish/guestfish-actions.pod:3229
25549 " mount-ro device mountpoint\n"
25554 #: ../fish/guestfish-actions.pod:3231
25556 "This is the same as the L</mount> command, but it mounts the filesystem with "
25557 "the read-only (I<-o ro>) flag."
25561 #: ../fish/guestfish-actions.pod:3234
25566 #: ../fish/guestfish-actions.pod:3236
25569 " mount-vfs options vfstype device mountpoint\n"
25574 #: ../fish/guestfish-actions.pod:3238
25576 "This is the same as the L</mount> command, but it allows you to set both the "
25577 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25581 #: ../fish/guestfish-actions.pod:3242
25582 msgid "mountpoints"
25586 #: ../fish/guestfish-actions.pod:3244
25594 #: ../fish/guestfish-actions.pod:3246
25596 "This call is similar to L</mounts>. That call returns a list of devices. "
25597 "This one returns a hash table (map) of device name to directory where the "
25598 "device is mounted."
25602 #: ../fish/guestfish-actions.pod:3250
25607 #: ../fish/guestfish-actions.pod:3252
25615 #: ../fish/guestfish-actions.pod:3259
25616 msgid "See also: L</mountpoints>"
25620 #: ../fish/guestfish-actions.pod:3261
25625 #: ../fish/guestfish-actions.pod:3263
25633 #: ../fish/guestfish-actions.pod:3268
25634 msgid "ntfs-3g-probe"
25638 #: ../fish/guestfish-actions.pod:3270
25641 " ntfs-3g-probe true|false device\n"
25646 #: ../fish/guestfish-actions.pod:3284
25651 #: ../fish/guestfish-actions.pod:3286
25654 " ntfsresize device\n"
25659 #: ../fish/guestfish-actions.pod:3292
25660 msgid "ntfsresize-size"
25664 #: ../fish/guestfish-actions.pod:3294
25667 " ntfsresize-size device size\n"
25672 #: ../fish/guestfish-actions.pod:3296
25674 "This command is the same as L</ntfsresize> except that it allows you to "
25675 "specify the new size (in bytes) explicitly."
25679 #: ../fish/guestfish-actions.pod:3299
25684 #: ../fish/guestfish-actions.pod:3301
25687 " part-add device prlogex startsect endsect\n"
25692 #: ../fish/guestfish-actions.pod:3303
25694 "This command adds a partition to C<device>. If there is no partition table "
25695 "on the device, call L</part-init> first."
25699 #: ../fish/guestfish-actions.pod:3315
25701 "Creating a partition which covers the whole disk is not so easy. Use L</"
25702 "part-disk> to do that."
25706 #: ../fish/guestfish-actions.pod:3318
25711 #: ../fish/guestfish-actions.pod:3320
25714 " part-del device partnum\n"
25719 #: ../fish/guestfish-actions.pod:3328
25724 #: ../fish/guestfish-actions.pod:3330
25727 " part-disk device parttype\n"
25732 #: ../fish/guestfish-actions.pod:3332
25734 "This command is simply a combination of L</part-init> followed by L</part-"
25735 "add> to create a single primary partition covering the whole disk."
25739 #: ../fish/guestfish-actions.pod:3336
25741 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25742 "possible values are described in L</part-init>."
25746 #: ../fish/guestfish-actions.pod:3342
25747 msgid "part-get-bootable"
25751 #: ../fish/guestfish-actions.pod:3344
25754 " part-get-bootable device partnum\n"
25759 #: ../fish/guestfish-actions.pod:3349
25760 msgid "See also L</part-set-bootable>."
25764 #: ../fish/guestfish-actions.pod:3351
25765 msgid "part-get-mbr-id"
25769 #: ../fish/guestfish-actions.pod:3353
25772 " part-get-mbr-id device partnum\n"
25777 #: ../fish/guestfish-actions.pod:3358 ../fish/guestfish-actions.pod:3496
25779 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25780 "undefined results for other partition table types (see L</part-get-"
25785 #: ../fish/guestfish-actions.pod:3362
25786 msgid "part-get-parttype"
25790 #: ../fish/guestfish-actions.pod:3364
25793 " part-get-parttype device\n"
25798 #: ../fish/guestfish-actions.pod:3369
25800 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25801 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25802 "possible, although unusual. See L</part-init> for a full list."
25806 #: ../fish/guestfish-actions.pod:3374
25811 #: ../fish/guestfish-actions.pod:3376
25814 " part-init device parttype\n"
25819 #: ../fish/guestfish-actions.pod:3382
25821 "Initially there are no partitions. Following this, you should call L</part-"
25822 "add> for each partition required."
25826 #: ../fish/guestfish-actions.pod:3445
25831 #: ../fish/guestfish-actions.pod:3447
25834 " part-list device\n"
25839 #: ../fish/guestfish-actions.pod:3462
25841 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25842 "the device's sector size, see L</blockdev-getss>."
25846 #: ../fish/guestfish-actions.pod:3475
25847 msgid "part-set-bootable"
25851 #: ../fish/guestfish-actions.pod:3477
25854 " part-set-bootable device partnum true|false\n"
25859 #: ../fish/guestfish-actions.pod:3486
25860 msgid "part-set-mbr-id"
25864 #: ../fish/guestfish-actions.pod:3488
25867 " part-set-mbr-id device partnum idbyte\n"
25872 #: ../fish/guestfish-actions.pod:3500
25873 msgid "part-set-name"
25877 #: ../fish/guestfish-actions.pod:3502
25880 " part-set-name device partnum name\n"
25885 #: ../fish/guestfish-actions.pod:3510
25886 msgid "part-to-dev"
25890 #: ../fish/guestfish-actions.pod:3512
25893 " part-to-dev partition\n"
25898 #: ../fish/guestfish-actions.pod:3518
25900 "The named partition must exist, for example as a string returned from L</"
25901 "list-partitions>."
25905 #: ../fish/guestfish-actions.pod:3521
25906 msgid "ping-daemon"
25910 #: ../fish/guestfish-actions.pod:3523
25918 #: ../fish/guestfish-actions.pod:3530
25923 #: ../fish/guestfish-actions.pod:3532
25926 " pread path count offset\n"
25931 #: ../fish/guestfish-actions.pod:3540
25932 msgid "See also L</pwrite>, L</pread-device>."
25936 #: ../fish/guestfish-actions.pod:3545
25937 msgid "pread-device"
25941 #: ../fish/guestfish-actions.pod:3547
25944 " pread-device device count offset\n"
25949 #: ../fish/guestfish-actions.pod:3555
25950 msgid "See also L</pread>."
25954 #: ../fish/guestfish-actions.pod:3560
25959 #: ../fish/guestfish-actions.pod:3562
25962 " pvcreate device\n"
25967 #: ../fish/guestfish-actions.pod:3568
25972 #: ../fish/guestfish-actions.pod:3570
25975 " pvremove device\n"
25980 #: ../fish/guestfish-actions.pod:3579
25985 #: ../fish/guestfish-actions.pod:3581
25988 " pvresize device\n"
25993 #: ../fish/guestfish-actions.pod:3586
25994 msgid "pvresize-size"
25998 #: ../fish/guestfish-actions.pod:3588
26001 " pvresize-size device size\n"
26006 #: ../fish/guestfish-actions.pod:3590
26008 "This command is the same as L</pvresize> except that it allows you to "
26009 "specify the new size (in bytes) explicitly."
26013 #: ../fish/guestfish-actions.pod:3593
26018 #: ../fish/guestfish-actions.pod:3595
26026 #: ../fish/guestfish-actions.pod:3603
26027 msgid "See also L</pvs-full>."
26031 #: ../fish/guestfish-actions.pod:3605
26036 #: ../fish/guestfish-actions.pod:3607
26044 #: ../fish/guestfish-actions.pod:3612
26049 #: ../fish/guestfish-actions.pod:3614
26057 #: ../fish/guestfish-actions.pod:3618
26062 #: ../fish/guestfish-actions.pod:3620
26065 " pwrite path content offset\n"
26070 #: ../fish/guestfish-actions.pod:3631
26071 msgid "See also L</pread>, L</pwrite-device>."
26075 #: ../fish/guestfish-actions.pod:3636
26076 msgid "pwrite-device"
26080 #: ../fish/guestfish-actions.pod:3638
26083 " pwrite-device device content offset\n"
26088 #: ../fish/guestfish-actions.pod:3648
26089 msgid "See also L</pwrite>."
26093 #: ../fish/guestfish-actions.pod:3653
26098 #: ../fish/guestfish-actions.pod:3655
26101 " read-file path\n"
26106 #: ../fish/guestfish-actions.pod:3660
26108 "Unlike L</cat>, this function can correctly handle files that contain "
26109 "embedded ASCII NUL characters. However unlike L</download>, this function "
26110 "is limited in the total size of file that can be handled."
26114 #: ../fish/guestfish-actions.pod:3668
26119 #: ../fish/guestfish-actions.pod:3670
26122 " read-lines path\n"
26127 #: ../fish/guestfish-actions.pod:3677
26129 "Note that this function cannot correctly handle binary files (specifically, "
26130 "files containing C<\\0> character which is treated as end of line). For "
26131 "those you need to use the L</read-file> function which has a more complex "
26136 #: ../fish/guestfish-actions.pod:3682
26141 #: ../fish/guestfish-actions.pod:3684
26149 #: ../fish/guestfish-actions.pod:3736
26151 "This function is primarily intended for use by programs. To get a simple "
26152 "list of names, use L</ls>. To get a printable directory for human "
26153 "consumption, use L</ll>."
26157 #: ../fish/guestfish-actions.pod:3740
26162 #: ../fish/guestfish-actions.pod:3742
26170 #: ../fish/guestfish-actions.pod:3746
26171 msgid "readlinklist"
26175 #: ../fish/guestfish-actions.pod:3748
26178 " readlinklist path 'names ...'\n"
26183 #: ../fish/guestfish-actions.pod:3772
26188 #: ../fish/guestfish-actions.pod:3774
26196 #: ../fish/guestfish-actions.pod:3779
26197 msgid "removexattr"
26201 #: ../fish/guestfish-actions.pod:3781
26204 " removexattr xattr path\n"
26209 #: ../fish/guestfish-actions.pod:3786
26210 msgid "See also: L</lremovexattr>, L<attr(5)>."
26214 #: ../fish/guestfish-actions.pod:3788
26219 #: ../fish/guestfish-actions.pod:3790
26222 " resize2fs device\n"
26227 #: ../fish/guestfish-actions.pod:3795
26229 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26230 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26231 "gives an error about this and sometimes not. In any case, it is always safe "
26232 "to call L</e2fsck-f> before calling this function."
26236 #: ../fish/guestfish-actions.pod:3801
26237 msgid "resize2fs-M"
26241 #: ../fish/guestfish-actions.pod:3803
26244 " resize2fs-M device\n"
26249 #: ../fish/guestfish-actions.pod:3805
26251 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26252 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26257 #: ../fish/guestfish-actions.pod:3809
26259 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26260 "and read the C<Block size> and C<Block count> values. These two numbers, "
26261 "multiplied together, give the resulting size of the minimal filesystem in "
26266 #: ../fish/guestfish-actions.pod:3814
26267 msgid "resize2fs-size"
26271 #: ../fish/guestfish-actions.pod:3816
26274 " resize2fs-size device size\n"
26279 #: ../fish/guestfish-actions.pod:3818
26281 "This command is the same as L</resize2fs> except that it allows you to "
26282 "specify the new size (in bytes) explicitly."
26286 #: ../fish/guestfish-actions.pod:3821
26291 #: ../fish/guestfish-actions.pod:3823
26299 #: ../fish/guestfish-actions.pod:3827
26304 #: ../fish/guestfish-actions.pod:3829
26312 #: ../fish/guestfish-actions.pod:3835
26317 #: ../fish/guestfish-actions.pod:3837
26325 #: ../fish/guestfish-actions.pod:3841
26326 msgid "rmmountpoint"
26330 #: ../fish/guestfish-actions.pod:3843
26333 " rmmountpoint exemptpath\n"
26338 #: ../fish/guestfish-actions.pod:3845
26340 "This calls removes a mountpoint that was previously created with L</"
26341 "mkmountpoint>. See L</mkmountpoint> for full details."
26345 #: ../fish/guestfish-actions.pod:3849
26346 msgid "scrub-device"
26350 #: ../fish/guestfish-actions.pod:3851
26353 " scrub-device device\n"
26358 #: ../fish/guestfish-actions.pod:3862
26363 #: ../fish/guestfish-actions.pod:3864
26366 " scrub-file file\n"
26371 #: ../fish/guestfish-actions.pod:3874
26372 msgid "scrub-freespace"
26376 #: ../fish/guestfish-actions.pod:3876
26379 " scrub-freespace dir\n"
26384 #: ../fish/guestfish-actions.pod:3878
26386 "This command creates the directory C<dir> and then fills it with files until "
26387 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26388 "deletes them. The intention is to scrub any free space on the partition "
26389 "containing C<dir>."
26393 #: ../fish/guestfish-actions.pod:3887
26398 #: ../fish/guestfish-actions.pod:3889
26403 #: ../fish/guestfish-actions.pod:3891
26406 " set-append append\n"
26411 #: ../fish/guestfish-actions.pod:3902
26412 msgid "set-attach-method"
26416 #: ../fish/guestfish-actions.pod:3904
26417 msgid "attach-method"
26421 #: ../fish/guestfish-actions.pod:3906
26424 " set-attach-method attachmethod\n"
26429 #: ../fish/guestfish-actions.pod:3928
26430 msgid "set-autosync"
26434 #: ../fish/guestfish-actions.pod:3930
26439 #: ../fish/guestfish-actions.pod:3932
26442 " set-autosync true|false\n"
26447 #: ../fish/guestfish-actions.pod:3942
26452 #: ../fish/guestfish-actions.pod:3944
26457 #: ../fish/guestfish-actions.pod:3946
26460 " set-direct true|false\n"
26465 #: ../fish/guestfish-actions.pod:3952
26467 "One consequence of this is that log messages aren't caught by the library "
26468 "and handled by L</set-log-message-callback>, but go straight to stdout."
26472 #: ../fish/guestfish-actions.pod:3961
26473 msgid "set-e2label"
26477 #: ../fish/guestfish-actions.pod:3963
26480 " set-e2label device label\n"
26485 #: ../fish/guestfish-actions.pod:3969
26487 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26488 "label on a filesystem."
26492 #: ../fish/guestfish-actions.pod:3972
26497 #: ../fish/guestfish-actions.pod:3974
26500 " set-e2uuid device uuid\n"
26505 #: ../fish/guestfish-actions.pod:3981
26507 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26508 "UUID of a filesystem."
26512 #: ../fish/guestfish-actions.pod:3984
26513 msgid "set-memsize"
26517 #: ../fish/guestfish-actions.pod:3986
26522 #: ../fish/guestfish-actions.pod:3988
26525 " set-memsize memsize\n"
26530 #: ../fish/guestfish-actions.pod:3990
26532 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26533 "This only has any effect if called before L</launch>."
26537 #: ../fish/guestfish-actions.pod:4001
26538 msgid "set-network"
26542 #: ../fish/guestfish-actions.pod:4003
26547 #: ../fish/guestfish-actions.pod:4005
26550 " set-network true|false\n"
26555 #: ../fish/guestfish-actions.pod:4013
26557 "You must call this before calling L</launch>, otherwise it has no effect."
26561 #: ../fish/guestfish-actions.pod:4016
26566 #: ../fish/guestfish-actions.pod:4018
26571 #: ../fish/guestfish-actions.pod:4020
26574 " set-path searchpath\n"
26579 #: ../fish/guestfish-actions.pod:4029
26584 #: ../fish/guestfish-actions.pod:4031
26589 #: ../fish/guestfish-actions.pod:4033
26597 #: ../fish/guestfish-actions.pod:4053
26598 msgid "set-recovery-proc"
26602 #: ../fish/guestfish-actions.pod:4055
26603 msgid "recovery-proc"
26607 #: ../fish/guestfish-actions.pod:4057
26610 " set-recovery-proc true|false\n"
26615 #: ../fish/guestfish-actions.pod:4059
26617 "If this is called with the parameter C<false> then L</launch> does not "
26618 "create a recovery process. The purpose of the recovery process is to stop "
26619 "runaway qemu processes in the case where the main program aborts abruptly."
26623 #: ../fish/guestfish-actions.pod:4064
26625 "This only has any effect if called before L</launch>, and the default is "
26630 #: ../fish/guestfish-actions.pod:4073
26631 msgid "set-selinux"
26635 #: ../fish/guestfish-actions.pod:4075
26640 #: ../fish/guestfish-actions.pod:4077
26643 " set-selinux true|false\n"
26648 #: ../fish/guestfish-actions.pod:4088
26653 #: ../fish/guestfish-actions.pod:4090
26658 #: ../fish/guestfish-actions.pod:4092
26661 " set-trace true|false\n"
26666 #: ../fish/guestfish-actions.pod:4104
26668 "Trace messages are normally sent to C<stderr>, unless you register a "
26669 "callback to send them somewhere else (see L</set-event-callback>)."
26673 #: ../fish/guestfish-actions.pod:4108
26674 msgid "set-verbose"
26678 #: ../fish/guestfish-actions.pod:4110
26683 #: ../fish/guestfish-actions.pod:4112
26686 " set-verbose true|false\n"
26691 #: ../fish/guestfish-actions.pod:4119
26693 "Verbose messages are normally sent to C<stderr>, unless you register a "
26694 "callback to send them somewhere else (see L</set-event-callback>)."
26698 #: ../fish/guestfish-actions.pod:4123
26703 #: ../fish/guestfish-actions.pod:4125
26706 " setcon context\n"
26711 #: ../fish/guestfish-actions.pod:4132
26716 #: ../fish/guestfish-actions.pod:4134
26719 " setxattr xattr val vallen path\n"
26724 #: ../fish/guestfish-actions.pod:4140
26725 msgid "See also: L</lsetxattr>, L<attr(5)>."
26729 #: ../fish/guestfish-actions.pod:4142
26734 #: ../fish/guestfish-actions.pod:4144
26737 " sfdisk device cyls heads sectors 'lines ...'\n"
26742 #: ../fish/guestfish-actions.pod:4166
26743 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26747 #: ../fish/guestfish-actions.pod:4172
26752 #: ../fish/guestfish-actions.pod:4174
26755 " sfdiskM device 'lines ...'\n"
26760 #: ../fish/guestfish-actions.pod:4176
26762 "This is a simplified interface to the L</sfdisk> command, where partition "
26763 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26764 "you don't need to specify the cyls, heads and sectors parameters which were "
26765 "rarely if ever used anyway."
26769 #: ../fish/guestfish-actions.pod:4182
26770 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26774 #: ../fish/guestfish-actions.pod:4188
26779 #: ../fish/guestfish-actions.pod:4190
26782 " sfdisk-N device partnum cyls heads sectors line\n"
26787 #: ../fish/guestfish-actions.pod:4195
26789 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26790 "cyls/heads/sectors parameters."
26794 #: ../fish/guestfish-actions.pod:4198
26795 msgid "See also: L</part-add>"
26799 #: ../fish/guestfish-actions.pod:4203
26800 msgid "sfdisk-disk-geometry"
26804 #: ../fish/guestfish-actions.pod:4205
26807 " sfdisk-disk-geometry device\n"
26812 #: ../fish/guestfish-actions.pod:4207
26814 "This displays the disk geometry of C<device> read from the partition table. "
26815 "Especially in the case where the underlying block device has been resized, "
26816 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26817 "kernel-geometry>)."
26821 #: ../fish/guestfish-actions.pod:4215
26822 msgid "sfdisk-kernel-geometry"
26826 #: ../fish/guestfish-actions.pod:4217
26829 " sfdisk-kernel-geometry device\n"
26834 #: ../fish/guestfish-actions.pod:4224
26839 #: ../fish/guestfish-actions.pod:4226
26842 " sfdisk-l device\n"
26847 #: ../fish/guestfish-actions.pod:4232
26848 msgid "See also: L</part-list>"
26852 #: ../fish/guestfish-actions.pod:4234
26857 #: ../fish/guestfish-actions.pod:4236
26865 #: ../fish/guestfish-actions.pod:4241
26866 msgid "This is like L</command>, but passes the command to:"
26870 #: ../fish/guestfish-actions.pod:4249
26871 msgid "All the provisos about L</command> apply to this call."
26875 #: ../fish/guestfish-actions.pod:4251
26880 #: ../fish/guestfish-actions.pod:4253
26883 " sh-lines command\n"
26888 #: ../fish/guestfish-actions.pod:4255
26889 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26893 #: ../fish/guestfish-actions.pod:4258
26894 msgid "See also: L</command-lines>"
26898 #: ../fish/guestfish-actions.pod:4260
26903 #: ../fish/guestfish-actions.pod:4262
26911 #: ../fish/guestfish-actions.pod:4266
26916 #: ../fish/guestfish-actions.pod:4268
26924 #: ../fish/guestfish-actions.pod:4274
26929 #: ../fish/guestfish-actions.pod:4276
26937 #: ../fish/guestfish-actions.pod:4284
26942 #: ../fish/guestfish-actions.pod:4286
26950 #: ../fish/guestfish-actions.pod:4294
26955 #: ../fish/guestfish-actions.pod:4296
26958 " strings-e encoding path\n"
26963 #: ../fish/guestfish-actions.pod:4298
26965 "This is like the L</strings> command, but allows you to specify the encoding "
26966 "of strings that are looked for in the source file C<path>."
26970 #: ../fish/guestfish-actions.pod:4308
26972 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26973 "ISO-8859-X (this is what L</strings> uses)."
26977 #: ../fish/guestfish-actions.pod:4340
26978 msgid "swapoff-device"
26982 #: ../fish/guestfish-actions.pod:4342
26985 " swapoff-device device\n"
26990 #: ../fish/guestfish-actions.pod:4344
26992 "This command disables the libguestfs appliance swap device or partition "
26993 "named C<device>. See L</swapon-device>."
26997 #: ../fish/guestfish-actions.pod:4348
26998 msgid "swapoff-file"
27002 #: ../fish/guestfish-actions.pod:4350
27005 " swapoff-file file\n"
27010 #: ../fish/guestfish-actions.pod:4354
27011 msgid "swapoff-label"
27015 #: ../fish/guestfish-actions.pod:4356
27018 " swapoff-label label\n"
27023 #: ../fish/guestfish-actions.pod:4361
27024 msgid "swapoff-uuid"
27028 #: ../fish/guestfish-actions.pod:4363
27031 " swapoff-uuid uuid\n"
27036 #: ../fish/guestfish-actions.pod:4368
27037 msgid "swapon-device"
27041 #: ../fish/guestfish-actions.pod:4370
27044 " swapon-device device\n"
27049 #: ../fish/guestfish-actions.pod:4372
27051 "This command enables the libguestfs appliance to use the swap device or "
27052 "partition named C<device>. The increased memory is made available for all "
27053 "commands, for example those run using L</command> or L</sh>."
27057 #: ../fish/guestfish-actions.pod:4384
27058 msgid "swapon-file"
27062 #: ../fish/guestfish-actions.pod:4386
27065 " swapon-file file\n"
27070 #: ../fish/guestfish-actions.pod:4388
27072 "This command enables swap to a file. See L</swapon-device> for other notes."
27076 #: ../fish/guestfish-actions.pod:4391
27077 msgid "swapon-label"
27081 #: ../fish/guestfish-actions.pod:4393
27084 " swapon-label label\n"
27089 #: ../fish/guestfish-actions.pod:4395
27091 "This command enables swap to a labeled swap partition. See L</swapon-"
27092 "device> for other notes."
27096 #: ../fish/guestfish-actions.pod:4398
27097 msgid "swapon-uuid"
27101 #: ../fish/guestfish-actions.pod:4400
27104 " swapon-uuid uuid\n"
27109 #: ../fish/guestfish-actions.pod:4402
27111 "This command enables swap to a swap partition with the given UUID. See L</"
27112 "swapon-device> for other notes."
27116 #: ../fish/guestfish-actions.pod:4405
27121 #: ../fish/guestfish-actions.pod:4407
27129 #: ../fish/guestfish-actions.pod:4415
27134 #: ../fish/guestfish-actions.pod:4417
27142 #: ../fish/guestfish-actions.pod:4425
27147 #: ../fish/guestfish-actions.pod:4427
27150 " tail-n nrlines path\n"
27155 #: ../fish/guestfish-actions.pod:4440
27160 #: ../fish/guestfish-actions.pod:4442
27163 " tar-in (tarfile|-) directory\n"
27168 #: ../fish/guestfish-actions.pod:4447
27169 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27173 #: ../fish/guestfish-actions.pod:4452
27178 #: ../fish/guestfish-actions.pod:4454
27181 " tar-out directory (tarfile|-)\n"
27186 #: ../fish/guestfish-actions.pod:4459
27187 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27191 #: ../fish/guestfish-actions.pod:4464
27196 #: ../fish/guestfish-actions.pod:4466
27199 " tgz-in (tarball|-) directory\n"
27204 #: ../fish/guestfish-actions.pod:4471
27205 msgid "To upload an uncompressed tarball, use L</tar-in>."
27209 #: ../fish/guestfish-actions.pod:4475
27214 #: ../fish/guestfish-actions.pod:4477
27217 " tgz-out directory (tarball|-)\n"
27222 #: ../fish/guestfish-actions.pod:4482
27223 msgid "To download an uncompressed tarball, use L</tar-out>."
27227 #: ../fish/guestfish-actions.pod:4486
27232 #: ../fish/guestfish-actions.pod:4488
27240 #: ../fish/guestfish-actions.pod:4497
27245 #: ../fish/guestfish-actions.pod:4499
27253 #: ../fish/guestfish-actions.pod:4504
27254 msgid "truncate-size"
27258 #: ../fish/guestfish-actions.pod:4506
27261 " truncate-size path size\n"
27266 #: ../fish/guestfish-actions.pod:4511
27268 "If the current file size is less than C<size> then the file is extended to "
27269 "the required size with zero bytes. This creates a sparse file (ie. disk "
27270 "blocks are not allocated for the file until you write to it). To create a "
27271 "non-sparse file of zeroes, use L</fallocate64> instead."
27275 #: ../fish/guestfish-actions.pod:4517
27280 #: ../fish/guestfish-actions.pod:4519
27283 " tune2fs-l device\n"
27288 #: ../fish/guestfish-actions.pod:4529
27293 #: ../fish/guestfish-actions.pod:4531
27296 " txz-in (tarball|-) directory\n"
27301 #: ../fish/guestfish-actions.pod:4538
27306 #: ../fish/guestfish-actions.pod:4540
27309 " txz-out directory (tarball|-)\n"
27314 #: ../fish/guestfish-actions.pod:4547
27319 #: ../fish/guestfish-actions.pod:4549
27327 #: ../fish/guestfish-actions.pod:4563
27328 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27332 #: ../fish/guestfish-actions.pod:4568
27337 #: ../fish/guestfish-actions.pod:4570
27342 #: ../fish/guestfish-actions.pod:4572
27345 " umount pathordevice\n"
27350 #: ../fish/guestfish-actions.pod:4578
27355 #: ../fish/guestfish-actions.pod:4580
27356 msgid "unmount-all"
27360 #: ../fish/guestfish-actions.pod:4582
27368 #: ../fish/guestfish-actions.pod:4588
27373 #: ../fish/guestfish-actions.pod:4590
27376 " upload (filename|-) remotefilename\n"
27381 #: ../fish/guestfish-actions.pod:4597
27382 msgid "See also L</download>."
27386 #: ../fish/guestfish-actions.pod:4601
27387 msgid "upload-offset"
27391 #: ../fish/guestfish-actions.pod:4603
27394 " upload-offset (filename|-) remotefilename offset\n"
27399 #: ../fish/guestfish-actions.pod:4615
27401 "Note that there is no limit on the amount of data that can be uploaded with "
27402 "this call, unlike with L</pwrite>, and this call always writes the full "
27403 "amount unless an error occurs."
27407 #: ../fish/guestfish-actions.pod:4620
27408 msgid "See also L</upload>, L</pwrite>."
27412 #: ../fish/guestfish-actions.pod:4624
27417 #: ../fish/guestfish-actions.pod:4626
27420 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27425 #: ../fish/guestfish-actions.pod:4645
27430 #: ../fish/guestfish-actions.pod:4647
27438 #: ../fish/guestfish-actions.pod:4674
27440 "I<Note:> Don't use this call to test for availability of features. In "
27441 "enterprise distributions we backport features from later versions into "
27442 "earlier versions, making this an unreliable way to test for features. Use "
27443 "L</available> instead."
27447 #: ../fish/guestfish-actions.pod:4680
27452 #: ../fish/guestfish-actions.pod:4682
27455 " vfs-label device\n"
27460 #: ../fish/guestfish-actions.pod:4689
27461 msgid "To find a filesystem from the label, use L</findfs-label>."
27465 #: ../fish/guestfish-actions.pod:4691
27470 #: ../fish/guestfish-actions.pod:4693
27473 " vfs-type device\n"
27478 #: ../fish/guestfish-actions.pod:4703
27483 #: ../fish/guestfish-actions.pod:4705
27486 " vfs-uuid device\n"
27491 #: ../fish/guestfish-actions.pod:4712
27492 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27496 #: ../fish/guestfish-actions.pod:4714
27497 msgid "vg-activate"
27501 #: ../fish/guestfish-actions.pod:4716
27504 " vg-activate true|false 'volgroups ...'\n"
27509 #: ../fish/guestfish-actions.pod:4729
27510 msgid "vg-activate-all"
27514 #: ../fish/guestfish-actions.pod:4731
27517 " vg-activate-all true|false\n"
27522 #: ../fish/guestfish-actions.pod:4741
27527 #: ../fish/guestfish-actions.pod:4743
27530 " vgcreate volgroup 'physvols ...'\n"
27535 #: ../fish/guestfish-actions.pod:4748
27540 #: ../fish/guestfish-actions.pod:4750
27543 " vglvuuids vgname\n"
27548 #: ../fish/guestfish-actions.pod:4755
27550 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27551 "logical volumes and volume groups."
27555 #: ../fish/guestfish-actions.pod:4758
27556 msgid "See also L</vgpvuuids>."
27560 #: ../fish/guestfish-actions.pod:4760
27565 #: ../fish/guestfish-actions.pod:4762
27568 " vgpvuuids vgname\n"
27573 #: ../fish/guestfish-actions.pod:4767
27575 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27576 "physical volumes and volume groups."
27580 #: ../fish/guestfish-actions.pod:4770
27581 msgid "See also L</vglvuuids>."
27585 #: ../fish/guestfish-actions.pod:4772
27590 #: ../fish/guestfish-actions.pod:4774
27593 " vgremove vgname\n"
27598 #: ../fish/guestfish-actions.pod:4781
27603 #: ../fish/guestfish-actions.pod:4783
27606 " vgrename volgroup newvolgroup\n"
27611 #: ../fish/guestfish-actions.pod:4787
27616 #: ../fish/guestfish-actions.pod:4789
27624 #: ../fish/guestfish-actions.pod:4797
27625 msgid "See also L</vgs-full>."
27629 #: ../fish/guestfish-actions.pod:4799
27634 #: ../fish/guestfish-actions.pod:4801
27642 #: ../fish/guestfish-actions.pod:4806
27647 #: ../fish/guestfish-actions.pod:4808
27655 #: ../fish/guestfish-actions.pod:4813
27660 #: ../fish/guestfish-actions.pod:4815
27668 #: ../fish/guestfish-actions.pod:4819
27673 #: ../fish/guestfish-actions.pod:4821
27681 #: ../fish/guestfish-actions.pod:4826
27686 #: ../fish/guestfish-actions.pod:4828
27694 #: ../fish/guestfish-actions.pod:4833
27699 #: ../fish/guestfish-actions.pod:4835
27707 #: ../fish/guestfish-actions.pod:4840
27712 #: ../fish/guestfish-actions.pod:4842
27715 " write path content\n"
27720 #: ../fish/guestfish-actions.pod:4850
27725 #: ../fish/guestfish-actions.pod:4852
27728 " write-file path content size\n"
27733 #: ../fish/guestfish-actions.pod:4875
27738 #: ../fish/guestfish-actions.pod:4877
27741 " zegrep regex path\n"
27746 #: ../fish/guestfish-actions.pod:4885
27751 #: ../fish/guestfish-actions.pod:4887
27754 " zegrepi regex path\n"
27759 #: ../fish/guestfish-actions.pod:4895
27764 #: ../fish/guestfish-actions.pod:4897
27772 #: ../fish/guestfish-actions.pod:4905
27773 msgid "See also: L</zero-device>, L</scrub-device>."
27777 #: ../fish/guestfish-actions.pod:4907
27778 msgid "zero-device"
27782 #: ../fish/guestfish-actions.pod:4909
27785 " zero-device device\n"
27790 #: ../fish/guestfish-actions.pod:4911
27792 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27793 "which just zeroes the first few blocks of a device."
27797 #: ../fish/guestfish-actions.pod:4918
27802 #: ../fish/guestfish-actions.pod:4920
27805 " zerofree device\n"
27810 #: ../fish/guestfish-actions.pod:4933
27815 #: ../fish/guestfish-actions.pod:4935
27818 " zfgrep pattern path\n"
27823 #: ../fish/guestfish-actions.pod:4943
27828 #: ../fish/guestfish-actions.pod:4945
27831 " zfgrepi pattern path\n"
27836 #: ../fish/guestfish-actions.pod:4953
27841 #: ../fish/guestfish-actions.pod:4955
27844 " zfile meth path\n"
27849 #: ../fish/guestfish-actions.pod:4962
27851 "Since 1.0.63, use L</file> instead which can now process compressed files."
27855 #: ../fish/guestfish-actions.pod:4972
27860 #: ../fish/guestfish-actions.pod:4974
27863 " zgrep regex path\n"
27868 #: ../fish/guestfish-actions.pod:4982
27873 #: ../fish/guestfish-actions.pod:4984
27876 " zgrepi regex path\n"
27881 #: ../fish/guestfish-commands.pod:1
27886 #: ../fish/guestfish-commands.pod:3
27891 #: ../fish/guestfish-commands.pod:5
27894 " alloc filename size\n"
27899 #: ../fish/guestfish-commands.pod:7
27901 "This creates an empty (zeroed) file of the given size, and then adds so it "
27902 "can be further examined."
27906 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27907 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27911 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27912 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27916 #: ../fish/guestfish-commands.pod:14
27918 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27919 "image, see L</PREPARED DISK IMAGES>."
27923 #: ../fish/guestfish-commands.pod:17
27928 #: ../fish/guestfish-commands.pod:19
27931 " copy-in local [local ...] /remotedir\n"
27936 #: ../fish/guestfish-commands.pod:21
27938 "C<copy-in> copies local files or directories recursively into the disk "
27939 "image, placing them in the directory called C</remotedir> (which must "
27940 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27941 "other commands as necessary."
27945 #: ../fish/guestfish-commands.pod:26
27947 "Multiple local files and directories can be specified, but the last "
27948 "parameter must always be a remote directory. Wildcards cannot be used."
27952 #: ../fish/guestfish-commands.pod:30
27957 #: ../fish/guestfish-commands.pod:32
27960 " copy-out remote [remote ...] localdir\n"
27965 #: ../fish/guestfish-commands.pod:34
27967 "C<copy-out> copies remote files or directories recursively out of the disk "
27968 "image, placing them on the host disk in a local directory called C<localdir> "
27969 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27970 "download>, L</tar-out> and other commands as necessary."
27974 #: ../fish/guestfish-commands.pod:40
27976 "Multiple remote files and directories can be specified, but the last "
27977 "parameter must always be a local directory. To download to the current "
27978 "directory, use C<.> as in:"
27982 #: ../fish/guestfish-commands.pod:44
27985 " copy-out /home .\n"
27990 #: ../fish/guestfish-commands.pod:46
27992 "Wildcards cannot be used in the ordinary command, but you can use them with "
27993 "the help of L</glob> like this:"
27997 #: ../fish/guestfish-commands.pod:49
28000 " glob copy-out /home/* .\n"
28005 #: ../fish/guestfish-commands.pod:51
28010 #: ../fish/guestfish-commands.pod:53
28013 " echo [params ...]\n"
28018 #: ../fish/guestfish-commands.pod:55
28019 msgid "This echos the parameters to the terminal."
28023 #: ../fish/guestfish-commands.pod:57
28028 #: ../fish/guestfish-commands.pod:59
28033 #: ../fish/guestfish-commands.pod:61
28038 #: ../fish/guestfish-commands.pod:63
28046 #: ../fish/guestfish-commands.pod:65
28048 "This is used to edit a file. It downloads the file, edits it locally using "
28049 "your editor, then uploads the result."
28053 #: ../fish/guestfish-commands.pod:68
28055 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28056 "or C<emacs> you will get those corresponding editors."
28060 #: ../fish/guestfish-commands.pod:72
28065 #: ../fish/guestfish-commands.pod:74
28068 " glob command args...\n"
28073 #: ../fish/guestfish-commands.pod:76
28075 "Expand wildcards in any paths in the args list, and run C<command> "
28076 "repeatedly on each matching path."
28080 #: ../fish/guestfish-commands.pod:79
28081 msgid "See L</WILDCARDS AND GLOBBING>."
28085 #: ../fish/guestfish-commands.pod:81
28090 #: ../fish/guestfish-commands.pod:83
28093 " hexedit <filename|device>\n"
28094 " hexedit <filename|device> <max>\n"
28095 " hexedit <filename|device> <start> <max>\n"
28100 #: ../fish/guestfish-commands.pod:87
28102 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28107 #: ../fish/guestfish-commands.pod:90
28109 "This command works by downloading potentially the whole file or device, "
28110 "editing it locally, then uploading it. If the file or device is large, you "
28111 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28112 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28113 "usual modifiers allowed such as C<1M> (1 megabyte)."
28117 #: ../fish/guestfish-commands.pod:97
28118 msgid "For example to edit the first few sectors of a disk you might do:"
28122 #: ../fish/guestfish-commands.pod:100
28125 " hexedit /dev/sda 1M\n"
28130 #: ../fish/guestfish-commands.pod:102
28132 "which would allow you to edit anywhere within the first megabyte of the disk."
28136 #: ../fish/guestfish-commands.pod:105
28137 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28141 #: ../fish/guestfish-commands.pod:107
28144 " hexedit /dev/sda1 0x400 0x400\n"
28149 #: ../fish/guestfish-commands.pod:109
28150 msgid "(assuming the superblock is in the standard location)."
28154 #: ../fish/guestfish-commands.pod:111
28156 "This command requires the external L<hexedit(1)> program. You can specify "
28157 "another program to use by setting the C<HEXEDITOR> environment variable."
28161 #: ../fish/guestfish-commands.pod:115
28162 msgid "See also L</hexdump>."
28166 #: ../fish/guestfish-commands.pod:117
28171 #: ../fish/guestfish-commands.pod:119
28179 #: ../fish/guestfish-commands.pod:121
28181 "Change the local directory, ie. the current directory of guestfish itself."
28185 #: ../fish/guestfish-commands.pod:124
28186 msgid "Note that C<!cd> won't do what you might expect."
28190 #: ../fish/guestfish-commands.pod:126
28195 #: ../fish/guestfish-commands.pod:128
28200 #: ../fish/guestfish-commands.pod:130
28208 #: ../fish/guestfish-commands.pod:132
28209 msgid "Opens the manual page for guestfish."
28213 #: ../fish/guestfish-commands.pod:134
28218 #: ../fish/guestfish-commands.pod:136
28223 #: ../fish/guestfish-commands.pod:138
28231 #: ../fish/guestfish-commands.pod:140
28239 #: ../fish/guestfish-commands.pod:142
28240 msgid "This is used to view a file."
28244 #: ../fish/guestfish-commands.pod:144
28246 "The default viewer is C<$PAGER>. However if you use the alternate command "
28247 "C<less> you will get the C<less> command specifically."
28251 #: ../fish/guestfish-commands.pod:147
28256 #: ../fish/guestfish-commands.pod:149
28264 #: ../fish/guestfish-commands.pod:151
28266 "Close and reopen the libguestfs handle. It is not necessary to use this "
28267 "normally, because the handle is closed properly when guestfish exits. "
28268 "However this is occasionally useful for testing."
28272 #: ../fish/guestfish-commands.pod:155
28277 #: ../fish/guestfish-commands.pod:157
28280 " sparse filename size\n"
28285 #: ../fish/guestfish-commands.pod:159
28287 "This creates an empty sparse file of the given size, and then adds so it can "
28288 "be further examined."
28292 #: ../fish/guestfish-commands.pod:162
28294 "In all respects it works the same as the L</alloc> command, except that the "
28295 "image file is allocated sparsely, which means that disk blocks are not "
28296 "assigned to the file until they are needed. Sparse disk files only use "
28297 "space when written to, but they are slower and there is a danger you could "
28298 "run out of real disk space during a write operation."
28302 #: ../fish/guestfish-commands.pod:172
28307 #: ../fish/guestfish-commands.pod:174
28315 #: ../fish/guestfish-commands.pod:176
28317 "This command returns a list of the optional groups known to the daemon, and "
28318 "indicates which ones are supported by this build of the libguestfs appliance."
28322 #: ../fish/guestfish-commands.pod:180
28323 msgid "See also L<guestfs(3)/AVAILABILITY>."
28327 #: ../fish/guestfish-commands.pod:182
28332 #: ../fish/guestfish-commands.pod:184
28335 " time command args...\n"
28340 #: ../fish/guestfish-commands.pod:186
28342 "Run the command as usual, but print the elapsed time afterwards. This can "
28343 "be useful for benchmarking operations."
28347 #: ../test-tool/libguestfs-test-tool.pod:5
28348 msgid "libguestfs-test-tool - End user tests for libguestfs"
28352 #: ../test-tool/libguestfs-test-tool.pod:9
28355 " libguestfs-test-tool [--options]\n"
28360 #: ../test-tool/libguestfs-test-tool.pod:13
28362 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28363 "and developers, to allow them to check basic libguestfs functionality is "
28364 "working. This is needed because libguestfs occasionally breaks for reasons "
28365 "beyond our control: usually because of changes in the underlying qemu or "
28366 "kernel packages, or the host environment."
28370 #: ../test-tool/libguestfs-test-tool.pod:20
28371 msgid "If you suspect a problem in libguestfs, then just run:"
28375 #: ../test-tool/libguestfs-test-tool.pod:22
28378 " libguestfs-test-tool\n"
28383 #: ../test-tool/libguestfs-test-tool.pod:24
28384 msgid "It will print lots of diagnostic messages."
28388 #: ../test-tool/libguestfs-test-tool.pod:26
28389 msgid "If it runs to completion successfully, you will see this near the end:"
28393 #: ../test-tool/libguestfs-test-tool.pod:28
28396 " ===== TEST FINISHED OK =====\n"
28401 #: ../test-tool/libguestfs-test-tool.pod:30
28402 msgid "and the test tool will exit with code 0."
28406 #: ../test-tool/libguestfs-test-tool.pod:32
28408 "If it fails (and/or exits with non-zero error code), please paste the "
28409 "B<complete, unedited> output of the test tool into a bug report. More "
28410 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28415 #: ../test-tool/libguestfs-test-tool.pod:41
28420 #: ../test-tool/libguestfs-test-tool.pod:43
28421 msgid "Display short usage information and exit."
28425 #: ../test-tool/libguestfs-test-tool.pod:45
28426 msgid "I<--qemu qemu_binary>"
28430 #: ../test-tool/libguestfs-test-tool.pod:47
28432 "If you have downloaded another qemu binary, point this option at the full "
28433 "path of the binary to try it."
28437 #: ../test-tool/libguestfs-test-tool.pod:50
28438 msgid "I<--qemudir qemu_source_dir>"
28442 #: ../test-tool/libguestfs-test-tool.pod:52
28444 "If you have compiled qemu from source, point this option at the source "
28445 "directory to try it."
28449 #: ../test-tool/libguestfs-test-tool.pod:55
28450 msgid "I<--timeout N>"
28454 #: ../test-tool/libguestfs-test-tool.pod:57
28456 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28457 "does not usually need to be adjusted unless your machine is very slow."
28461 #: ../test-tool/libguestfs-test-tool.pod:63
28462 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28466 #: ../test-tool/libguestfs-test-tool.pod:65
28468 "If you have compiled another version of qemu from source and would like to "
28469 "try that, then you can use the I<--qemudir> option to point to the qemu "
28470 "source directory."
28474 #: ../test-tool/libguestfs-test-tool.pod:69
28476 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28477 "option to point to the binary."
28481 #: ../test-tool/libguestfs-test-tool.pod:72
28483 "When using an alternate qemu with libguestfs, usually you would need to "
28484 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28485 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28486 "use either of the I<--qemudir> or I<--qemu> options."
28490 #: ../test-tool/libguestfs-test-tool.pod:79
28492 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28493 "I<1> if there was an error."
28497 #: ../test-tool/libguestfs-test-tool.pod:84
28499 "For the full list of environment variables which may affect libguestfs, "
28500 "please see the L<guestfs(3)> manual page."
28504 #: ../test-tool/libguestfs-test-tool.pod:89
28505 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28509 #: ../fuse/guestmount.pod:5
28511 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28515 #: ../fuse/guestmount.pod:9
28518 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28523 #: ../fuse/guestmount.pod:11
28526 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28531 #: ../fuse/guestmount.pod:13
28534 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28539 #: ../fuse/guestmount.pod:17
28541 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28542 "machines. If you do this, you risk disk corruption in the VM."
28546 #: ../fuse/guestmount.pod:22
28548 "The guestmount program can be used to mount virtual machine filesystems and "
28549 "other disk images on the host. It uses libguestfs for access to the guest "
28550 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28551 "a mountable device."
28555 #: ../fuse/guestmount.pod:27
28557 "Along with other options, you have to give at least one device (I<-a> "
28558 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28559 "option) or use the I<-i> inspection option. How this works is better "
28560 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28565 #: ../fuse/guestmount.pod:33
28567 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28568 "by you, and the filesystem will not be visible to any other users unless you "
28569 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28570 "the filesystem, use the C<fusermount -u> command."
28574 #: ../fuse/guestmount.pod:41
28576 "For a typical Windows guest which has its main filesystem on the first "
28581 #: ../fuse/guestmount.pod:44
28584 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28589 #: ../fuse/guestmount.pod:46
28591 "For a typical Linux guest which has a /boot filesystem on the first "
28592 "partition, and the root filesystem on a logical volume:"
28596 #: ../fuse/guestmount.pod:49
28599 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28604 #: ../fuse/guestmount.pod:51
28605 msgid "To get libguestfs to detect guest mountpoints for you:"
28609 #: ../fuse/guestmount.pod:53
28612 " guestmount -a guest.img -i --ro /mnt\n"
28617 #: ../fuse/guestmount.pod:55
28618 msgid "For a libvirt guest called \"Guest\" you could do:"
28622 #: ../fuse/guestmount.pod:57
28625 " guestmount -d Guest -i --ro /mnt\n"
28630 #: ../fuse/guestmount.pod:59
28632 "If you don't know what filesystems are contained in a guest or disk image, "
28633 "use L<virt-filesystems(1)> first:"
28637 #: ../fuse/guestmount.pod:62
28640 " virt-filesystems MyGuest\n"
28645 #: ../fuse/guestmount.pod:64
28647 "If you want to trace the libguestfs calls but without excessive debugging "
28648 "information, we recommend:"
28652 #: ../fuse/guestmount.pod:67
28655 " guestmount [...] --trace /mnt\n"
28660 #: ../fuse/guestmount.pod:69
28661 msgid "If you want to debug the program, we recommend:"
28665 #: ../fuse/guestmount.pod:71
28668 " guestmount [...] --trace --verbose /mnt\n"
28673 #: ../fuse/guestmount.pod:77
28674 msgid "B<-a image> | B<--add image>"
28678 #: ../fuse/guestmount.pod:79
28679 msgid "Add a block device or virtual machine image."
28683 #: ../fuse/guestmount.pod:84
28684 msgid "B<-c URI> | B<--connect URI>"
28688 #: ../fuse/guestmount.pod:90
28689 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28693 #: ../fuse/guestmount.pod:98
28694 msgid "B<--dir-cache-timeout N>"
28698 #: ../fuse/guestmount.pod:100
28700 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28701 "seconds. The readdir cache [actually, there are several semi-independent "
28702 "caches] is populated after a readdir(2) call with the stat and extended "
28703 "attributes of the files in the directory, in anticipation that they will be "
28704 "requested soon after."
28708 #: ../fuse/guestmount.pod:106
28710 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28711 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28712 "requests, only cache existing ones."
28716 #: ../fuse/guestmount.pod:117
28717 msgid "B<--format=raw|qcow2|..> | B<--format>"
28721 #: ../fuse/guestmount.pod:124
28723 "If you have untrusted raw-format guest disk images, you should use this "
28724 "option to specify the disk format. This avoids a possible security problem "
28725 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28726 "guestfs_add_drive_opts>."
28730 #: ../fuse/guestmount.pod:129
28731 msgid "B<--fuse-help>"
28735 #: ../fuse/guestmount.pod:131
28736 msgid "Display help on special FUSE options (see I<-o> below)."
28740 #: ../fuse/guestmount.pod:135
28741 msgid "Display brief help and exit."
28745 #: ../fuse/guestmount.pod:137
28746 msgid "B<-i> | B<--inspector>"
28750 #: ../fuse/guestmount.pod:157
28752 "Mount the named partition or logical volume on the given mountpoint B<in the "
28753 "guest> (this has nothing to do with mountpoints in the host)."
28757 #: ../fuse/guestmount.pod:160
28759 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28760 "something on C</>."
28764 #: ../fuse/guestmount.pod:173
28765 msgid "B<-n> | B<--no-sync>"
28769 #: ../fuse/guestmount.pod:175
28771 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28772 "unmounted. If you specify this option, then we don't attempt to sync the "
28773 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28777 #: ../fuse/guestmount.pod:180
28778 msgid "B<-o option> | B<--option option>"
28782 #: ../fuse/guestmount.pod:182
28783 msgid "Pass extra options to FUSE."
28787 #: ../fuse/guestmount.pod:184
28789 "To get a list of all the extra options supported by FUSE, use the command "
28790 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28791 "of them are a good idea."
28795 #: ../fuse/guestmount.pod:188
28798 " guestmount --fuse-help\n"
28803 #: ../fuse/guestmount.pod:190
28804 msgid "Some potentially useful FUSE options:"
28808 #: ../fuse/guestmount.pod:194
28809 msgid "B<-o allow_other>"
28813 #: ../fuse/guestmount.pod:196
28814 msgid "Allow other users to see the filesystem."
28818 #: ../fuse/guestmount.pod:198
28819 msgid "B<-o attr_timeout=N>"
28823 #: ../fuse/guestmount.pod:200
28824 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28828 #: ../fuse/guestmount.pod:202
28829 msgid "B<-o kernel_cache>"
28833 #: ../fuse/guestmount.pod:204
28835 "Allow the kernel to cache files (reduces the number of reads that have to go "
28836 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28837 "afford the extra memory usage."
28841 #: ../fuse/guestmount.pod:208
28842 msgid "B<-o uid=N> B<-o gid=N>"
28846 #: ../fuse/guestmount.pod:210
28848 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28849 "the chosen values."
28853 #: ../fuse/guestmount.pod:215
28854 msgid "B<-r> | B<--ro>"
28858 #: ../fuse/guestmount.pod:217
28860 "Add devices and mount everything read-only. Also disallow writes and make "
28861 "the disk appear read-only to FUSE."
28865 #: ../fuse/guestmount.pod:220
28867 "This is highly recommended if you are not going to edit the guest disk. If "
28868 "the guest is running and this option is I<not> supplied, then there is a "
28869 "strong risk of disk corruption in the guest. We try to prevent this from "
28870 "happening, but it is not always possible."
28874 #: ../fuse/guestmount.pod:225
28875 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28879 #: ../fuse/guestmount.pod:229
28880 msgid "Enable SELinux support for the guest."
28884 #: ../fuse/guestmount.pod:231
28885 msgid "B<-v> | B<--verbose>"
28889 #: ../fuse/guestmount.pod:233
28890 msgid "Enable verbose messages from underlying libguestfs."
28894 #: ../fuse/guestmount.pod:235
28895 msgid "B<-V> | B<--version>"
28899 #: ../fuse/guestmount.pod:237
28900 msgid "Display the program version and exit."
28904 #: ../fuse/guestmount.pod:239
28905 msgid "B<-w> | B<--rw>"
28909 #: ../fuse/guestmount.pod:244 ../fuse/guestmount.pod:265
28910 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28914 #: ../fuse/guestmount.pod:246
28915 msgid "B<-x> | B<--trace>"
28919 #: ../fuse/guestmount.pod:248
28920 msgid "Trace libguestfs calls and entry into each FUSE function."
28924 #: ../fuse/guestmount.pod:250
28925 msgid "This also stops the daemon from forking into the background."
28929 #: ../fuse/guestmount.pod:271
28931 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28932 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28937 #: ../fuse/guestmount.pod:286
28938 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28942 #: ../tools/virt-edit.pl:34
28943 msgid "virt-edit - Edit a file in a virtual machine"
28947 #: ../tools/virt-edit.pl:38
28950 " virt-edit [--options] domname file\n"
28955 #: ../tools/virt-edit.pl:40
28958 " virt-edit [--options] disk.img [disk.img ...] file\n"
28963 #: ../tools/virt-edit.pl:42
28966 " virt-edit [domname|disk.img] file -e 'expr'\n"
28971 #: ../tools/virt-edit.pl:46
28973 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28974 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28975 "doing this, but doesn't catch all cases."
28979 #: ../tools/virt-edit.pl:52
28981 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28982 "the named virtual machine (or disk image)."
28986 #: ../tools/virt-edit.pl:55
28987 msgid "If you want to just view a file, use L<virt-cat(1)>."
28991 #: ../tools/virt-edit.pl:57
28993 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
28994 "USING GUESTFISH> below)."
28998 #: ../tools/virt-edit.pl:60
29000 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
29001 "files. L<guestfish(1)> can do that and much more."
29005 #: ../tools/virt-edit.pl:65
29006 msgid "Edit the named files interactively:"
29010 #: ../tools/virt-edit.pl:67
29013 " virt-edit mydomain /boot/grub/grub.conf\n"
29018 #: ../tools/virt-edit.pl:69
29021 " virt-edit mydomain /etc/passwd\n"
29026 #: ../tools/virt-edit.pl:71
29027 msgid "For Windows guests, some Windows paths are understood:"
29031 #: ../tools/virt-edit.pl:73
29034 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
29039 #: ../tools/virt-edit.pl:75
29041 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
29042 "below). To change the init default level to 5:"
29046 #: ../tools/virt-edit.pl:79
29049 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
29054 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
29055 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
29056 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29057 msgid "Display brief help."
29061 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
29062 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
29063 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29064 msgid "Display version number and exit."
29068 #: ../tools/virt-edit.pl:105
29069 msgid "B<--backup extension> | B<-b extension>"
29073 #: ../tools/virt-edit.pl:107
29075 "Create a backup of the original file I<in the guest disk image>. The backup "
29076 "has the original filename with C<extension> added."
29080 #: ../tools/virt-edit.pl:110
29082 "Usually the first character of C<extension> would be a dot C<.> so you would "
29087 #: ../tools/virt-edit.pl:113
29090 " virt-edit -b .orig [etc]\n"
29095 #: ../tools/virt-edit.pl:115
29096 msgid "By default, no backup file is made."
29100 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
29101 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
29102 #: ../tools/virt-list-partitions.pl:78
29103 msgid "B<--connect URI> | B<-c URI>"
29107 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
29108 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
29109 #: ../tools/virt-list-partitions.pl:80
29111 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29112 "to the default libvirt hypervisor."
29116 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
29117 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
29118 #: ../tools/virt-list-partitions.pl:83
29120 "If you specify guest block devices directly, then libvirt is not used at all."
29124 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
29125 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
29126 #: ../tools/virt-list-partitions.pl:90
29127 msgid "B<--format> raw"
29131 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
29132 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
29133 #: ../tools/virt-list-partitions.pl:92
29135 "Specify the format of disk images given on the command line. If this is "
29136 "omitted then the format is autodetected from the content of the disk image."
29140 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
29141 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
29142 #: ../tools/virt-list-partitions.pl:96
29144 "If disk images are requested from libvirt, then this program asks libvirt "
29145 "for this information. In this case, the value of the format parameter is "
29150 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
29151 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
29152 #: ../tools/virt-list-partitions.pl:100
29154 "If working with untrusted raw-format guest disk images, you should ensure "
29155 "the format is always specified."
29159 #: ../tools/virt-edit.pl:150
29160 msgid "B<--expr EXPR> | B<-e EXPR>"
29164 #: ../tools/virt-edit.pl:152
29166 "Instead of launching the external editor, non-interactively apply the Perl "
29167 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29172 #: ../tools/virt-edit.pl:156
29174 "Be careful to properly quote the expression to prevent it from being altered "
29179 #: ../tools/virt-edit.pl:280
29180 msgid "NON-INTERACTIVE EDITING"
29184 #: ../tools/virt-edit.pl:282
29186 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29187 "administrator can interactively edit the file."
29191 #: ../tools/virt-edit.pl:285
29193 "There are two ways also to use C<virt-edit> from scripts in order to make "
29194 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29195 "like this, it's less error-prone to write scripts directly using the "
29196 "libguestfs API and Augeas for configuration file editing.)"
29200 #: ../tools/virt-edit.pl:291
29202 "The first method is to temporarily set C<$EDITOR> to any script or program "
29203 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29204 "update C<tmpfile> in place however it likes."
29208 #: ../tools/virt-edit.pl:295
29210 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
29211 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29212 "instances of C<foo> with C<bar> in a file:"
29216 #: ../tools/virt-edit.pl:299
29219 " virt-edit domname filename -e 's/foo/bar/'\n"
29224 #: ../tools/virt-edit.pl:301
29226 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29227 "For example to delete root's password you could do:"
29231 #: ../tools/virt-edit.pl:304
29234 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29239 #: ../tools/virt-edit.pl:306
29241 "What really happens is that the snippet is evaluated as a Perl expression "
29242 "for each line of the file. The line, including the final C<\\n>, is passed "
29243 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29247 #: ../tools/virt-edit.pl:311
29249 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29250 "C<apache> user account from the password file you can do:"
29254 #: ../tools/virt-edit.pl:314
29257 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29262 #: ../tools/virt-edit.pl:316
29264 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29265 "the end of the file is rather difficult this way since there is no concept "
29266 "of \"last line of the file\" - your expression just doesn't get called "
29267 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29272 #: ../tools/virt-edit.pl:322
29274 "The variable C<$lineno> contains the current line number. As is "
29275 "traditional, the first line in the file is number C<1>."
29279 #: ../tools/virt-edit.pl:325
29281 "The return value from the expression is ignored, but the expression may call "
29282 "C<die> in order to abort the whole program, leaving the original file "
29287 #: ../tools/virt-edit.pl:329
29289 "Remember when matching the end of a line that C<$_> may contain the final C<"
29290 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29291 "newline then neither of these. Thus to match or substitute some text at the "
29292 "end of a line, use this regular expression:"
29296 #: ../tools/virt-edit.pl:334
29299 " /some text(\\r?\\n)?$/\n"
29304 #: ../tools/virt-edit.pl:336
29306 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29307 "$_> itself (since that would remove all newlines from the file):"
29311 #: ../tools/virt-edit.pl:340
29314 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29319 #: ../tools/virt-edit.pl:344
29321 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29322 "paths (eg. C<E:\\foo\\bar.txt>)."
29326 #: ../tools/virt-edit.pl:347
29327 msgid "If and only if the guest is running Windows then:"
29331 #: ../tools/virt-edit.pl:353
29333 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29334 "to the correct filesystem."
29338 #: ../tools/virt-edit.pl:358
29340 "Any backslash (C<\\>) characters in the path are replaced with forward "
29341 "slashes so that libguestfs can process it."
29345 #: ../tools/virt-edit.pl:363
29347 "The path is resolved case insensitively to locate the file that should be "
29352 #: ../tools/virt-edit.pl:368
29353 msgid "There are some known shortcomings:"
29357 #: ../tools/virt-edit.pl:374
29358 msgid "Some NTFS symbolic links may not be followed correctly."
29362 #: ../tools/virt-edit.pl:378
29363 msgid "NTFS junction points that cross filesystems are not followed."
29367 #: ../tools/virt-edit.pl:435
29368 msgid "USING GUESTFISH"
29372 #: ../tools/virt-edit.pl:437
29374 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29375 "C<virt-edit> doesn't work."
29379 #: ../tools/virt-edit.pl:440
29380 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29384 #: ../tools/virt-edit.pl:442
29387 " guestfish --rw -i -d domname edit /file\n"
29392 #: ../tools/virt-edit.pl:444
29394 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29395 "path to the file."
29399 #: ../tools/virt-edit.pl:447
29401 "The command above uses libguestfs's guest inspection feature and so does not "
29402 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29403 "disk images that don't contain guests. To edit a file on a disk image "
29408 #: ../tools/virt-edit.pl:452
29411 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29416 #: ../tools/virt-edit.pl:454
29418 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29419 "the disk image to edit, and C</file> is the full path to the file."
29423 #: ../tools/virt-edit.pl:458
29425 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29426 "C<write> or C<upload> instead:"
29430 #: ../tools/virt-edit.pl:461
29433 " guestfish --rw -i -d domname touch /newfile\n"
29438 #: ../tools/virt-edit.pl:463
29441 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29446 #: ../tools/virt-edit.pl:465
29449 " guestfish --rw -i -d domname upload localfile /newfile\n"
29454 #: ../tools/virt-edit.pl:467
29456 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29460 #: ../tools/virt-edit.pl:470
29463 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29468 #: ../tools/virt-edit.pl:480
29473 #: ../tools/virt-edit.pl:482
29475 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29480 #: ../tools/virt-edit.pl:485
29481 msgid "If not set, C<vi> is used."
29485 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29486 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29487 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29488 msgid "SHELL QUOTING"
29492 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29493 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29494 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29496 "Libvirt guest names can contain arbitrary characters, some of which have "
29497 "meaning to the shell such as C<#> and space. You may need to quote or "
29498 "escape these characters on the command line. See the shell manual page L<sh"
29499 "(1)> for details."
29503 #: ../tools/virt-edit.pl:498
29505 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29506 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29507 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29511 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29512 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29513 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29518 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29519 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29520 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29521 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29525 #: ../tools/virt-edit.pl:516
29526 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29530 #: ../tools/virt-win-reg.pl:37
29532 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29536 #: ../tools/virt-win-reg.pl:41
29539 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29544 #: ../tools/virt-win-reg.pl:43
29547 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29552 #: ../tools/virt-win-reg.pl:45
29555 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29560 #: ../tools/virt-win-reg.pl:47
29563 " virt-win-reg --merge domname [input.reg ...]\n"
29568 #: ../tools/virt-win-reg.pl:49
29571 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29576 #: ../tools/virt-win-reg.pl:53
29578 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29579 "virtual machines. If you do this, you I<will> get irreversible disk "
29580 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29581 "but doesn't catch all cases."
29585 #: ../tools/virt-win-reg.pl:58
29587 "Modifying the Windows Registry is an inherently risky operation. The format "
29588 "is deliberately obscure and undocumented, and Registry changes can leave the "
29589 "system unbootable. Therefore when using the I<--merge> option, make sure "
29590 "you have a reliable backup first."
29594 #: ../tools/virt-win-reg.pl:65
29596 "This program can export and merge Windows Registry entries from a Windows "
29601 #: ../tools/virt-win-reg.pl:68
29603 "The first parameter is the libvirt guest name or the raw disk image of a "
29608 #: ../tools/virt-win-reg.pl:71
29610 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29611 "exported (recursively). For example:"
29615 #: ../tools/virt-win-reg.pl:74
29618 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29623 #: ../tools/virt-win-reg.pl:76
29625 "You can also display single values from within registry keys, for example:"
29629 #: ../tools/virt-win-reg.pl:79
29632 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29633 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29634 " Windows 7 Enterprise\n"
29639 #: ../tools/virt-win-reg.pl:83
29641 "With I<--merge>, you can merge a textual regedit file into the Windows "
29646 #: ../tools/virt-win-reg.pl:86
29649 " $ virt-win-reg --merge Windows7 changes.reg\n"
29654 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29659 #: ../tools/virt-win-reg.pl:90
29661 "This program is only meant for simple access to the registry. If you want "
29662 "to do complicated things with the registry, we suggest you download the "
29663 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29664 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29665 "L<hivexregedit(1)>."
29669 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29674 #: ../tools/virt-win-reg.pl:122
29675 msgid "Enable debugging messages."
29679 #: ../tools/virt-win-reg.pl:157
29684 #: ../tools/virt-win-reg.pl:159
29686 "In merge mode, this merges a textual regedit file into the Windows Registry "
29687 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29688 "displays or exports Registry entries instead."
29692 #: ../tools/virt-win-reg.pl:163
29694 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29695 "result in disk corruption. However exporting (without this flag) is always "
29700 #: ../tools/virt-win-reg.pl:171
29701 msgid "B<--encoding> UTF-16LE|ASCII"
29705 #: ../tools/virt-win-reg.pl:173
29707 "When merging (only), you may need to specify the encoding for strings to be "
29708 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29709 "(3)/ENCODING STRINGS>."
29713 #: ../tools/virt-win-reg.pl:177
29715 "The default is to use UTF-16LE, which should work with recent versions of "
29720 #: ../tools/virt-win-reg.pl:402
29721 msgid "SUPPORTED SYSTEMS"
29725 #: ../tools/virt-win-reg.pl:404
29727 "The program currently supports Windows NT-derived guests starting with "
29728 "Windows XP through to at least Windows 7."
29732 #: ../tools/virt-win-reg.pl:407
29734 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29735 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29736 "and C<HKEY_USERS\\.DEFAULT>."
29740 #: ../tools/virt-win-reg.pl:411
29742 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29747 #: ../tools/virt-win-reg.pl:414
29749 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29754 #: ../tools/virt-win-reg.pl:417
29759 #: ../tools/virt-win-reg.pl:419
29761 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29762 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29763 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29764 "Windows-style line endings, you may need to reencode the whole file before "
29765 "or after processing."
29769 #: ../tools/virt-win-reg.pl:425
29771 "To reencode a file from Windows format to Linux (before processing it with "
29772 "the I<--merge> option), you would do something like this:"
29776 #: ../tools/virt-win-reg.pl:428
29779 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29784 #: ../tools/virt-win-reg.pl:430
29786 "To go in the opposite direction, after exporting and before sending the file "
29787 "to a Windows user, do something like this:"
29791 #: ../tools/virt-win-reg.pl:433
29794 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29799 #: ../tools/virt-win-reg.pl:435
29800 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29804 #: ../tools/virt-win-reg.pl:437
29806 "If you are unsure about the current encoding, use the L<file(1)> command. "
29807 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29808 "style (CRLF) line endings, like this:"
29812 #: ../tools/virt-win-reg.pl:441
29815 " $ file software.reg\n"
29816 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29817 " with CRLF line terminators\n"
29822 #: ../tools/virt-win-reg.pl:445
29823 msgid "This file would need conversion before you could I<--merge> it."
29827 #: ../tools/virt-win-reg.pl:447
29828 msgid "CurrentControlSet etc."
29832 #: ../tools/virt-win-reg.pl:449
29834 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29835 "Registry at the level of the hive file, and therefore you cannot modify "
29840 #: ../tools/virt-win-reg.pl:453
29842 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29843 "circumstances it might refer to another control set. The way to find out is "
29844 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29848 #: ../tools/virt-win-reg.pl:457
29851 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29852 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29853 " \"Current\"=dword:00000001\n"
29854 " \"Default\"=dword:00000001\n"
29855 " \"Failed\"=dword:00000000\n"
29856 " \"LastKnownGood\"=dword:00000002\n"
29861 #: ../tools/virt-win-reg.pl:464
29862 msgid "\"Current\" is the one which Windows will choose when it boots."
29866 #: ../tools/virt-win-reg.pl:466
29868 "Similarly, other C<Current...> keys in the path may need to be replaced."
29872 #: ../tools/virt-win-reg.pl:469
29873 msgid "WINDOWS TIPS"
29877 #: ../tools/virt-win-reg.pl:471
29879 "Note that some of these tips modify the guest disk image. The guest I<must> "
29880 "be shut off, else you will get disk corruption."
29884 #: ../tools/virt-win-reg.pl:474
29885 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29889 #: ../tools/virt-win-reg.pl:476
29891 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29892 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29893 "is uploaded into C<C:\\>:"
29897 #: ../tools/virt-win-reg.pl:480
29900 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29905 #: ../tools/virt-win-reg.pl:482
29906 msgid "Prepare a regedit file containing the registry change:"
29910 #: ../tools/virt-win-reg.pl:484
29913 " cat > test.reg <<'EOF'\n"
29914 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29915 " \"Test\"=\"c:\\\\test.bat\"\n"
29921 #: ../tools/virt-win-reg.pl:489
29923 "In this example we use the key C<RunOnce> which means that the script will "
29924 "run precisely once when the first user logs in. If you want it to run every "
29925 "time a user logs in, replace C<RunOnce> with C<Run>."
29929 #: ../tools/virt-win-reg.pl:493
29930 msgid "Now update the registry:"
29934 #: ../tools/virt-win-reg.pl:495
29937 " virt-win-reg --merge WindowsGuest test.reg\n"
29942 #: ../tools/virt-win-reg.pl:497
29943 msgid "INSTALLING A SERVICE"
29947 #: ../tools/virt-win-reg.pl:499
29949 "This section assumes you are familiar with Windows services, and you either "
29950 "have a program which handles the Windows Service Control Protocol directly "
29951 "or you want to run any program using a service wrapper like SrvAny or the "
29956 #: ../tools/virt-win-reg.pl:504
29958 "First upload the program and optionally the service wrapper. In this case "
29959 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29963 #: ../tools/virt-win-reg.pl:508
29966 " guestfish -i -d WindowsGuest <<EOF\n"
29967 " upload rhsrvany.exe /rhsrvany.exe\n"
29968 " upload test.exe /test.exe\n"
29974 #: ../tools/virt-win-reg.pl:513
29976 "Prepare a regedit file containing the registry changes. In this example, "
29977 "the first registry change is needed for the service itself or the service "
29978 "wrapper (if used). The second registry change is only needed because I am "
29979 "using the RHSrvAny service wrapper."
29983 #: ../tools/virt-win-reg.pl:518
29986 " cat > service.reg <<'EOF'\n"
29987 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29988 " \"Type\"=dword:00000010\n"
29989 " \"Start\"=dword:00000002\n"
29990 " \"ErrorControl\"=dword:00000001\n"
29991 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29992 " \"DisplayName\"=\"RHSrvAny\"\n"
29993 " \"ObjectName\"=\"NetworkService\"\n"
29998 #: ../tools/virt-win-reg.pl:527
30001 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30002 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30003 " \"PWD\"=\"c:\\\\Temp\"\n"
30009 #: ../tools/virt-win-reg.pl:538
30011 "For use of C<ControlSet001> see the section above in this manual page. You "
30012 "may need to adjust this according to the control set that is in use by the "
30017 #: ../tools/virt-win-reg.pl:544
30019 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30020 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30021 "privileged account."
30025 #: ../tools/virt-win-reg.pl:550
30027 "For the meaning of the magic numbers, see this Microsoft KB article: "
30028 "L<http://support.microsoft.com/kb/103000>."
30032 #: ../tools/virt-win-reg.pl:555
30033 msgid "Update the registry:"
30037 #: ../tools/virt-win-reg.pl:557
30040 " virt-win-reg --merge WindowsGuest service.reg\n"
30045 #: ../tools/virt-win-reg.pl:561
30047 "Be careful when passing parameters containing C<\\> (backslash) in the "
30048 "shell. Usually you will have to use 'single quotes' or double backslashes "
30049 "(but not both) to protect them from the shell."
30053 #: ../tools/virt-win-reg.pl:565
30054 msgid "Paths and value names are case-insensitive."
30058 #: ../tools/virt-win-reg.pl:574
30060 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30061 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30062 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30066 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
30068 "When reporting bugs, please enable debugging and capture the I<complete> "
30073 #: ../tools/virt-win-reg.pl:592
30076 " export LIBGUESTFS_DEBUG=1\n"
30077 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30082 #: ../tools/virt-win-reg.pl:595
30084 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30089 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
30090 msgid "Copyright (C) 2010 Red Hat Inc."
30094 #: ../tools/virt-list-filesystems.pl:32
30096 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30100 #: ../tools/virt-list-filesystems.pl:36
30103 " virt-list-filesystems [--options] domname\n"
30108 #: ../tools/virt-list-filesystems.pl:38
30111 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30116 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30118 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30123 #: ../tools/virt-list-filesystems.pl:45
30125 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30126 "are contained in a virtual machine or disk image."
30130 #: ../tools/virt-list-filesystems.pl:49
30132 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30133 "functionality. For more complex cases you should look at the L<guestfish(1)"
30138 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30139 msgid "B<-l> | B<--long>"
30143 #: ../tools/virt-list-filesystems.pl:108
30145 "With this option, C<virt-list-filesystems> displays the type of each "
30146 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30150 #: ../tools/virt-list-filesystems.pl:115
30151 msgid "B<-a> | B<--all>"
30155 #: ../tools/virt-list-filesystems.pl:117
30157 "Normally we only show mountable filesystems. If this option is given then "
30158 "swap devices are shown too."
30162 #: ../tools/virt-list-filesystems.pl:191
30164 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30165 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30166 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30170 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30171 msgid "Copyright (C) 2009 Red Hat Inc."
30175 #: ../tools/virt-tar.pl:33
30176 msgid "virt-tar - Extract or upload files to a virtual machine"
30180 #: ../tools/virt-tar.pl:37
30183 " virt-tar [--options] -x domname directory tarball\n"
30188 #: ../tools/virt-tar.pl:39
30191 " virt-tar [--options] -u domname tarball directory\n"
30196 #: ../tools/virt-tar.pl:41
30199 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30204 #: ../tools/virt-tar.pl:43
30207 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30212 #: ../tools/virt-tar.pl:47
30214 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30215 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30219 #: ../tools/virt-tar.pl:52
30220 msgid "Download C</home> from the VM into a local tarball:"
30224 #: ../tools/virt-tar.pl:54
30227 " virt-tar -x domname /home home.tar\n"
30232 #: ../tools/virt-tar.pl:56
30235 " virt-tar -zx domname /home home.tar.gz\n"
30240 #: ../tools/virt-tar.pl:58
30241 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30245 #: ../tools/virt-tar.pl:60
30248 " virt-tar -u domname uploadstuff.tar /tmp\n"
30253 #: ../tools/virt-tar.pl:62
30256 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30261 #: ../tools/virt-tar.pl:66
30263 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30264 "virtual machines. If you do this, you risk disk corruption in the VM. "
30265 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30269 #: ../tools/virt-tar.pl:71
30271 "You can use I<-x> (extract) on live virtual machines, but you might get "
30272 "inconsistent results or errors if there is filesystem activity inside the "
30273 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30274 "work, but the only way to guarantee consistent results is if the virtual "
30275 "machine is shut down."
30279 #: ../tools/virt-tar.pl:79
30281 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30282 "parts of a guest filesystem. There are many possibilities: making backups, "
30283 "uploading data files, snooping on guest activity, fixing or customizing "
30288 #: ../tools/virt-tar.pl:84
30290 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30291 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30292 "should look at the L<guestfish(1)> tool."
30296 #: ../tools/virt-tar.pl:88
30298 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30299 "its contents (recursively) from the virtual machine into a local tarball. "
30300 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30301 "virtual machine. You cannot use these two options together."
30305 #: ../tools/virt-tar.pl:94
30307 "In addition, you may need to use the I<-z> (gZip) option to enable "
30308 "compression. When uploading, you have to specify I<-z> if the upload file "
30309 "is compressed because virt-tar won't detect this on its own."
30313 #: ../tools/virt-tar.pl:98
30315 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30316 "example it cannot do PKZip files or bzip2 compression. If you want that "
30317 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30318 "the L<libguestfs(3)> API)."
30322 #: ../tools/virt-tar.pl:156
30323 msgid "B<-x> | B<--extract> | B<--download>"
30327 #: ../tools/virt-tar.pl:158
30328 msgid "B<-u> | B<--upload>"
30332 #: ../tools/virt-tar.pl:160
30334 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30339 #: ../tools/virt-tar.pl:163
30341 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30342 "Please read the L</WARNING> section above before using this option."
30346 #: ../tools/virt-tar.pl:167
30347 msgid "You must specify exactly one of these options."
30351 #: ../tools/virt-tar.pl:173
30352 msgid "B<-z> | B<--gzip>"
30356 #: ../tools/virt-tar.pl:175
30357 msgid "Specify that the input or output tarball is gzip-compressed."
30361 #: ../tools/virt-tar.pl:288
30363 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30364 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30365 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30370 #: ../tools/virt-make-fs.pl:37
30371 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30375 #: ../tools/virt-make-fs.pl:41
30378 " virt-make-fs [--options] input.tar output.img\n"
30383 #: ../tools/virt-make-fs.pl:43
30386 " virt-make-fs [--options] input.tar.gz output.img\n"
30391 #: ../tools/virt-make-fs.pl:45
30394 " virt-make-fs [--options] directory output.img\n"
30399 #: ../tools/virt-make-fs.pl:49
30401 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30402 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30403 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30404 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30405 "you want to attach these filesystems to existing virtual machines (eg. to "
30406 "import large amounts of read-only data to a VM)."
30410 #: ../tools/virt-make-fs.pl:57
30411 msgid "Basic usage is:"
30415 #: ../tools/virt-make-fs.pl:59
30418 " virt-make-fs input output\n"
30423 #: ../tools/virt-make-fs.pl:61
30425 "where C<input> is either a directory containing files that you want to add, "
30426 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30427 "C<output> is a disk image. The input type is detected automatically. The "
30428 "output disk image defaults to a raw ext2 image unless you specify extra "
30429 "flags (see L</OPTIONS> below)."
30433 #: ../tools/virt-make-fs.pl:67
30434 msgid "EXTRA SPACE"
30438 #: ../tools/virt-make-fs.pl:69
30440 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30441 "the files that it contains, but might have extra space. Depending on how "
30442 "you are going to use the output, you might think this extra space is wasted "
30443 "and want to minimize it, or you might want to leave space so that more files "
30444 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30445 "but you can use the I<--size> flag to leave space in the filesystem if you "
30450 #: ../tools/virt-make-fs.pl:77
30452 "An alternative way to leave extra space but not make the output image any "
30453 "bigger is to use an alternative disk image format (instead of the default "
30454 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30455 "image format (check your hypervisor supports this before using it). This "
30456 "allows you to choose a large I<--size> but the extra space won't actually be "
30457 "allocated in the image until you try to store something in it."
30461 #: ../tools/virt-make-fs.pl:85
30463 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30464 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30465 "to build another image from scratch."
30469 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30470 #: ../tools/virt-make-fs.pl:142
30475 #: ../tools/virt-make-fs.pl:91
30478 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30483 #: ../tools/virt-make-fs.pl:93
30484 msgid "FILESYSTEM TYPE"
30488 #: ../tools/virt-make-fs.pl:95
30490 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30491 "libguestfs supports can be used (but I<not> read-only formats like "
30492 "ISO9660). Here are some of the more common choices:"
30496 #: ../tools/virt-make-fs.pl:101
30501 #: ../tools/virt-make-fs.pl:103
30503 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30504 "you are not going to use the filesystem in a way that requires the journal, "
30505 "then this is just wasted overhead."
30509 #: ../tools/virt-make-fs.pl:107
30510 msgid "I<ntfs> or I<vfat>"
30514 #: ../tools/virt-make-fs.pl:109
30515 msgid "Useful if exporting data to a Windows guest."
30519 #: ../tools/virt-make-fs.pl:111
30521 "I<Note for vfat>: The tar archive or local directory must only contain files "
30522 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30523 "program running within libguestfs is unable to change the ownership of non-"
30524 "root files, since vfat itself does not support this."
30528 #: ../tools/virt-make-fs.pl:116
30533 #: ../tools/virt-make-fs.pl:118
30535 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30536 "total filesystem size."
30540 #: ../tools/virt-make-fs.pl:125
30543 " virt-make-fs --type=minix input minixfs.img\n"
30548 #: ../tools/virt-make-fs.pl:127
30549 msgid "TO PARTITION OR NOT TO PARTITION"
30553 #: ../tools/virt-make-fs.pl:129
30554 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30558 #: ../tools/virt-make-fs.pl:131
30560 "Adding a partition can make the disk image more compatible with certain "
30561 "virtualized operating systems which don't expect to see a filesystem "
30562 "directly located on a block device (Linux doesn't care and will happily "
30563 "handle both types)."
30567 #: ../tools/virt-make-fs.pl:136
30569 "On the other hand, if you have a partition table then the output image is no "
30570 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30571 "directly on a partitioned disk image. (However libguestfs tools such as "
30572 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30576 #: ../tools/virt-make-fs.pl:144
30577 msgid "Add an MBR partition:"
30581 #: ../tools/virt-make-fs.pl:146
30584 " virt-make-fs --partition -- input disk.img\n"
30589 #: ../tools/virt-make-fs.pl:148
30591 "If the output disk image could be terabyte-sized or larger, it's better to "
30592 "use an EFI/GPT-compatible partition table:"
30596 #: ../tools/virt-make-fs.pl:151
30599 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30604 #: ../tools/virt-make-fs.pl:179
30605 msgid "Enable debugging information."
30609 #: ../tools/virt-make-fs.pl:185
30610 msgid "B<--size=E<lt>NE<gt>>"
30614 #: ../tools/virt-make-fs.pl:187
30615 msgid "B<--size=+E<lt>NE<gt>>"
30619 #: ../tools/virt-make-fs.pl:189
30620 msgid "B<-s E<lt>NE<gt>>"
30624 #: ../tools/virt-make-fs.pl:191
30625 msgid "B<-s +E<lt>NE<gt>>"
30629 #: ../tools/virt-make-fs.pl:193
30631 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30635 #: ../tools/virt-make-fs.pl:196
30637 "If this option is I<not> given, then the output image will be just large "
30638 "enough to contain all the files, with not much wasted space."
30642 #: ../tools/virt-make-fs.pl:199
30644 "To choose a fixed size output disk, specify an absolute number followed by b/"
30645 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30646 "Petabytes or Exabytes. This must be large enough to contain all the input "
30647 "files, else you will get an error."
30651 #: ../tools/virt-make-fs.pl:204
30653 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30654 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30655 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30656 "the input files, and (approximately) an extra 200 MB free space."
30660 #: ../tools/virt-make-fs.pl:210
30662 "Note that virt-make-fs estimates free space, and therefore will not produce "
30663 "filesystems containing precisely the free space requested. (It is much more "
30664 "expensive and time-consuming to produce a filesystem which has precisely the "
30665 "desired free space)."
30669 #: ../tools/virt-make-fs.pl:219
30670 msgid "B<--format=E<lt>fmtE<gt>>"
30674 #: ../tools/virt-make-fs.pl:221
30675 msgid "B<-F E<lt>fmtE<gt>>"
30679 #: ../tools/virt-make-fs.pl:223
30680 msgid "Choose the output disk image format."
30684 #: ../tools/virt-make-fs.pl:225
30685 msgid "The default is C<raw> (raw disk image)."
30689 #: ../tools/virt-make-fs.pl:227
30691 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30692 "that would really make sense here is C<qcow2>."
30696 #: ../tools/virt-make-fs.pl:234
30697 msgid "B<--type=E<lt>fsE<gt>>"
30701 #: ../tools/virt-make-fs.pl:236
30702 msgid "B<-t E<lt>fsE<gt>>"
30706 #: ../tools/virt-make-fs.pl:238
30707 msgid "Choose the output filesystem type."
30711 #: ../tools/virt-make-fs.pl:240
30712 msgid "The default is C<ext2>."
30716 #: ../tools/virt-make-fs.pl:242
30718 "Any filesystem which is supported read-write by libguestfs can be used here."
30722 #: ../tools/virt-make-fs.pl:249
30723 msgid "B<--partition>"
30727 #: ../tools/virt-make-fs.pl:251
30728 msgid "B<--partition=E<lt>parttypeE<gt>>"
30732 #: ../tools/virt-make-fs.pl:253
30734 "If specified, this flag adds an MBR partition table to the output disk image."
30738 #: ../tools/virt-make-fs.pl:256
30740 "You can change the partition table type, eg. I<--partition=gpt> for large "
30745 #: ../tools/virt-make-fs.pl:259
30747 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30748 "might consider the next parameter to be the partition type. For example:"
30752 #: ../tools/virt-make-fs.pl:263
30755 " virt-make-fs --partition input.tar ...\n"
30760 #: ../tools/virt-make-fs.pl:265
30762 "would cause virt-make-fs to think you wanted to use a partition type of "
30763 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30764 "dash) between options and the input file argument:"
30768 #: ../tools/virt-make-fs.pl:269
30771 " virt-make-fs --partition -- input.tar ...\n"
30776 #: ../tools/virt-make-fs.pl:541
30778 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30779 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30780 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30784 #: ../tools/virt-make-fs.pl:558
30787 " export LIBGUESTFS_DEBUG=1\n"
30788 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30793 #: ../tools/virt-make-fs.pl:561
30795 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30800 #: ../tools/virt-list-partitions.pl:32
30802 "virt-list-partitions - List partitions in a virtual machine or disk image"
30806 #: ../tools/virt-list-partitions.pl:36
30809 " virt-list-partitions [--options] domname\n"
30814 #: ../tools/virt-list-partitions.pl:38
30817 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30822 #: ../tools/virt-list-partitions.pl:45
30824 "C<virt-list-partitions> is a command line tool to list the partitions that "
30825 "are contained in a virtual machine or disk image. It is mainly useful as a "
30826 "first step to using L<virt-resize(1)>."
30830 #: ../tools/virt-list-partitions.pl:50
30832 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30833 "functionality. For more complex cases you should look at the L<guestfish(1)"
30838 #: ../tools/virt-list-partitions.pl:107
30839 msgid "B<-h> | B<--human-readable>"
30843 #: ../tools/virt-list-partitions.pl:109
30844 msgid "Show sizes in human-readable form (eg. \"1G\")."
30848 #: ../tools/virt-list-partitions.pl:117
30850 "With this option, C<virt-list-partitions> displays the type and size of each "
30851 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30855 #: ../tools/virt-list-partitions.pl:124
30856 msgid "B<-t> | B<--total>"
30860 #: ../tools/virt-list-partitions.pl:126
30862 "Display the total size of each block device (as a separate row or rows)."
30866 #: ../tools/virt-list-partitions.pl:259
30868 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30869 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30870 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30874 #: ../tools/virt-list-partitions.pl:275
30875 msgid "Copyright (C) 2009-2010 Red Hat Inc."