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-09 15:21+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
34 "guestfs — бібліотека для доступу та внесення змін до образів віртуальних "
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
41 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
42 #: ../tools/virt-list-partitions.pl:34
44 msgstr "КОРОТКИЙ ОПИС"
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
53 " #include <guestfs.h>\n"
57 #: ../src/guestfs.pod:11
60 " guestfs_h *g = guestfs_create ();\n"
61 " guestfs_add_drive (g, \"guest.img\");\n"
62 " guestfs_launch (g);\n"
63 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
64 " guestfs_touch (g, \"/hello\");\n"
65 " guestfs_umount (g, \"/\");\n"
66 " guestfs_close (g);\n"
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_close (g);\n"
79 #: ../src/guestfs.pod:19
82 " cc prog.c -o prog -lguestfs\n"
84 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
87 " cc prog.c -o prog -lguestfs\n"
89 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
93 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
94 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
95 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
97 #: ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:25
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:33
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:38
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:43
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:48
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:51
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:54
155 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
165 #: ../src/guestfs.pod:59
167 "This section provides a gentler overview of the libguestfs API. We also try "
168 "to group API calls together, where that may not be obvious from reading "
169 "about the individual calls in the main section of this manual."
173 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
188 #: ../src/guestfs.pod:73
189 msgid "The general structure of all libguestfs-using programs looks like this:"
193 #: ../src/guestfs.pod:76
196 " guestfs_h *g = guestfs_create ();\n"
199 " guestfs_h *g = guestfs_create ();\n"
203 #: ../src/guestfs.pod:78
206 " /* Call guestfs_add_drive additional times if there are\n"
207 " * multiple disk images.\n"
209 " guestfs_add_drive (g, \"guest.img\");\n"
214 #: ../src/guestfs.pod:83
217 " /* Most manipulation calls won't work until you've launched\n"
218 " * the handle 'g'. You have to do this _after_ adding drives\n"
219 " * and _before_ other commands.\n"
221 " guestfs_launch (g);\n"
226 #: ../src/guestfs.pod:89
229 " /* Now you can examine what partitions, LVs etc are available.\n"
231 " char **partitions = guestfs_list_partitions (g);\n"
232 " char **logvols = guestfs_lvs (g);\n"
237 #: ../src/guestfs.pod:94
240 " /* To access a filesystem in the image, you must mount it.\n"
242 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
245 " /* Щоб отримати доступ до файлової системи на образі, вам слід його змонтувати.\n"
247 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 #| " /* Now you can perform filesystem actions on the guest\n"
255 #| " * disk image.\n"
257 #| " guestfs_touch (g, \"/hello\");\n"
260 " /* Now you can perform filesystem actions on the guest\n"
263 " guestfs_touch (g, \"/hello\");\n"
266 " /* Тепер ви можете виконувати дії з файловою системою на\n"
267 " * образі диска операційної системи.\n"
269 " guestfs_touch (g, \"/hello\");\n"
273 #: ../src/guestfs.pod:103
276 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
277 " * it is done automatically when you close the handle. See\n"
278 " * discussion of autosync in this page.\n"
280 " guestfs_sync (g);\n"
285 #: ../src/guestfs.pod:109
288 " /* Close the handle 'g'. */\n"
289 " guestfs_close (g);\n"
294 #: ../src/guestfs.pod:112
296 "The code above doesn't include any error checking. In real code you should "
297 "check return values carefully for errors. In general all functions that "
298 "return integers return C<-1> on error, and all functions that return "
299 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
300 "how to handle errors, and consult the documentation for each function call "
301 "below to see precisely how they return error indications. See L<guestfs-"
302 "examples(3)> for fully worked examples."
306 #: ../src/guestfs.pod:121
311 #: ../src/guestfs.pod:123
313 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
314 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
315 "actual block device, or simply an empty file of zeroes that you have created "
316 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
321 #: ../src/guestfs.pod:129
323 "The call you should use in modern code for adding drives is L</"
324 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
325 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
344 #: ../src/guestfs.pod:139
347 " guestfs_add_drive_opts (g, filename,\n"
348 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
349 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
355 #: ../src/guestfs.pod:144
357 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
358 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
370 #: ../src/guestfs.pod:151
372 "You must add at least one disk image, and you may add multiple disk images. "
373 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
374 "first one you added), C</dev/sdb> (for the second one you added), etc."
378 #: ../src/guestfs.pod:156
380 "Once L</guestfs_launch> has been called you cannot add any more images. You "
381 "can call L</guestfs_list_devices> to get a list of the device names, in the "
382 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
386 #: ../src/guestfs.pod:161
391 #: ../src/guestfs.pod:163
393 "Before you can read or write files, create directories and so on in a disk "
394 "image that contains filesystems, you have to mount those filesystems using "
395 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
396 "a disk image contains (for example) one partition with a filesystem on that "
397 "partition, then you can mount it directly:"
401 #: ../src/guestfs.pod:170
404 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
409 #: ../src/guestfs.pod:172
411 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
412 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
413 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
414 "that these are libguestfs virtual devices, and are nothing to do with host "
419 #: ../src/guestfs.pod:178
421 "If you are given a disk image and you don't know what it contains then you "
422 "have to find out. Libguestfs can do that too: use L</"
423 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
424 "LVs, and either try mounting each to see what is mountable, or else examine "
425 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
426 "filesystems, use L</guestfs_list_filesystems>."
430 #: ../src/guestfs.pod:186
432 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
433 "L</INSPECTION> below). But you might find it easier to look at higher level "
434 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
438 #: ../src/guestfs.pod:191
440 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
441 "several other variations of the C<guestfs_mount_*> call."
445 #: ../src/guestfs.pod:194
446 msgid "FILESYSTEM ACCESS AND MODIFICATION"
450 #: ../src/guestfs.pod:196
452 "The majority of the libguestfs API consists of fairly low-level calls for "
453 "accessing and modifying the files, directories, symlinks etc on mounted "
454 "filesystems. There are over a hundred such calls which you can find listed "
455 "in detail below in this man page, and we don't even pretend to cover them "
456 "all in this overview."
460 #: ../src/guestfs.pod:202
462 "Specify filenames as full paths, starting with C<\"/\"> and including the "
467 #: ../src/guestfs.pod:205
469 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
470 "the file called C<\"etc/passwd\"> then you could do:"
474 #: ../src/guestfs.pod:208
477 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
482 #: ../src/guestfs.pod:210
484 "This would return C<data> as a newly allocated buffer containing the full "
485 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
486 "or C<NULL> if there was an error."
490 #: ../src/guestfs.pod:214
492 "As another example, to create a top-level directory on that filesystem "
493 "called C<\"var\"> you would do:"
497 #: ../src/guestfs.pod:217
500 " guestfs_mkdir (g, \"/var\");\n"
505 #: ../src/guestfs.pod:219
506 msgid "To create a symlink you could do:"
510 #: ../src/guestfs.pod:221
513 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
514 " \"/etc/rc3.d/S30portmap\");\n"
519 #: ../src/guestfs.pod:224
521 "Libguestfs will reject attempts to use relative paths and there is no "
522 "concept of a current working directory."
526 #: ../src/guestfs.pod:227
528 "Libguestfs can return errors in many situations: for example if the "
529 "filesystem isn't writable, or if a file or directory that you requested "
530 "doesn't exist. If you are using the C API (documented here) you have to "
531 "check for those error conditions after each call. (Other language bindings "
532 "turn these errors into exceptions)."
536 #: ../src/guestfs.pod:233
538 "File writes are affected by the per-handle umask, set by calling L</"
539 "guestfs_umask> and defaulting to 022. See L</UMASK>."
543 #: ../src/guestfs.pod:236
545 msgstr "ПОДІЛ НА РОЗДІЛИ"
548 #: ../src/guestfs.pod:238
550 "Libguestfs contains API calls to read, create and modify partition tables on "
555 #: ../src/guestfs.pod:241
557 "In the common case where you want to create a single partition covering the "
558 "whole disk, you should use the L</guestfs_part_disk> call:"
562 #: ../src/guestfs.pod:245
565 " const char *parttype = \"mbr\";\n"
566 " if (disk_is_larger_than_2TB)\n"
567 " parttype = \"gpt\";\n"
568 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
573 #: ../src/guestfs.pod:250
575 "Obviously this effectively wipes anything that was on that disk image before."
579 #: ../src/guestfs.pod:253
584 #: ../src/guestfs.pod:255
586 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
587 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
588 "you familiarize yourself with the concepts of physical volumes, volume "
589 "groups and logical volumes."
593 #: ../src/guestfs.pod:260
595 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
596 "tldp.org/HOWTO/LVM-HOWTO/>."
600 #: ../src/guestfs.pod:263
605 #: ../src/guestfs.pod:265
607 "Use L</guestfs_cat> to download small, text only files. This call is "
608 "limited to files which are less than 2 MB and which cannot contain any ASCII "
609 "NUL (C<\\0>) characters. However the API is very simple to use."
613 #: ../src/guestfs.pod:269
615 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
616 "bit data, since it returns a (pointer, size) pair. However it is still "
617 "limited to \"small\" files, less than 2 MB."
621 #: ../src/guestfs.pod:273
623 "L</guestfs_download> can be used to download any file, with no limits on "
624 "content or size (even files larger than 4 GB)."
628 #: ../src/guestfs.pod:276
630 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
634 #: ../src/guestfs.pod:279
636 msgstr "ВИВАНТАЖЕННЯ"
639 #: ../src/guestfs.pod:281
641 "It's often the case that you want to write a file or files to the disk image."
645 #: ../src/guestfs.pod:284
647 "To write a small file with fixed content, use L</guestfs_write>. To create "
648 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
649 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
650 "of other functions for creating test files, for example L</guestfs_fill> and "
651 "L</guestfs_fill_pattern>."
655 #: ../src/guestfs.pod:290
657 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
658 "file content or size (even files larger than 4 GB)."
662 #: ../src/guestfs.pod:293
664 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
668 #: ../src/guestfs.pod:295
670 "However the fastest way to upload I<large numbers of arbitrary files> is to "
671 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
672 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
673 "in a predictable way (eg. adding it last after all other drives) then you "
674 "can get the device name from L</guestfs_list_devices> and mount it directly "
675 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
676 "portable between kernel versions, and they don't support labels or UUIDs. "
677 "If you want to pre-build an image or you need to mount it using a label or "
678 "UUID, use an ISO image instead."
682 #: ../src/guestfs.pod:306
687 #: ../src/guestfs.pod:308
689 "There are various different commands for copying between files and devices "
690 "and in and out of the guest filesystem. These are summarised in the table "
695 #: ../src/guestfs.pod:314
696 msgid "B<file> to B<file>"
700 #: ../src/guestfs.pod:316
702 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
703 "directories recursively."
707 #: ../src/guestfs.pod:319
708 msgid "B<file or device> to B<file or device>"
712 #: ../src/guestfs.pod:321
714 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
715 "devices in the guest."
719 #: ../src/guestfs.pod:324
720 msgid "Example: duplicate the contents of an LV:"
724 #: ../src/guestfs.pod:326
727 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
732 #: ../src/guestfs.pod:328
734 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
735 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
736 "guestfs_copy_size>."
740 #: ../src/guestfs.pod:332
741 msgid "B<file on the host> to B<file or device>"
745 #: ../src/guestfs.pod:334
746 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
750 #: ../src/guestfs.pod:336
751 msgid "B<file or device> to B<file on the host>"
755 #: ../src/guestfs.pod:338
756 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
760 #: ../src/guestfs.pod:342
761 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
765 #: ../src/guestfs.pod:344
767 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
768 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
769 "appears you can only upload and download to files. However many Un*x-like "
770 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
771 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
772 "and arbitrary file descriptor N."
776 #: ../src/guestfs.pod:352
777 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
781 #: ../src/guestfs.pod:355
784 " guestfs_download (g, filename, \"/dev/stdout\");\n"
789 #: ../src/guestfs.pod:357
790 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
794 #: ../src/guestfs.pod:359
798 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
799 " guestfs_tar_out (g, \"/\", devfd);\n"
804 #: ../src/guestfs.pod:363
805 msgid "LISTING FILES"
809 #: ../src/guestfs.pod:365
811 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
812 "L<guestfish(1)>-equivalent command C<ll>)."
816 #: ../src/guestfs.pod:368
818 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
819 "programs, as a flat list of strings."
823 #: ../src/guestfs.pod:371
825 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
826 "directory, plus additional information about each one. It is more "
827 "equivalent to using the L<readdir(3)> call on a local filesystem."
831 #: ../src/guestfs.pod:375
833 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
837 #: ../src/guestfs.pod:378
838 msgid "RUNNING COMMANDS"
842 #: ../src/guestfs.pod:380
844 "Although libguestfs is primarily an API for manipulating files inside guest "
845 "images, we also provide some limited facilities for running commands inside "
850 #: ../src/guestfs.pod:384
851 msgid "There are many limitations to this:"
855 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
856 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
857 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
858 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
859 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
860 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
861 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
862 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
863 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
864 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
865 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
866 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
867 #: ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975
868 #: ../src/guestfs.pod:2979 ../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-win-reg.pl:536
894 #: ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548
899 #: ../src/guestfs.pod:390
901 "The kernel version that the command runs under will be different from what "
906 #: ../src/guestfs.pod:395
908 "If the command needs to communicate with daemons, then most likely they "
913 #: ../src/guestfs.pod:400
914 msgid "The command will be running in limited memory."
918 #: ../src/guestfs.pod:404
920 "The network may not be available unless you enable it (see L</"
921 "guestfs_set_network>)."
925 #: ../src/guestfs.pod:409
926 msgid "Only supports Linux guests (not Windows, BSD, etc)."
930 #: ../src/guestfs.pod:413
932 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
936 #: ../src/guestfs.pod:418
938 "For SELinux guests, you may need to enable SELinux and load policy first. "
939 "See L</SELINUX> in this manpage."
943 #: ../src/guestfs.pod:423
945 "I<Security:> It is not safe to run commands from untrusted, possibly "
946 "malicious guests. These commands may attempt to exploit your program by "
947 "sending unexpected output. They could also try to exploit the Linux kernel "
948 "or qemu provided by the libguestfs appliance. They could use the network "
949 "provided by the libguestfs appliance to bypass ordinary network partitions "
950 "and firewalls. They could use the elevated privileges or different SELinux "
951 "context of your program to their advantage."
955 #: ../src/guestfs.pod:432
957 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
958 "(a script which runs when the guest next boots normally), and to have this "
959 "script run the commands you want in the normal context of the running guest, "
960 "network security and so on. For information about other security issues, "
965 #: ../src/guestfs.pod:440
967 "The two main API calls to run commands are L</guestfs_command> and L</"
968 "guestfs_sh> (there are also variations)."
972 #: ../src/guestfs.pod:443
974 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
975 "shell globs, redirections, etc will work."
979 #: ../src/guestfs.pod:446
980 msgid "CONFIGURATION FILES"
981 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
984 #: ../src/guestfs.pod:448
986 "To read and write configuration files in Linux guest filesystems, we "
987 "strongly recommend using Augeas. For example, Augeas understands how to "
988 "read and write, say, a Linux shadow password file or X.org configuration "
989 "file, and so avoids you having to write that code."
993 #: ../src/guestfs.pod:453
995 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
996 "document Augeas itself here because there is excellent documentation on the "
997 "L<http://augeas.net/> website."
1001 #: ../src/guestfs.pod:457
1003 "If you don't want to use Augeas (you fool!) then try calling L</"
1004 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1009 #: ../src/guestfs.pod:461
1014 #: ../src/guestfs.pod:463
1016 "We support SELinux guests. To ensure that labeling happens correctly in "
1017 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1021 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1022 #: ../src/guestfs.pod:2426
1027 #: ../src/guestfs.pod:471
1028 msgid "Before launching, do:"
1032 #: ../src/guestfs.pod:473
1035 " guestfs_set_selinux (g, 1);\n"
1040 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1041 #: ../src/guestfs.pod:2451
1046 #: ../src/guestfs.pod:477
1048 "After mounting the guest's filesystem(s), load the policy. This is best "
1049 "done by running the L<load_policy(8)> command in the guest itself:"
1053 #: ../src/guestfs.pod:481
1056 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1061 #: ../src/guestfs.pod:483
1063 "(Older versions of C<load_policy> require you to specify the name of the "
1068 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1073 #: ../src/guestfs.pod:488
1075 "Optionally, set the security context for the API. The correct security "
1076 "context to use can only be known by inspecting the guest. As an example:"
1080 #: ../src/guestfs.pod:492
1083 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1088 #: ../src/guestfs.pod:496
1089 msgid "This will work for running commands and editing existing files."
1093 #: ../src/guestfs.pod:498
1095 "When new files are created, you may need to label them explicitly, for "
1096 "example by running the external command C<restorecon pathname>."
1100 #: ../src/guestfs.pod:502
1105 #: ../src/guestfs.pod:504
1107 "Certain calls are affected by the current file mode creation mask (the "
1108 "\"umask\"). In particular ones which create files or directories, such as "
1109 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1110 "either the default mode that the file is created with or modifies the mode "
1115 #: ../src/guestfs.pod:510
1117 "The default umask is C<022>, so files are created with modes such as C<0644> "
1118 "and directories with C<0755>."
1122 #: ../src/guestfs.pod:513
1124 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1125 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1126 "guestfs_chmod> after creating each file or directory."
1130 #: ../src/guestfs.pod:517
1131 msgid "For more information about umask, see L<umask(2)>."
1135 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1136 msgid "ENCRYPTED DISKS"
1140 #: ../src/guestfs.pod:521
1142 "Libguestfs allows you to access Linux guests which have been encrypted using "
1143 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1144 "standard. This includes nearly all whole disk encryption systems used by "
1145 "modern Linux guests."
1149 #: ../src/guestfs.pod:527
1151 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1152 "returns the string C<crypto_LUKS>)."
1156 #: ../src/guestfs.pod:530
1158 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1159 "will require the passphrase!"
1163 #: ../src/guestfs.pod:533
1165 "Opening a LUKS device creates a new device mapper device called C</dev/"
1166 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1167 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1168 "from and encrypted to the underlying block device respectively."
1172 #: ../src/guestfs.pod:539
1174 "LVM volume groups on the device can be made visible by calling L</"
1175 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1176 "(s) can now be mounted in the usual way."
1180 #: ../src/guestfs.pod:543
1182 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1183 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1184 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1185 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1186 "underlying encrypted block device)."
1190 #: ../src/guestfs.pod:550
1195 #: ../src/guestfs.pod:552
1197 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1198 "contains operating systems, an install CD or a live CD. (These APIs used to "
1199 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1200 "version 1.5.3 the most frequently used part of this library has been "
1201 "rewritten in C and moved into the core code)."
1205 #: ../src/guestfs.pod:559
1207 "Add all disks belonging to the unknown virtual machine and call L</"
1208 "guestfs_launch> in the usual way."
1212 #: ../src/guestfs.pod:562
1214 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1215 "and certain heuristics, and returns a list of operating systems that were "
1216 "found. An empty list means none were found. A single element is the root "
1217 "filesystem of the operating system. For dual- or multi-boot guests, "
1218 "multiple roots can be returned, each one corresponding to a separate "
1219 "operating system. (Multi-boot virtual machines are extremely rare in the "
1220 "world of virtualization, but since this scenario can happen, we have built "
1221 "libguestfs to deal with it.)"
1225 #: ../src/guestfs.pod:571
1227 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1228 "to get additional details about that operating system. For example, call L</"
1229 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1230 "Windows and Linux-based operating systems respectively."
1234 #: ../src/guestfs.pod:577
1236 "Un*x-like and Linux-based operating systems usually consist of several "
1237 "filesystems which are mounted at boot time (for example, a separate boot "
1238 "partition mounted on C</boot>). The inspection rules are able to detect how "
1239 "filesystems correspond to mount points. Call "
1240 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1241 "hash table like this example:"
1245 #: ../src/guestfs.pod:584
1248 " /boot => /dev/sda1\n"
1249 " / => /dev/vg_guest/lv_root\n"
1250 " /usr => /dev/vg_guest/lv_usr\n"
1255 #: ../src/guestfs.pod:588
1257 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1258 "filesystems as suggested."
1262 #: ../src/guestfs.pod:591
1264 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1265 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1269 #: ../src/guestfs.pod:595
1271 "Inspection currently only works for some common operating systems. "
1272 "Contributors are welcome to send patches for other operating systems that we "
1273 "currently cannot detect."
1277 #: ../src/guestfs.pod:599
1279 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1280 "for more details. The L</guestfs_inspect_os> function just ignores any "
1281 "encrypted devices."
1285 #: ../src/guestfs.pod:603
1287 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1288 "inspection and caches the results in the guest handle. Subsequent calls to "
1289 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1290 "read the disks. If you change the content of the guest disks, you can redo "
1291 "inspection by calling L</guestfs_inspect_os> again. (L</"
1292 "guestfs_inspect_list_applications> works a little differently from the other "
1293 "calls and does read the disks. See documentation for that function for "
1298 #: ../src/guestfs.pod:612
1299 msgid "INSPECTING INSTALL DISKS"
1303 #: ../src/guestfs.pod:614
1305 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1310 #: ../src/guestfs.pod:617
1312 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1313 "system, which currently can be C<installed> (a regular operating system) or "
1314 "C<installer> (some sort of install disk)."
1318 #: ../src/guestfs.pod:621
1320 "Further information is available about the operating system that can be "
1321 "installed using the regular inspection APIs like L</"
1322 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1326 #: ../src/guestfs.pod:626
1328 "Some additional information specific to installer disks is also available "
1329 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1330 "guestfs_inspect_is_multipart> calls."
1334 #: ../src/guestfs.pod:631
1335 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1339 #: ../src/guestfs.pod:633
1341 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1342 "ntfs-3g.org/> driver."
1346 #: ../src/guestfs.pod:636
1347 msgid "DRIVE LETTERS AND PATHS"
1351 #: ../src/guestfs.pod:638
1353 "DOS and Windows still use drive letters, and the filesystems are always "
1354 "treated as case insensitive by Windows itself, and therefore you might find "
1355 "a Windows configuration file referring to a path like C<c:\\windows"
1356 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1357 "might be referred to as C</WINDOWS/System32>."
1361 #: ../src/guestfs.pod:644
1363 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1364 "L</guestfs_inspect_get_drive_mappings>)"
1368 #: ../src/guestfs.pod:647
1370 "Dealing with separator characters (backslash vs forward slash) is outside "
1371 "the scope of libguestfs, but usually a simple character replacement will "
1376 #: ../src/guestfs.pod:651
1378 "To resolve the case insensitivity of paths, call L</"
1379 "guestfs_case_sensitive_path>."
1383 #: ../src/guestfs.pod:654
1384 msgid "ACCESSING THE WINDOWS REGISTRY"
1388 #: ../src/guestfs.pod:656
1390 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1391 "files, through the library C<hivex> which is part of the libguestfs project "
1392 "although ships as a separate tarball. You have to locate and download the "
1393 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1394 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1395 "reg(1)> for more help on this issue."
1399 #: ../src/guestfs.pod:664
1400 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1404 #: ../src/guestfs.pod:666
1406 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1407 "provide something which looks like a Linux symlink. The way it tries to do "
1408 "the rewriting is described here:"
1412 #: ../src/guestfs.pod:670
1414 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1417 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1421 #: ../src/guestfs.pod:672
1423 "The essential problem is that ntfs-3g simply does not have enough "
1424 "information to do a correct job. NTFS links can contain drive letters and "
1425 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1426 "It is almost certainly the case that libguestfs callers should ignore what "
1427 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1431 #: ../src/guestfs.pod:679
1433 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1434 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1435 "attribute, and read the raw reparse data from that (you can find the format "
1436 "documented in various places around the web)."
1440 #: ../src/guestfs.pod:684
1441 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1445 #: ../src/guestfs.pod:686
1447 "There are other useful extended attributes that can be read from ntfs-3g "
1448 "filesystems (using L</guestfs_getxattr>). See:"
1452 #: ../src/guestfs.pod:689
1454 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1456 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1459 #: ../src/guestfs.pod:691
1460 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1464 #: ../src/guestfs.pod:693
1466 "Although we don't want to discourage you from using the C API, we will "
1467 "mention here that the same API is also available in other languages."
1471 #: ../src/guestfs.pod:696
1473 "The API is broadly identical in all supported languages. This means that "
1474 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1475 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1476 "OCaml. In other words, a straightforward, predictable isomorphism between "
1481 #: ../src/guestfs.pod:702
1483 "Error messages are automatically transformed into exceptions if the language "
1488 #: ../src/guestfs.pod:705
1490 "We don't try to \"object orientify\" parts of the API in OO languages, "
1491 "although contributors are welcome to write higher level APIs above what we "
1492 "provide in their favourite languages if they wish."
1496 #: ../src/guestfs.pod:711
1501 #: ../src/guestfs.pod:713
1503 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1504 "identical to the C API. C++ classes and exceptions are not used."
1508 #: ../src/guestfs.pod:717
1513 #: ../src/guestfs.pod:719
1515 "The C# bindings are highly experimental. Please read the warnings at the "
1516 "top of C<csharp/Libguestfs.cs>."
1520 #: ../src/guestfs.pod:722
1525 #: ../src/guestfs.pod:724
1527 "This is the only language binding that is working but incomplete. Only "
1528 "calls which return simple integers have been bound in Haskell, and we are "
1529 "looking for help to complete this binding."
1533 #: ../src/guestfs.pod:728
1538 #: ../src/guestfs.pod:730
1540 "Full documentation is contained in the Javadoc which is distributed with "
1545 #: ../src/guestfs.pod:733
1550 #: ../src/guestfs.pod:735
1551 msgid "See L<guestfs-ocaml(3)>."
1552 msgstr "Див. L<guestfs-ocaml(3)>."
1555 #: ../src/guestfs.pod:737
1560 #: ../src/guestfs.pod:739
1561 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1562 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1565 #: ../src/guestfs.pod:741
1570 #: ../src/guestfs.pod:743
1572 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1573 "the php-libguestfs package for your distribution."
1577 #: ../src/guestfs.pod:746
1578 msgid "The PHP binding only works correctly on 64 bit machines."
1582 #: ../src/guestfs.pod:748
1587 #: ../src/guestfs.pod:750
1588 msgid "See L<guestfs-python(3)>."
1589 msgstr "Див. L<guestfs-python(3)>."
1592 #: ../src/guestfs.pod:752
1597 #: ../src/guestfs.pod:754
1598 msgid "See L<guestfs-ruby(3)>."
1599 msgstr "Див. L<guestfs-ruby(3)>."
1602 #: ../src/guestfs.pod:756
1603 msgid "B<shell scripts>"
1604 msgstr "B<скрипти оболонки>"
1607 #: ../src/guestfs.pod:758
1608 msgid "See L<guestfish(1)>."
1609 msgstr "Див. L<guestfish(1)>."
1612 #: ../src/guestfs.pod:762
1613 msgid "LIBGUESTFS GOTCHAS"
1617 #: ../src/guestfs.pod:764
1619 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1620 "system [...] that works in the way it is documented but is counterintuitive "
1621 "and almost invites mistakes.\""
1625 #: ../src/guestfs.pod:768
1627 "Since we developed libguestfs and the associated tools, there are several "
1628 "things we would have designed differently, but are now stuck with for "
1629 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1630 "release, you can expect these to change. Beware of them."
1634 #: ../src/guestfs.pod:776
1635 msgid "Autosync / forgetting to sync."
1639 #: ../src/guestfs.pod:778
1641 "I<Update:> Autosync is enabled by default for all API users starting from "
1642 "libguestfs 1.5.24. This section only applies to older versions."
1646 #: ../src/guestfs.pod:781
1648 "When modifying a filesystem from C or another language, you B<must> unmount "
1649 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1650 "libguestfs handle. You can also call:"
1654 #: ../src/guestfs.pod:785
1657 " guestfs_set_autosync (g, 1);\n"
1662 #: ../src/guestfs.pod:787
1664 "to have the unmount/sync done automatically for you when the handle 'g' is "
1665 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1669 #: ../src/guestfs.pod:791
1671 "If you forget to do this, then it is entirely possible that your changes "
1672 "won't be written out, or will be partially written, or (very rarely) that "
1673 "you'll get disk corruption."
1677 #: ../src/guestfs.pod:795
1679 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1680 "guestfish scripts that forget to sync will work just fine, which can make "
1681 "this very puzzling if you are trying to debug a problem."
1685 #: ../src/guestfs.pod:799
1686 msgid "Mount option C<-o sync> should not be the default."
1690 #: ../src/guestfs.pod:801
1692 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1693 "However C<-o sync> does not add any reliability benefit, but does have a "
1694 "very large performance impact."
1698 #: ../src/guestfs.pod:805
1700 "The work around is to use L</guestfs_mount_options> and set the mount "
1701 "options that you actually want to use."
1705 #: ../src/guestfs.pod:808
1706 msgid "Read-only should be the default."
1710 #: ../src/guestfs.pod:810
1712 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1713 "specify I<--rw> if you want to make changes to the image."
1717 #: ../src/guestfs.pod:813
1718 msgid "This would reduce the potential to corrupt live VM images."
1722 #: ../src/guestfs.pod:815
1724 "Note that many filesystems change the disk when you just mount and unmount, "
1725 "even if you didn't perform any writes. You need to use L</"
1726 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1730 #: ../src/guestfs.pod:819
1731 msgid "guestfish command line is hard to use."
1735 #: ../src/guestfs.pod:821
1737 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1738 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1739 "exist, so it fails. In earlier versions of guestfish the error message was "
1740 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1741 "we should have used C<guestfish -c command> to run commands."
1745 #: ../src/guestfs.pod:828
1746 msgid "guestfish megabyte modifiers don't work right on all commands"
1750 #: ../src/guestfs.pod:830
1752 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1753 "other modifiers). What guestfish actually does is to multiply the number "
1754 "part by the modifier part and pass the result to the C API. However this "
1755 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1756 "expecting some other unit (eg. megabytes)."
1760 #: ../src/guestfs.pod:837
1761 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1765 #: ../src/guestfs.pod:839
1768 " lvcreate LV VG 100M\n"
1773 #: ../src/guestfs.pod:841
1775 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1776 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1777 "megabytes * megabytes) logical volume. The error message you get from this "
1778 "is also a little obscure."
1782 #: ../src/guestfs.pod:846
1784 "This could be fixed in the generator by specially marking parameters and "
1785 "return values which take bytes or other units."
1789 #: ../src/guestfs.pod:849
1790 msgid "Ambiguity between devices and paths"
1794 #: ../src/guestfs.pod:851
1796 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1797 "sdb2>) and a similar pathname. A file might just happen to be called "
1798 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1802 #: ../src/guestfs.pod:856
1804 "In the current API we usually resolve this ambiguity by having two separate "
1805 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1806 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1807 "detecting if the path supplied begins with C</dev/>."
1811 #: ../src/guestfs.pod:862
1813 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1814 "make paths/devices into structured names. One way to do this would be to "
1815 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1816 "aspect of grub. Another way would be to use a structured type, equivalent "
1817 "to this OCaml type:"
1821 #: ../src/guestfs.pod:868
1824 " type path = Path of string | Device of int | Partition of int * int\n"
1829 #: ../src/guestfs.pod:870
1830 msgid "which would allow you to pass arguments like:"
1834 #: ../src/guestfs.pod:872
1837 " Path \"/foo/bar\"\n"
1838 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1839 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1840 " Path \"/dev/sdb2\" (* not a device *)\n"
1845 #: ../src/guestfs.pod:877
1847 "As you can see there are still problems to resolve even with this "
1848 "representation. Also consider how it might work in guestfish."
1852 #: ../src/guestfs.pod:882
1853 msgid "KEYS AND PASSPHRASES"
1857 #: ../src/guestfs.pod:884
1859 "Certain libguestfs calls take a parameter that contains sensitive key "
1860 "material, passed in as a C string."
1864 #: ../src/guestfs.pod:887
1866 "In the future we would hope to change the libguestfs implementation so that "
1867 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1868 "swap. However this is I<not> done at the moment, because of the complexity "
1869 "of such an implementation."
1873 #: ../src/guestfs.pod:892
1875 "Therefore you should be aware that any key parameter you pass to libguestfs "
1876 "might end up being written out to the swap partition. If this is a concern, "
1877 "scrub the swap partition or don't use libguestfs on encrypted devices."
1881 #: ../src/guestfs.pod:897
1882 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1886 #: ../src/guestfs.pod:899
1888 "All high-level libguestfs actions are synchronous. If you want to use "
1889 "libguestfs asynchronously then you must create a thread."
1893 #: ../src/guestfs.pod:902
1895 "Only use the handle from a single thread. Either use the handle exclusively "
1896 "from one thread, or provide your own mutex so that two threads cannot issue "
1897 "calls on the same handle at the same time."
1901 #: ../src/guestfs.pod:906
1903 "See the graphical program guestfs-browser for one possible architecture for "
1904 "multithreaded programs using libvirt and libguestfs."
1908 #: ../src/guestfs.pod:909
1913 #: ../src/guestfs.pod:911
1915 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1920 #: ../src/guestfs.pod:914
1922 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1923 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1927 #: ../src/guestfs.pod:917
1929 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1930 "to change the directories that libguestfs will search in. The value is a "
1931 "colon-separated list of paths. The current directory is I<not> searched "
1932 "unless the path contains an empty element or C<.>. For example "
1933 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1934 "then C</usr/lib/guestfs>."
1938 #: ../src/guestfs.pod:924
1939 msgid "QEMU WRAPPERS"
1943 #: ../src/guestfs.pod:926
1945 "If you want to compile your own qemu, run qemu from a non-standard location, "
1946 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1951 #: ../src/guestfs.pod:930
1953 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1954 "last command in the shell script (so that qemu replaces the shell and "
1955 "becomes the direct child of the libguestfs-using program). If you don't do "
1956 "this, then the qemu process won't be cleaned up correctly."
1960 #: ../src/guestfs.pod:935
1962 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1967 #: ../src/guestfs.pod:938
1971 " qemudir=/home/rjones/d/qemu\n"
1972 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1977 #: ../src/guestfs.pod:942
1979 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1980 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1985 #: ../src/guestfs.pod:946
1988 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1993 #: ../src/guestfs.pod:948
1995 "Note that libguestfs also calls qemu with the -help and -version options in "
1996 "order to determine features."
2000 #: ../src/guestfs.pod:951
2001 msgid "ATTACHING TO RUNNING DAEMONS"
2005 #: ../src/guestfs.pod:953
2007 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2008 "babies. Use with caution."
2012 #: ../src/guestfs.pod:956
2014 "I<Note (2):> This section explains how to attach to a running daemon from a "
2015 "low level perspective. For most users, simply using virt tools such as "
2016 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2020 #: ../src/guestfs.pod:960
2021 msgid "Using guestfs_set_attach_method"
2025 #: ../src/guestfs.pod:962
2027 "By calling L</guestfs_set_attach_method> you can change how the library "
2028 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2029 "ARCHITECTURE> for some background)."
2033 #: ../src/guestfs.pod:966
2035 "The normal attach method is C<appliance>, where a small appliance is created "
2036 "containing the daemon, and then the library connects to this."
2040 #: ../src/guestfs.pod:969
2042 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2043 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2044 "daemon over the Unix domain socket."
2048 #: ../src/guestfs.pod:973
2050 "The normal use for this is to connect to a running virtual machine that "
2051 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2052 "files inside the live virtual machine."
2056 #: ../src/guestfs.pod:977
2057 msgid "Using guestfs_add_domain with live flag"
2061 #: ../src/guestfs.pod:979
2063 "L</guestfs_add_domain> provides some help for getting the correct attach "
2064 "method. If you pass the C<live> option to this function, then (if the "
2065 "virtual machine is running) it will examine the libvirt XML looking for a "
2066 "virtio-serial channel to connect to:"
2070 #: ../src/guestfs.pod:985
2077 " <channel type='unix'>\n"
2078 " <source mode='bind' path='/path/to/socket'/>\n"
2079 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2088 #: ../src/guestfs.pod:997
2090 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2091 "method to C<unix:/path/to/socket>."
2095 #: ../src/guestfs.pod:1000
2097 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2098 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2099 "to attach to and modify live virtual machines."
2103 #: ../src/guestfs.pod:1004
2105 "The virtual machine needs to have been set up beforehand so that it has the "
2106 "virtio-serial channel and so that guestfsd is running inside it."
2110 #: ../src/guestfs.pod:1008
2111 msgid "ABI GUARANTEE"
2115 #: ../src/guestfs.pod:1010
2117 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2118 "actions as outlined in this section. Although we will deprecate some "
2119 "actions, for example if they get replaced by newer calls, we will keep the "
2120 "old actions forever. This allows you the developer to program in confidence "
2121 "against the libguestfs API."
2125 #: ../src/guestfs.pod:1016
2126 msgid "BLOCK DEVICE NAMING"
2130 #: ../src/guestfs.pod:1018
2132 "In the kernel there is now quite a profusion of schemata for naming block "
2133 "devices (in this context, by I<block device> I mean a physical or virtual "
2134 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2135 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2136 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2137 "for the old IDE driver (particularly for SATA devices) those devices also "
2138 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2139 "paravirtualized drivers. This has created several different naming systems, "
2140 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2144 #: ../src/guestfs.pod:1030
2146 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2147 "Linux kernel to access block devices. We can run a variety of appliances "
2148 "based on a variety of Linux kernels."
2152 #: ../src/guestfs.pod:1034
2154 "This causes a problem for libguestfs because many API calls use device or "
2155 "partition names. Working scripts and the recipe (example) scripts that we "
2156 "make available over the internet could fail if the naming scheme changes."
2160 #: ../src/guestfs.pod:1039
2162 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2163 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2164 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2165 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2169 #: ../src/guestfs.pod:1045
2171 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2172 "L</guestfs_list_partitions> and similar calls return the true names of the "
2173 "devices and partitions as known to the appliance."
2177 #: ../src/guestfs.pod:1050
2178 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2182 #: ../src/guestfs.pod:1052
2184 "Usually this translation is transparent. However in some (very rare) cases "
2185 "you may need to know the exact algorithm. Such cases include where you use "
2186 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2187 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2191 #: ../src/guestfs.pod:1058
2193 "The algorithm is applied only to I<parameters> which are known to be either "
2194 "device or partition names. Return values from functions such as L</"
2195 "guestfs_list_devices> are never changed."
2199 #: ../src/guestfs.pod:1066
2200 msgid "Is the string a parameter which is a device or partition name?"
2204 #: ../src/guestfs.pod:1070
2205 msgid "Does the string begin with C</dev/sd>?"
2209 #: ../src/guestfs.pod:1074
2211 "Does the named device exist? If so, we use that device. However if I<not> "
2212 "then we continue with this algorithm."
2216 #: ../src/guestfs.pod:1079
2217 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2221 #: ../src/guestfs.pod:1081
2222 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2226 #: ../src/guestfs.pod:1083
2227 msgid "If that named device exists, use it. If not, continue."
2231 #: ../src/guestfs.pod:1087
2232 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2236 #: ../src/guestfs.pod:1089
2237 msgid "If that named device exists, use it. If not, return an error."
2241 #: ../src/guestfs.pod:1093
2242 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2246 #: ../src/guestfs.pod:1095
2248 "Although the standard naming scheme and automatic translation is useful for "
2249 "simple programs and guestfish scripts, for larger programs it is best not to "
2250 "rely on this mechanism."
2254 #: ../src/guestfs.pod:1099
2256 "Where possible for maximum future portability programs using libguestfs "
2257 "should use these future-proof techniques:"
2261 #: ../src/guestfs.pod:1106
2263 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2264 "device names, and then use those names directly."
2268 #: ../src/guestfs.pod:1109
2270 "Since those device names exist by definition, they will never be translated."
2274 #: ../src/guestfs.pod:1114
2276 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2277 "filesystem labels."
2281 #: ../src/guestfs.pod:1119
2286 #: ../src/guestfs.pod:1121
2288 "This section discusses security implications of using libguestfs, "
2289 "particularly with untrusted or malicious guests or disk images."
2293 #: ../src/guestfs.pod:1124
2294 msgid "GENERAL SECURITY CONSIDERATIONS"
2298 #: ../src/guestfs.pod:1126
2300 "Be careful with any files or data that you download from a guest (by "
2301 "\"download\" we mean not just the L</guestfs_download> command but any "
2302 "command that reads files, filenames, directories or anything else from a "
2303 "disk image). An attacker could manipulate the data to fool your program "
2304 "into doing the wrong thing. Consider cases such as:"
2308 #: ../src/guestfs.pod:1136
2309 msgid "the data (file etc) not being present"
2313 #: ../src/guestfs.pod:1140
2314 msgid "being present but empty"
2318 #: ../src/guestfs.pod:1144
2319 msgid "being much larger than normal"
2323 #: ../src/guestfs.pod:1148
2324 msgid "containing arbitrary 8 bit data"
2328 #: ../src/guestfs.pod:1152
2329 msgid "being in an unexpected character encoding"
2333 #: ../src/guestfs.pod:1156
2334 msgid "containing homoglyphs."
2338 #: ../src/guestfs.pod:1160
2339 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2343 #: ../src/guestfs.pod:1162
2345 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2346 "(VFS) module can sometimes be escalated into exploits by deliberately "
2347 "creating a malicious, malformed filesystem. These exploits are very severe "
2348 "for two reasons. Firstly there are very many filesystem drivers in the "
2349 "kernel, and many of them are infrequently used and not much developer "
2350 "attention has been paid to the code. Linux userspace helps potential "
2351 "crackers by detecting the filesystem type and automatically choosing the "
2352 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2353 "the administrator. Secondly, a kernel-level exploit is like a local root "
2354 "exploit (worse in some ways), giving immediate and total access to the "
2355 "system right down to the hardware level."
2359 #: ../src/guestfs.pod:1175
2361 "That explains why you should never mount a filesystem from an untrusted "
2362 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2363 "inside a qemu virtual machine, usually running as a non-root user. The "
2364 "attacker would need to write a filesystem which first exploited the kernel, "
2365 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2366 "the libguestfs protocol, and finally to be as serious as the host kernel "
2367 "exploit it would need to escalate its privileges to root. This multi-step "
2368 "escalation, performed by a static piece of data, is thought to be extremely "
2369 "hard to do, although we never say 'never' about security issues."
2373 #: ../src/guestfs.pod:1186
2375 "In any case callers can reduce the attack surface by forcing the filesystem "
2376 "type when mounting (use L</guestfs_mount_vfs>)."
2380 #: ../src/guestfs.pod:1189
2381 msgid "PROTOCOL SECURITY"
2385 #: ../src/guestfs.pod:1191
2387 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2388 "defined upper message size. However a program that uses libguestfs must "
2389 "also take care - for example you can write a program that downloads a binary "
2390 "from a disk image and executes it locally, and no amount of protocol "
2391 "security will save you from the consequences."
2395 #: ../src/guestfs.pod:1197
2396 msgid "INSPECTION SECURITY"
2400 #: ../src/guestfs.pod:1199
2402 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2403 "directly from the guest, and these could contain any 8 bit data. Callers "
2404 "should be careful to escape these before printing them to a structured file "
2405 "(for example, use HTML escaping if creating a web page)."
2409 #: ../src/guestfs.pod:1205
2411 "Guest configuration may be altered in unusual ways by the administrator of "
2412 "the virtual machine, and may not reflect reality (particularly for untrusted "
2413 "or actively malicious guests). For example we parse the hostname from "
2414 "configuration files like C</etc/sysconfig/network> that we find in the "
2415 "guest, but the guest administrator can easily manipulate these files to "
2416 "provide the wrong hostname."
2420 #: ../src/guestfs.pod:1213
2422 "The inspection API parses guest configuration using two external libraries: "
2423 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2424 "designed to be robust in the face of malicious data, although denial of "
2425 "service attacks are still possible, for example with oversized configuration "
2430 #: ../src/guestfs.pod:1219
2431 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2435 #: ../src/guestfs.pod:1221
2437 "Be very cautious about running commands from the guest. By running a "
2438 "command in the guest, you are giving CPU time to a binary that you do not "
2439 "control, under the same user account as the library, albeit wrapped in qemu "
2440 "virtualization. More information and alternatives can be found in the "
2441 "section L</RUNNING COMMANDS>."
2445 #: ../src/guestfs.pod:1227
2446 msgid "CVE-2010-3851"
2447 msgstr "CVE-2010-3851"
2450 #: ../src/guestfs.pod:1229
2451 msgid "https://bugzilla.redhat.com/642934"
2452 msgstr "https://bugzilla.redhat.com/642934"
2455 #: ../src/guestfs.pod:1231
2457 "This security bug concerns the automatic disk format detection that qemu "
2458 "does on disk images."
2462 #: ../src/guestfs.pod:1234
2464 "A raw disk image is just the raw bytes, there is no header. Other disk "
2465 "images like qcow2 contain a special header. Qemu deals with this by looking "
2466 "for one of the known headers, and if none is found then assuming the disk "
2467 "image must be raw."
2471 #: ../src/guestfs.pod:1239
2473 "This allows a guest which has been given a raw disk image to write some "
2474 "other header. At next boot (or when the disk image is accessed by "
2475 "libguestfs) qemu would do autodetection and think the disk image format was, "
2476 "say, qcow2 based on the header written by the guest."
2480 #: ../src/guestfs.pod:1244
2482 "This in itself would not be a problem, but qcow2 offers many features, one "
2483 "of which is to allow a disk image to refer to another image (called the "
2484 "\"backing disk\"). It does this by placing the path to the backing disk "
2485 "into the qcow2 header. This path is not validated and could point to any "
2486 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2487 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2488 "control of the attacker."
2492 #: ../src/guestfs.pod:1252
2494 "In libguestfs this is rather hard to exploit except under two circumstances:"
2498 #: ../src/guestfs.pod:1259
2499 msgid "You have enabled the network or have opened the disk in write mode."
2503 #: ../src/guestfs.pod:1263
2505 "You are also running untrusted code from the guest (see L</RUNNING "
2510 #: ../src/guestfs.pod:1268
2512 "The way to avoid this is to specify the expected disk format when adding "
2513 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2514 "should always do this if the disk is raw format, and it's a good idea for "
2519 #: ../src/guestfs.pod:1273
2521 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2522 "format is fetched from libvirt and passed through."
2526 #: ../src/guestfs.pod:1276
2528 "For libguestfs tools, use the I<--format> command line parameter as "
2533 #: ../src/guestfs.pod:1279
2534 msgid "CONNECTION MANAGEMENT"
2538 #: ../src/guestfs.pod:1281
2543 #: ../src/guestfs.pod:1283
2545 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2546 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2547 "handle and release all resources used."
2551 #: ../src/guestfs.pod:1287
2553 "For information on using multiple handles and threads, see the section L</"
2554 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2558 #: ../src/guestfs.pod:1290
2559 msgid "guestfs_create"
2563 #: ../src/guestfs.pod:1292
2566 " guestfs_h *guestfs_create (void);\n"
2571 #: ../src/guestfs.pod:1294
2572 msgid "Create a connection handle."
2576 #: ../src/guestfs.pod:1296
2578 "On success this returns a non-NULL pointer to a handle. On error it returns "
2583 #: ../src/guestfs.pod:1299
2585 "You have to \"configure\" the handle after creating it. This includes "
2586 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2587 "handle at least once."
2591 #: ../src/guestfs.pod:1303
2592 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2596 #: ../src/guestfs.pod:1305
2598 "You may also want to configure error handling for the handle. See the L</"
2599 "ERROR HANDLING> section below."
2603 #: ../src/guestfs.pod:1308
2604 msgid "guestfs_close"
2608 #: ../src/guestfs.pod:1310
2611 " void guestfs_close (guestfs_h *g);\n"
2616 #: ../src/guestfs.pod:1312
2617 msgid "This closes the connection handle and frees up all resources used."
2621 #: ../src/guestfs.pod:1314
2623 "If autosync was set on the handle and the handle was launched, then this "
2624 "implicitly calls various functions to unmount filesystems and sync the "
2625 "disk. See L</guestfs_set_autosync> for more details."
2629 #: ../src/guestfs.pod:1318
2630 msgid "If a close callback was set on the handle, then it is called."
2634 #: ../src/guestfs.pod:1320
2635 msgid "ERROR HANDLING"
2636 msgstr "ОБРОБКА ПОМИЛОК"
2639 #: ../src/guestfs.pod:1322
2641 "API functions can return errors. For example, almost all functions that "
2642 "return C<int> will return C<-1> to indicate an error."
2646 #: ../src/guestfs.pod:1325
2648 "Additional information is available for errors: an error message string and "
2649 "optionally an error number (errno) if the thing that failed was a system "
2654 #: ../src/guestfs.pod:1329
2656 "You can get at the additional information about the last error on the handle "
2657 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2658 "up an error handler with L</guestfs_set_error_handler>."
2662 #: ../src/guestfs.pod:1334
2664 "When the handle is created, a default error handler is installed which "
2665 "prints the error message string to C<stderr>. For small short-running "
2666 "command line programs it is sufficient to do:"
2670 #: ../src/guestfs.pod:1338
2673 " if (guestfs_launch (g) == -1)\n"
2674 " exit (EXIT_FAILURE);\n"
2679 #: ../src/guestfs.pod:1341
2681 "since the default error handler will ensure that an error message has been "
2682 "printed to C<stderr> before the program exits."
2686 #: ../src/guestfs.pod:1344
2688 "For other programs the caller will almost certainly want to install an "
2689 "alternate error handler or do error handling in-line like this:"
2693 #: ../src/guestfs.pod:1347
2696 " g = guestfs_create ();\n"
2701 #: ../src/guestfs.pod:1349
2704 " /* This disables the default behaviour of printing errors\n"
2706 " guestfs_set_error_handler (g, NULL, NULL);\n"
2711 #: ../src/guestfs.pod:1353
2714 " if (guestfs_launch (g) == -1) {\n"
2715 " /* Examine the error message and print it etc. */\n"
2716 " char *msg = guestfs_last_error (g);\n"
2717 " int errnum = guestfs_last_errno (g);\n"
2718 " fprintf (stderr, \"%s\\n\", msg);\n"
2725 #: ../src/guestfs.pod:1361
2727 "Out of memory errors are handled differently. The default action is to call "
2728 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2729 "guestfs_set_out_of_memory_handler>."
2733 #: ../src/guestfs.pod:1365
2735 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2736 "because there is no handle if this happens there is no way to get additional "
2737 "error information. However L</guestfs_create> is supposed to be a "
2738 "lightweight operation which can only fail because of insufficient memory (it "
2739 "returns NULL in this case)."
2743 #: ../src/guestfs.pod:1371
2744 msgid "guestfs_last_error"
2748 #: ../src/guestfs.pod:1373
2751 " const char *guestfs_last_error (guestfs_h *g);\n"
2756 #: ../src/guestfs.pod:1375
2758 "This returns the last error message that happened on C<g>. If there has not "
2759 "been an error since the handle was created, then this returns C<NULL>."
2763 #: ../src/guestfs.pod:1379
2765 "The lifetime of the returned string is until the next error occurs, or L</"
2766 "guestfs_close> is called."
2770 #: ../src/guestfs.pod:1382
2771 msgid "guestfs_last_errno"
2775 #: ../src/guestfs.pod:1384
2778 " int guestfs_last_errno (guestfs_h *g);\n"
2783 #: ../src/guestfs.pod:1386
2784 msgid "This returns the last error number (errno) that happened on C<g>."
2788 #: ../src/guestfs.pod:1388
2789 msgid "If successful, an errno integer not equal to zero is returned."
2793 #: ../src/guestfs.pod:1390
2795 "If no error, this returns 0. This call can return 0 in three situations:"
2799 #: ../src/guestfs.pod:1397
2800 msgid "There has not been any error on the handle."
2804 #: ../src/guestfs.pod:1401
2806 "There has been an error but the errno was meaningless. This corresponds to "
2807 "the case where the error did not come from a failed system call, but for "
2808 "some other reason."
2812 #: ../src/guestfs.pod:1407
2814 "There was an error from a failed system call, but for some reason the errno "
2815 "was not captured and returned. This usually indicates a bug in libguestfs."
2819 #: ../src/guestfs.pod:1413
2821 "Libguestfs tries to convert the errno from inside the applicance into a "
2822 "corresponding errno for the caller (not entirely trivial: the appliance "
2823 "might be running a completely different operating system from the library "
2824 "and error numbers are not standardized across Un*xen). If this could not be "
2825 "done, then the error is translated to C<EINVAL>. In practice this should "
2826 "only happen in very rare circumstances."
2830 #: ../src/guestfs.pod:1421
2831 msgid "guestfs_set_error_handler"
2835 #: ../src/guestfs.pod:1423
2838 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2840 " const char *msg);\n"
2841 " void guestfs_set_error_handler (guestfs_h *g,\n"
2842 " guestfs_error_handler_cb cb,\n"
2848 #: ../src/guestfs.pod:1430
2850 "The callback C<cb> will be called if there is an error. The parameters "
2851 "passed to the callback are an opaque data pointer and the error message "
2856 #: ../src/guestfs.pod:1434
2858 "C<errno> is not passed to the callback. To get that the callback must call "
2859 "L</guestfs_last_errno>."
2863 #: ../src/guestfs.pod:1437
2865 "Note that the message string C<msg> is freed as soon as the callback "
2866 "function returns, so if you want to stash it somewhere you must make your "
2871 #: ../src/guestfs.pod:1441
2872 msgid "The default handler prints messages on C<stderr>."
2876 #: ../src/guestfs.pod:1443
2877 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2881 #: ../src/guestfs.pod:1445
2882 msgid "guestfs_get_error_handler"
2886 #: ../src/guestfs.pod:1447
2889 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2890 " void **opaque_rtn);\n"
2895 #: ../src/guestfs.pod:1450
2896 msgid "Returns the current error handler callback."
2900 #: ../src/guestfs.pod:1452
2901 msgid "guestfs_set_out_of_memory_handler"
2905 #: ../src/guestfs.pod:1454
2908 " typedef void (*guestfs_abort_cb) (void);\n"
2909 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2910 " guestfs_abort_cb);\n"
2915 #: ../src/guestfs.pod:1458
2917 "The callback C<cb> will be called if there is an out of memory situation. "
2918 "I<Note this callback must not return>."
2922 #: ../src/guestfs.pod:1461
2923 msgid "The default is to call L<abort(3)>."
2927 #: ../src/guestfs.pod:1463
2929 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2933 #: ../src/guestfs.pod:1466
2934 msgid "guestfs_get_out_of_memory_handler"
2938 #: ../src/guestfs.pod:1468
2941 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2946 #: ../src/guestfs.pod:1470
2947 msgid "This returns the current out of memory handler."
2951 #: ../src/guestfs.pod:1472
2956 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
2961 #: ../src/guestfs.pod:1476
2966 #: ../src/guestfs.pod:1478
2971 #: ../src/guestfs.pod:1480
2972 msgid "AVAILABILITY"
2976 #: ../src/guestfs.pod:1482
2977 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2981 #: ../src/guestfs.pod:1484
2983 "Using L</guestfs_available> you can test availability of the following "
2984 "groups of functions. This test queries the appliance to see if the "
2985 "appliance you are currently using supports the functionality."
2989 #: ../src/guestfs.pod:1489
2990 msgid "@AVAILABILITY@"
2994 #: ../src/guestfs.pod:1491
2995 msgid "GUESTFISH supported COMMAND"
2999 #: ../src/guestfs.pod:1493
3001 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3002 "prints out the available groups and whether they are supported by this build "
3003 "of libguestfs. Note however that you have to do C<run> first."
3007 #: ../src/guestfs.pod:1498
3008 msgid "SINGLE CALLS AT COMPILE TIME"
3012 #: ../src/guestfs.pod:1500
3014 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3015 "function, such as:"
3019 #: ../src/guestfs.pod:1503
3022 " #define LIBGUESTFS_HAVE_DD 1\n"
3027 #: ../src/guestfs.pod:1505
3028 msgid "if L</guestfs_dd> is available."
3032 #: ../src/guestfs.pod:1507
3034 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3035 "function is available at compile time, we recommended using build tools such "
3036 "as autoconf or cmake. For example in autotools you could use:"
3040 #: ../src/guestfs.pod:1512
3043 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3044 " AC_CHECK_FUNCS([guestfs_dd])\n"
3049 #: ../src/guestfs.pod:1515
3051 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3056 #: ../src/guestfs.pod:1518
3057 msgid "SINGLE CALLS AT RUN TIME"
3061 #: ../src/guestfs.pod:1520
3063 "Testing at compile time doesn't guarantee that a function really exists in "
3064 "the library. The reason is that you might be dynamically linked against a "
3065 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3066 "This situation unfortunately results in a segmentation fault, which is a "
3067 "shortcoming of the C dynamic linking system itself."
3071 #: ../src/guestfs.pod:1527
3073 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3074 "in this example program (note that you still need the compile time check as "
3079 #: ../src/guestfs.pod:1531
3082 " #include <stdio.h>\n"
3083 " #include <stdlib.h>\n"
3084 " #include <unistd.h>\n"
3085 " #include <dlfcn.h>\n"
3086 " #include <guestfs.h>\n"
3091 #: ../src/guestfs.pod:1537
3096 " #ifdef LIBGUESTFS_HAVE_DD\n"
3098 " int has_function;\n"
3103 #: ../src/guestfs.pod:1543
3106 " /* Test if the function guestfs_dd is really available. */\n"
3107 " dl = dlopen (NULL, RTLD_LAZY);\n"
3109 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3110 " exit (EXIT_FAILURE);\n"
3112 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3118 #: ../src/guestfs.pod:1552
3121 " if (!has_function)\n"
3122 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3124 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3125 " /* Now it's safe to call\n"
3126 " guestfs_dd (g, \"foo\", \"bar\");\n"
3130 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3137 #: ../src/guestfs.pod:1565
3139 "You may think the above is an awful lot of hassle, and it is. There are "
3140 "other ways outside of the C linking system to ensure that this kind of "
3141 "incompatibility never arises, such as using package versioning:"
3145 #: ../src/guestfs.pod:1570
3148 " Requires: libguestfs >= 1.0.80\n"
3153 #: ../src/guestfs.pod:1572
3154 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3158 #: ../src/guestfs.pod:1574
3160 "A recent feature of the API is the introduction of calls which take optional "
3161 "arguments. In C these are declared 3 ways. The main way is as a call which "
3162 "takes variable arguments (ie. C<...>), as in this example:"
3166 #: ../src/guestfs.pod:1579
3169 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3174 #: ../src/guestfs.pod:1581
3176 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3177 "call with no optional arguments specified:"
3181 #: ../src/guestfs.pod:1584
3184 " guestfs_add_drive_opts (g, filename, -1);\n"
3189 #: ../src/guestfs.pod:1586
3190 msgid "With a single optional argument:"
3194 #: ../src/guestfs.pod:1588
3197 " guestfs_add_drive_opts (g, filename,\n"
3198 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3204 #: ../src/guestfs.pod:1592
3209 #: ../src/guestfs.pod:1594
3212 " guestfs_add_drive_opts (g, filename,\n"
3213 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3214 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3220 #: ../src/guestfs.pod:1599
3222 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3227 #: ../src/guestfs.pod:1602
3228 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3232 #: ../src/guestfs.pod:1604
3234 "The second variant has the same name with the suffix C<_va>, which works the "
3235 "same way but takes a C<va_list>. See the C manual for details. For the "
3236 "example function, this is declared:"
3240 #: ../src/guestfs.pod:1608
3243 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3249 #: ../src/guestfs.pod:1611
3250 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3254 #: ../src/guestfs.pod:1613
3256 "The third variant is useful where you need to construct these calls. You "
3257 "pass in a structure where you fill in the optional fields. The structure "
3258 "has a bitmask as the first element which you must set to indicate which "
3259 "fields you have filled in. For our example function the structure and call "
3264 #: ../src/guestfs.pod:1619
3267 " struct guestfs_add_drive_opts_argv {\n"
3268 " uint64_t bitmask;\n"
3270 " const char *format;\n"
3273 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3274 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3279 #: ../src/guestfs.pod:1628
3280 msgid "You could call it like this:"
3284 #: ../src/guestfs.pod:1630
3287 " struct guestfs_add_drive_opts_argv optargs = {\n"
3288 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3289 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3291 " .format = \"qcow2\"\n"
3297 #: ../src/guestfs.pod:1637
3300 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3305 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3306 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:9
3307 #: ../fish/guestfish-actions.pod:1265 ../tools/virt-win-reg.pl:532
3312 #: ../src/guestfs.pod:1645
3313 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3317 #: ../src/guestfs.pod:1650
3318 msgid "You do not need to fill in all fields of the structure."
3322 #: ../src/guestfs.pod:1654
3324 "There must be a one-to-one correspondence between fields of the structure "
3325 "that are filled in, and bits set in the bitmask."
3329 #: ../src/guestfs.pod:1659
3330 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3334 #: ../src/guestfs.pod:1661
3336 "In other languages, optional arguments are expressed in the way that is "
3337 "natural for that language. We refer you to the language-specific "
3338 "documentation for more details on that."
3342 #: ../src/guestfs.pod:1665
3343 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3347 #: ../src/guestfs.pod:1667
3348 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3352 #: ../src/guestfs.pod:1669
3354 "B<Note:> This section documents the generic event mechanism introduced in "
3355 "libguestfs 1.10, which you should use in new code if possible. The old "
3356 "functions C<guestfs_set_log_message_callback>, "
3357 "C<guestfs_set_subprocess_quit_callback>, "
3358 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3359 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3360 "page. Because of the ABI guarantee, the old functions continue to work."
3364 #: ../src/guestfs.pod:1678
3366 "Handles generate events when certain things happen, such as log messages "
3367 "being generated, progress messages during long-running operations, or the "
3368 "handle being closed. The API calls described below let you register a "
3369 "callback to be called when events happen. You can register multiple "
3370 "callbacks (for the same, different or overlapping sets of events), and "
3371 "individually remove callbacks. If callbacks are not removed, then they "
3372 "remain in force until the handle is closed."
3376 #: ../src/guestfs.pod:1686
3378 "In the current implementation, events are only generated synchronously: that "
3379 "means that events (and hence callbacks) can only happen while you are in the "
3380 "middle of making another libguestfs call. The callback is called in the "
3385 #: ../src/guestfs.pod:1691
3387 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3388 "unsigned integers, or a message buffer. Payloads are discussed later on."
3392 #: ../src/guestfs.pod:1695
3393 msgid "CLASSES OF EVENTS"
3397 #: ../src/guestfs.pod:1699
3398 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3402 #: ../src/guestfs.pod:1702
3404 "The callback function will be called while the handle is being closed "
3405 "(synchronously from L</guestfs_close>)."
3409 #: ../src/guestfs.pod:1705
3411 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3412 "handles that are open when the program exits. This means that this callback "
3413 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3414 "problems in higher-level languages (eg. if your HLL interpreter has already "
3415 "been cleaned up by the time this is called, and if your callback then jumps "
3416 "into some HLL function)."
3420 #: ../src/guestfs.pod:1712
3422 "If no callback is registered: the handle is closed without any callback "
3427 #: ../src/guestfs.pod:1715
3428 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3432 #: ../src/guestfs.pod:1718
3434 "The callback function will be called when the child process quits, either "
3435 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3436 "corresponds to a transition from any state to the CONFIG state)."
3440 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3441 msgid "If no callback is registered: the event is ignored."
3445 #: ../src/guestfs.pod:1724
3446 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3450 #: ../src/guestfs.pod:1727
3452 "The callback function will be called when the child process becomes ready "
3453 "first time after it has been launched. (This corresponds to a transition "
3454 "from LAUNCHING to the READY state)."
3458 #: ../src/guestfs.pod:1733
3459 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3463 #: ../src/guestfs.pod:1736
3465 "Some long-running operations can generate progress messages. If this "
3466 "callback is registered, then it will be called each time a progress message "
3467 "is generated (usually two seconds after the operation started, and three "
3468 "times per second thereafter until it completes, although the frequency may "
3469 "change in future versions)."
3473 #: ../src/guestfs.pod:1742
3475 "The callback receives in the payload four unsigned 64 bit numbers which are "
3476 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3480 #: ../src/guestfs.pod:1745
3482 "The units of C<total> are not defined, although for some operations C<total> "
3483 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3484 "or megabytes), and C<position> may be the portion which has been transferred."
3488 #: ../src/guestfs.pod:1750
3489 msgid "The only defined and stable parts of the API are:"
3493 #: ../src/guestfs.pod:1756
3495 "The callback can display to the user some type of progress bar or indicator "
3496 "which shows the ratio of C<position>:C<total>."
3500 #: ../src/guestfs.pod:1761
3501 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3505 #: ../src/guestfs.pod:1765
3507 "If any progress notification is sent during a call, then a final progress "
3508 "notification is always sent when C<position> = C<total> (I<unless> the call "
3509 "fails with an error)."
3513 #: ../src/guestfs.pod:1769
3515 "This is to simplify caller code, so callers can easily set the progress "
3516 "indicator to \"100%\" at the end of the operation, without requiring special "
3517 "code to detect this case."
3521 #: ../src/guestfs.pod:1775
3523 "For some calls we are unable to estimate the progress of the call, but we "
3524 "can still generate progress messages to indicate activity. This is known as "
3525 "\"pulse mode\", and is directly supported by certain progress bar "
3526 "implementations (eg. GtkProgressBar)."
3530 #: ../src/guestfs.pod:1780
3532 "For these calls, zero or more progress messages are generated with "
3533 "C<position = 0> and C<total = 1>, followed by a final message with "
3534 "C<position = total = 1>."
3538 #: ../src/guestfs.pod:1784
3540 "As noted above, if the call fails with an error then the final message may "
3545 #: ../src/guestfs.pod:1789
3547 "The callback also receives the procedure number (C<proc_nr>) and serial "
3548 "number (C<serial>) of the call. These are only useful for debugging "
3549 "protocol issues, and the callback can normally ignore them. The callback "
3550 "may want to print these numbers in error messages or debugging messages."
3554 #: ../src/guestfs.pod:1795
3555 msgid "If no callback is registered: progress messages are discarded."
3559 #: ../src/guestfs.pod:1797
3560 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3564 #: ../src/guestfs.pod:1800
3566 "The callback function is called whenever a log message is generated by qemu, "
3567 "the appliance kernel, guestfsd (daemon), or utility programs."
3571 #: ../src/guestfs.pod:1803
3573 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3574 "guestfs_launch>) then additional debug messages are generated."
3578 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3580 "If no callback is registered: the messages are discarded unless the verbose "
3581 "flag is set in which case they are sent to stderr. You can override the "
3582 "printing of verbose messages to stderr by setting up a callback."
3586 #: ../src/guestfs.pod:1811
3587 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3591 #: ../src/guestfs.pod:1814
3593 "The callback function is called whenever a log message is generated by the "
3594 "library part of libguestfs."
3598 #: ../src/guestfs.pod:1817
3600 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3601 "messages are generated."
3605 #: ../src/guestfs.pod:1825
3606 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3610 #: ../src/guestfs.pod:1828
3612 "The callback function is called whenever a trace message is generated. This "
3613 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3617 #: ../src/guestfs.pod:1831
3619 "If no callback is registered: the messages are sent to stderr. You can "
3620 "override the printing of trace messages to stderr by setting up a callback."
3624 #: ../src/guestfs.pod:1837
3625 msgid "guestfs_set_event_callback"
3629 #: ../src/guestfs.pod:1839
3632 " int guestfs_set_event_callback (guestfs_h *g,\n"
3633 " guestfs_event_callback cb,\n"
3634 " uint64_t event_bitmask,\n"
3641 #: ../src/guestfs.pod:1845
3643 "This function registers a callback (C<cb>) for all event classes in the "
3648 #: ../src/guestfs.pod:1848
3650 "For example, to register for all log message events, you could call this "
3651 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3652 "To register a single callback for all possible classes of events, use "
3653 "C<GUESTFS_EVENT_ALL>."
3657 #: ../src/guestfs.pod:1854
3658 msgid "C<flags> should always be passed as 0."
3662 #: ../src/guestfs.pod:1856
3664 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3665 "it for any purpose."
3669 #: ../src/guestfs.pod:1859
3671 "The return value is the event handle (an integer) which you can use to "
3672 "delete the callback (see below)."
3676 #: ../src/guestfs.pod:1862
3678 "If there is an error, this function returns C<-1>, and sets the error in the "
3679 "handle in the usual way (see L</guestfs_last_error> etc.)"
3683 #: ../src/guestfs.pod:1865
3685 "Callbacks remain in effect until they are deleted, or until the handle is "
3690 #: ../src/guestfs.pod:1868
3692 "In the case where multiple callbacks are registered for a particular event "
3693 "class, all of the callbacks are called. The order in which multiple "
3694 "callbacks are called is not defined."
3698 #: ../src/guestfs.pod:1872
3699 msgid "guestfs_delete_event_callback"
3703 #: ../src/guestfs.pod:1874
3706 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3711 #: ../src/guestfs.pod:1876
3713 "Delete a callback that was previously registered. C<event_handle> should be "
3714 "the integer that was returned by a previous call to "
3715 "C<guestfs_set_event_callback> on the same handle."
3719 #: ../src/guestfs.pod:1880
3720 msgid "guestfs_event_callback"
3724 #: ../src/guestfs.pod:1882
3727 " typedef void (*guestfs_event_callback) (\n"
3730 " uint64_t event,\n"
3731 " int event_handle,\n"
3733 " const char *buf, size_t buf_len,\n"
3734 " const uint64_t *array, size_t array_len);\n"
3739 #: ../src/guestfs.pod:1891
3741 "This is the type of the event callback function that you have to provide."
3745 #: ../src/guestfs.pod:1894
3747 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3748 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3749 "handle, and C<flags> which in the current API you should ignore."
3753 #: ../src/guestfs.pod:1898
3755 "The remaining parameters contain the event payload (if any). Each event may "
3756 "contain a payload, which usually relates to the event class, but for future "
3757 "proofing your code should be written to handle any payload for any event "
3762 #: ../src/guestfs.pod:1903
3764 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3765 "there is no message buffer). Note that this message buffer can contain "
3766 "arbitrary 8 bit data, including NUL bytes."
3770 #: ../src/guestfs.pod:1907
3772 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3773 "moment this is only used for progress messages."
3777 #: ../src/guestfs.pod:1910
3778 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3782 #: ../src/guestfs.pod:1912
3784 "One motivation for the generic event API was to allow GUI programs to "
3785 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3786 "unconditionally to C<stderr>."
3790 #: ../src/guestfs.pod:1916
3792 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3793 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3794 "messages are not events; you must capture error messages separately)."
3798 #: ../src/guestfs.pod:1921
3800 "Programs have to set up a callback to capture the classes of events of "
3805 #: ../src/guestfs.pod:1924
3809 " guestfs_set_event_callback\n"
3810 " (g, message_callback,\n"
3811 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3812 " GUESTFS_EVENT_TRACE,\n"
3813 " 0, NULL) == -1)\n"
3814 " if (eh == -1) {\n"
3815 " // handle error in the usual way\n"
3821 #: ../src/guestfs.pod:1934
3823 "The callback can then direct messages to the appropriate place. In this "
3824 "example, messages are directed to syslog:"
3828 #: ../src/guestfs.pod:1937
3832 " message_callback (\n"
3835 " uint64_t event,\n"
3836 " int event_handle,\n"
3838 " const char *buf, size_t buf_len,\n"
3839 " const uint64_t *array, size_t array_len)\n"
3841 " const int priority = LOG_USER|LOG_INFO;\n"
3842 " if (buf_len > 0)\n"
3843 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3849 #: ../src/guestfs.pod:1952
3850 msgid "PRIVATE DATA AREA"
3854 #: ../src/guestfs.pod:1954
3856 "You can attach named pieces of private data to the libguestfs handle, fetch "
3857 "them by name, and walk over them, for the lifetime of the handle. This is "
3858 "called the private data area and is only available from the C API."
3862 #: ../src/guestfs.pod:1959
3863 msgid "To attach a named piece of data, use the following call:"
3867 #: ../src/guestfs.pod:1961
3870 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3875 #: ../src/guestfs.pod:1963
3877 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3878 "pointer (which can be C<NULL>). Any previous item with the same key is "
3883 #: ../src/guestfs.pod:1967
3885 "You can use any C<key> you want, but your key should I<not> start with an "
3886 "underscore character. Keys beginning with an underscore character are "
3887 "reserved for internal libguestfs purposes (eg. for implementing language "
3888 "bindings). It is recommended that you prefix the key with some unique "
3889 "string to avoid collisions with other users."
3893 #: ../src/guestfs.pod:1973
3894 msgid "To retrieve the pointer, use:"
3898 #: ../src/guestfs.pod:1975
3901 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3906 #: ../src/guestfs.pod:1977
3908 "This function returns C<NULL> if either no data is found associated with "
3909 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3914 #: ../src/guestfs.pod:1981
3916 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3917 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3918 "all. In particular, libguestfs does I<not> try to free the data when the "
3919 "handle is closed. If the data must be freed, then the caller must either "
3920 "free it before calling L</guestfs_close> or must set up a close callback to "
3921 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3925 #: ../src/guestfs.pod:1988
3926 msgid "To walk over all entries, use these two functions:"
3930 #: ../src/guestfs.pod:1990
3933 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3938 #: ../src/guestfs.pod:1992
3941 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3946 #: ../src/guestfs.pod:1994
3948 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3949 "not have any particular meaning -- keys are not returned in any defined "
3950 "order). A pointer to the key is returned in C<*key_rtn> and the "
3951 "corresponding data pointer is returned from the function. C<NULL> is "
3952 "returned if there are no keys stored in the handle."
3956 #: ../src/guestfs.pod:2000
3958 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3959 "value of this function is also C<NULL> is there are no further entries to "
3964 #: ../src/guestfs.pod:2004
3965 msgid "Notes about walking over entries:"
3969 #: ../src/guestfs.pod:2010
3971 "You must not call C<guestfs_set_private> while walking over the entries."
3975 #: ../src/guestfs.pod:2015
3977 "The handle maintains an internal iterator which is reset when you call "
3978 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3979 "call C<guestfs_set_private>."
3983 #: ../src/guestfs.pod:2021
3984 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3988 #: ../src/guestfs.pod:2023
3991 " guestfs_set_private (g, key, NULL);\n"
3996 #: ../src/guestfs.pod:2025
3997 msgid "then that C<key> is not returned when walking."
4001 #: ../src/guestfs.pod:2029
4003 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4004 "C<guestfs_next_private> or C<guestfs_set_private>."
4008 #: ../src/guestfs.pod:2035
4010 "The following example code shows how to print all keys and data pointers "
4011 "that are associated with the handle C<g>:"
4015 #: ../src/guestfs.pod:2038
4018 " const char *key;\n"
4019 " void *data = guestfs_first_private (g, &key);\n"
4020 " while (data != NULL)\n"
4022 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4023 " data = guestfs_next_private (g, &key);\n"
4029 #: ../src/guestfs.pod:2046
4031 "More commonly you are only interested in keys that begin with an application-"
4032 "specific prefix C<foo_>. Modify the loop like so:"
4036 #: ../src/guestfs.pod:2049
4039 " const char *key;\n"
4040 " void *data = guestfs_first_private (g, &key);\n"
4041 " while (data != NULL)\n"
4043 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4044 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4045 " data = guestfs_next_private (g, &key);\n"
4051 #: ../src/guestfs.pod:2058
4053 "If you need to modify keys while walking, then you have to jump back to the "
4054 "beginning of the loop. For example, to delete all keys prefixed with "
4059 #: ../src/guestfs.pod:2062
4062 " const char *key;\n"
4065 " data = guestfs_first_private (g, &key);\n"
4066 " while (data != NULL)\n"
4068 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4070 " guestfs_set_private (g, key, NULL);\n"
4071 " /* note that 'key' pointer is now invalid, and so is\n"
4072 " the internal iterator */\n"
4075 " data = guestfs_next_private (g, &key);\n"
4081 #: ../src/guestfs.pod:2078
4083 "Note that the above loop is guaranteed to terminate because the keys are "
4084 "being deleted, but other manipulations of keys within the loop might not "
4085 "terminate unless you also maintain an indication of which keys have been "
4090 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4095 #: ../src/guestfs.pod:2085
4097 "<!-- old anchor for the next section --> <a name="
4098 "\"state_machine_and_low_level_event_api\"/>"
4100 "<!-- old anchor for the next section --> <a name="
4101 "\"state_machine_and_low_level_event_api\"/>"
4104 #: ../src/guestfs.pod:2090
4105 msgid "ARCHITECTURE"
4106 msgstr "АРХІТЕКТУРА"
4109 #: ../src/guestfs.pod:2092
4111 "Internally, libguestfs is implemented by running an appliance (a special "
4112 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4113 "process of the main program."
4117 #: ../src/guestfs.pod:2096
4120 " ___________________\n"
4122 " | main program |\n"
4124 " | | child process / appliance\n"
4125 " | | __________________________\n"
4127 " +-------------------+ RPC | +-----------------+ |\n"
4128 " | libguestfs <--------------------> guestfsd | |\n"
4129 " | | | +-----------------+ |\n"
4130 " \\___________________/ | | Linux kernel | |\n"
4131 " | +--^--------------+ |\n"
4132 " \\_________|________________/\n"
4138 " \\______________/\n"
4143 #: ../src/guestfs.pod:2116
4145 "The library, linked to the main program, creates the child process and hence "
4146 "the appliance in the L</guestfs_launch> function."
4150 #: ../src/guestfs.pod:2119
4152 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4153 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4154 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4155 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4156 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4157 "attached to the qemu process which translates device access by the "
4158 "appliance's Linux kernel into accesses to the image."
4162 #: ../src/guestfs.pod:2128
4164 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4165 "Although the disk image you are attached to might also be used by some "
4166 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4167 "care if both libguestfs's qemu process and your virtual machine are trying "
4168 "to update the disk image at the same time, since these usually results in "
4169 "massive disk corruption)."
4173 #: ../src/guestfs.pod:2135
4174 msgid "STATE MACHINE"
4175 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4178 #: ../src/guestfs.pod:2137
4179 msgid "libguestfs uses a state machine to model the child process:"
4183 #: ../src/guestfs.pod:2139
4195 " / | \\ \\ guestfs_launch\n"
4196 " / | _\\__V______\n"
4198 " / | | LAUNCHING |\n"
4199 " / | \\___________/\n"
4201 " / | guestfs_launch\n"
4203 " ______ / __|____V\n"
4204 " / \\ ------> / \\\n"
4205 " | BUSY | | READY |\n"
4206 " \\______/ <------ \\________/\n"
4211 #: ../src/guestfs.pod:2161
4213 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4214 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4215 "(3) alternating between READY and BUSY as commands are issued to, and "
4216 "carried out by, the child process."
4220 #: ../src/guestfs.pod:2166
4222 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4223 "asynchronously at any time (eg. due to some internal error), and that causes "
4224 "the state to transition back to CONFIG."
4228 #: ../src/guestfs.pod:2170
4230 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4231 "issued when in the CONFIG state."
4235 #: ../src/guestfs.pod:2173
4237 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4238 "L</guestfs_launch> blocks until the child process is READY to accept "
4239 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4240 "moves the state from CONFIG to LAUNCHING while it is running."
4244 #: ../src/guestfs.pod:2179
4246 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4247 "state. These API calls block waiting for the command to be carried out (ie. "
4248 "the state to transition to BUSY and then back to READY). There are no non-"
4249 "blocking versions, and no way to issue more than one command per handle at "
4254 #: ../src/guestfs.pod:2185
4256 "Finally, the child process sends asynchronous messages back to the main "
4257 "program, such as kernel log messages. You can register a callback to "
4258 "receive these messages."
4262 #: ../src/guestfs.pod:2189
4267 #: ../src/guestfs.pod:2191
4268 msgid "COMMUNICATION PROTOCOL"
4272 #: ../src/guestfs.pod:2193
4274 "Don't rely on using this protocol directly. This section documents how it "
4275 "currently works, but it may change at any time."
4279 #: ../src/guestfs.pod:2196
4281 "The protocol used to talk between the library and the daemon running inside "
4282 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4283 "1014, RFC 1832, RFC 4506)."
4287 #: ../src/guestfs.pod:2200
4289 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4290 "this file is automatically generated)."
4294 #: ../src/guestfs.pod:2203
4296 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4297 "and C<FileOut> parameters, which are handled with very simple request/reply "
4298 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4299 "parameters, which use the same request and reply messages, but they may also "
4300 "be followed by files sent using a chunked encoding."
4304 #: ../src/guestfs.pod:2210
4305 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4309 #: ../src/guestfs.pod:2212
4310 msgid "For ordinary functions, the request message is:"
4314 #: ../src/guestfs.pod:2214
4317 " total length (header + arguments,\n"
4318 " but not including the length word itself)\n"
4319 " struct guestfs_message_header (encoded as XDR)\n"
4320 " struct guestfs_<foo>_args (encoded as XDR)\n"
4325 #: ../src/guestfs.pod:2219
4327 "The total length field allows the daemon to allocate a fixed size buffer "
4328 "into which it slurps the rest of the message. As a result, the total length "
4329 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4330 "effective size of any request is limited to somewhere under this size."
4334 #: ../src/guestfs.pod:2225
4336 "Note also that many functions don't take any arguments, in which case the "
4337 "C<guestfs_I<foo>_args> is completely omitted."
4341 #: ../src/guestfs.pod:2228
4343 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4344 "receiver knows what type of args structure to expect, or none at all."
4348 #: ../src/guestfs.pod:2232
4350 "For functions that take optional arguments, the optional arguments are "
4351 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4352 "arguments. A bitmask in the header indicates which optional arguments are "
4353 "meaningful. The bitmask is also checked to see if it contains bits set "
4354 "which the daemon does not know about (eg. if more optional arguments were "
4355 "added in a later version of the library), and this causes the call to be "
4360 #: ../src/guestfs.pod:2240
4361 msgid "The reply message for ordinary functions is:"
4365 #: ../src/guestfs.pod:2242
4368 " total length (header + ret,\n"
4369 " but not including the length word itself)\n"
4370 " struct guestfs_message_header (encoded as XDR)\n"
4371 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4376 #: ../src/guestfs.pod:2247
4378 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4379 "functions that return no formal return values."
4383 #: ../src/guestfs.pod:2250
4385 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4389 #: ../src/guestfs.pod:2253
4391 "In the case of an error, a flag is set in the header, and the reply message "
4392 "is slightly changed:"
4396 #: ../src/guestfs.pod:2256
4399 " total length (header + error,\n"
4400 " but not including the length word itself)\n"
4401 " struct guestfs_message_header (encoded as XDR)\n"
4402 " struct guestfs_message_error (encoded as XDR)\n"
4407 #: ../src/guestfs.pod:2261
4409 "The C<guestfs_message_error> structure contains the error message as a "
4414 #: ../src/guestfs.pod:2264
4415 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4419 #: ../src/guestfs.pod:2266
4421 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4422 "The normal request message is sent (see above). However this is followed by "
4423 "a sequence of file chunks."
4427 #: ../src/guestfs.pod:2270
4430 " total length (header + arguments,\n"
4431 " but not including the length word itself,\n"
4432 " and not including the chunks)\n"
4433 " struct guestfs_message_header (encoded as XDR)\n"
4434 " struct guestfs_<foo>_args (encoded as XDR)\n"
4435 " sequence of chunks for FileIn param #0\n"
4436 " sequence of chunks for FileIn param #1 etc.\n"
4441 #: ../src/guestfs.pod:2278
4442 msgid "The \"sequence of chunks\" is:"
4446 #: ../src/guestfs.pod:2280
4449 " length of chunk (not including length word itself)\n"
4450 " struct guestfs_chunk (encoded as XDR)\n"
4451 " length of chunk\n"
4452 " struct guestfs_chunk (encoded as XDR)\n"
4454 " length of chunk\n"
4455 " struct guestfs_chunk (with data.data_len == 0)\n"
4460 #: ../src/guestfs.pod:2288
4462 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4463 "is set in the final chunk to indicate either successful completion or early "
4468 #: ../src/guestfs.pod:2292
4470 "At time of writing there are no functions that have more than one FileIn "
4471 "parameter. However this is (theoretically) supported, by sending the "
4472 "sequence of chunks for each FileIn parameter one after another (from left to "
4477 #: ../src/guestfs.pod:2297
4479 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4480 "transfer. The library does this by sending a chunk with a special flag set "
4481 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4482 "RPC, does I<not> send any reply, and goes back to reading the next request."
4486 #: ../src/guestfs.pod:2303
4488 "The daemon may also cancel. It does this by writing a special word "
4489 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4490 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4491 "cancel chunk). The special word is chosen so that even if cancellation "
4492 "happens right at the end of the transfer (after the library has finished "
4493 "writing and has started listening for the reply), the \"spurious\" cancel "
4494 "flag will not be confused with the reply message."
4498 #: ../src/guestfs.pod:2312
4500 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4501 "limit), and also files where the size is not known in advance (eg. from "
4502 "pipes or sockets). However the chunks are rather small "
4503 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4504 "to keep much in memory."
4508 #: ../src/guestfs.pod:2318
4509 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4513 #: ../src/guestfs.pod:2320
4515 "The protocol for FileOut parameters is exactly the same as for FileIn "
4516 "parameters, but with the roles of daemon and library reversed."
4520 #: ../src/guestfs.pod:2323
4523 " total length (header + ret,\n"
4524 " but not including the length word itself,\n"
4525 " and not including the chunks)\n"
4526 " struct guestfs_message_header (encoded as XDR)\n"
4527 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4528 " sequence of chunks for FileOut param #0\n"
4529 " sequence of chunks for FileOut param #1 etc.\n"
4534 #: ../src/guestfs.pod:2331
4535 msgid "INITIAL MESSAGE"
4539 #: ../src/guestfs.pod:2333
4541 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4542 "which indicates that the guest and daemon is alive. This is what L</"
4543 "guestfs_launch> waits for."
4547 #: ../src/guestfs.pod:2337
4548 msgid "PROGRESS NOTIFICATION MESSAGES"
4552 #: ../src/guestfs.pod:2339
4554 "The daemon may send progress notification messages at any time. These are "
4555 "distinguished by the normal length word being replaced by "
4556 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4560 #: ../src/guestfs.pod:2343
4562 "The library turns them into progress callbacks (see L</"
4563 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4568 #: ../src/guestfs.pod:2347
4570 "The daemon self-limits the frequency of progress messages it sends (see "
4571 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4576 #: ../src/guestfs.pod:2351
4577 msgid "LIBGUESTFS VERSION NUMBERS"
4581 #: ../src/guestfs.pod:2353
4583 "Since April 2010, libguestfs has started to make separate development and "
4584 "stable releases, along with corresponding branches in our git repository. "
4585 "These separate releases can be identified by version number:"
4589 #: ../src/guestfs.pod:2358
4592 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4593 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4599 " | `-------- sub-version\n"
4601 " `------ always '1' because we don't change the ABI\n"
4606 #: ../src/guestfs.pod:2369
4607 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4611 #: ../src/guestfs.pod:2371
4613 "As time passes we cherry pick fixes from the development branch and backport "
4614 "those into the stable branch, the effect being that the stable branch should "
4615 "get more stable and less buggy over time. So the stable releases are ideal "
4616 "for people who don't need new features but would just like the software to "
4621 #: ../src/guestfs.pod:2377
4622 msgid "Our criteria for backporting changes are:"
4626 #: ../src/guestfs.pod:2383
4628 "Documentation changes which don't affect any code are backported unless the "
4629 "documentation refers to a future feature which is not in stable."
4633 #: ../src/guestfs.pod:2389
4635 "Bug fixes which are not controversial, fix obvious problems, and have been "
4636 "well tested are backported."
4640 #: ../src/guestfs.pod:2394
4642 "Simple rearrangements of code which shouldn't affect how it works get "
4643 "backported. This is so that the code in the two branches doesn't get too "
4644 "far out of step, allowing us to backport future fixes more easily."
4648 #: ../src/guestfs.pod:2400
4650 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4651 "exceptional case: the new feature is required in order to implement an "
4652 "important bug fix."
4656 #: ../src/guestfs.pod:2406
4658 "A new stable branch starts when we think the new features in development are "
4659 "substantial and compelling enough over the current stable branch to warrant "
4660 "it. When that happens we create new stable and development versions 1.N.0 "
4661 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4662 "stable at this point, but by backporting fixes from development, that branch "
4663 "will stabilize over time."
4667 #: ../src/guestfs.pod:2414
4668 msgid "EXTENDING LIBGUESTFS"
4672 #: ../src/guestfs.pod:2416
4673 msgid "ADDING A NEW API ACTION"
4677 #: ../src/guestfs.pod:2418
4679 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4680 "documentation) are generated, and this makes it easy to extend the "
4685 #: ../src/guestfs.pod:2422
4686 msgid "To add a new API action there are two changes:"
4690 #: ../src/guestfs.pod:2428
4692 "You need to add a description of the call (name, parameters, return type, "
4693 "tests, documentation) to C<generator/generator_actions.ml>."
4697 #: ../src/guestfs.pod:2431
4699 "There are two sorts of API action, depending on whether the call goes "
4700 "through to the daemon in the appliance, or is serviced entirely by the "
4701 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4702 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4703 "an example of the latter, since a trace flag is maintained in the handle and "
4704 "all tracing is done on the library side."
4708 #: ../src/guestfs.pod:2439
4710 "Most new actions are of the first type, and get added to the "
4711 "C<daemon_functions> list. Each function has a unique procedure number used "
4712 "in the RPC protocol which is assigned to that action when we publish "
4713 "libguestfs and cannot be reused. Take the latest procedure number and "
4718 #: ../src/guestfs.pod:2445
4720 "For library-only actions of the second type, add to the "
4721 "C<non_daemon_functions> list. Since these functions are serviced by the "
4722 "library and do not travel over the RPC mechanism to the daemon, these "
4723 "functions do not need a procedure number, and so the procedure number is set "
4728 #: ../src/guestfs.pod:2453
4729 msgid "Implement the action (in C):"
4733 #: ../src/guestfs.pod:2455
4735 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4736 "C<daemon/> directory."
4740 #: ../src/guestfs.pod:2458
4742 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4743 "(note: double underscore) in the C<src/> directory."
4747 #: ../src/guestfs.pod:2461
4748 msgid "In either case, use another function as an example of what to do."
4752 #: ../src/guestfs.pod:2465
4753 msgid "After making these changes, use C<make> to compile."
4757 #: ../src/guestfs.pod:2467
4759 "Note that you don't need to implement the RPC, language bindings, manual "
4760 "pages or anything else. It's all automatically generated from the OCaml "
4765 #: ../src/guestfs.pod:2471
4766 msgid "ADDING TESTS FOR AN API ACTION"
4770 #: ../src/guestfs.pod:2473
4772 "You can supply zero or as many tests as you want per API call. The tests "
4773 "can either be added as part of the API description (C<generator/"
4774 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4775 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4776 "slower, so if possible use the first method."
4780 #: ../src/guestfs.pod:2479
4782 "The following describes the test environment used when you add an API test "
4783 "in C<generator_actions.ml>."
4787 #: ../src/guestfs.pod:2482
4788 msgid "The test environment has 4 block devices:"
4792 #: ../src/guestfs.pod:2486
4793 msgid "C</dev/sda> 500MB"
4797 #: ../src/guestfs.pod:2488
4798 msgid "General block device for testing."
4802 #: ../src/guestfs.pod:2490
4803 msgid "C</dev/sdb> 50MB"
4807 #: ../src/guestfs.pod:2492
4809 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4814 #: ../src/guestfs.pod:2495
4815 msgid "C</dev/sdc> 10MB"
4819 #: ../src/guestfs.pod:2497
4820 msgid "Used in a few tests where two block devices are needed."
4824 #: ../src/guestfs.pod:2499
4826 msgstr "C</dev/sdd>"
4829 #: ../src/guestfs.pod:2501
4830 msgid "ISO with fixed content (see C<images/test.iso>)."
4834 #: ../src/guestfs.pod:2505
4836 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4837 "appliance and block devices are reused between tests. So don't try testing "
4838 "L</guestfs_kill_subprocess> :-x"
4842 #: ../src/guestfs.pod:2509
4844 "Each test starts with an initial scenario, selected using one of the "
4845 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4846 "initialize the disks mentioned above in a particular way as documented in "
4847 "C<generator_types.ml>. You should not assume anything about the previous "
4848 "contents of other disks that are not initialized."
4852 #: ../src/guestfs.pod:2515
4854 "You can add a prerequisite clause to any individual test. This is a run-"
4855 "time check, which, if it fails, causes the test to be skipped. Useful if "
4856 "testing a command which might not work on all variations of libguestfs "
4857 "builds. A test that has prerequisite of C<Always> means to run "
4862 #: ../src/guestfs.pod:2521
4864 "In addition, packagers can skip individual tests by setting environment "
4865 "variables before running C<make check>."
4869 #: ../src/guestfs.pod:2524
4872 " SKIP_TEST_<CMD>_<NUM>=1\n"
4877 #: ../src/guestfs.pod:2526
4878 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4882 #: ../src/guestfs.pod:2528
4887 #: ../src/guestfs.pod:2530
4890 " SKIP_TEST_<CMD>=1\n"
4895 #: ../src/guestfs.pod:2532
4896 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4900 #: ../src/guestfs.pod:2534
4901 msgid "Packagers can run only certain tests by setting for example:"
4905 #: ../src/guestfs.pod:2536
4908 " TEST_ONLY=\"vfs_type zerofree\"\n"
4913 #: ../src/guestfs.pod:2538
4915 "See C<capitests/tests.c> for more details of how these environment variables "
4920 #: ../src/guestfs.pod:2541
4921 msgid "DEBUGGING NEW API ACTIONS"
4925 #: ../src/guestfs.pod:2543
4926 msgid "Test new actions work before submitting them."
4930 #: ../src/guestfs.pod:2545
4931 msgid "You can use guestfish to try out new commands."
4935 #: ../src/guestfs.pod:2547
4937 "Debugging the daemon is a problem because it runs inside a minimal "
4938 "environment. However you can fprintf messages in the daemon to stderr, and "
4939 "they will show up if you use C<guestfish -v>."
4943 #: ../src/guestfs.pod:2551
4944 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4948 #: ../src/guestfs.pod:2553
4950 "Our C source code generally adheres to some basic code-formatting "
4951 "conventions. The existing code base is not totally consistent on this "
4952 "front, but we do prefer that contributed code be formatted similarly. In "
4953 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4954 "indentation level, and other than that, follow the K&R style."
4958 #: ../src/guestfs.pod:2559
4960 "If you use Emacs, add the following to one of one of your start-up files (e."
4961 "g., ~/.emacs), to help ensure that you get indentation right:"
4965 #: ../src/guestfs.pod:2562
4968 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4969 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4970 " (add-hook 'find-file-hook\n"
4971 " '(lambda () (if (and buffer-file-name\n"
4972 " (string-match \"/libguestfs\\\\>\"\n"
4973 " (buffer-file-name))\n"
4974 " (not (string-equal mode-name \"Change Log\"))\n"
4975 " (not (string-equal mode-name \"Makefile\")))\n"
4976 " (setq indent-tabs-mode nil))))\n"
4981 #: ../src/guestfs.pod:2572
4984 " ;;; When editing C sources in libguestfs, use this style.\n"
4985 " (defun libguestfs-c-mode ()\n"
4986 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4988 " (c-set-style \"K&R\")\n"
4989 " (setq c-indent-level 2)\n"
4990 " (setq c-basic-offset 2))\n"
4991 " (add-hook 'c-mode-hook\n"
4992 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4993 " (buffer-file-name))\n"
4994 " (libguestfs-c-mode))))\n"
4999 #: ../src/guestfs.pod:2584
5000 msgid "Enable warnings when compiling (and fix any problems this finds):"
5004 #: ../src/guestfs.pod:2587
5007 " ./configure --enable-gcc-warnings\n"
5012 #: ../src/guestfs.pod:2589
5013 msgid "Useful targets are:"
5017 #: ../src/guestfs.pod:2591
5020 " make syntax-check # checks the syntax of the C code\n"
5021 " make check # runs the test suite\n"
5026 #: ../src/guestfs.pod:2594
5027 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5031 #: ../src/guestfs.pod:2596
5033 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5034 "which are used to do shell quoting."
5038 #: ../src/guestfs.pod:2601
5043 #: ../src/guestfs.pod:2603
5045 "Simple shell quoted string. Any spaces or other shell characters are "
5050 #: ../src/guestfs.pod:2606
5055 #: ../src/guestfs.pod:2608
5057 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5062 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5063 msgid "For example:"
5067 #: ../src/guestfs.pod:2615
5070 " asprintf (&cmd, \"cat %R\", path);\n"
5075 #: ../src/guestfs.pod:2617
5076 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5080 #: ../src/guestfs.pod:2619
5082 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5083 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5084 "they are not passed via the shell (instead, straight to exec). You probably "
5085 "want to use the C<sysroot_path()> function however."
5089 #: ../src/guestfs.pod:2625
5090 msgid "SUBMITTING YOUR NEW API ACTIONS"
5094 #: ../src/guestfs.pod:2627
5096 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5097 "libguestfs> and CC to L<rjones@redhat.com>."
5101 #: ../src/guestfs.pod:2631
5102 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5106 #: ../src/guestfs.pod:2633
5107 msgid "We support i18n (gettext anyhow) in the library."
5111 #: ../src/guestfs.pod:2635
5113 "However many messages come from the daemon, and we don't translate those at "
5114 "the moment. One reason is that the appliance generally has all locale files "
5115 "removed from it, because they take up a lot of space. So we'd have to readd "
5116 "some of those, as well as copying our PO files into the appliance."
5120 #: ../src/guestfs.pod:2641
5122 "Debugging messages are never translated, since they are intended for the "
5127 #: ../src/guestfs.pod:2644
5128 msgid "SOURCE CODE SUBDIRECTORIES"
5132 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5820
5133 #: ../fish/guestfish-actions.pod:3913
5134 msgid "C<appliance>"
5135 msgstr "C<appliance>"
5138 #: ../src/guestfs.pod:2650
5139 msgid "The libguestfs appliance, build scripts and so on."
5143 #: ../src/guestfs.pod:2652
5144 msgid "C<capitests>"
5145 msgstr "C<capitests>"
5148 #: ../src/guestfs.pod:2654
5149 msgid "Automated tests of the C API."
5153 #: ../src/guestfs.pod:2656
5158 #: ../src/guestfs.pod:2658
5160 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5165 #: ../src/guestfs.pod:2661
5170 #: ../src/guestfs.pod:2663
5171 msgid "Outside contributions, experimental parts."
5175 #: ../src/guestfs.pod:2665
5180 #: ../src/guestfs.pod:2667
5182 "The daemon that runs inside the libguestfs appliance and carries out actions."
5186 #: ../src/guestfs.pod:2670
5191 #: ../src/guestfs.pod:2672
5192 msgid "L<virt-df(1)> command and documentation."
5196 #: ../src/guestfs.pod:2674
5201 #: ../src/guestfs.pod:2676
5202 msgid "L<virt-edit(1)> command and documentation."
5206 #: ../src/guestfs.pod:2678
5208 msgstr "C<examples>"
5211 #: ../src/guestfs.pod:2680
5212 msgid "C API example code."
5213 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5216 #: ../src/guestfs.pod:2682
5221 #: ../src/guestfs.pod:2684
5223 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5224 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5225 "L<virt-tar-out(1)>."
5229 #: ../src/guestfs.pod:2688
5234 #: ../src/guestfs.pod:2690
5236 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5240 #: ../src/guestfs.pod:2692
5241 msgid "C<generator>"
5242 msgstr "C<generator>"
5245 #: ../src/guestfs.pod:2694
5247 "The crucially important generator, used to automatically generate large "
5248 "amounts of boilerplate C code for things like RPC and bindings."
5252 #: ../src/guestfs.pod:2697
5257 #: ../src/guestfs.pod:2699
5258 msgid "Files used by the test suite."
5262 #: ../src/guestfs.pod:2701
5263 msgid "Some \"phony\" guest images which we test against."
5267 #: ../src/guestfs.pod:2703
5268 msgid "C<inspector>"
5269 msgstr "C<inspector>"
5272 #: ../src/guestfs.pod:2705
5273 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5277 #: ../src/guestfs.pod:2707
5282 #: ../src/guestfs.pod:2709
5283 msgid "Logo used on the website. The fish is called Arthur by the way."
5287 #: ../src/guestfs.pod:2711
5292 #: ../src/guestfs.pod:2713
5293 msgid "M4 macros used by autoconf."
5297 #: ../src/guestfs.pod:2715
5302 #: ../src/guestfs.pod:2717
5303 msgid "Translations of simple gettext strings."
5304 msgstr "Переклади простих рядків gettext."
5307 #: ../src/guestfs.pod:2719
5312 #: ../src/guestfs.pod:2721
5314 "The build infrastructure and PO files for translations of manpages and POD "
5315 "files. Eventually this will be combined with the C<po> directory, but that "
5316 "is rather complicated."
5320 #: ../src/guestfs.pod:2725
5321 msgid "C<regressions>"
5322 msgstr "C<regressions>"
5325 #: ../src/guestfs.pod:2727
5326 msgid "Regression tests."
5327 msgstr "Тести на регресії."
5330 #: ../src/guestfs.pod:2729
5335 #: ../src/guestfs.pod:2731
5336 msgid "L<virt-rescue(1)> command and documentation."
5340 #: ../src/guestfs.pod:2733
5345 #: ../src/guestfs.pod:2735
5346 msgid "Source code to the C library."
5350 #: ../src/guestfs.pod:2737
5355 #: ../src/guestfs.pod:2739
5356 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5360 #: ../src/guestfs.pod:2741
5361 msgid "C<test-tool>"
5362 msgstr "C<test-tool>"
5365 #: ../src/guestfs.pod:2743
5367 "Test tool for end users to test if their qemu/kernel combination will work "
5372 #: ../src/guestfs.pod:2746
5377 #: ../src/guestfs.pod:2748
5382 #: ../src/guestfs.pod:2750
5387 #: ../src/guestfs.pod:2752
5392 #: ../src/guestfs.pod:2754
5397 #: ../src/guestfs.pod:2756
5402 #: ../src/guestfs.pod:2758
5407 #: ../src/guestfs.pod:2760
5412 #: ../src/guestfs.pod:2762
5413 msgid "Language bindings."
5414 msgstr "Прив’язки до мов програмування."
5417 #: ../src/guestfs.pod:2766
5422 #: ../src/guestfs.pod:2768
5423 msgid "PROTOCOL LIMITS"
5427 #: ../src/guestfs.pod:2770
5429 "Internally libguestfs uses a message-based protocol to pass API calls and "
5430 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5431 "plenty more detail about this). The maximum message size used by the "
5432 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5433 "aware of this limit. The API calls which may be affected are individually "
5434 "documented, with a link back to this section of the documentation."
5438 #: ../src/guestfs.pod:2778
5440 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5441 "a simple string. Because this string is at some point internally encoded as "
5442 "a message, the maximum size that it can return is slightly under 4 MB. If "
5443 "the requested file is larger than this then you will get an error."
5447 #: ../src/guestfs.pod:2784
5449 "In order to transfer large files into and out of the guest filesystem, you "
5450 "need to use particular calls that support this. The sections L</UPLOADING> "
5451 "and L</DOWNLOADING> document how to do this."
5455 #: ../src/guestfs.pod:2788
5457 "You might also consider mounting the disk image using our FUSE filesystem "
5458 "support (L<guestmount(1)>)."
5462 #: ../src/guestfs.pod:2791
5463 msgid "MAXIMUM NUMBER OF DISKS"
5467 #: ../src/guestfs.pod:2793
5468 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5472 #: ../src/guestfs.pod:2796
5474 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5475 "slots. However febootstrap only understands disks with names C</dev/vda> "
5476 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5481 #: ../src/guestfs.pod:2801
5483 "We are working to substantially raise this limit in future versions but it "
5484 "requires complex changes to qemu."
5488 #: ../src/guestfs.pod:2804
5490 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5491 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5492 "requires changes to qemu."
5496 #: ../src/guestfs.pod:2808
5497 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5501 #: ../src/guestfs.pod:2810
5502 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5506 #: ../src/guestfs.pod:2812
5508 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5509 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5513 #: ../src/guestfs.pod:2815
5515 "If you attach a disk with more than 15 partitions, the extra partitions are "
5516 "ignored by libguestfs."
5520 #: ../src/guestfs.pod:2818
5521 msgid "MAXIMUM SIZE OF A DISK"
5525 #: ../src/guestfs.pod:2820
5526 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5530 #: ../src/guestfs.pod:2822
5532 "We have tested block devices up to 1 exabyte (2**60 or "
5533 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5538 #: ../src/guestfs.pod:2826
5540 "Although libguestfs probably does not impose any limit, the underlying host "
5541 "storage will. If you store disk images on a host ext4 filesystem, then the "
5542 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5543 "TB). If you store disk images as host logical volumes then you are limited "
5544 "by the maximum size of an LV."
5548 #: ../src/guestfs.pod:2832
5550 "For the hugest disk image files, we recommend using XFS on the host for "
5555 #: ../src/guestfs.pod:2835
5556 msgid "MAXIMUM SIZE OF A PARTITION"
5560 #: ../src/guestfs.pod:2837
5562 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5563 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5564 "address a partition located beyond 2 TB on the disk."
5568 #: ../src/guestfs.pod:2841
5570 "It is recommended that you use GPT partitions on disks which are larger than "
5571 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5572 "which are theoretically larger than the largest disk we could support."
5576 #: ../src/guestfs.pod:2846
5577 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5581 #: ../src/guestfs.pod:2848
5583 "This depends on the filesystem type. libguestfs itself does not impose any "
5584 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5585 "what these limits are."
5589 #: ../src/guestfs.pod:2852
5590 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5594 #: ../src/guestfs.pod:2854
5596 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5597 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5598 "uploads and downloads."
5602 #: ../src/guestfs.pod:2858
5604 #| msgid "INSPECTION"
5605 msgid "INSPECTION LIMITS"
5609 #: ../src/guestfs.pod:2860
5611 "The inspection code has several arbitrary limits on things like the size of "
5612 "Windows Registry hive it will read, and the length of product name. These "
5613 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5614 "memory and disk space on the host, and should not be reached in practice. "
5615 "See the source code for more information."
5619 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017
5620 #: ../test-tool/libguestfs-test-tool.pod:82
5621 msgid "ENVIRONMENT VARIABLES"
5622 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5625 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1043
5626 msgid "LIBGUESTFS_APPEND"
5630 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1045
5631 msgid "Pass additional options to the guest kernel."
5635 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1047
5636 msgid "LIBGUESTFS_DEBUG"
5640 #: ../src/guestfs.pod:2876
5642 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5643 "effect as calling C<guestfs_set_verbose (g, 1)>."
5647 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
5648 msgid "LIBGUESTFS_MEMSIZE"
5652 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1054
5654 "Set the memory allocated to the qemu process, in megabytes. For example:"
5658 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
5661 " LIBGUESTFS_MEMSIZE=700\n"
5666 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
5667 msgid "LIBGUESTFS_PATH"
5671 #: ../src/guestfs.pod:2888
5673 "Set the path that libguestfs uses to search for a supermin appliance. See "
5674 "the discussion of paths in section L</PATH> above."
5678 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
5679 msgid "LIBGUESTFS_QEMU"
5683 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1066
5685 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5686 "which was found at compile time by the configure script is used."
5690 #: ../src/guestfs.pod:2897
5691 msgid "See also L</QEMU WRAPPERS> above."
5695 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1070
5696 msgid "LIBGUESTFS_TRACE"
5700 #: ../src/guestfs.pod:2901
5702 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5703 "effect as calling C<guestfs_set_trace (g, 1)>."
5707 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1079
5712 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1081
5714 "Location of temporary directory, defaults to C</tmp> except for the cached "
5715 "supermin appliance which defaults to C</var/tmp>."
5719 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
5721 "If libguestfs was compiled to use the supermin appliance then the real "
5722 "appliance is cached in this directory, shared between all handles belonging "
5723 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5724 "use in case C</var/tmp> is not large enough."
5728 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1151
5729 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:269
5730 #: ../tools/virt-win-reg.pl:572 ../tools/virt-list-filesystems.pl:189
5731 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5732 #: ../tools/virt-list-partitions.pl:257
5734 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5737 #: ../src/guestfs.pod:2919
5739 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5740 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5741 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5742 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5743 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5744 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5745 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5749 #: ../src/guestfs.pod:2946
5751 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5752 "(8)>, L<disktype(1)>."
5756 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:587
5757 #: ../tools/virt-make-fs.pl:553
5762 #: ../src/guestfs.pod:2955
5763 msgid "To get a list of bugs against libguestfs use this link:"
5765 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5769 #: ../src/guestfs.pod:2957
5771 "L<https://bugzilla.redhat.com/buglist.cgi?"
5772 "component=libguestfs&product=Virtualization+Tools>"
5774 "L<https://bugzilla.redhat.com/buglist.cgi?"
5775 "component=libguestfs&product=Virtualization+Tools>"
5778 #: ../src/guestfs.pod:2959
5779 msgid "To report a new bug against libguestfs use this link:"
5780 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5783 #: ../src/guestfs.pod:2961
5785 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5786 "component=libguestfs&product=Virtualization+Tools>"
5788 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5789 "component=libguestfs&product=Virtualization+Tools>"
5792 #: ../src/guestfs.pod:2963
5793 msgid "When reporting a bug, please check:"
5797 #: ../src/guestfs.pod:2969
5798 msgid "That the bug hasn't been reported already."
5802 #: ../src/guestfs.pod:2973
5803 msgid "That you are testing a recent version."
5807 #: ../src/guestfs.pod:2977
5808 msgid "Describe the bug accurately, and give a way to reproduce it."
5812 #: ../src/guestfs.pod:2981
5814 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5819 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1174
5820 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:280
5825 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1176
5826 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:282
5827 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5831 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1178
5832 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:284
5833 #: ../tools/virt-win-reg.pl:602 ../tools/virt-list-filesystems.pl:206
5834 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5835 #: ../tools/virt-list-partitions.pl:273
5837 msgstr "АВТОРСЬКІ ПРАВА"
5840 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1180
5841 #: ../test-tool/libguestfs-test-tool.pod:99
5842 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5846 #: ../src/guestfs.pod:2995
5848 "This library is free software; you can redistribute it and/or modify it "
5849 "under the terms of the GNU Lesser General Public License as published by the "
5850 "Free Software Foundation; either version 2 of the License, or (at your "
5851 "option) any later version."
5855 #: ../src/guestfs.pod:3000
5857 "This library is distributed in the hope that it will be useful, but WITHOUT "
5858 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5859 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5864 #: ../src/guestfs.pod:3005
5866 "You should have received a copy of the GNU Lesser General Public License "
5867 "along with this library; if not, write to the Free Software Foundation, "
5868 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5872 #: ../src/guestfs-actions.pod:1
5873 msgid "guestfs_add_cdrom"
5877 #: ../src/guestfs-actions.pod:3
5881 " guestfs_add_cdrom (guestfs_h *g,\n"
5882 " const char *filename);\n"
5887 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5888 msgid "This function adds a virtual CD-ROM disk image to the guest."
5892 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5893 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5897 #: ../src/guestfs-actions.pod:17
5899 "This call checks for the existence of C<filename>. This stops you from "
5900 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5901 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5906 #: ../src/guestfs-actions.pod:24
5908 "If you just want to add an ISO file (often you use this as an efficient way "
5909 "to transfer large files into the guest), then you should probably use "
5910 "C<guestfs_add_drive_ro> instead."
5914 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
5915 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5916 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5917 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5918 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5919 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5920 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5921 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5922 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
5923 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
5924 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
5925 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
5926 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
5927 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
5928 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
5929 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
5930 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
5931 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
5932 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1723
5933 #: ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:2272
5934 #: ../src/guestfs-actions.pod:2416 ../src/guestfs-actions.pod:2477
5935 #: ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:3465
5936 #: ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3505
5937 #: ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3674
5938 #: ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3701
5939 #: ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3752
5940 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3844
5941 #: ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3884
5942 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:3939
5943 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977
5944 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4024
5945 #: ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4076
5946 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104
5947 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4214
5948 #: ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4247
5949 #: ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4316
5950 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4350
5951 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4378
5952 #: ../src/guestfs-actions.pod:4395 ../src/guestfs-actions.pod:4410
5953 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4488
5954 #: ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4592
5955 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4630
5956 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4659
5957 #: ../src/guestfs-actions.pod:4672 ../src/guestfs-actions.pod:4687
5958 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4737
5959 #: ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4772
5960 #: ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4803
5961 #: ../src/guestfs-actions.pod:4852 ../src/guestfs-actions.pod:4889
5962 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4931
5963 #: ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4966
5964 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5157
5965 #: ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:5197
5966 #: ../src/guestfs-actions.pod:5229 ../src/guestfs-actions.pod:5295
5967 #: ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5325
5968 #: ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5628
5969 #: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5666
5970 #: ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5690
5971 #: ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5716
5972 #: ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:5746
5973 #: ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:5786
5974 #: ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5835
5975 #: ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:5874
5976 #: ../src/guestfs-actions.pod:5892 ../src/guestfs-actions.pod:5911
5977 #: ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5951
5978 #: ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:5996
5979 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6039
5980 #: ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6082
5981 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6116
5982 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6176
5983 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6310
5984 #: ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6443
5985 #: ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6469
5986 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504
5987 #: ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6530
5988 #: ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6604
5989 #: ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:6637
5990 #: ../src/guestfs-actions.pod:6653 ../src/guestfs-actions.pod:6670
5991 #: ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6703
5992 #: ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6753
5993 #: ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6807
5994 #: ../src/guestfs-actions.pod:6825 ../src/guestfs-actions.pod:6859
5995 #: ../src/guestfs-actions.pod:6895 ../src/guestfs-actions.pod:7014
5996 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7046
5997 #: ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7114
5998 #: ../src/guestfs-actions.pod:7159 ../src/guestfs-actions.pod:7192
5999 #: ../src/guestfs-actions.pod:7246 ../src/guestfs-actions.pod:7272
6000 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7357
6001 #: ../src/guestfs-actions.pod:7386
6002 msgid "This function returns 0 on success or -1 on error."
6006 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6007 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6008 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6010 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6015 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6016 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6017 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
6018 #: ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:7280
6019 #: ../src/guestfs-actions.pod:7449 ../fish/guestfish-actions.pod:31
6020 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6021 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1324
6022 #: ../fish/guestfish-actions.pod:1338 ../fish/guestfish-actions.pod:3013
6023 #: ../fish/guestfish-actions.pod:4871 ../fish/guestfish-actions.pod:4968
6025 "Deprecated functions will not be removed from the API, but the fact that "
6026 "they are deprecated indicates that there are problems with correct use of "
6031 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6032 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1922
6033 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:2123
6034 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3487
6035 #: ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:5853
6036 #: ../src/guestfs-actions.pod:5970 ../src/guestfs-actions.pod:6084
6037 #: ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6672
6038 #: ../src/guestfs-actions.pod:7194
6039 msgid "(Added in 0.3)"
6043 #: ../src/guestfs-actions.pod:41
6044 msgid "guestfs_add_domain"
6048 #: ../src/guestfs-actions.pod:43
6052 " guestfs_add_domain (guestfs_h *g,\n"
6053 " const char *dom,\n"
6059 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6060 #: ../src/guestfs-actions.pod:4449
6062 "You may supply a list of optional arguments to this call. Use zero or more "
6063 "of the following pairs of parameters, and terminate the list with C<-1> on "
6064 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6068 #: ../src/guestfs-actions.pod:53
6071 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6072 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6073 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6074 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6075 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6080 #: ../src/guestfs-actions.pod:59
6082 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6083 "It works by connecting to libvirt, requesting the domain and domain XML from "
6084 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6089 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6091 "The number of disks added is returned. This operation is atomic: if an "
6092 "error is returned, then no disks are added."
6096 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6098 "This function does some minimal checks to make sure the libvirt domain is "
6099 "not running (unless C<readonly> is true). In a future version we will try "
6100 "to acquire the libvirt lock on each disk."
6104 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6106 "Disks must be accessible locally. This often means that adding disks from a "
6107 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6108 "unless those disks are accessible via the same device path locally too."
6112 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6114 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6115 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6116 "libvirt URI (or one set through an environment variable, see the libvirt "
6117 "documentation for full details)."
6121 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6123 "The optional C<live> flag controls whether this call will try to connect to "
6124 "a running virtual machine C<guestfsd> process if it sees a suitable "
6125 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6126 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6127 "DAEMONS> for more information."
6131 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6133 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6134 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6135 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6140 #: ../src/guestfs-actions.pod:94
6142 "The other optional parameters are passed directly through to "
6143 "C<guestfs_add_drive_opts>."
6147 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6148 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6149 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6150 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6151 #: ../src/guestfs-actions.pod:1680 ../src/guestfs-actions.pod:1883
6152 #: ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2032
6153 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
6154 #: ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:2786
6155 #: ../src/guestfs-actions.pod:2807 ../src/guestfs-actions.pod:4875
6156 #: ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5409
6157 #: ../src/guestfs-actions.pod:5435 ../src/guestfs-actions.pod:6780
6158 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218
6159 #: ../src/guestfs-actions.pod:7231
6160 msgid "On error this function returns -1."
6164 #: ../src/guestfs-actions.pod:99
6165 msgid "(Added in 1.7.4)"
6169 #: ../src/guestfs-actions.pod:101
6170 msgid "guestfs_add_domain_va"
6174 #: ../src/guestfs-actions.pod:103
6178 " guestfs_add_domain_va (guestfs_h *g,\n"
6179 " const char *dom,\n"
6185 #: ../src/guestfs-actions.pod:108
6186 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6190 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6191 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6192 #: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4514
6193 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6197 #: ../src/guestfs-actions.pod:112
6198 msgid "guestfs_add_domain_argv"
6202 #: ../src/guestfs-actions.pod:114
6206 " guestfs_add_domain_argv (guestfs_h *g,\n"
6207 " const char *dom,\n"
6208 " const struct guestfs_add_domain_argv *optargs);\n"
6213 #: ../src/guestfs-actions.pod:119
6214 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6218 #: ../src/guestfs-actions.pod:123
6219 msgid "guestfs_add_drive"
6223 #: ../src/guestfs-actions.pod:125
6227 " guestfs_add_drive (guestfs_h *g,\n"
6228 " const char *filename);\n"
6233 #: ../src/guestfs-actions.pod:129
6235 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6236 "optional parameters, so the disk is added writable, with the format being "
6237 "detected automatically."
6241 #: ../src/guestfs-actions.pod:133
6243 "Automatic detection of the format opens you up to a potential security hole "
6244 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6245 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6246 "you should think about replacing calls to this function with calls to "
6247 "C<guestfs_add_drive_opts>, and specifying the format."
6251 #: ../src/guestfs-actions.pod:144
6252 msgid "guestfs_add_drive_opts"
6256 #: ../src/guestfs-actions.pod:146
6260 " guestfs_add_drive_opts (guestfs_h *g,\n"
6261 " const char *filename,\n"
6267 #: ../src/guestfs-actions.pod:156
6270 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6271 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6272 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6277 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6279 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6280 "The first time you call this function, the disk appears as C</dev/sda>, the "
6281 "second time as C</dev/sdb>, and so on."
6285 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6287 "You don't necessarily need to be root when using libguestfs. However you "
6288 "obviously do need sufficient permissions to access the filename for whatever "
6289 "operations you want to perform (ie. read access if you just want to read the "
6290 "image or write access if you want to modify the image)."
6294 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6295 msgid "This call checks that C<filename> exists."
6299 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4460
6300 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3024
6301 msgid "The optional arguments are:"
6305 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6307 msgstr "C<readonly>"
6310 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6312 "If true then the image is treated as read-only. Writes are still allowed, "
6313 "but they are stored in a temporary snapshot overlay which is discarded at "
6314 "the end. The disk that you add is not modified."
6318 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6323 #: ../src/guestfs-actions.pod:185
6325 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6326 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6327 "Possible formats include C<raw> and C<qcow2>."
6331 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6333 "Automatic detection of the format opens you up to a potential security hole "
6334 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6335 "RHBZ#642934. Specifying the format closes this security hole."
6339 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6344 #: ../src/guestfs-actions.pod:196
6346 "This rarely-used option lets you emulate the behaviour of the deprecated "
6347 "C<guestfs_add_drive_with_if> call (q.v.)"
6351 #: ../src/guestfs-actions.pod:203
6352 msgid "(Added in 1.5.23)"
6356 #: ../src/guestfs-actions.pod:205
6357 msgid "guestfs_add_drive_opts_va"
6361 #: ../src/guestfs-actions.pod:207
6365 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6366 " const char *filename,\n"
6372 #: ../src/guestfs-actions.pod:212
6373 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6377 #: ../src/guestfs-actions.pod:216
6378 msgid "guestfs_add_drive_opts_argv"
6382 #: ../src/guestfs-actions.pod:218
6386 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6387 " const char *filename,\n"
6388 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6393 #: ../src/guestfs-actions.pod:223
6394 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6398 #: ../src/guestfs-actions.pod:227
6399 msgid "guestfs_add_drive_ro"
6403 #: ../src/guestfs-actions.pod:229
6407 " guestfs_add_drive_ro (guestfs_h *g,\n"
6408 " const char *filename);\n"
6413 #: ../src/guestfs-actions.pod:233
6415 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6416 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6417 "disk is added read-only, with the format being detected automatically."
6421 #: ../src/guestfs-actions.pod:240
6422 msgid "(Added in 1.0.38)"
6426 #: ../src/guestfs-actions.pod:242
6427 msgid "guestfs_add_drive_ro_with_if"
6431 #: ../src/guestfs-actions.pod:244
6435 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6436 " const char *filename,\n"
6437 " const char *iface);\n"
6442 #: ../src/guestfs-actions.pod:249
6444 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6445 "QEMU interface emulation to use at run time."
6449 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6450 #: ../src/guestfs-actions.pod:2362
6451 msgid "(Added in 1.0.84)"
6455 #: ../src/guestfs-actions.pod:263
6456 msgid "guestfs_add_drive_with_if"
6460 #: ../src/guestfs-actions.pod:265
6464 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6465 " const char *filename,\n"
6466 " const char *iface);\n"
6471 #: ../src/guestfs-actions.pod:270
6473 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6474 "QEMU interface emulation to use at run time."
6478 #: ../src/guestfs-actions.pod:284
6479 msgid "guestfs_aug_clear"
6483 #: ../src/guestfs-actions.pod:286
6487 " guestfs_aug_clear (guestfs_h *g,\n"
6488 " const char *augpath);\n"
6493 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6495 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6496 "L<augtool(1)> C<clear> command."
6500 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2112
6501 msgid "(Added in 1.3.4)"
6505 #: ../src/guestfs-actions.pod:297
6506 msgid "guestfs_aug_close"
6510 #: ../src/guestfs-actions.pod:299
6514 " guestfs_aug_close (guestfs_h *g);\n"
6519 #: ../src/guestfs-actions.pod:302
6521 "Close the current Augeas handle and free up any resources used by it. After "
6522 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6523 "any other Augeas functions."
6527 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6528 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6529 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6530 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6531 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6532 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6533 #: ../src/guestfs-actions.pod:5486
6534 msgid "(Added in 0.7)"
6538 #: ../src/guestfs-actions.pod:311
6539 msgid "guestfs_aug_defnode"
6543 #: ../src/guestfs-actions.pod:313
6546 " struct guestfs_int_bool *\n"
6547 " guestfs_aug_defnode (guestfs_h *g,\n"
6548 " const char *name,\n"
6549 " const char *expr,\n"
6550 " const char *val);\n"
6555 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6557 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6561 #: ../src/guestfs-actions.pod:322
6563 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6564 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6565 "containing that single node."
6569 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6571 "On success this returns a pair containing the number of nodes in the "
6572 "nodeset, and a boolean flag if a node was created."
6576 #: ../src/guestfs-actions.pod:330
6578 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6579 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6583 #: ../src/guestfs-actions.pod:336
6584 msgid "guestfs_aug_defvar"
6588 #: ../src/guestfs-actions.pod:338
6592 " guestfs_aug_defvar (guestfs_h *g,\n"
6593 " const char *name,\n"
6594 " const char *expr);\n"
6599 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6601 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6602 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6606 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6608 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6609 "evaluates to something which is not a nodeset."
6613 #: ../src/guestfs-actions.pod:354
6614 msgid "guestfs_aug_get"
6618 #: ../src/guestfs-actions.pod:356
6622 " guestfs_aug_get (guestfs_h *g,\n"
6623 " const char *augpath);\n"
6628 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6630 "Look up the value associated with C<path>. If C<path> matches exactly one "
6631 "node, the C<value> is returned."
6635 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
6636 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
6637 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
6638 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
6639 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
6640 #: ../src/guestfs-actions.pod:1551 ../src/guestfs-actions.pod:1663
6641 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843
6642 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:1944
6643 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2135
6644 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2534
6645 #: ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2738
6646 #: ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2878
6647 #: ../src/guestfs-actions.pod:2909 ../src/guestfs-actions.pod:2933
6648 #: ../src/guestfs-actions.pod:2970 ../src/guestfs-actions.pod:3030
6649 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
6650 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3996
6651 #: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4276
6652 #: ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5214
6653 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5562
6654 #: ../src/guestfs-actions.pod:5611 ../src/guestfs-actions.pod:6223
6655 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6256
6656 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6954
6657 #: ../src/guestfs-actions.pod:6973 ../src/guestfs-actions.pod:6991
6658 #: ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7443
6660 "This function returns a string, or NULL on error. I<The caller must free "
6661 "the returned string after use>."
6665 #: ../src/guestfs-actions.pod:368
6666 msgid "guestfs_aug_init"
6670 #: ../src/guestfs-actions.pod:370
6674 " guestfs_aug_init (guestfs_h *g,\n"
6675 " const char *root,\n"
6681 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6683 "Create a new Augeas handle for editing configuration files. If there was "
6684 "any previous Augeas handle associated with this guestfs session, then it is "
6689 #: ../src/guestfs-actions.pod:379
6690 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6694 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6696 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6700 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6702 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6703 "logical I<or> of the following integers:"
6707 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6708 msgid "C<AUG_SAVE_BACKUP> = 1"
6709 msgstr "C<AUG_SAVE_BACKUP> = 1"
6712 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6713 msgid "Keep the original file with a C<.augsave> extension."
6717 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6718 msgid "C<AUG_SAVE_NEWFILE> = 2"
6719 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6722 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6724 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6725 "original. Overrides C<AUG_SAVE_BACKUP>."
6729 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6730 msgid "C<AUG_TYPE_CHECK> = 4"
6731 msgstr "C<AUG_TYPE_CHECK> = 4"
6734 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6735 msgid "Typecheck lenses (can be expensive)."
6739 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6740 msgid "C<AUG_NO_STDINC> = 8"
6741 msgstr "C<AUG_NO_STDINC> = 8"
6744 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6745 msgid "Do not use standard load path for modules."
6749 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6750 msgid "C<AUG_SAVE_NOOP> = 16"
6751 msgstr "C<AUG_SAVE_NOOP> = 16"
6754 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6755 msgid "Make save a no-op, just record what would have been changed."
6759 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6760 msgid "C<AUG_NO_LOAD> = 32"
6761 msgstr "C<AUG_NO_LOAD> = 32"
6764 #: ../src/guestfs-actions.pod:414
6765 msgid "Do not load the tree in C<guestfs_aug_init>."
6769 #: ../src/guestfs-actions.pod:418
6770 msgid "To close the handle, you can call C<guestfs_aug_close>."
6774 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6775 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6779 #: ../src/guestfs-actions.pod:426
6780 msgid "guestfs_aug_insert"
6784 #: ../src/guestfs-actions.pod:428
6788 " guestfs_aug_insert (guestfs_h *g,\n"
6789 " const char *augpath,\n"
6790 " const char *label,\n"
6796 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6798 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6799 "or after C<path> (depending on the boolean flag C<before>)."
6803 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6805 "C<path> must match exactly one existing node in the tree, and C<label> must "
6806 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6810 #: ../src/guestfs-actions.pod:446
6811 msgid "guestfs_aug_load"
6815 #: ../src/guestfs-actions.pod:448
6819 " guestfs_aug_load (guestfs_h *g);\n"
6824 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6825 msgid "Load files into the tree."
6826 msgstr "Завантажити файли до ієрархії."
6829 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6830 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6834 #: ../src/guestfs-actions.pod:460
6835 msgid "guestfs_aug_ls"
6839 #: ../src/guestfs-actions.pod:462
6843 " guestfs_aug_ls (guestfs_h *g,\n"
6844 " const char *augpath);\n"
6849 #: ../src/guestfs-actions.pod:466
6851 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6852 "sorting the resulting nodes into alphabetical order."
6856 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6857 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
6858 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
6859 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
6860 #: ../src/guestfs-actions.pod:1765 ../src/guestfs-actions.pod:2207
6861 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
6862 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309
6863 #: ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:2429
6864 #: ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2987
6865 #: ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3566
6866 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3733
6867 #: ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4836
6868 #: ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5482
6869 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:6296
6870 #: ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6412
6871 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6582
6872 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7084
6873 #: ../src/guestfs-actions.pod:7131 ../src/guestfs-actions.pod:7296
6874 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-actions.pod:7400
6875 #: ../src/guestfs-actions.pod:7419 ../src/guestfs-actions.pod:7465
6876 #: ../src/guestfs-actions.pod:7484
6878 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6879 ">), or NULL if there was an error. I<The caller must free the strings and "
6880 "the array after use>."
6884 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
6885 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
6886 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3385
6887 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4029
6888 #: ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4249
6889 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4840
6890 #: ../src/guestfs-actions.pod:5297 ../src/guestfs-actions.pod:5692
6891 #: ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5718
6892 #: ../src/guestfs-actions.pod:6158 ../src/guestfs-actions.pod:6796
6893 #: ../src/guestfs-actions.pod:6809 ../src/guestfs-actions.pod:7048
6894 #: ../src/guestfs-actions.pod:7284
6895 msgid "(Added in 0.8)"
6899 #: ../src/guestfs-actions.pod:475
6900 msgid "guestfs_aug_match"
6904 #: ../src/guestfs-actions.pod:477
6908 " guestfs_aug_match (guestfs_h *g,\n"
6909 " const char *augpath);\n"
6914 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6916 "Returns a list of paths which match the path expression C<path>. The "
6917 "returned paths are sufficiently qualified so that they match exactly one "
6918 "node in the current tree."
6922 #: ../src/guestfs-actions.pod:491
6923 msgid "guestfs_aug_mv"
6927 #: ../src/guestfs-actions.pod:493
6931 " guestfs_aug_mv (guestfs_h *g,\n"
6932 " const char *src,\n"
6933 " const char *dest);\n"
6938 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6940 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6941 "C<dest> is overwritten if it exists."
6945 #: ../src/guestfs-actions.pod:505
6946 msgid "guestfs_aug_rm"
6950 #: ../src/guestfs-actions.pod:507
6954 " guestfs_aug_rm (guestfs_h *g,\n"
6955 " const char *augpath);\n"
6960 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6961 msgid "Remove C<path> and all of its children."
6965 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6966 msgid "On success this returns the number of entries which were removed."
6970 #: ../src/guestfs-actions.pod:519
6971 msgid "guestfs_aug_save"
6975 #: ../src/guestfs-actions.pod:521
6979 " guestfs_aug_save (guestfs_h *g);\n"
6984 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6985 msgid "This writes all pending changes to disk."
6989 #: ../src/guestfs-actions.pod:526
6991 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6996 #: ../src/guestfs-actions.pod:533
6997 msgid "guestfs_aug_set"
7001 #: ../src/guestfs-actions.pod:535
7005 " guestfs_aug_set (guestfs_h *g,\n"
7006 " const char *augpath,\n"
7007 " const char *val);\n"
7012 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7013 msgid "Set the value associated with C<path> to C<val>."
7017 #: ../src/guestfs-actions.pod:542
7019 "In the Augeas API, it is possible to clear a node by setting the value to "
7020 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7021 "this call. Instead you must use the C<guestfs_aug_clear> call."
7025 #: ../src/guestfs-actions.pod:551
7026 msgid "guestfs_available"
7030 #: ../src/guestfs-actions.pod:553
7034 " guestfs_available (guestfs_h *g,\n"
7035 " char *const *groups);\n"
7040 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7042 "This command is used to check the availability of some groups of "
7043 "functionality in the appliance, which not all builds of the libguestfs "
7044 "appliance will be able to provide."
7048 #: ../src/guestfs-actions.pod:561
7050 "The libguestfs groups, and the functions that those groups correspond to, "
7051 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7052 "runtime by calling C<guestfs_available_all_groups>."
7056 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7058 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7059 "\"]> would check for the availability of the Linux inotify functions and "
7060 "Augeas (configuration file editing) functions."
7064 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7065 msgid "The command returns no error if I<all> requested groups are available."
7069 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7071 "It fails with an error if one or more of the requested groups is unavailable "
7076 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7078 "If an unknown group name is included in the list of groups then an error is "
7083 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7085 msgstr "I<Нотатки:>"
7088 #: ../src/guestfs-actions.pod:585
7089 msgid "You must call C<guestfs_launch> before calling this function."
7093 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7095 "The reason is because we don't know what groups are supported by the "
7096 "appliance/daemon until it is running and can be queried."
7100 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7102 "If a group of functions is available, this does not necessarily mean that "
7103 "they will work. You still have to check for errors when calling individual "
7104 "API functions even if they are available."
7108 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7110 "It is usually the job of distro packagers to build complete functionality "
7111 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7112 "with all requirements satisfied, will support everything."
7116 #: ../src/guestfs-actions.pod:607
7118 "This call was added in version C<1.0.80>. In previous versions of "
7119 "libguestfs all you could do would be to speculatively execute a command to "
7120 "find out if the daemon implemented it. See also C<guestfs_version>."
7124 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7125 msgid "(Added in 1.0.80)"
7129 #: ../src/guestfs-actions.pod:618
7130 msgid "guestfs_available_all_groups"
7134 #: ../src/guestfs-actions.pod:620
7138 " guestfs_available_all_groups (guestfs_h *g);\n"
7143 #: ../src/guestfs-actions.pod:623
7145 "This command returns a list of all optional groups that this daemon knows "
7146 "about. Note this returns both supported and unsupported groups. To find "
7147 "out which ones the daemon can actually support you have to call "
7148 "C<guestfs_available> on each member of the returned list."
7152 #: ../src/guestfs-actions.pod:629
7153 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7157 #: ../src/guestfs-actions.pod:635
7158 msgid "(Added in 1.3.15)"
7162 #: ../src/guestfs-actions.pod:637
7163 msgid "guestfs_base64_in"
7167 #: ../src/guestfs-actions.pod:639
7171 " guestfs_base64_in (guestfs_h *g,\n"
7172 " const char *base64file,\n"
7173 " const char *filename);\n"
7178 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7180 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7184 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7185 msgid "(Added in 1.3.5)"
7189 #: ../src/guestfs-actions.pod:651
7190 msgid "guestfs_base64_out"
7194 #: ../src/guestfs-actions.pod:653
7198 " guestfs_base64_out (guestfs_h *g,\n"
7199 " const char *filename,\n"
7200 " const char *base64file);\n"
7205 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7207 "This command downloads the contents of C<filename>, writing it out to local "
7208 "file C<base64file> encoded as base64."
7212 #: ../src/guestfs-actions.pod:665
7213 msgid "guestfs_blockdev_flushbufs"
7217 #: ../src/guestfs-actions.pod:667
7221 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7222 " const char *device);\n"
7227 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7229 "This tells the kernel to flush internal buffers associated with C<device>."
7233 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7234 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7235 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7236 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7237 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7238 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7239 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7240 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7241 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7242 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7243 msgid "This uses the L<blockdev(8)> command."
7247 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7248 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7249 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7250 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7251 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7252 msgid "(Added in 0.9.3)"
7256 #: ../src/guestfs-actions.pod:680
7257 msgid "guestfs_blockdev_getbsz"
7261 #: ../src/guestfs-actions.pod:682
7265 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7266 " const char *device);\n"
7271 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7272 msgid "This returns the block size of a device."
7276 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7277 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7279 "(Note this is different from both I<size in blocks> and I<filesystem block "
7284 #: ../src/guestfs-actions.pod:697
7285 msgid "guestfs_blockdev_getro"
7289 #: ../src/guestfs-actions.pod:699
7293 " guestfs_blockdev_getro (guestfs_h *g,\n"
7294 " const char *device);\n"
7299 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7301 "Returns a boolean indicating if the block device is read-only (true if read-"
7302 "only, false if not)."
7306 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7307 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1920
7308 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2003
7309 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2073
7310 #: ../src/guestfs-actions.pod:2098 ../src/guestfs-actions.pod:2121
7311 #: ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111
7312 #: ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3293
7313 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3322
7314 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3352
7315 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3383
7316 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3410
7317 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3439
7318 #: ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:4985
7319 msgid "This function returns a C truth value on success or -1 on error."
7323 #: ../src/guestfs-actions.pod:712
7324 msgid "guestfs_blockdev_getsize64"
7328 #: ../src/guestfs-actions.pod:714
7332 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7333 " const char *device);\n"
7338 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7339 msgid "This returns the size of the device in bytes."
7343 #: ../src/guestfs-actions.pod:720
7344 msgid "See also C<guestfs_blockdev_getsz>."
7348 #: ../src/guestfs-actions.pod:728
7349 msgid "guestfs_blockdev_getss"
7353 #: ../src/guestfs-actions.pod:730
7357 " guestfs_blockdev_getss (guestfs_h *g,\n"
7358 " const char *device);\n"
7363 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7365 "This returns the size of sectors on a block device. Usually 512, but can be "
7366 "larger for modern devices."
7370 #: ../src/guestfs-actions.pod:737
7372 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7377 #: ../src/guestfs-actions.pod:746
7378 msgid "guestfs_blockdev_getsz"
7382 #: ../src/guestfs-actions.pod:748
7386 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7387 " const char *device);\n"
7392 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7394 "This returns the size of the device in units of 512-byte sectors (even if "
7395 "the sectorsize isn't 512 bytes ... weird)."
7399 #: ../src/guestfs-actions.pod:755
7401 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7402 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7406 #: ../src/guestfs-actions.pod:765
7407 msgid "guestfs_blockdev_rereadpt"
7411 #: ../src/guestfs-actions.pod:767
7415 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7416 " const char *device);\n"
7421 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7422 msgid "Reread the partition table on C<device>."
7426 #: ../src/guestfs-actions.pod:779
7427 msgid "guestfs_blockdev_setbsz"
7431 #: ../src/guestfs-actions.pod:781
7435 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7436 " const char *device,\n"
7437 " int blocksize);\n"
7442 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7443 msgid "This sets the block size of a device."
7447 #: ../src/guestfs-actions.pod:797
7448 msgid "guestfs_blockdev_setro"
7452 #: ../src/guestfs-actions.pod:799
7456 " guestfs_blockdev_setro (guestfs_h *g,\n"
7457 " const char *device);\n"
7462 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7463 msgid "Sets the block device named C<device> to read-only."
7467 #: ../src/guestfs-actions.pod:811
7468 msgid "guestfs_blockdev_setrw"
7472 #: ../src/guestfs-actions.pod:813
7476 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7477 " const char *device);\n"
7482 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7483 msgid "Sets the block device named C<device> to read-write."
7487 #: ../src/guestfs-actions.pod:825
7488 msgid "guestfs_case_sensitive_path"
7492 #: ../src/guestfs-actions.pod:827
7496 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7497 " const char *path);\n"
7502 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7504 "This can be used to resolve case insensitive paths on a filesystem which is "
7505 "case sensitive. The use case is to resolve paths which you have read from "
7506 "Windows configuration files or the Windows Registry, to the true path."
7510 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7512 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7513 "(and probably others), which is that although the underlying filesystem is "
7514 "case-insensitive, the driver exports the filesystem to Linux as case-"
7519 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7521 "One consequence of this is that special directories such as C<c:\\windows> "
7522 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7523 "precise details of how they were created. In Windows itself this would not "
7528 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7530 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7535 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7537 "This function resolves the true case of each element in the path and returns "
7538 "the case-sensitive path."
7542 #: ../src/guestfs-actions.pod:853
7544 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7545 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7546 "how the directories were originally created under Windows)."
7550 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7551 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7555 #: ../src/guestfs-actions.pod:861
7556 msgid "See also C<guestfs_realpath>."
7560 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:6976
7561 msgid "(Added in 1.0.75)"
7565 #: ../src/guestfs-actions.pod:868
7570 #: ../src/guestfs-actions.pod:870
7574 " guestfs_cat (guestfs_h *g,\n"
7575 " const char *path);\n"
7580 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5472
7581 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3672
7582 msgid "Return the contents of the file named C<path>."
7586 #: ../src/guestfs-actions.pod:876
7588 "Note that this function cannot correctly handle binary files (specifically, "
7589 "files containing C<\\0> character which is treated as end of string). For "
7590 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7591 "functions which have a more complex interface."
7595 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
7596 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
7597 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
7598 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1769
7599 #: ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246
7600 #: ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313
7601 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2359
7602 #: ../src/guestfs-actions.pod:5254 ../src/guestfs-actions.pod:5280
7603 #: ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5437
7604 #: ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:6361
7605 #: ../src/guestfs-actions.pod:6416 ../src/guestfs-actions.pod:6562
7606 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:7248
7607 #: ../src/guestfs-actions.pod:7274 ../src/guestfs-actions.pod:7300
7608 #: ../src/guestfs-actions.pod:7319 ../src/guestfs-actions.pod:7404
7609 #: ../src/guestfs-actions.pod:7423 ../src/guestfs-actions.pod:7469
7610 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:592
7611 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7612 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7613 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7614 #: ../fish/guestfish-actions.pod:1197 ../fish/guestfish-actions.pod:1498
7615 #: ../fish/guestfish-actions.pod:1508 ../fish/guestfish-actions.pod:1536
7616 #: ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1561
7617 #: ../fish/guestfish-actions.pod:1580 ../fish/guestfish-actions.pod:3542
7618 #: ../fish/guestfish-actions.pod:3557 ../fish/guestfish-actions.pod:3633
7619 #: ../fish/guestfish-actions.pod:3650 ../fish/guestfish-actions.pod:3665
7620 #: ../fish/guestfish-actions.pod:4291 ../fish/guestfish-actions.pod:4337
7621 #: ../fish/guestfish-actions.pod:4422 ../fish/guestfish-actions.pod:4437
7622 #: ../fish/guestfish-actions.pod:4847 ../fish/guestfish-actions.pod:4865
7623 #: ../fish/guestfish-actions.pod:4882 ../fish/guestfish-actions.pod:4892
7624 #: ../fish/guestfish-actions.pod:4940 ../fish/guestfish-actions.pod:4950
7625 #: ../fish/guestfish-actions.pod:4979 ../fish/guestfish-actions.pod:4989
7627 "Because of the message protocol, there is a transfer limit of somewhere "
7628 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7632 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3570
7633 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3649
7634 #: ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:4142
7635 #: ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:5360
7636 #: ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:7135
7637 #: ../src/guestfs-actions.pod:7149
7638 msgid "(Added in 0.4)"
7642 #: ../src/guestfs-actions.pod:889
7643 msgid "guestfs_checksum"
7647 #: ../src/guestfs-actions.pod:891
7651 " guestfs_checksum (guestfs_h *g,\n"
7652 " const char *csumtype,\n"
7653 " const char *path);\n"
7658 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7660 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7664 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7666 "The type of checksum to compute is given by the C<csumtype> parameter which "
7667 "must have one of the following values:"
7671 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7676 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7678 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7683 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7688 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7689 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7693 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7698 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7699 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7703 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7708 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7709 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7713 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7718 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7719 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7723 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7728 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7729 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7733 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7738 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7739 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7743 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7744 msgid "The checksum is returned as a printable string."
7748 #: ../src/guestfs-actions.pod:937
7749 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7753 #: ../src/guestfs-actions.pod:939
7754 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7758 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
7759 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3309
7760 #: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3399
7761 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:6832
7762 msgid "(Added in 1.0.2)"
7766 #: ../src/guestfs-actions.pod:946
7767 msgid "guestfs_checksum_device"
7771 #: ../src/guestfs-actions.pod:948
7775 " guestfs_checksum_device (guestfs_h *g,\n"
7776 " const char *csumtype,\n"
7777 " const char *device);\n"
7782 #: ../src/guestfs-actions.pod:953
7784 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7785 "device named C<device>. For the types of checksums supported see the "
7786 "C<guestfs_checksum> command."
7790 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:4891
7791 #: ../src/guestfs-actions.pod:4950 ../src/guestfs-actions.pod:4987
7792 #: ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5181
7793 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:6755
7794 #: ../src/guestfs-actions.pod:7161
7795 msgid "(Added in 1.3.2)"
7799 #: ../src/guestfs-actions.pod:962
7800 msgid "guestfs_checksums_out"
7804 #: ../src/guestfs-actions.pod:964
7808 " guestfs_checksums_out (guestfs_h *g,\n"
7809 " const char *csumtype,\n"
7810 " const char *directory,\n"
7811 " const char *sumsfile);\n"
7816 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7818 "This command computes the checksums of all regular files in C<directory> and "
7819 "then emits a list of those checksums to the local output file C<sumsfile>."
7823 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7825 "This can be used for verifying the integrity of a virtual machine. However "
7826 "to be properly secure you should pay attention to the output of the checksum "
7827 "command (it uses the ones from GNU coreutils). In particular when the "
7828 "filename is not printable, coreutils uses a special backslash syntax. For "
7829 "more information, see the GNU coreutils info file."
7833 #: ../src/guestfs-actions.pod:984
7834 msgid "(Added in 1.3.7)"
7838 #: ../src/guestfs-actions.pod:986
7839 msgid "guestfs_chmod"
7843 #: ../src/guestfs-actions.pod:988
7847 " guestfs_chmod (guestfs_h *g,\n"
7849 " const char *path);\n"
7854 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7856 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7861 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7863 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7864 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7869 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4393
7870 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609
7871 #: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:681
7872 #: ../fish/guestfish-actions.pod:2988 ../fish/guestfish-actions.pod:3117
7873 #: ../fish/guestfish-actions.pod:3127 ../fish/guestfish-actions.pod:3137
7874 msgid "The mode actually set is affected by the umask."
7878 #: ../src/guestfs-actions.pod:1006
7879 msgid "guestfs_chown"
7883 #: ../src/guestfs-actions.pod:1008
7887 " guestfs_chown (guestfs_h *g,\n"
7890 " const char *path);\n"
7895 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7896 msgid "Change the file owner to C<owner> and group to C<group>."
7900 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3501
7901 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2446
7903 "Only numeric uid and gid are supported. If you want to use names, you will "
7904 "need to locate and parse the password file yourself (Augeas support makes "
7905 "this relatively easy)."
7909 #: ../src/guestfs-actions.pod:1024
7910 msgid "guestfs_command"
7914 #: ../src/guestfs-actions.pod:1026
7918 " guestfs_command (guestfs_h *g,\n"
7919 " char *const *arguments);\n"
7924 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7926 "This call runs a command from the guest filesystem. The filesystem must be "
7927 "mounted, and must contain a compatible operating system (ie. something "
7928 "Linux, with the same or compatible processor architecture)."
7932 #: ../src/guestfs-actions.pod:1035
7934 "The single parameter is an argv-style list of arguments. The first element "
7935 "is the name of the program to run. Subsequent elements are parameters. The "
7936 "list must be non-empty (ie. must contain a program name). Note that the "
7937 "command runs directly, and is I<not> invoked via the shell (see "
7942 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7943 msgid "The return value is anything printed to I<stdout> by the command."
7947 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7949 "If the command returns a non-zero exit status, then this function returns an "
7950 "error message. The error message string is the content of I<stderr> from "
7955 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7957 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7958 "bin>. If you require a program from another location, you should provide "
7959 "the full path in the first parameter."
7963 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7965 "Shared libraries and data files required by the program must be available on "
7966 "filesystems which are mounted in the correct places. It is the caller's "
7967 "responsibility to ensure all filesystems that are needed are mounted at the "
7972 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
7973 #: ../src/guestfs-actions.pod:1554
7974 msgid "(Added in 0.9.1)"
7978 #: ../src/guestfs-actions.pod:1068
7979 msgid "guestfs_command_lines"
7983 #: ../src/guestfs-actions.pod:1070
7987 " guestfs_command_lines (guestfs_h *g,\n"
7988 " char *const *arguments);\n"
7993 #: ../src/guestfs-actions.pod:1074
7995 "This is the same as C<guestfs_command>, but splits the result into a list of "
8000 #: ../src/guestfs-actions.pod:1077
8001 msgid "See also: C<guestfs_sh_lines>"
8005 #: ../src/guestfs-actions.pod:1088
8006 msgid "guestfs_config"
8010 #: ../src/guestfs-actions.pod:1090
8014 " guestfs_config (guestfs_h *g,\n"
8015 " const char *qemuparam,\n"
8016 " const char *qemuvalue);\n"
8021 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8023 "This can be used to add arbitrary qemu command line parameters of the form "
8024 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8025 "setting some parameters which would interfere with parameters that we use."
8029 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8030 msgid "The first character of C<param> string must be a C<-> (dash)."
8034 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8035 msgid "C<value> can be NULL."
8039 #: ../src/guestfs-actions.pod:1108
8040 msgid "guestfs_copy_size"
8044 #: ../src/guestfs-actions.pod:1110
8048 " guestfs_copy_size (guestfs_h *g,\n"
8049 " const char *src,\n"
8050 " const char *dest,\n"
8056 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8058 "This command copies exactly C<size> bytes from one source device or file "
8059 "C<src> to another destination device or file C<dest>."
8063 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8065 "Note this will fail if the source is too short or if the destination is not "
8070 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8071 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8072 #: ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:1725
8073 #: ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:6827
8074 #: ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:7340
8075 #: ../src/guestfs-actions.pod:7359
8077 "This long-running command can generate progress notification messages so "
8078 "that the caller can display a progress bar or indicator. To receive these "
8079 "messages, the caller must register a progress event callback. See L<guestfs"
8080 "(3)/GUESTFS_EVENT_PROGRESS>."
8084 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4169
8085 #: ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:7068
8086 #: ../src/guestfs-actions.pod:7088 ../src/guestfs-actions.pod:7174
8087 msgid "(Added in 1.0.87)"
8091 #: ../src/guestfs-actions.pod:1131
8096 #: ../src/guestfs-actions.pod:1133
8100 " guestfs_cp (guestfs_h *g,\n"
8101 " const char *src,\n"
8102 " const char *dest);\n"
8107 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8109 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8110 "destination filename or destination directory."
8114 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8115 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8116 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4854
8117 #: ../src/guestfs-actions.pod:5231
8118 msgid "(Added in 1.0.18)"
8122 #: ../src/guestfs-actions.pod:1145
8123 msgid "guestfs_cp_a"
8127 #: ../src/guestfs-actions.pod:1147
8131 " guestfs_cp_a (guestfs_h *g,\n"
8132 " const char *src,\n"
8133 " const char *dest);\n"
8138 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8140 "This copies a file or directory from C<src> to C<dest> recursively using the "
8145 #: ../src/guestfs-actions.pod:1159
8150 #: ../src/guestfs-actions.pod:1161
8154 " guestfs_dd (guestfs_h *g,\n"
8155 " const char *src,\n"
8156 " const char *dest);\n"
8161 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8163 "This command copies from one source device or file C<src> to another "
8164 "destination device or file C<dest>. Normally you would use this to copy to "
8165 "or from a device or partition, for example to duplicate a filesystem."
8169 #: ../src/guestfs-actions.pod:1171
8171 "If the destination is a device, it must be as large or larger than the "
8172 "source file or device, otherwise the copy will fail. This command cannot do "
8173 "partial copies (see C<guestfs_copy_size>)."
8177 #: ../src/guestfs-actions.pod:1179
8182 #: ../src/guestfs-actions.pod:1181
8186 " guestfs_df (guestfs_h *g);\n"
8191 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8192 msgid "This command runs the C<df> command to report disk space used."
8196 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8198 "This command is mostly useful for interactive sessions. It is I<not> "
8199 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8204 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8205 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2292
8206 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2384
8207 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4754
8208 #: ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6589
8209 #: ../src/guestfs-actions.pod:7207 ../src/guestfs-actions.pod:7220
8210 #: ../src/guestfs-actions.pod:7233
8211 msgid "(Added in 1.0.54)"
8215 #: ../src/guestfs-actions.pod:1195
8216 msgid "guestfs_df_h"
8220 #: ../src/guestfs-actions.pod:1197
8224 " guestfs_df_h (guestfs_h *g);\n"
8229 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
8231 "This command runs the C<df -h> command to report disk space used in human-"
8236 #: ../src/guestfs-actions.pod:1212
8237 msgid "guestfs_dmesg"
8241 #: ../src/guestfs-actions.pod:1214
8245 " guestfs_dmesg (guestfs_h *g);\n"
8250 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
8252 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8253 "This is sometimes useful for extended debugging of problems."
8257 #: ../src/guestfs-actions.pod:1221
8259 "Another way to get the same information is to enable verbose messages with "
8260 "C<guestfs_set_verbose> or by setting the environment variable "
8261 "C<LIBGUESTFS_DEBUG=1> before running the program."
8265 #: ../src/guestfs-actions.pod:1231
8266 msgid "guestfs_download"
8270 #: ../src/guestfs-actions.pod:1233
8274 " guestfs_download (guestfs_h *g,\n"
8275 " const char *remotefilename,\n"
8276 " const char *filename);\n"
8281 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
8282 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8284 "Download file C<remotefilename> and save it as C<filename> on the local "
8289 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6821
8290 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4595
8291 msgid "C<filename> can also be a named pipe."
8295 #: ../src/guestfs-actions.pod:1243
8296 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8300 #: ../src/guestfs-actions.pod:1254
8301 msgid "guestfs_download_offset"
8305 #: ../src/guestfs-actions.pod:1256
8309 " guestfs_download_offset (guestfs_h *g,\n"
8310 " const char *remotefilename,\n"
8311 " const char *filename,\n"
8312 " int64_t offset,\n"
8318 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
8320 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8321 "region must be within the file or device)."
8325 #: ../src/guestfs-actions.pod:1269
8327 "Note that there is no limit on the amount of data that can be downloaded "
8328 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8329 "full amount unless an error occurs."
8333 #: ../src/guestfs-actions.pod:1274
8334 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8338 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:6866
8339 msgid "(Added in 1.5.17)"
8343 #: ../src/guestfs-actions.pod:1285
8344 msgid "guestfs_drop_caches"
8348 #: ../src/guestfs-actions.pod:1287
8352 " guestfs_drop_caches (guestfs_h *g,\n"
8353 " int whattodrop);\n"
8358 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
8360 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8361 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8362 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8366 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
8367 msgid "Setting C<whattodrop> to 3 should drop everything."
8371 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
8373 "This automatically calls L<sync(2)> before the operation, so that the "
8374 "maximum guest memory is freed."
8378 #: ../src/guestfs-actions.pod:1305
8383 #: ../src/guestfs-actions.pod:1307
8387 " guestfs_du (guestfs_h *g,\n"
8388 " const char *path);\n"
8393 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
8395 "This command runs the C<du -s> command to estimate file space usage for "
8400 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8402 "C<path> can be a file or a directory. If C<path> is a directory then the "
8403 "estimate includes the contents of the directory and all subdirectories "
8408 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8410 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8414 #: ../src/guestfs-actions.pod:1330
8415 msgid "guestfs_e2fsck_f"
8419 #: ../src/guestfs-actions.pod:1332
8423 " guestfs_e2fsck_f (guestfs_h *g,\n"
8424 " const char *device);\n"
8429 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8431 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8432 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8437 #: ../src/guestfs-actions.pod:1340
8439 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8440 "Normally you should use C<guestfs_fsck>."
8444 #: ../src/guestfs-actions.pod:1345
8445 msgid "(Added in 1.0.29)"
8449 #: ../src/guestfs-actions.pod:1347
8450 msgid "guestfs_echo_daemon"
8454 #: ../src/guestfs-actions.pod:1349
8458 " guestfs_echo_daemon (guestfs_h *g,\n"
8459 " char *const *words);\n"
8464 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8466 "This command concatenates the list of C<words> passed with single spaces "
8467 "between them and returns the resulting string."
8471 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8472 msgid "You can use this command to test the connection through to the daemon."
8476 #: ../src/guestfs-actions.pod:1358
8477 msgid "See also C<guestfs_ping_daemon>."
8481 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2100
8482 #: ../src/guestfs-actions.pod:6065
8483 msgid "(Added in 1.0.69)"
8487 #: ../src/guestfs-actions.pod:1365
8488 msgid "guestfs_egrep"
8492 #: ../src/guestfs-actions.pod:1367
8496 " guestfs_egrep (guestfs_h *g,\n"
8497 " const char *regex,\n"
8498 " const char *path);\n"
8503 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8505 "This calls the external C<egrep> program and returns the matching lines."
8509 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
8510 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
8511 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2230
8512 #: ../src/guestfs-actions.pod:2249 ../src/guestfs-actions.pod:2405
8513 #: ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2433
8514 #: ../src/guestfs-actions.pod:2479 ../src/guestfs-actions.pod:2501
8515 #: ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:3662
8516 #: ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:3689
8517 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:4689
8518 #: ../src/guestfs-actions.pod:5565 ../src/guestfs-actions.pod:5614
8519 #: ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6445
8520 #: ../src/guestfs-actions.pod:6458 ../src/guestfs-actions.pod:6471
8521 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506
8522 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6532
8523 #: ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7322
8524 #: ../src/guestfs-actions.pod:7407 ../src/guestfs-actions.pod:7426
8525 #: ../src/guestfs-actions.pod:7472 ../src/guestfs-actions.pod:7491
8526 msgid "(Added in 1.0.66)"
8530 #: ../src/guestfs-actions.pod:1384
8531 msgid "guestfs_egrepi"
8535 #: ../src/guestfs-actions.pod:1386
8539 " guestfs_egrepi (guestfs_h *g,\n"
8540 " const char *regex,\n"
8541 " const char *path);\n"
8546 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8548 "This calls the external C<egrep -i> program and returns the matching lines."
8552 #: ../src/guestfs-actions.pod:1403
8553 msgid "guestfs_equal"
8557 #: ../src/guestfs-actions.pod:1405
8561 " guestfs_equal (guestfs_h *g,\n"
8562 " const char *file1,\n"
8563 " const char *file2);\n"
8568 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8570 "This compares the two files C<file1> and C<file2> and returns true if their "
8571 "content is exactly equal, or false otherwise."
8575 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8576 msgid "The external L<cmp(1)> program is used for the comparison."
8580 #: ../src/guestfs-actions.pod:1419
8581 msgid "guestfs_exists"
8585 #: ../src/guestfs-actions.pod:1421
8589 " guestfs_exists (guestfs_h *g,\n"
8590 " const char *path);\n"
8595 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8597 "This returns C<true> if and only if there is a file, directory (or anything) "
8598 "with the given C<path> name."
8602 #: ../src/guestfs-actions.pod:1428
8603 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8607 #: ../src/guestfs-actions.pod:1434
8608 msgid "guestfs_fallocate"
8612 #: ../src/guestfs-actions.pod:1436
8616 " guestfs_fallocate (guestfs_h *g,\n"
8617 " const char *path,\n"
8623 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
8624 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8626 "This command preallocates a file (containing zero bytes) named C<path> of "
8627 "size C<len> bytes. If the file exists already, it is overwritten."
8631 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8633 "Do not confuse this with the guestfish-specific C<alloc> command which "
8634 "allocates a file in the host and attaches it as a device."
8638 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8640 "This function is deprecated. In new code, use the C<fallocate64> call "
8645 #: ../src/guestfs-actions.pod:1460
8646 msgid "guestfs_fallocate64"
8650 #: ../src/guestfs-actions.pod:1462
8654 " guestfs_fallocate64 (guestfs_h *g,\n"
8655 " const char *path,\n"
8661 #: ../src/guestfs-actions.pod:1471
8663 "Note that this call allocates disk blocks for the file. To create a sparse "
8664 "file use C<guestfs_truncate_size> instead."
8668 #: ../src/guestfs-actions.pod:1474
8670 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8671 "oversight it only allowed 30 bit lengths to be specified, effectively "
8672 "limiting the maximum size of files created through that call to 1GB."
8676 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8678 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8679 "commands which create a file in the host and attach it as a device."
8683 #: ../src/guestfs-actions.pod:1485
8684 msgid "(Added in 1.3.17)"
8688 #: ../src/guestfs-actions.pod:1487
8689 msgid "guestfs_fgrep"
8693 #: ../src/guestfs-actions.pod:1489
8697 " guestfs_fgrep (guestfs_h *g,\n"
8698 " const char *pattern,\n"
8699 " const char *path);\n"
8704 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8706 "This calls the external C<fgrep> program and returns the matching lines."
8710 #: ../src/guestfs-actions.pod:1506
8711 msgid "guestfs_fgrepi"
8715 #: ../src/guestfs-actions.pod:1508
8719 " guestfs_fgrepi (guestfs_h *g,\n"
8720 " const char *pattern,\n"
8721 " const char *path);\n"
8726 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8728 "This calls the external C<fgrep -i> program and returns the matching lines."
8732 #: ../src/guestfs-actions.pod:1525
8733 msgid "guestfs_file"
8737 #: ../src/guestfs-actions.pod:1527
8741 " guestfs_file (guestfs_h *g,\n"
8742 " const char *path);\n"
8747 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8749 "This call uses the standard L<file(1)> command to determine the type or "
8750 "contents of the file."
8754 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8756 "This call will also transparently look inside various types of compressed "
8761 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8763 "The exact command which runs is C<file -zb path>. Note in particular that "
8764 "the filename is not prepended to the output (the I<-b> option)."
8768 #: ../src/guestfs-actions.pod:1541
8770 "This command can also be used on C</dev/> devices (and partitions, LV "
8771 "names). You can for example use this to determine if a device contains a "
8772 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8776 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
8778 "If the C<path> does not begin with C</dev/> then this command only works for "
8779 "the content of regular files. For other file types (directory, symbolic "
8780 "link etc) it will just return the string C<directory> etc."
8784 #: ../src/guestfs-actions.pod:1556
8785 msgid "guestfs_file_architecture"
8789 #: ../src/guestfs-actions.pod:1558
8793 " guestfs_file_architecture (guestfs_h *g,\n"
8794 " const char *filename);\n"
8799 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8801 "This detects the architecture of the binary C<filename>, and returns it if "
8806 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1036
8807 msgid "Currently defined architectures are:"
8811 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1040
8816 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8818 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8819 "irrespective of the precise processor requirements of the binary."
8823 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1045
8828 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1047
8829 msgid "64 bit x86-64."
8833 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1049
8838 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1051
8839 msgid "32 bit SPARC."
8843 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1053
8848 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1055
8849 msgid "64 bit SPARC V9 and above."
8853 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1057
8858 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1059
8859 msgid "Intel Itanium."
8860 msgstr "Intel Itanium."
8863 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1061
8868 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1063
8869 msgid "32 bit Power PC."
8873 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1065
8878 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1067
8879 msgid "64 bit Power PC."
8883 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1071
8884 msgid "Libguestfs may return other architecture strings in future."
8888 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1073
8889 msgid "The function works on at least the following types of files:"
8893 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1079
8894 msgid "many types of Un*x and Linux binary"
8898 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1083
8899 msgid "many types of Un*x and Linux shared library"
8903 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1087
8904 msgid "Windows Win32 and Win64 binaries"
8908 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1091
8909 msgid "Windows Win32 and Win64 DLLs"
8913 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1093
8914 msgid "Win32 binaries and DLLs return C<i386>."
8918 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1095
8919 msgid "Win64 binaries and DLLs return C<x86_64>."
8923 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1099
8924 msgid "Linux kernel modules"
8928 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1103
8929 msgid "Linux new-style initrd images"
8933 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1107
8934 msgid "some non-x86 Linux vmlinuz kernels"
8938 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1111
8939 msgid "What it can't do currently:"
8943 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1117
8944 msgid "static libraries (libfoo.a)"
8948 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1121
8949 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8953 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1125
8954 msgid "x86 Linux vmlinuz kernels"
8958 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1127
8960 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8961 "compressed code, and are horribly hard to unpack. If you want to find the "
8962 "architecture of a kernel, use the architecture of the associated initrd or "
8963 "kernel module(s) instead."
8967 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1829
8968 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:2537
8969 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2700
8970 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2809
8971 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:2936
8972 #: ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3280
8973 #: ../src/guestfs-actions.pod:3412
8974 msgid "(Added in 1.5.3)"
8978 #: ../src/guestfs-actions.pod:1668
8979 msgid "guestfs_filesize"
8983 #: ../src/guestfs-actions.pod:1670
8987 " guestfs_filesize (guestfs_h *g,\n"
8988 " const char *file);\n"
8993 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1138
8994 msgid "This command returns the size of C<file> in bytes."
8998 #: ../src/guestfs-actions.pod:1676
9000 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9001 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9002 "devices, use C<guestfs_blockdev_getsize64>."
9006 #: ../src/guestfs-actions.pod:1682
9007 msgid "(Added in 1.0.82)"
9011 #: ../src/guestfs-actions.pod:1684
9012 msgid "guestfs_fill"
9016 #: ../src/guestfs-actions.pod:1686
9020 " guestfs_fill (guestfs_h *g,\n"
9023 " const char *path);\n"
9028 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1148
9030 "This command creates a new file called C<path>. The initial content of the "
9031 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9036 #: ../src/guestfs-actions.pod:1696
9038 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9039 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9040 "bytes use C<guestfs_fill_pattern>."
9044 #: ../src/guestfs-actions.pod:1708
9045 msgid "(Added in 1.0.79)"
9049 #: ../src/guestfs-actions.pod:1710
9050 msgid "guestfs_fill_pattern"
9054 #: ../src/guestfs-actions.pod:1712
9058 " guestfs_fill_pattern (guestfs_h *g,\n"
9059 " const char *pattern,\n"
9061 " const char *path);\n"
9066 #: ../src/guestfs-actions.pod:1718
9068 "This function is like C<guestfs_fill> except that it creates a new file of "
9069 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9070 "pattern is truncated if necessary to ensure the length of the file is "
9071 "exactly C<len> bytes."
9075 #: ../src/guestfs-actions.pod:1730
9076 msgid "(Added in 1.3.12)"
9080 #: ../src/guestfs-actions.pod:1732
9081 msgid "guestfs_find"
9085 #: ../src/guestfs-actions.pod:1734
9089 " guestfs_find (guestfs_h *g,\n"
9090 " const char *directory);\n"
9095 #: ../src/guestfs-actions.pod:1738 ../fish/guestfish-actions.pod:1170
9097 "This command lists out all files and directories, recursively, starting at "
9098 "C<directory>. It is essentially equivalent to running the shell command "
9099 "C<find directory -print> but some post-processing happens on the output, "
9104 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
9106 "This returns a list of strings I<without any prefix>. Thus if the directory "
9111 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1178
9121 #: ../src/guestfs-actions.pod:1750
9123 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9127 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1185
9138 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
9139 msgid "If C<directory> is not a directory, then this command returns an error."
9143 #: ../src/guestfs-actions.pod:1761 ../fish/guestfish-actions.pod:1193
9144 msgid "The returned list is sorted."
9148 #: ../src/guestfs-actions.pod:1763
9149 msgid "See also C<guestfs_find0>."
9153 #: ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:4106
9154 #: ../src/guestfs-actions.pod:5649
9155 msgid "(Added in 1.0.27)"
9159 #: ../src/guestfs-actions.pod:1774
9160 msgid "guestfs_find0"
9164 #: ../src/guestfs-actions.pod:1776
9168 " guestfs_find0 (guestfs_h *g,\n"
9169 " const char *directory,\n"
9170 " const char *files);\n"
9175 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1204
9177 "This command lists out all files and directories, recursively, starting at "
9178 "C<directory>, placing the resulting list in the external file called "
9183 #: ../src/guestfs-actions.pod:1785
9185 "This command works the same way as C<guestfs_find> with the following "
9190 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1215
9191 msgid "The resulting list is written to an external file."
9195 #: ../src/guestfs-actions.pod:1796 ../fish/guestfish-actions.pod:1219
9197 "Items (filenames) in the result are separated by C<\\0> characters. See "
9198 "L<find(1)> option I<-print0>."
9202 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1224
9203 msgid "This command is not limited in the number of names that it can return."
9207 #: ../src/guestfs-actions.pod:1806 ../fish/guestfish-actions.pod:1229
9208 msgid "The result list is not sorted."
9212 #: ../src/guestfs-actions.pod:1812
9213 msgid "(Added in 1.0.74)"
9217 #: ../src/guestfs-actions.pod:1814
9218 msgid "guestfs_findfs_label"
9222 #: ../src/guestfs-actions.pod:1816
9226 " guestfs_findfs_label (guestfs_h *g,\n"
9227 " const char *label);\n"
9232 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
9234 "This command searches the filesystems and returns the one which has the "
9235 "given label. An error is returned if no such filesystem can be found."
9239 #: ../src/guestfs-actions.pod:1824
9240 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9244 #: ../src/guestfs-actions.pod:1831
9245 msgid "guestfs_findfs_uuid"
9249 #: ../src/guestfs-actions.pod:1833
9253 " guestfs_findfs_uuid (guestfs_h *g,\n"
9254 " const char *uuid);\n"
9259 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1249
9261 "This command searches the filesystems and returns the one which has the "
9262 "given UUID. An error is returned if no such filesystem can be found."
9266 #: ../src/guestfs-actions.pod:1841
9267 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9271 #: ../src/guestfs-actions.pod:1848
9272 msgid "guestfs_fsck"
9276 #: ../src/guestfs-actions.pod:1850
9280 " guestfs_fsck (guestfs_h *g,\n"
9281 " const char *fstype,\n"
9282 " const char *device);\n"
9287 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
9289 "This runs the filesystem checker (fsck) on C<device> which should have "
9290 "filesystem type C<fstype>."
9294 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1262
9296 "The returned integer is the status. See L<fsck(8)> for the list of status "
9297 "codes from C<fsck>."
9301 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1271
9302 msgid "Multiple status codes can be summed together."
9306 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1275
9308 "A non-zero return code can mean \"success\", for example if errors have been "
9309 "corrected on the filesystem."
9313 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1280
9314 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9318 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1285
9320 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9324 #: ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:7345
9325 msgid "(Added in 1.0.16)"
9329 #: ../src/guestfs-actions.pod:1887
9330 msgid "guestfs_get_append"
9334 #: ../src/guestfs-actions.pod:1889
9338 " guestfs_get_append (guestfs_h *g);\n"
9343 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
9345 "Return the additional kernel options which are added to the guest kernel "
9350 #: ../src/guestfs-actions.pod:1895 ../fish/guestfish-actions.pod:1294
9351 msgid "If C<NULL> then no options are added."
9355 #: ../src/guestfs-actions.pod:1897
9357 "This function returns a string which may be NULL. There is no way to return "
9358 "an error from this function. The string is owned by the guest handle and "
9359 "must I<not> be freed."
9363 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5327
9364 #: ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:6207
9365 #: ../src/guestfs-actions.pod:6226 ../src/guestfs-actions.pod:6242
9366 #: ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:7016
9367 #: ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7388
9368 msgid "(Added in 1.0.26)"
9372 #: ../src/guestfs-actions.pod:1903
9373 msgid "guestfs_get_attach_method"
9377 #: ../src/guestfs-actions.pod:1905
9381 " guestfs_get_attach_method (guestfs_h *g);\n"
9386 #: ../src/guestfs-actions.pod:1908
9387 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9391 #: ../src/guestfs-actions.pod:1913
9392 msgid "guestfs_get_autosync"
9396 #: ../src/guestfs-actions.pod:1915
9400 " guestfs_get_autosync (guestfs_h *g);\n"
9405 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1306
9406 msgid "Get the autosync flag."
9410 #: ../src/guestfs-actions.pod:1924
9411 msgid "guestfs_get_direct"
9415 #: ../src/guestfs-actions.pod:1926
9419 " guestfs_get_direct (guestfs_h *g);\n"
9424 #: ../src/guestfs-actions.pod:1929 ../fish/guestfish-actions.pod:1312
9425 msgid "Return the direct appliance mode flag."
9429 #: ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:5876
9430 msgid "(Added in 1.0.72)"
9434 #: ../src/guestfs-actions.pod:1935
9435 msgid "guestfs_get_e2label"
9439 #: ../src/guestfs-actions.pod:1937
9443 " guestfs_get_e2label (guestfs_h *g,\n"
9444 " const char *device);\n"
9449 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1318
9451 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9455 #: ../src/guestfs-actions.pod:1947 ../fish/guestfish-actions.pod:1321
9457 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9461 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:1975
9462 #: ../src/guestfs-actions.pod:5894 ../src/guestfs-actions.pod:5913
9463 msgid "(Added in 1.0.15)"
9467 #: ../src/guestfs-actions.pod:1956
9468 msgid "guestfs_get_e2uuid"
9472 #: ../src/guestfs-actions.pod:1958
9476 " guestfs_get_e2uuid (guestfs_h *g,\n"
9477 " const char *device);\n"
9482 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1332
9484 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9488 #: ../src/guestfs-actions.pod:1968 ../fish/guestfish-actions.pod:1335
9490 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9494 #: ../src/guestfs-actions.pod:1977
9495 msgid "guestfs_get_memsize"
9499 #: ../src/guestfs-actions.pod:1979
9503 " guestfs_get_memsize (guestfs_h *g);\n"
9508 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1346
9510 "This gets the memory size in megabytes allocated to the qemu subprocess."
9514 #: ../src/guestfs-actions.pod:1985
9516 "If C<guestfs_set_memsize> was not called on this handle, and if "
9517 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9518 "value for memsize."
9522 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2070
9523 #: ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:6036
9524 #: ../fish/guestfish-actions.pod:1353 ../fish/guestfish-actions.pod:1404
9525 #: ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4085
9527 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9531 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:4397
9532 #: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4613
9533 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4644
9534 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4674
9535 #: ../src/guestfs-actions.pod:5552 ../src/guestfs-actions.pod:5934
9536 #: ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6782
9537 msgid "(Added in 1.0.55)"
9541 #: ../src/guestfs-actions.pod:1996
9542 msgid "guestfs_get_network"
9546 #: ../src/guestfs-actions.pod:1998
9550 " guestfs_get_network (guestfs_h *g);\n"
9555 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1360
9556 msgid "This returns the enable network flag."
9560 #: ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:5953
9561 msgid "(Added in 1.5.4)"
9565 #: ../src/guestfs-actions.pod:2007
9566 msgid "guestfs_get_path"
9570 #: ../src/guestfs-actions.pod:2009
9574 " guestfs_get_path (guestfs_h *g);\n"
9579 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1366
9580 msgid "Return the current search path."
9584 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1368
9586 "This is always non-NULL. If it wasn't set already, then this will return "
9591 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2046
9593 "This function returns a string, or NULL on error. The string is owned by "
9594 "the guest handle and must I<not> be freed."
9598 #: ../src/guestfs-actions.pod:2022
9599 msgid "guestfs_get_pid"
9603 #: ../src/guestfs-actions.pod:2024
9607 " guestfs_get_pid (guestfs_h *g);\n"
9612 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9614 "Return the process ID of the qemu subprocess. If there is no qemu "
9615 "subprocess, then this will return an error."
9619 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1380
9620 msgid "This is an internal call used for debugging and testing."
9624 #: ../src/guestfs-actions.pod:2034
9625 msgid "(Added in 1.0.56)"
9629 #: ../src/guestfs-actions.pod:2036
9630 msgid "guestfs_get_qemu"
9634 #: ../src/guestfs-actions.pod:2038
9638 " guestfs_get_qemu (guestfs_h *g);\n"
9643 #: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1386
9644 msgid "Return the current qemu binary."
9648 #: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1388
9650 "This is always non-NULL. If it wasn't set already, then this will return "
9651 "the default qemu binary name."
9655 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:5998
9656 msgid "(Added in 1.0.6)"
9660 #: ../src/guestfs-actions.pod:2051
9661 msgid "guestfs_get_recovery_proc"
9665 #: ../src/guestfs-actions.pod:2053
9669 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9674 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1395
9675 msgid "Return the recovery process enabled flag."
9679 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3507
9680 #: ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:4204
9681 #: ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:5257
9682 #: ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6022
9683 #: ../src/guestfs-actions.pod:6685 ../src/guestfs-actions.pod:6705
9684 #: ../src/guestfs-actions.pod:6897
9685 msgid "(Added in 1.0.77)"
9689 #: ../src/guestfs-actions.pod:2062
9690 msgid "guestfs_get_selinux"
9694 #: ../src/guestfs-actions.pod:2064
9698 " guestfs_get_selinux (guestfs_h *g);\n"
9703 #: ../src/guestfs-actions.pod:2067
9705 "This returns the current setting of the selinux flag which is passed to the "
9706 "appliance at boot time. See C<guestfs_set_selinux>."
9710 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2138
9711 #: ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6099
9712 msgid "(Added in 1.0.67)"
9716 #: ../src/guestfs-actions.pod:2077
9717 msgid "guestfs_get_state"
9721 #: ../src/guestfs-actions.pod:2079
9725 " guestfs_get_state (guestfs_h *g);\n"
9730 #: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1411
9732 "This returns the current state as an opaque integer. This is only useful "
9733 "for printing debug and internal error messages."
9737 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305
9738 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395
9739 #: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:1414
9740 #: ../fish/guestfish-actions.pod:2328 ../fish/guestfish-actions.pod:2346
9741 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2400
9742 msgid "For more information on states, see L<guestfs(3)>."
9746 #: ../src/guestfs-actions.pod:2091
9747 msgid "guestfs_get_trace"
9751 #: ../src/guestfs-actions.pod:2093
9755 " guestfs_get_trace (guestfs_h *g);\n"
9760 #: ../src/guestfs-actions.pod:2096 ../fish/guestfish-actions.pod:1420
9761 msgid "Return the command trace flag."
9765 #: ../src/guestfs-actions.pod:2102
9766 msgid "guestfs_get_umask"
9770 #: ../src/guestfs-actions.pod:2104
9774 " guestfs_get_umask (guestfs_h *g);\n"
9779 #: ../src/guestfs-actions.pod:2107
9781 "Return the current umask. By default the umask is C<022> unless it has been "
9782 "set by calling C<guestfs_umask>."
9786 #: ../src/guestfs-actions.pod:2114
9787 msgid "guestfs_get_verbose"
9791 #: ../src/guestfs-actions.pod:2116
9795 " guestfs_get_verbose (guestfs_h *g);\n"
9800 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1433
9801 msgid "This returns the verbose messages flag."
9805 #: ../src/guestfs-actions.pod:2125
9806 msgid "guestfs_getcon"
9810 #: ../src/guestfs-actions.pod:2127
9814 " guestfs_getcon (guestfs_h *g);\n"
9819 #: ../src/guestfs-actions.pod:2130 ../fish/guestfish-actions.pod:1439
9820 msgid "This gets the SELinux security context of the daemon."
9824 #: ../src/guestfs-actions.pod:2132
9826 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9830 #: ../src/guestfs-actions.pod:2140
9831 msgid "guestfs_getxattr"
9835 #: ../src/guestfs-actions.pod:2142
9839 " guestfs_getxattr (guestfs_h *g,\n"
9840 " const char *path,\n"
9841 " const char *name,\n"
9842 " size_t *size_r);\n"
9847 #: ../src/guestfs-actions.pod:2148
9849 "Get a single extended attribute from file C<path> named C<name>. This call "
9850 "follows symlinks. If you want to lookup an extended attribute for the "
9851 "symlink itself, use C<guestfs_lgetxattr>."
9855 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3521
9857 "Normally it is better to get all extended attributes from a file in one go "
9858 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9859 "implementations are buggy and do not provide a way to list out attributes. "
9860 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9861 "extended attributes you want in advance and call this function."
9865 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
9866 #: ../fish/guestfish-actions.pod:1459 ../fish/guestfish-actions.pod:2465
9868 "Extended attribute values are blobs of binary data. If there is no extended "
9869 "attribute named C<name>, this returns an error."
9873 #: ../src/guestfs-actions.pod:2162
9874 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9878 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2355
9879 #: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:5250
9880 #: ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5457
9882 "This function returns a buffer, or NULL on error. The size of the returned "
9883 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9888 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:3537
9889 msgid "(Added in 1.7.24)"
9893 #: ../src/guestfs-actions.pod:2170
9894 msgid "guestfs_getxattrs"
9898 #: ../src/guestfs-actions.pod:2172
9901 " struct guestfs_xattr_list *\n"
9902 " guestfs_getxattrs (guestfs_h *g,\n"
9903 " const char *path);\n"
9908 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
9910 "This call lists the extended attributes of the file or directory C<path>."
9914 #: ../src/guestfs-actions.pod:2179 ../fish/guestfish-actions.pod:1471
9916 "At the system call level, this is a combination of the L<listxattr(2)> and "
9917 "L<getxattr(2)> calls."
9921 #: ../src/guestfs-actions.pod:2182
9922 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9926 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549
9927 #: ../src/guestfs-actions.pod:4200
9929 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9930 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9934 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3553
9935 #: ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754
9936 #: ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:6118
9937 #: ../src/guestfs-actions.pod:7453
9938 msgid "(Added in 1.0.59)"
9942 #: ../src/guestfs-actions.pod:2190
9943 msgid "guestfs_glob_expand"
9947 #: ../src/guestfs-actions.pod:2192
9951 " guestfs_glob_expand (guestfs_h *g,\n"
9952 " const char *pattern);\n"
9957 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1480
9959 "This command searches for all the pathnames matching C<pattern> according to "
9960 "the wildcard expansion rules used by the shell."
9964 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
9966 "If no paths match, then this returns an empty list (note: not an error)."
9970 #: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1487
9972 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9973 "GLOB_BRACE>. See that manual page for more details."
9977 #: ../src/guestfs-actions.pod:2211 ../src/guestfs-actions.pod:6283
9978 #: ../src/guestfs-actions.pod:6300
9979 msgid "(Added in 1.0.50)"
9983 #: ../src/guestfs-actions.pod:2213
9984 msgid "guestfs_grep"
9988 #: ../src/guestfs-actions.pod:2215
9992 " guestfs_grep (guestfs_h *g,\n"
9993 " const char *regex,\n"
9994 " const char *path);\n"
9999 #: ../src/guestfs-actions.pod:2220 ../fish/guestfish-actions.pod:1495
10000 msgid "This calls the external C<grep> program and returns the matching lines."
10004 #: ../src/guestfs-actions.pod:2232
10005 msgid "guestfs_grepi"
10009 #: ../src/guestfs-actions.pod:2234
10013 " guestfs_grepi (guestfs_h *g,\n"
10014 " const char *regex,\n"
10015 " const char *path);\n"
10020 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1505
10022 "This calls the external C<grep -i> program and returns the matching lines."
10026 #: ../src/guestfs-actions.pod:2251
10027 msgid "guestfs_grub_install"
10031 #: ../src/guestfs-actions.pod:2253
10035 " guestfs_grub_install (guestfs_h *g,\n"
10036 " const char *root,\n"
10037 " const char *device);\n"
10042 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
10044 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10045 "the root directory being C<root>."
10049 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1518
10051 "Note: If grub-install reports the error \"No suitable drive was found in the "
10052 "generated device map.\" it may be that you need to create a C</boot/grub/"
10053 "device.map> file first that contains the mapping between grub device names "
10054 "and Linux device names. It is usually sufficient to create a file "
10059 #: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1525
10062 " (hd0) /dev/vda\n"
10067 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1527
10068 msgid "replacing C</dev/vda> with the name of the installation device."
10072 #: ../src/guestfs-actions.pod:2274
10073 msgid "(Added in 1.0.17)"
10077 #: ../src/guestfs-actions.pod:2276
10078 msgid "guestfs_head"
10082 #: ../src/guestfs-actions.pod:2278
10086 " guestfs_head (guestfs_h *g,\n"
10087 " const char *path);\n"
10092 #: ../src/guestfs-actions.pod:2282 ../fish/guestfish-actions.pod:1533
10094 "This command returns up to the first 10 lines of a file as a list of strings."
10098 #: ../src/guestfs-actions.pod:2294
10099 msgid "guestfs_head_n"
10103 #: ../src/guestfs-actions.pod:2296
10107 " guestfs_head_n (guestfs_h *g,\n"
10109 " const char *path);\n"
10114 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
10116 "If the parameter C<nrlines> is a positive number, this returns the first "
10117 "C<nrlines> lines of the file C<path>."
10121 #: ../src/guestfs-actions.pod:2304 ../fish/guestfish-actions.pod:1546
10123 "If the parameter C<nrlines> is a negative number, this returns lines from "
10124 "the file C<path>, excluding the last C<nrlines> lines."
10128 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:6580
10129 #: ../fish/guestfish-actions.pod:1549 ../fish/guestfish-actions.pod:4435
10130 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10134 #: ../src/guestfs-actions.pod:2318
10135 msgid "guestfs_hexdump"
10139 #: ../src/guestfs-actions.pod:2320
10143 " guestfs_hexdump (guestfs_h *g,\n"
10144 " const char *path);\n"
10149 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1558
10151 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10152 "readable, canonical hex dump of the file."
10156 #: ../src/guestfs-actions.pod:2333 ../src/guestfs-actions.pod:6364
10157 #: ../src/guestfs-actions.pod:6419
10158 msgid "(Added in 1.0.22)"
10162 #: ../src/guestfs-actions.pod:2335
10163 msgid "guestfs_initrd_cat"
10167 #: ../src/guestfs-actions.pod:2337
10171 " guestfs_initrd_cat (guestfs_h *g,\n"
10172 " const char *initrdpath,\n"
10173 " const char *filename,\n"
10174 " size_t *size_r);\n"
10179 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1568
10181 "This command unpacks the file C<filename> from the initrd file called "
10182 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10187 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1572
10189 "For example, in guestfish you could use the following command to examine the "
10190 "boot script (usually called C</init>) contained in a Linux initrd or "
10195 #: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1576
10198 " initrd-cat /boot/initrd-<version>.img init\n"
10203 #: ../src/guestfs-actions.pod:2353
10204 msgid "See also C<guestfs_initrd_list>."
10208 #: ../src/guestfs-actions.pod:2364
10209 msgid "guestfs_initrd_list"
10213 #: ../src/guestfs-actions.pod:2366
10217 " guestfs_initrd_list (guestfs_h *g,\n"
10218 " const char *path);\n"
10223 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1587
10224 msgid "This command lists out files contained in an initrd."
10228 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1589
10230 "The files are listed without any initial C</> character. The files are "
10231 "listed in the order they appear (not necessarily alphabetical). Directory "
10232 "names are listed as separate items."
10236 #: ../src/guestfs-actions.pod:2376 ../fish/guestfish-actions.pod:1593
10238 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10239 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10244 #: ../src/guestfs-actions.pod:2386
10245 msgid "guestfs_inotify_add_watch"
10249 #: ../src/guestfs-actions.pod:2388
10253 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10254 " const char *path,\n"
10260 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1601
10261 msgid "Watch C<path> for the events listed in C<mask>."
10265 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1603
10267 "Note that if C<path> is a directory then events within that directory are "
10268 "watched, but this does I<not> happen recursively (in subdirectories)."
10272 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1607
10274 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10275 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10279 #: ../src/guestfs-actions.pod:2407
10280 msgid "guestfs_inotify_close"
10284 #: ../src/guestfs-actions.pod:2409
10288 " guestfs_inotify_close (guestfs_h *g);\n"
10293 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1615
10295 "This closes the inotify handle which was previously opened by inotify_init. "
10296 "It removes all watches, throws away any pending events, and deallocates all "
10301 #: ../src/guestfs-actions.pod:2420
10302 msgid "guestfs_inotify_files"
10306 #: ../src/guestfs-actions.pod:2422
10310 " guestfs_inotify_files (guestfs_h *g);\n"
10315 #: ../src/guestfs-actions.pod:2425
10317 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10318 "returns a list of pathnames of objects that were touched. The returned "
10319 "pathnames are sorted and deduplicated."
10323 #: ../src/guestfs-actions.pod:2435
10324 msgid "guestfs_inotify_init"
10328 #: ../src/guestfs-actions.pod:2437
10332 " guestfs_inotify_init (guestfs_h *g,\n"
10333 " int maxevents);\n"
10338 #: ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1631
10340 "This command creates a new inotify handle. The inotify subsystem can be "
10341 "used to notify events which happen to objects in the guest filesystem."
10345 #: ../src/guestfs-actions.pod:2445
10347 "C<maxevents> is the maximum number of events which will be queued up between "
10348 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10349 "passed as C<0>, then the kernel (or previously set) default is used. For "
10350 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10351 "throws away events, but records the fact that it threw them away by setting "
10352 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10353 "C<guestfs_inotify_read>)."
10357 #: ../src/guestfs-actions.pod:2455
10359 "Before any events are generated, you have to add some watches to the "
10360 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10361 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10365 #: ../src/guestfs-actions.pod:2461
10367 "Queued up events should be read periodically by calling "
10368 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10369 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10370 "often enough then you risk the internal queue overflowing."
10374 #: ../src/guestfs-actions.pod:2468
10376 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10377 "This also removes any watches automatically."
10381 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1662
10383 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10384 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10385 "that there is one global inotify handle per libguestfs instance."
10389 #: ../src/guestfs-actions.pod:2481
10390 msgid "guestfs_inotify_read"
10394 #: ../src/guestfs-actions.pod:2483
10397 " struct guestfs_inotify_event_list *\n"
10398 " guestfs_inotify_read (guestfs_h *g);\n"
10403 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
10405 "Return the complete queue of events that have happened since the previous "
10410 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1674
10411 msgid "If no events have happened, this returns an empty list."
10415 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
10417 "I<Note>: In order to make sure that all events have been read, you must call "
10418 "this function repeatedly until it returns an empty list. The reason is that "
10419 "the call will read events up to the maximum appliance-to-host message size "
10420 "and leave remaining events in the queue."
10424 #: ../src/guestfs-actions.pod:2497
10426 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10427 "there was an error. I<The caller must call "
10428 "C<guestfs_free_inotify_event_list> after use>."
10432 #: ../src/guestfs-actions.pod:2503
10433 msgid "guestfs_inotify_rm_watch"
10437 #: ../src/guestfs-actions.pod:2505
10441 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10447 #: ../src/guestfs-actions.pod:2509
10449 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10453 #: ../src/guestfs-actions.pod:2516
10454 msgid "guestfs_inspect_get_arch"
10458 #: ../src/guestfs-actions.pod:2518
10462 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10463 " const char *root);\n"
10468 #: ../src/guestfs-actions.pod:2522 ../src/guestfs-actions.pod:2545
10469 #: ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2682
10470 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2747
10471 #: ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2796
10472 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860
10473 #: ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2920
10474 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2999
10475 #: ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3062
10476 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
10477 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3138
10479 "This function should only be called with a root device string as returned by "
10480 "C<guestfs_inspect_os>."
10484 #: ../src/guestfs-actions.pod:2525
10486 "This returns the architecture of the inspected operating system. The "
10487 "possible return values are listed under C<guestfs_file_architecture>."
10491 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1700
10493 "If the architecture could not be determined, then the string C<unknown> is "
10498 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2625
10499 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:2756
10500 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2876
10501 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2931
10502 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3028
10503 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
10504 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3109
10505 #: ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3231
10506 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:1703
10507 #: ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1877
10508 #: ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1913
10509 #: ../fish/guestfish-actions.pod:1983 ../fish/guestfish-actions.pod:2007
10510 #: ../fish/guestfish-actions.pod:2024 ../fish/guestfish-actions.pod:2067
10511 #: ../fish/guestfish-actions.pod:2102 ../fish/guestfish-actions.pod:2118
10512 #: ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147
10513 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2175
10514 #: ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2308
10515 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10519 #: ../src/guestfs-actions.pod:2539
10520 msgid "guestfs_inspect_get_distro"
10524 #: ../src/guestfs-actions.pod:2541
10528 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10529 " const char *root);\n"
10534 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
10536 "This returns the distro (distribution) of the inspected operating system."
10540 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1715
10541 msgid "Currently defined distros are:"
10545 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1719
10546 msgid "\"archlinux\""
10547 msgstr "\"archlinux\""
10550 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1721
10551 msgid "Arch Linux."
10552 msgstr "Arch Linux."
10555 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1723
10557 #| msgid "\"gentoo\""
10559 msgstr "\"gentoo\""
10562 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1725
10567 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1727
10569 msgstr "\"debian\""
10572 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1729
10577 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1731
10579 msgstr "\"fedora\""
10582 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1733
10587 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1735
10589 msgstr "\"gentoo\""
10592 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1737
10597 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1739
10598 msgid "\"linuxmint\""
10599 msgstr "\"linuxmint\""
10602 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1741
10603 msgid "Linux Mint."
10604 msgstr "Linux Mint."
10607 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1743
10608 msgid "\"mandriva\""
10609 msgstr "\"mandriva\""
10612 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1745
10617 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1747
10622 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1749
10627 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1751
10629 msgstr "\"pardus\""
10632 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1753
10637 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1755
10638 msgid "\"redhat-based\""
10639 msgstr "\"redhat-based\""
10642 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1757
10643 msgid "Some Red Hat-derived distro."
10644 msgstr "Дистрибутив, що походить від Red Hat."
10647 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1759
10652 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1761
10654 #| msgid "Red Hat Enterprise Linux and some derivatives."
10655 msgid "Red Hat Enterprise Linux."
10656 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10659 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1763
10660 msgid "\"scientificlinux\""
10664 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1765
10665 msgid "Scientific Linux."
10669 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1767
10670 msgid "\"slackware\""
10674 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1769
10679 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1771
10681 msgstr "\"ubuntu\""
10684 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1773
10689 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2727
10690 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1775
10691 #: ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:2093
10692 msgid "\"unknown\""
10693 msgstr "\"unknown\""
10696 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1777
10697 msgid "The distro could not be determined."
10698 msgstr "Дистрибутив, тип якого не вдалося визначити."
10701 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3011
10702 #: ../fish/guestfish-actions.pod:1779 ../fish/guestfish-actions.pod:2085
10703 msgid "\"windows\""
10704 msgstr "\"windows\""
10707 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1781
10709 "Windows does not have distributions. This string is returned if the OS type "
10714 #: ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2733
10715 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:1786
10716 #: ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:2099
10718 "Future versions of libguestfs may return other strings here. The caller "
10719 "should be prepared to handle any string."
10723 #: ../src/guestfs-actions.pod:2632
10724 msgid "guestfs_inspect_get_drive_mappings"
10728 #: ../src/guestfs-actions.pod:2634
10732 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10733 " const char *root);\n"
10738 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1798
10740 "This call is useful for Windows which uses a primitive system of assigning "
10741 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10742 "Windows Registry to find out how disks/partitions are mapped to drive "
10743 "letters, and returns a hash table as in the example below:"
10747 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
10750 " C => /dev/vda2\n"
10751 " E => /dev/vdb1\n"
10752 " F => /dev/vdc1\n"
10757 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
10759 "Note that keys are drive letters. For Windows, the key is case insensitive "
10760 "and just contains the drive letter, without the customary colon separator "
10765 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1812
10767 "In future we may support other operating systems that also used drive "
10768 "letters, but the keys for those might not be case insensitive and might be "
10769 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10774 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1817
10776 "For Windows guests, currently only hard drive mappings are returned. "
10777 "Removable disks (eg. DVD-ROMs) are ignored."
10781 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1820
10783 "For guests that do not use drive mappings, or if the drive mappings could "
10784 "not be determined, this returns an empty hash table."
10788 #: ../src/guestfs-actions.pod:2666
10790 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10791 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10795 #: ../src/guestfs-actions.pod:2670 ../src/guestfs-actions.pod:2846
10796 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:4816
10797 #: ../src/guestfs-actions.pod:6721
10799 "This function returns a NULL-terminated array of strings, or NULL if there "
10800 "was an error. The array of strings will always have length C<2n+1>, where "
10801 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10802 "caller must free the strings and the array after use>."
10806 #: ../src/guestfs-actions.pod:2676
10807 msgid "guestfs_inspect_get_filesystems"
10811 #: ../src/guestfs-actions.pod:2678
10815 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10816 " const char *root);\n"
10821 #: ../src/guestfs-actions.pod:2685 ../fish/guestfish-actions.pod:1834
10823 "This returns a list of all the filesystems that we think are associated with "
10824 "this operating system. This includes the root filesystem, other ordinary "
10825 "filesystems, and non-mounted devices like swap partitions."
10829 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1839
10831 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10832 "to be shared between operating systems."
10836 #: ../src/guestfs-actions.pod:2693
10838 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10839 "C<guestfs_inspect_get_mountpoints>."
10843 #: ../src/guestfs-actions.pod:2702
10844 msgid "guestfs_inspect_get_format"
10848 #: ../src/guestfs-actions.pod:2704
10852 " guestfs_inspect_get_format (guestfs_h *g,\n"
10853 " const char *root);\n"
10858 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
10860 "This returns the format of the inspected operating system. You can use it "
10861 "to detect install images, live CDs and similar."
10865 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1855
10866 msgid "Currently defined formats are:"
10870 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1859
10871 msgid "\"installed\""
10872 msgstr "\"installed\""
10875 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1861
10876 msgid "This is an installed operating system."
10877 msgstr "Це встановлена операційна система."
10880 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1863
10881 msgid "\"installer\""
10885 #: ../src/guestfs-actions.pod:2724 ../fish/guestfish-actions.pod:1865
10887 "The disk image being inspected is not an installed operating system, but a "
10888 "I<bootable> install disk, live CD, or similar."
10892 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1870
10893 msgid "The format of this disk image is not known."
10897 #: ../src/guestfs-actions.pod:2741
10898 msgid "guestfs_inspect_get_hostname"
10902 #: ../src/guestfs-actions.pod:2743
10906 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10907 " const char *root);\n"
10912 #: ../src/guestfs-actions.pod:2750 ../fish/guestfish-actions.pod:1886
10914 "This function returns the hostname of the operating system as found by "
10915 "inspection of the guest's configuration files."
10919 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1889
10921 "If the hostname could not be determined, then the string C<unknown> is "
10926 #: ../src/guestfs-actions.pod:2761
10927 msgid "(Added in 1.7.9)"
10931 #: ../src/guestfs-actions.pod:2763
10932 msgid "guestfs_inspect_get_major_version"
10936 #: ../src/guestfs-actions.pod:2765
10940 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10941 " const char *root);\n"
10946 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1901
10948 "This returns the major version number of the inspected operating system."
10952 #: ../src/guestfs-actions.pod:2775 ../fish/guestfish-actions.pod:1904
10954 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10955 "popular public names used by the operating system. Notably the operating "
10956 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10957 "1). You can find out the real versions corresponding to releases of Windows "
10958 "by consulting Wikipedia or MSDN."
10962 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2802
10963 #: ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1925
10964 msgid "If the version could not be determined, then C<0> is returned."
10968 #: ../src/guestfs-actions.pod:2790
10969 msgid "guestfs_inspect_get_minor_version"
10973 #: ../src/guestfs-actions.pod:2792
10977 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10978 " const char *root);\n"
10983 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1922
10985 "This returns the minor version number of the inspected operating system."
10989 #: ../src/guestfs-actions.pod:2804
10991 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10992 "C<guestfs_inspect_get_major_version>."
10996 #: ../src/guestfs-actions.pod:2811
10997 msgid "guestfs_inspect_get_mountpoints"
11001 #: ../src/guestfs-actions.pod:2813
11005 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11006 " const char *root);\n"
11011 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1937
11013 "This returns a hash of where we think the filesystems associated with this "
11014 "operating system should be mounted. Callers should note that this is at "
11015 "best an educated guess made by reading configuration files such as C</etc/"
11016 "fstab>. I<In particular note> that this may return filesystems which are "
11017 "non-existent or not mountable and callers should be prepared to handle or "
11018 "ignore failures if they try to mount them."
11022 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1946
11024 "Each element in the returned hashtable has a key which is the path of the "
11025 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11026 "mounted there (eg. C</dev/sda1>)."
11030 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1951
11032 "Non-mounted devices such as swap devices are I<not> returned in this list."
11036 #: ../src/guestfs-actions.pod:2837
11038 "For operating systems like Windows which still use drive letters, this call "
11039 "will only return an entry for the first drive \"mounted on\" C</>. For "
11040 "information about the mapping of drive letters to partitions, see "
11041 "C<guestfs_inspect_get_drive_mappings>."
11045 #: ../src/guestfs-actions.pod:2843
11047 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11048 "C<guestfs_inspect_get_filesystems>."
11052 #: ../src/guestfs-actions.pod:2854
11053 msgid "guestfs_inspect_get_package_format"
11057 #: ../src/guestfs-actions.pod:2856
11061 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11062 " const char *root);\n"
11067 #: ../src/guestfs-actions.pod:2863
11069 "This function and C<guestfs_inspect_get_package_management> return the "
11070 "package format and package management tool used by the inspected operating "
11071 "system. For example for Fedora these functions would return C<rpm> (package "
11072 "format) and C<yum> (package management)."
11076 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1976
11078 "This returns the string C<unknown> if we could not determine the package "
11079 "format I<or> if the operating system does not have a real packaging system "
11084 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1980
11086 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11087 "Future versions of libguestfs may return other strings."
11091 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:2912
11092 msgid "(Added in 1.7.5)"
11096 #: ../src/guestfs-actions.pod:2883
11097 msgid "guestfs_inspect_get_package_management"
11101 #: ../src/guestfs-actions.pod:2885
11105 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11106 " const char *root);\n"
11111 #: ../src/guestfs-actions.pod:2892
11113 "C<guestfs_inspect_get_package_format> and this function return the package "
11114 "format and package management tool used by the inspected operating system. "
11115 "For example for Fedora these functions would return C<rpm> (package format) "
11116 "and C<yum> (package management)."
11120 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1998
11122 "This returns the string C<unknown> if we could not determine the package "
11123 "management tool I<or> if the operating system does not have a real packaging "
11124 "system (eg. Windows)."
11128 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2002
11130 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11131 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11132 "libguestfs may return other strings."
11136 #: ../src/guestfs-actions.pod:2914
11137 msgid "guestfs_inspect_get_product_name"
11141 #: ../src/guestfs-actions.pod:2916
11145 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11146 " const char *root);\n"
11151 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2016
11153 "This returns the product name of the inspected operating system. The "
11154 "product name is generally some freeform string which can be displayed to the "
11155 "user, but should not be parsed by programs."
11159 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2021
11161 "If the product name could not be determined, then the string C<unknown> is "
11166 #: ../src/guestfs-actions.pod:2938
11167 msgid "guestfs_inspect_get_product_variant"
11171 #: ../src/guestfs-actions.pod:2940
11175 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11176 " const char *root);\n"
11181 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2033
11183 #| msgid "This is an installed operating system."
11184 msgid "This returns the product variant of the inspected operating system."
11185 msgstr "Це встановлена операційна система."
11188 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2036
11190 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11191 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11192 "is usually a string such as C<Client> or C<Server> (other values are "
11193 "possible). This can be used to distinguish consumer and enterprise versions "
11194 "of Windows that have the same version number (for example, Windows 7 and "
11195 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11196 "the latter is C<Server>)."
11200 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2045
11202 "For enterprise Linux guests, in future we intend this to return the product "
11203 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11204 "implemented at present."
11208 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2049
11210 "If the product variant could not be determined, then the string C<unknown> "
11215 #: ../src/guestfs-actions.pod:2966
11217 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11218 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11222 #: ../src/guestfs-actions.pod:2973
11223 msgid "guestfs_inspect_get_roots"
11227 #: ../src/guestfs-actions.pod:2975
11231 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11236 #: ../src/guestfs-actions.pod:2978
11238 "This function is a convenient way to get the list of root devices, as "
11239 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11240 "the whole inspection process."
11244 #: ../src/guestfs-actions.pod:2982
11246 "This returns an empty list if either no root devices were found or the "
11247 "caller has not called C<guestfs_inspect_os>."
11251 #: ../src/guestfs-actions.pod:2991
11252 msgid "(Added in 1.7.3)"
11256 #: ../src/guestfs-actions.pod:2993
11257 msgid "guestfs_inspect_get_type"
11261 #: ../src/guestfs-actions.pod:2995
11265 " guestfs_inspect_get_type (guestfs_h *g,\n"
11266 " const char *root);\n"
11271 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2076
11273 "This returns the type of the inspected operating system. Currently defined "
11278 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2081
11283 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2083
11284 msgid "Any Linux-based operating system."
11288 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2087
11289 msgid "Any Microsoft Windows operating system."
11293 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2089
11294 msgid "\"freebsd\""
11295 msgstr "\"freebsd\""
11298 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2091
11303 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2095
11304 msgid "The operating system type could not be determined."
11308 #: ../src/guestfs-actions.pod:3035
11309 msgid "guestfs_inspect_get_windows_current_control_set"
11313 #: ../src/guestfs-actions.pod:3037
11317 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11318 " const char *root);\n"
11323 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
11325 "This returns the Windows CurrentControlSet of the inspected guest. The "
11326 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11330 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2114
11332 "This call assumes that the guest is Windows and that the Registry could be "
11333 "examined by inspection. If this is not the case then an error is returned."
11337 #: ../src/guestfs-actions.pod:3056
11338 msgid "guestfs_inspect_get_windows_systemroot"
11342 #: ../src/guestfs-actions.pod:3058
11346 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11347 " const char *root);\n"
11352 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2127
11354 "This returns the Windows systemroot of the inspected guest. The systemroot "
11355 "is a directory path such as C</WINDOWS>."
11359 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
11361 "This call assumes that the guest is Windows and that the systemroot could be "
11362 "determined by inspection. If this is not the case then an error is returned."
11366 #: ../src/guestfs-actions.pod:3077
11367 msgid "(Added in 1.5.25)"
11371 #: ../src/guestfs-actions.pod:3079
11372 msgid "guestfs_inspect_is_live"
11376 #: ../src/guestfs-actions.pod:3081
11380 " guestfs_inspect_is_live (guestfs_h *g,\n"
11381 " const char *root);\n"
11386 #: ../src/guestfs-actions.pod:3088
11388 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11389 "disk), then this returns true if a live image was detected on the disk."
11393 #: ../src/guestfs-actions.pod:3096
11394 msgid "guestfs_inspect_is_multipart"
11398 #: ../src/guestfs-actions.pod:3098
11402 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11403 " const char *root);\n"
11408 #: ../src/guestfs-actions.pod:3105
11410 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11411 "disk), then this returns true if the disk is part of a set."
11415 #: ../src/guestfs-actions.pod:3113
11416 msgid "guestfs_inspect_is_netinst"
11420 #: ../src/guestfs-actions.pod:3115
11424 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11425 " const char *root);\n"
11430 #: ../src/guestfs-actions.pod:3122
11432 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11433 "disk), then this returns true if the disk is a network installer, ie. not a "
11434 "self-contained install CD but one which is likely to require network access "
11435 "to complete the install."
11439 #: ../src/guestfs-actions.pod:3132
11440 msgid "guestfs_inspect_list_applications"
11444 #: ../src/guestfs-actions.pod:3134
11447 " struct guestfs_application_list *\n"
11448 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11449 " const char *root);\n"
11454 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2184
11455 msgid "Return the list of applications installed in the operating system."
11459 #: ../src/guestfs-actions.pod:3143
11461 "I<Note:> This call works differently from other parts of the inspection "
11462 "API. You have to call C<guestfs_inspect_os>, then "
11463 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11464 "this. Listing applications is a significantly more difficult operation "
11465 "which requires access to the full filesystem. Also note that unlike the "
11466 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11467 "the libguestfs handle, this call actually reads parts of the mounted "
11468 "filesystems during the call."
11472 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2196
11474 "This returns an empty list if the inspection code was not able to determine "
11475 "the list of applications."
11479 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2199
11480 msgid "The application structure contains the following fields:"
11484 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2203
11485 msgid "C<app_name>"
11486 msgstr "C<app_name>"
11489 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2205
11491 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11492 "guests, this is the package name."
11496 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2208
11497 msgid "C<app_display_name>"
11498 msgstr "C<app_display_name>"
11501 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2210
11503 "The display name of the application, sometimes localized to the install "
11504 "language of the guest operating system."
11508 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2213
11510 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11511 "to display something can use C<app_name> instead."
11515 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2216
11516 msgid "C<app_epoch>"
11517 msgstr "C<app_epoch>"
11520 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2218
11522 "For package managers which use epochs, this contains the epoch of the "
11523 "package (an integer). If unavailable, this is returned as C<0>."
11527 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2221
11528 msgid "C<app_version>"
11529 msgstr "C<app_version>"
11532 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2223
11534 "The version string of the application or package. If unavailable this is "
11535 "returned as an empty string C<\"\">."
11539 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2226
11540 msgid "C<app_release>"
11541 msgstr "C<app_release>"
11544 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2228
11546 "The release string of the application or package, for package managers that "
11547 "use this. If unavailable this is returned as an empty string C<\"\">."
11551 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2232
11552 msgid "C<app_install_path>"
11553 msgstr "C<app_install_path>"
11556 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2234
11558 "The installation path of the application (on operating systems such as "
11559 "Windows which use installation paths). This path is in the format used by "
11560 "the guest operating system, it is not a libguestfs path."
11564 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2239
11565 msgid "If unavailable this is returned as an empty string C<\"\">."
11569 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2241
11570 msgid "C<app_trans_path>"
11571 msgstr "C<app_trans_path>"
11574 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2243
11576 "The install path translated into a libguestfs path. If unavailable this is "
11577 "returned as an empty string C<\"\">."
11581 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2246
11582 msgid "C<app_publisher>"
11583 msgstr "C<app_publisher>"
11586 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2248
11588 "The name of the publisher of the application, for package managers that use "
11589 "this. If unavailable this is returned as an empty string C<\"\">."
11593 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2252
11595 msgstr "C<app_url>"
11598 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2254
11600 "The URL (eg. upstream URL) of the application. If unavailable this is "
11601 "returned as an empty string C<\"\">."
11605 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2257
11606 msgid "C<app_source_package>"
11610 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2259
11612 "For packaging systems which support this, the name of the source package. "
11613 "If unavailable this is returned as an empty string C<\"\">."
11617 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2262
11618 msgid "C<app_summary>"
11622 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2264
11624 "A short (usually one line) description of the application or package. If "
11625 "unavailable this is returned as an empty string C<\"\">."
11629 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2267
11630 msgid "C<app_description>"
11634 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2269
11636 "A longer description of the application or package. If unavailable this is "
11637 "returned as an empty string C<\"\">."
11641 #: ../src/guestfs-actions.pod:3233
11643 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11644 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11649 #: ../src/guestfs-actions.pod:3237
11650 msgid "(Added in 1.7.8)"
11654 #: ../src/guestfs-actions.pod:3239
11655 msgid "guestfs_inspect_os"
11659 #: ../src/guestfs-actions.pod:3241
11663 " guestfs_inspect_os (guestfs_h *g);\n"
11668 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2280
11670 "This function uses other libguestfs functions and certain heuristics to "
11671 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11672 "for operating systems."
11676 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2284
11677 msgid "The list returned is empty if no operating systems were found."
11681 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2286
11683 "If one operating system was found, then this returns a list with a single "
11684 "element, which is the name of the root filesystem of this operating system. "
11685 "It is also possible for this function to return a list containing more than "
11686 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11687 "element being the root filesystem of one of the operating systems."
11691 #: ../src/guestfs-actions.pod:3257
11693 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11694 "functions in order to query further information about each operating system, "
11695 "such as the name and version."
11699 #: ../src/guestfs-actions.pod:3262
11701 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11702 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11703 "the contents. This should be called with no disks currently mounted. The "
11704 "function may also use Augeas, so any existing Augeas handle will be closed."
11708 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2304
11710 "This function cannot decrypt encrypted disks. The caller must do that first "
11711 "(supplying the necessary keys) if the disk is encrypted."
11715 #: ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3564
11716 #: ../src/guestfs-actions.pod:3626
11717 msgid "See also C<guestfs_list_filesystems>."
11721 #: ../src/guestfs-actions.pod:3282
11722 msgid "guestfs_is_blockdev"
11726 #: ../src/guestfs-actions.pod:3284
11730 " guestfs_is_blockdev (guestfs_h *g,\n"
11731 " const char *path);\n"
11736 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2316
11738 "This returns C<true> if and only if there is a block device with the given "
11743 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320
11744 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3365
11745 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3437
11746 #: ../src/guestfs-actions.pod:3452
11747 msgid "See also C<guestfs_stat>."
11751 #: ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324
11752 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3441
11753 #: ../src/guestfs-actions.pod:3456
11754 msgid "(Added in 1.5.10)"
11758 #: ../src/guestfs-actions.pod:3297
11759 msgid "guestfs_is_busy"
11763 #: ../src/guestfs-actions.pod:3299
11767 " guestfs_is_busy (guestfs_h *g);\n"
11772 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2325
11774 "This returns true iff this handle is busy processing a command (in the "
11779 #: ../src/guestfs-actions.pod:3311
11780 msgid "guestfs_is_chardev"
11784 #: ../src/guestfs-actions.pod:3313
11788 " guestfs_is_chardev (guestfs_h *g,\n"
11789 " const char *path);\n"
11794 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2334
11796 "This returns C<true> if and only if there is a character device with the "
11797 "given C<path> name."
11801 #: ../src/guestfs-actions.pod:3326
11802 msgid "guestfs_is_config"
11806 #: ../src/guestfs-actions.pod:3328
11810 " guestfs_is_config (guestfs_h *g);\n"
11815 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2343
11817 "This returns true iff this handle is being configured (in the C<CONFIG> "
11822 #: ../src/guestfs-actions.pod:3340
11823 msgid "guestfs_is_dir"
11827 #: ../src/guestfs-actions.pod:3342
11831 " guestfs_is_dir (guestfs_h *g,\n"
11832 " const char *path);\n"
11837 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2352
11839 "This returns C<true> if and only if there is a directory with the given "
11840 "C<path> name. Note that it returns false for other objects like files."
11844 #: ../src/guestfs-actions.pod:3356
11845 msgid "guestfs_is_fifo"
11849 #: ../src/guestfs-actions.pod:3358
11853 " guestfs_is_fifo (guestfs_h *g,\n"
11854 " const char *path);\n"
11859 #: ../src/guestfs-actions.pod:3362 ../fish/guestfish-actions.pod:2362
11861 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11862 "given C<path> name."
11866 #: ../src/guestfs-actions.pod:3371
11867 msgid "guestfs_is_file"
11871 #: ../src/guestfs-actions.pod:3373
11875 " guestfs_is_file (guestfs_h *g,\n"
11876 " const char *path);\n"
11881 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2371
11883 "This returns C<true> if and only if there is a regular file with the given "
11884 "C<path> name. Note that it returns false for other objects like directories."
11888 #: ../src/guestfs-actions.pod:3387
11889 msgid "guestfs_is_launching"
11893 #: ../src/guestfs-actions.pod:3389
11897 " guestfs_is_launching (guestfs_h *g);\n"
11902 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2381
11904 "This returns true iff this handle is launching the subprocess (in the "
11905 "C<LAUNCHING> state)."
11909 #: ../src/guestfs-actions.pod:3401
11910 msgid "guestfs_is_lv"
11914 #: ../src/guestfs-actions.pod:3403
11918 " guestfs_is_lv (guestfs_h *g,\n"
11919 " const char *device);\n"
11924 #: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2390
11926 "This command tests whether C<device> is a logical volume, and returns true "
11927 "iff this is the case."
11931 #: ../src/guestfs-actions.pod:3414
11932 msgid "guestfs_is_ready"
11936 #: ../src/guestfs-actions.pod:3416
11940 " guestfs_is_ready (guestfs_h *g);\n"
11945 #: ../src/guestfs-actions.pod:3419 ../fish/guestfish-actions.pod:2397
11947 "This returns true iff this handle is ready to accept commands (in the "
11952 #: ../src/guestfs-actions.pod:3428
11953 msgid "guestfs_is_socket"
11957 #: ../src/guestfs-actions.pod:3430
11961 " guestfs_is_socket (guestfs_h *g,\n"
11962 " const char *path);\n"
11967 #: ../src/guestfs-actions.pod:3434 ../fish/guestfish-actions.pod:2406
11969 "This returns C<true> if and only if there is a Unix domain socket with the "
11970 "given C<path> name."
11974 #: ../src/guestfs-actions.pod:3443
11975 msgid "guestfs_is_symlink"
11979 #: ../src/guestfs-actions.pod:3445
11983 " guestfs_is_symlink (guestfs_h *g,\n"
11984 " const char *path);\n"
11989 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2415
11991 "This returns C<true> if and only if there is a symbolic link with the given "
11996 #: ../src/guestfs-actions.pod:3458
11997 msgid "guestfs_kill_subprocess"
12001 #: ../src/guestfs-actions.pod:3460
12005 " guestfs_kill_subprocess (guestfs_h *g);\n"
12010 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2424
12011 msgid "This kills the qemu subprocess. You should never need to call this."
12015 #: ../src/guestfs-actions.pod:3469
12016 msgid "guestfs_launch"
12020 #: ../src/guestfs-actions.pod:3471
12024 " guestfs_launch (guestfs_h *g);\n"
12029 #: ../src/guestfs-actions.pod:3474 ../fish/guestfish-actions.pod:2432
12031 "Internally libguestfs is implemented by running a virtual machine using "
12036 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2435
12038 "You should call this after configuring the handle (eg. adding drives) but "
12039 "before performing any actions."
12043 #: ../src/guestfs-actions.pod:3489
12044 msgid "guestfs_lchown"
12048 #: ../src/guestfs-actions.pod:3491
12052 " guestfs_lchown (guestfs_h *g,\n"
12055 " const char *path);\n"
12060 #: ../src/guestfs-actions.pod:3497
12062 "Change the file owner to C<owner> and group to C<group>. This is like "
12063 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12064 "changed, not the target."
12068 #: ../src/guestfs-actions.pod:3509
12069 msgid "guestfs_lgetxattr"
12073 #: ../src/guestfs-actions.pod:3511
12077 " guestfs_lgetxattr (guestfs_h *g,\n"
12078 " const char *path,\n"
12079 " const char *name,\n"
12080 " size_t *size_r);\n"
12085 #: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2454
12087 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12088 "is a symlink, then this call returns an extended attribute from the symlink."
12092 #: ../src/guestfs-actions.pod:3531
12093 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12097 #: ../src/guestfs-actions.pod:3539
12098 msgid "guestfs_lgetxattrs"
12102 #: ../src/guestfs-actions.pod:3541
12105 " struct guestfs_xattr_list *\n"
12106 " guestfs_lgetxattrs (guestfs_h *g,\n"
12107 " const char *path);\n"
12112 #: ../src/guestfs-actions.pod:3545
12114 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12115 "then it returns the extended attributes of the link itself."
12119 #: ../src/guestfs-actions.pod:3555
12120 msgid "guestfs_list_devices"
12124 #: ../src/guestfs-actions.pod:3557
12128 " guestfs_list_devices (guestfs_h *g);\n"
12133 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2482
12134 msgid "List all the block devices."
12138 #: ../src/guestfs-actions.pod:3562 ../fish/guestfish-actions.pod:2484
12139 msgid "The full block device names are returned, eg. C</dev/sda>."
12143 #: ../src/guestfs-actions.pod:3572
12144 msgid "guestfs_list_filesystems"
12148 #: ../src/guestfs-actions.pod:3574
12152 " guestfs_list_filesystems (guestfs_h *g);\n"
12157 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2492
12159 "This inspection command looks for filesystems on partitions, block devices "
12160 "and logical volumes, returning a list of devices containing filesystems and "
12165 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2496
12167 "The return value is a hash, where the keys are the devices containing "
12168 "filesystems, and the values are the filesystem types. For example:"
12172 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2500
12175 " \"/dev/sda1\" => \"ntfs\"\n"
12176 " \"/dev/sda2\" => \"ext2\"\n"
12177 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12178 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12183 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2505
12185 "The value can have the special value \"unknown\", meaning the content of the "
12186 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12190 #: ../src/guestfs-actions.pod:3594
12192 "This command runs other libguestfs commands, which might include "
12193 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12194 "soon after launch and only when nothing is mounted."
12198 #: ../src/guestfs-actions.pod:3598
12200 "Not all of the filesystems returned will be mountable. In particular, swap "
12201 "partitions are returned in the list. Also this command does not check that "
12202 "each filesystem found is valid and mountable, and some filesystems might be "
12203 "mountable but require special options. Filesystems may not all belong to a "
12204 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12208 #: ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:5217
12209 msgid "(Added in 1.5.15)"
12213 #: ../src/guestfs-actions.pod:3614
12214 msgid "guestfs_list_partitions"
12218 #: ../src/guestfs-actions.pod:3616
12222 " guestfs_list_partitions (guestfs_h *g);\n"
12227 #: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2525
12228 msgid "List all the partitions detected on all block devices."
12232 #: ../src/guestfs-actions.pod:3621 ../fish/guestfish-actions.pod:2527
12233 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12237 #: ../src/guestfs-actions.pod:3623
12239 "This does not return logical volumes. For that you will need to call "
12244 #: ../src/guestfs-actions.pod:3634
12249 #: ../src/guestfs-actions.pod:3636
12253 " guestfs_ll (guestfs_h *g,\n"
12254 " const char *directory);\n"
12259 #: ../src/guestfs-actions.pod:3640 ../fish/guestfish-actions.pod:2538
12261 "List the files in C<directory> (relative to the root directory, there is no "
12262 "cwd) in the format of 'ls -la'."
12266 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2541
12268 "This command is mostly useful for interactive sessions. It is I<not> "
12269 "intended that you try to parse the output string."
12273 #: ../src/guestfs-actions.pod:3651
12278 #: ../src/guestfs-actions.pod:3653
12282 " guestfs_ln (guestfs_h *g,\n"
12283 " const char *target,\n"
12284 " const char *linkname);\n"
12289 #: ../src/guestfs-actions.pod:3658 ../fish/guestfish-actions.pod:2548
12290 msgid "This command creates a hard link using the C<ln> command."
12294 #: ../src/guestfs-actions.pod:3664
12295 msgid "guestfs_ln_f"
12299 #: ../src/guestfs-actions.pod:3666
12303 " guestfs_ln_f (guestfs_h *g,\n"
12304 " const char *target,\n"
12305 " const char *linkname);\n"
12310 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2554
12312 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12313 "option removes the link (C<linkname>) if it exists already."
12317 #: ../src/guestfs-actions.pod:3678
12318 msgid "guestfs_ln_s"
12322 #: ../src/guestfs-actions.pod:3680
12326 " guestfs_ln_s (guestfs_h *g,\n"
12327 " const char *target,\n"
12328 " const char *linkname);\n"
12333 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2561
12334 msgid "This command creates a symbolic link using the C<ln -s> command."
12338 #: ../src/guestfs-actions.pod:3691
12339 msgid "guestfs_ln_sf"
12343 #: ../src/guestfs-actions.pod:3693
12347 " guestfs_ln_sf (guestfs_h *g,\n"
12348 " const char *target,\n"
12349 " const char *linkname);\n"
12354 #: ../src/guestfs-actions.pod:3698 ../fish/guestfish-actions.pod:2567
12356 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12357 "option removes the link (C<linkname>) if it exists already."
12361 #: ../src/guestfs-actions.pod:3705
12362 msgid "guestfs_lremovexattr"
12366 #: ../src/guestfs-actions.pod:3707
12370 " guestfs_lremovexattr (guestfs_h *g,\n"
12371 " const char *xattr,\n"
12372 " const char *path);\n"
12377 #: ../src/guestfs-actions.pod:3712
12379 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12380 "link, then it removes an extended attribute of the link itself."
12384 #: ../src/guestfs-actions.pod:3720
12389 #: ../src/guestfs-actions.pod:3722
12393 " guestfs_ls (guestfs_h *g,\n"
12394 " const char *directory);\n"
12399 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2582
12401 "List the files in C<directory> (relative to the root directory, there is no "
12402 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12406 #: ../src/guestfs-actions.pod:3730
12408 "This command is mostly useful for interactive sessions. Programs should "
12409 "probably use C<guestfs_readdir> instead."
12413 #: ../src/guestfs-actions.pod:3739
12414 msgid "guestfs_lsetxattr"
12418 #: ../src/guestfs-actions.pod:3741
12422 " guestfs_lsetxattr (guestfs_h *g,\n"
12423 " const char *xattr,\n"
12424 " const char *val,\n"
12426 " const char *path);\n"
12431 #: ../src/guestfs-actions.pod:3748
12433 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12434 "then it sets an extended attribute of the link itself."
12438 #: ../src/guestfs-actions.pod:3756
12439 msgid "guestfs_lstat"
12443 #: ../src/guestfs-actions.pod:3758
12446 " struct guestfs_stat *\n"
12447 " guestfs_lstat (guestfs_h *g,\n"
12448 " const char *path);\n"
12453 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:6320
12454 #: ../fish/guestfish-actions.pod:2601 ../fish/guestfish-actions.pod:4270
12455 msgid "Returns file information for the given C<path>."
12459 #: ../src/guestfs-actions.pod:3764
12461 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12462 "link, then the link is stat-ed, not the file it refers to."
12466 #: ../src/guestfs-actions.pod:3768 ../fish/guestfish-actions.pod:2607
12467 msgid "This is the same as the C<lstat(2)> system call."
12471 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6324
12473 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12474 "error. I<The caller must call C<guestfs_free_stat> after use>."
12478 #: ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:6328
12479 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6727
12480 msgid "(Added in 0.9.2)"
12484 #: ../src/guestfs-actions.pod:3776
12485 msgid "guestfs_lstatlist"
12489 #: ../src/guestfs-actions.pod:3778
12492 " struct guestfs_stat_list *\n"
12493 " guestfs_lstatlist (guestfs_h *g,\n"
12494 " const char *path,\n"
12495 " char *const *names);\n"
12500 #: ../src/guestfs-actions.pod:3783
12502 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12503 "files, where all files are in the directory C<path>. C<names> is the list "
12504 "of files from this directory."
12508 #: ../src/guestfs-actions.pod:3787 ../fish/guestfish-actions.pod:2617
12510 "On return you get a list of stat structs, with a one-to-one correspondence "
12511 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12512 "then the C<ino> field of that structure is set to C<-1>."
12516 #: ../src/guestfs-actions.pod:3792
12518 "This call is intended for programs that want to efficiently list a directory "
12519 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12520 "for a similarly efficient call for getting extended attributes. Very long "
12521 "directory listings might cause the protocol message size to be exceeded, "
12522 "causing this call to fail. The caller must split up such requests into "
12523 "smaller groups of names."
12527 #: ../src/guestfs-actions.pod:3800
12529 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12530 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12534 #: ../src/guestfs-actions.pod:3806
12535 msgid "guestfs_luks_add_key"
12539 #: ../src/guestfs-actions.pod:3808
12543 " guestfs_luks_add_key (guestfs_h *g,\n"
12544 " const char *device,\n"
12545 " const char *key,\n"
12546 " const char *newkey,\n"
12552 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2634
12554 "This command adds a new key on LUKS device C<device>. C<key> is any "
12555 "existing key, and is used to access the device. C<newkey> is the new key to "
12556 "add. C<keyslot> is the key slot that will be replaced."
12560 #: ../src/guestfs-actions.pod:3820
12562 "Note that if C<keyslot> already contains a key, then this command will "
12563 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12567 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866
12568 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
12569 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3960
12571 "This function takes a key or passphrase parameter which could contain "
12572 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12577 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3870
12578 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3913
12579 msgid "(Added in 1.5.2)"
12583 #: ../src/guestfs-actions.pod:3832
12584 msgid "guestfs_luks_close"
12588 #: ../src/guestfs-actions.pod:3834
12592 " guestfs_luks_close (guestfs_h *g,\n"
12593 " const char *device);\n"
12598 #: ../src/guestfs-actions.pod:3838
12600 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12601 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12602 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12603 "underlying block device."
12607 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3945
12608 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:4014
12609 #: ../src/guestfs-actions.pod:4062
12610 msgid "(Added in 1.5.1)"
12614 #: ../src/guestfs-actions.pod:3848
12615 msgid "guestfs_luks_format"
12619 #: ../src/guestfs-actions.pod:3850
12623 " guestfs_luks_format (guestfs_h *g,\n"
12624 " const char *device,\n"
12625 " const char *key,\n"
12631 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2660
12633 "This command erases existing data on C<device> and formats the device as a "
12634 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12635 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12639 #: ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3886
12640 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4968
12641 #: ../src/guestfs-actions.pod:5748 ../src/guestfs-actions.pod:6155
12642 #: ../src/guestfs-actions.pod:6178 ../src/guestfs-actions.pod:6204
12643 #: ../src/guestfs-actions.pod:7364 ../fish/guestfish-actions.pod:2668
12644 #: ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2765
12645 #: ../fish/guestfish-actions.pod:3339 ../fish/guestfish-actions.pod:3859
12646 #: ../fish/guestfish-actions.pod:4169 ../fish/guestfish-actions.pod:4185
12647 #: ../fish/guestfish-actions.pod:4200 ../fish/guestfish-actions.pod:4915
12649 "B<This command is dangerous. Without careful use you can easily destroy all "
12654 #: ../src/guestfs-actions.pod:3872
12655 msgid "guestfs_luks_format_cipher"
12659 #: ../src/guestfs-actions.pod:3874
12663 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12664 " const char *device,\n"
12665 " const char *key,\n"
12667 " const char *cipher);\n"
12672 #: ../src/guestfs-actions.pod:3881
12674 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12675 "set the C<cipher> used."
12679 #: ../src/guestfs-actions.pod:3895
12680 msgid "guestfs_luks_kill_slot"
12684 #: ../src/guestfs-actions.pod:3897
12688 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12689 " const char *device,\n"
12690 " const char *key,\n"
12696 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2688
12698 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12699 "device C<device>. C<key> must be one of the I<other> keys."
12703 #: ../src/guestfs-actions.pod:3915
12704 msgid "guestfs_luks_open"
12708 #: ../src/guestfs-actions.pod:3917
12712 " guestfs_luks_open (guestfs_h *g,\n"
12713 " const char *device,\n"
12714 " const char *key,\n"
12715 " const char *mapname);\n"
12720 #: ../src/guestfs-actions.pod:3923 ../fish/guestfish-actions.pod:2699
12722 "This command opens a block device which has been encrypted according to the "
12723 "Linux Unified Key Setup (LUKS) standard."
12727 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2702
12728 msgid "C<device> is the encrypted block device or partition."
12732 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2704
12734 "The caller must supply one of the keys associated with the LUKS block "
12735 "device, in the C<key> parameter."
12739 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2707
12741 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12742 "writes to this block device are decrypted from and encrypted to the "
12743 "underlying C<device> respectively."
12747 #: ../src/guestfs-actions.pod:3935
12749 "If this block device contains LVM volume groups, then calling "
12750 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12755 #: ../src/guestfs-actions.pod:3947
12756 msgid "guestfs_luks_open_ro"
12760 #: ../src/guestfs-actions.pod:3949
12764 " guestfs_luks_open_ro (guestfs_h *g,\n"
12765 " const char *device,\n"
12766 " const char *key,\n"
12767 " const char *mapname);\n"
12772 #: ../src/guestfs-actions.pod:3955
12774 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12779 #: ../src/guestfs-actions.pod:3966
12780 msgid "guestfs_lvcreate"
12784 #: ../src/guestfs-actions.pod:3968
12788 " guestfs_lvcreate (guestfs_h *g,\n"
12789 " const char *logvol,\n"
12790 " const char *volgroup,\n"
12796 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2732
12798 "This creates an LVM logical volume called C<logvol> on the volume group "
12799 "C<volgroup>, with C<size> megabytes."
12803 #: ../src/guestfs-actions.pod:3981
12804 msgid "guestfs_lvm_canonical_lv_name"
12808 #: ../src/guestfs-actions.pod:3983
12812 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12813 " const char *lvname);\n"
12818 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2739
12820 "This converts alternative naming schemes for LVs that you might find to the "
12821 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12826 #: ../src/guestfs-actions.pod:3991 ../fish/guestfish-actions.pod:2743
12828 "This command returns an error if the C<lvname> parameter does not refer to a "
12833 #: ../src/guestfs-actions.pod:3994
12834 msgid "See also C<guestfs_is_lv>."
12838 #: ../src/guestfs-actions.pod:3999
12839 msgid "(Added in 1.5.24)"
12843 #: ../src/guestfs-actions.pod:4001
12844 msgid "guestfs_lvm_clear_filter"
12848 #: ../src/guestfs-actions.pod:4003
12852 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12857 #: ../src/guestfs-actions.pod:4006
12859 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12860 "see every block device."
12864 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4051
12865 #: ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2786
12867 "This command also clears the LVM cache and performs a volume group scan."
12871 #: ../src/guestfs-actions.pod:4016
12872 msgid "guestfs_lvm_remove_all"
12876 #: ../src/guestfs-actions.pod:4018
12880 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12885 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2762
12887 "This command removes all LVM logical volumes, volume groups and physical "
12892 #: ../src/guestfs-actions.pod:4031
12893 msgid "guestfs_lvm_set_filter"
12897 #: ../src/guestfs-actions.pod:4033
12901 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12902 " char *const *devices);\n"
12907 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2772
12909 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12910 "block devices in the list C<devices>, and will ignore all other attached "
12915 #: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2776
12917 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12918 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12919 "there are two types of duplication possible: either cloned PVs/VGs which "
12920 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12921 "same name. In normal operation you cannot create this situation, but you "
12922 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12923 "inside the LVM metadata."
12927 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2789
12928 msgid "You can filter whole block devices or individual partitions."
12932 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2791
12934 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12935 "filesystem), even if you are not filtering out that VG."
12939 #: ../src/guestfs-actions.pod:4064
12940 msgid "guestfs_lvremove"
12944 #: ../src/guestfs-actions.pod:4066
12948 " guestfs_lvremove (guestfs_h *g,\n"
12949 " const char *device);\n"
12954 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2799
12956 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12957 "LV, such as C</dev/VG/LV>."
12961 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2802
12963 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12968 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:5314
12969 #: ../src/guestfs-actions.pod:7103
12970 msgid "(Added in 1.0.13)"
12974 #: ../src/guestfs-actions.pod:4080
12975 msgid "guestfs_lvrename"
12979 #: ../src/guestfs-actions.pod:4082
12983 " guestfs_lvrename (guestfs_h *g,\n"
12984 " const char *logvol,\n"
12985 " const char *newlogvol);\n"
12990 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2809
12991 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12995 #: ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:7116
12996 msgid "(Added in 1.0.83)"
13000 #: ../src/guestfs-actions.pod:4093
13001 msgid "guestfs_lvresize"
13005 #: ../src/guestfs-actions.pod:4095
13009 " guestfs_lvresize (guestfs_h *g,\n"
13010 " const char *device,\n"
13016 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2815
13018 "This resizes (expands or shrinks) an existing LVM logical volume to "
13019 "C<mbytes>. When reducing, data in the reduced part is lost."
13023 #: ../src/guestfs-actions.pod:4108
13024 msgid "guestfs_lvresize_free"
13028 #: ../src/guestfs-actions.pod:4110
13032 " guestfs_lvresize_free (guestfs_h *g,\n"
13033 " const char *lv,\n"
13039 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2823
13041 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13042 "remaining free space in the volume group. Commonly you would call this with "
13043 "pc = 100 which expands the logical volume as much as possible, using all "
13044 "remaining free space in the volume group."
13048 #: ../src/guestfs-actions.pod:4123
13049 msgid "(Added in 1.3.3)"
13053 #: ../src/guestfs-actions.pod:4125
13054 msgid "guestfs_lvs"
13058 #: ../src/guestfs-actions.pod:4127
13062 " guestfs_lvs (guestfs_h *g);\n"
13067 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2833
13069 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13074 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2836
13076 "This returns a list of the logical volume device names (eg. C</dev/"
13077 "VolGroup00/LogVol00>)."
13081 #: ../src/guestfs-actions.pod:4136
13082 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13086 #: ../src/guestfs-actions.pod:4144
13087 msgid "guestfs_lvs_full"
13091 #: ../src/guestfs-actions.pod:4146
13094 " struct guestfs_lvm_lv_list *\n"
13095 " guestfs_lvs_full (guestfs_h *g);\n"
13100 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2845
13102 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13103 "(8)> command. The \"full\" version includes all fields."
13107 #: ../src/guestfs-actions.pod:4152
13109 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13110 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13114 #: ../src/guestfs-actions.pod:4158
13115 msgid "guestfs_lvuuid"
13119 #: ../src/guestfs-actions.pod:4160
13123 " guestfs_lvuuid (guestfs_h *g,\n"
13124 " const char *device);\n"
13129 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2852
13130 msgid "This command returns the UUID of the LVM LV C<device>."
13134 #: ../src/guestfs-actions.pod:4171
13135 msgid "guestfs_lxattrlist"
13139 #: ../src/guestfs-actions.pod:4173
13142 " struct guestfs_xattr_list *\n"
13143 " guestfs_lxattrlist (guestfs_h *g,\n"
13144 " const char *path,\n"
13145 " char *const *names);\n"
13150 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2858
13152 "This call allows you to get the extended attributes of multiple files, where "
13153 "all files are in the directory C<path>. C<names> is the list of files from "
13158 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2862
13160 "On return you get a flat list of xattr structs which must be interpreted "
13161 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13162 "C<attrval> in this struct is zero-length to indicate there was an error "
13163 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13164 "number (the number of following attributes for this file, which could be C<"
13165 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13166 "for the first named file. This repeats for the second and subsequent files."
13170 #: ../src/guestfs-actions.pod:4192
13172 "This call is intended for programs that want to efficiently list a directory "
13173 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13174 "a similarly efficient call for getting standard stats. Very long directory "
13175 "listings might cause the protocol message size to be exceeded, causing this "
13176 "call to fail. The caller must split up such requests into smaller groups of "
13181 #: ../src/guestfs-actions.pod:4206
13182 msgid "guestfs_mkdir"
13186 #: ../src/guestfs-actions.pod:4208
13190 " guestfs_mkdir (guestfs_h *g,\n"
13191 " const char *path);\n"
13196 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2884
13197 msgid "Create a directory named C<path>."
13201 #: ../src/guestfs-actions.pod:4218
13202 msgid "guestfs_mkdir_mode"
13206 #: ../src/guestfs-actions.pod:4220
13210 " guestfs_mkdir_mode (guestfs_h *g,\n"
13211 " const char *path,\n"
13217 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2890
13219 "This command creates a directory, setting the initial permissions of the "
13220 "directory to C<mode>."
13224 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2893
13226 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13227 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13232 #: ../src/guestfs-actions.pod:4232
13233 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13237 #: ../src/guestfs-actions.pod:4238
13238 msgid "guestfs_mkdir_p"
13242 #: ../src/guestfs-actions.pod:4240
13246 " guestfs_mkdir_p (guestfs_h *g,\n"
13247 " const char *path);\n"
13252 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2903
13254 "Create a directory named C<path>, creating any parent directories as "
13255 "necessary. This is like the C<mkdir -p> shell command."
13259 #: ../src/guestfs-actions.pod:4251
13260 msgid "guestfs_mkdtemp"
13264 #: ../src/guestfs-actions.pod:4253
13268 " guestfs_mkdtemp (guestfs_h *g,\n"
13269 " const char *template);\n"
13274 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2910
13276 "This command creates a temporary directory. The C<template> parameter "
13277 "should be a full pathname for the temporary directory name with the final "
13278 "six characters being \"XXXXXX\"."
13282 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2915
13284 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13285 "being suitable for Windows filesystems."
13289 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2918
13290 msgid "The name of the temporary directory that was created is returned."
13294 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2921
13295 msgid "The temporary directory is created with mode 0700 and is owned by root."
13299 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2924
13301 "The caller is responsible for deleting the temporary directory and its "
13302 "contents after use."
13306 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2927
13307 msgid "See also: L<mkdtemp(3)>"
13311 #: ../src/guestfs-actions.pod:4281
13312 msgid "guestfs_mke2fs_J"
13316 #: ../src/guestfs-actions.pod:4283
13320 " guestfs_mke2fs_J (guestfs_h *g,\n"
13321 " const char *fstype,\n"
13322 " int blocksize,\n"
13323 " const char *device,\n"
13324 " const char *journal);\n"
13329 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2933
13331 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13332 "C<journal>. It is equivalent to the command:"
13336 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2937
13339 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13344 #: ../src/guestfs-actions.pod:4296
13345 msgid "See also C<guestfs_mke2journal>."
13349 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4318
13350 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4352
13351 #: ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4380
13352 #: ../src/guestfs-actions.pod:4439 ../src/guestfs-actions.pod:4704
13353 msgid "(Added in 1.0.68)"
13357 #: ../src/guestfs-actions.pod:4302
13358 msgid "guestfs_mke2fs_JL"
13362 #: ../src/guestfs-actions.pod:4304
13366 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13367 " const char *fstype,\n"
13368 " int blocksize,\n"
13369 " const char *device,\n"
13370 " const char *label);\n"
13375 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2945
13377 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13378 "the journal labeled C<label>."
13382 #: ../src/guestfs-actions.pod:4314
13383 msgid "See also C<guestfs_mke2journal_L>."
13387 #: ../src/guestfs-actions.pod:4320
13388 msgid "guestfs_mke2fs_JU"
13392 #: ../src/guestfs-actions.pod:4322
13396 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13397 " const char *fstype,\n"
13398 " int blocksize,\n"
13399 " const char *device,\n"
13400 " const char *uuid);\n"
13405 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2954
13407 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13408 "the journal with UUID C<uuid>."
13412 #: ../src/guestfs-actions.pod:4332
13413 msgid "See also C<guestfs_mke2journal_U>."
13417 #: ../src/guestfs-actions.pod:4338
13418 msgid "guestfs_mke2journal"
13422 #: ../src/guestfs-actions.pod:4340
13426 " guestfs_mke2journal (guestfs_h *g,\n"
13427 " int blocksize,\n"
13428 " const char *device);\n"
13433 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2963
13435 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13440 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2966
13443 " mke2fs -O journal_dev -b blocksize device\n"
13448 #: ../src/guestfs-actions.pod:4354
13449 msgid "guestfs_mke2journal_L"
13453 #: ../src/guestfs-actions.pod:4356
13457 " guestfs_mke2journal_L (guestfs_h *g,\n"
13458 " int blocksize,\n"
13459 " const char *label,\n"
13460 " const char *device);\n"
13465 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2972
13466 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13470 #: ../src/guestfs-actions.pod:4368
13471 msgid "guestfs_mke2journal_U"
13475 #: ../src/guestfs-actions.pod:4370
13479 " guestfs_mke2journal_U (guestfs_h *g,\n"
13480 " int blocksize,\n"
13481 " const char *uuid,\n"
13482 " const char *device);\n"
13487 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2978
13488 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13492 #: ../src/guestfs-actions.pod:4382
13493 msgid "guestfs_mkfifo"
13497 #: ../src/guestfs-actions.pod:4384
13501 " guestfs_mkfifo (guestfs_h *g,\n"
13503 " const char *path);\n"
13508 #: ../src/guestfs-actions.pod:4389
13510 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13511 "is just a convenient wrapper around C<guestfs_mknod>."
13515 #: ../src/guestfs-actions.pod:4399
13516 msgid "guestfs_mkfs"
13520 #: ../src/guestfs-actions.pod:4401
13524 " guestfs_mkfs (guestfs_h *g,\n"
13525 " const char *fstype,\n"
13526 " const char *device);\n"
13531 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:2994
13533 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13534 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13538 #: ../src/guestfs-actions.pod:4414
13539 msgid "guestfs_mkfs_b"
13543 #: ../src/guestfs-actions.pod:4416
13547 " guestfs_mkfs_b (guestfs_h *g,\n"
13548 " const char *fstype,\n"
13549 " int blocksize,\n"
13550 " const char *device);\n"
13555 #: ../src/guestfs-actions.pod:4422
13557 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13558 "block size of the resulting filesystem. Supported block sizes depend on the "
13559 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13563 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4470
13564 #: ../fish/guestfish-actions.pod:3007 ../fish/guestfish-actions.pod:3034
13566 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13571 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:3010
13573 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13577 #: ../src/guestfs-actions.pod:4441
13578 msgid "guestfs_mkfs_opts"
13582 #: ../src/guestfs-actions.pod:4443
13586 " guestfs_mkfs_opts (guestfs_h *g,\n"
13587 " const char *fstype,\n"
13588 " const char *device,\n"
13594 #: ../src/guestfs-actions.pod:4454
13597 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13598 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13603 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3021
13605 "This function creates a filesystem on C<device>. The filesystem type is "
13606 "C<fstype>, for example C<ext3>."
13610 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3028
13611 msgid "C<blocksize>"
13615 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3030
13617 "The filesystem block size. Supported block sizes depend on the filesystem "
13618 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13623 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3037
13624 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13628 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3039
13629 msgid "C<features>"
13633 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3041
13634 msgid "This passes the I<-O> parameter to the external mkfs program."
13638 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3043
13640 "For certain filesystem types, this allows extra filesystem features to be "
13641 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13645 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3047
13647 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13652 #: ../src/guestfs-actions.pod:4490
13653 msgid "(Added in 1.7.19)"
13657 #: ../src/guestfs-actions.pod:4492
13658 msgid "guestfs_mkfs_opts_va"
13662 #: ../src/guestfs-actions.pod:4494
13666 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13667 " const char *fstype,\n"
13668 " const char *device,\n"
13669 " va_list args);\n"
13674 #: ../src/guestfs-actions.pod:4500
13675 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13679 #: ../src/guestfs-actions.pod:4504
13680 msgid "guestfs_mkfs_opts_argv"
13684 #: ../src/guestfs-actions.pod:4506
13688 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13689 " const char *fstype,\n"
13690 " const char *device,\n"
13691 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13696 #: ../src/guestfs-actions.pod:4512
13697 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13701 #: ../src/guestfs-actions.pod:4516
13702 msgid "guestfs_mkmountpoint"
13706 #: ../src/guestfs-actions.pod:4518
13710 " guestfs_mkmountpoint (guestfs_h *g,\n"
13711 " const char *exemptpath);\n"
13716 #: ../src/guestfs-actions.pod:4522
13718 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13719 "that can be used to create extra mountpoints before mounting the first "
13724 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3062
13726 "These calls are I<only> necessary in some very limited circumstances, mainly "
13727 "the case where you want to mount a mix of unrelated and/or read-only "
13728 "filesystems together."
13732 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3066
13734 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13735 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13736 "inside that. You can unpack this as follows in guestfish:"
13740 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3071
13743 " add-ro Fedora-11-i686-Live.iso\n"
13745 " mkmountpoint /cd\n"
13746 " mkmountpoint /sqsh\n"
13747 " mkmountpoint /ext3fs\n"
13748 " mount /dev/sda /cd\n"
13749 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13750 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13755 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3080
13756 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13760 #: ../src/guestfs-actions.pod:4546
13762 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13763 "may get unexpected errors if you try to mix these calls. It is safest to "
13764 "manually unmount filesystems and remove mountpoints after use."
13768 #: ../src/guestfs-actions.pod:4550
13770 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13771 "first, so for this to work for manual mountpoints, you must ensure that the "
13772 "innermost mountpoints have the longest pathnames, as in the example code "
13777 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3091
13779 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13783 #: ../src/guestfs-actions.pod:4557
13785 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13786 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13787 "can also trigger these issues."
13791 #: ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4822
13792 #: ../src/guestfs-actions.pod:5732
13793 msgid "(Added in 1.0.62)"
13797 #: ../src/guestfs-actions.pod:4565
13798 msgid "guestfs_mknod"
13802 #: ../src/guestfs-actions.pod:4567
13806 " guestfs_mknod (guestfs_h *g,\n"
13810 " const char *path);\n"
13815 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3101
13817 "This call creates block or character special devices, or named pipes (FIFOs)."
13821 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3104
13823 "The C<mode> parameter should be the mode, using the standard constants. "
13824 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13825 "used when creating block and character special devices."
13829 #: ../src/guestfs-actions.pod:4582
13831 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13832 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13833 "regular file). These constants are available in the standard Linux header "
13834 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13835 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13836 "the appropriate constant for you."
13840 #: ../src/guestfs-actions.pod:4596
13841 msgid "guestfs_mknod_b"
13845 #: ../src/guestfs-actions.pod:4598
13849 " guestfs_mknod_b (guestfs_h *g,\n"
13853 " const char *path);\n"
13858 #: ../src/guestfs-actions.pod:4605
13860 "This call creates a block device node called C<path> with mode C<mode> and "
13861 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13862 "wrapper around C<guestfs_mknod>."
13866 #: ../src/guestfs-actions.pod:4615
13867 msgid "guestfs_mknod_c"
13871 #: ../src/guestfs-actions.pod:4617
13875 " guestfs_mknod_c (guestfs_h *g,\n"
13879 " const char *path);\n"
13884 #: ../src/guestfs-actions.pod:4624
13886 "This call creates a char device node called C<path> with mode C<mode> and "
13887 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13888 "wrapper around C<guestfs_mknod>."
13892 #: ../src/guestfs-actions.pod:4634
13893 msgid "guestfs_mkswap"
13897 #: ../src/guestfs-actions.pod:4636
13901 " guestfs_mkswap (guestfs_h *g,\n"
13902 " const char *device);\n"
13907 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3143
13908 msgid "Create a swap partition on C<device>."
13912 #: ../src/guestfs-actions.pod:4646
13913 msgid "guestfs_mkswap_L"
13917 #: ../src/guestfs-actions.pod:4648
13921 " guestfs_mkswap_L (guestfs_h *g,\n"
13922 " const char *label,\n"
13923 " const char *device);\n"
13928 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3149
13929 msgid "Create a swap partition on C<device> with label C<label>."
13933 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3151
13935 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13936 "sda>), just to a partition. This appears to be a limitation of the kernel "
13941 #: ../src/guestfs-actions.pod:4663
13942 msgid "guestfs_mkswap_U"
13946 #: ../src/guestfs-actions.pod:4665
13950 " guestfs_mkswap_U (guestfs_h *g,\n"
13951 " const char *uuid,\n"
13952 " const char *device);\n"
13957 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3159
13958 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13962 #: ../src/guestfs-actions.pod:4676
13963 msgid "guestfs_mkswap_file"
13967 #: ../src/guestfs-actions.pod:4678
13971 " guestfs_mkswap_file (guestfs_h *g,\n"
13972 " const char *path);\n"
13977 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3165
13978 msgid "Create a swap file."
13982 #: ../src/guestfs-actions.pod:4684
13984 "This command just writes a swap file signature to an existing file. To "
13985 "create the file itself, use something like C<guestfs_fallocate>."
13989 #: ../src/guestfs-actions.pod:4691
13990 msgid "guestfs_modprobe"
13994 #: ../src/guestfs-actions.pod:4693
13998 " guestfs_modprobe (guestfs_h *g,\n"
13999 " const char *modulename);\n"
14004 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3174
14005 msgid "This loads a kernel module in the appliance."
14009 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3176
14011 "The kernel module must have been whitelisted when libguestfs was built (see "
14012 "C<appliance/kmod.whitelist.in> in the source)."
14016 #: ../src/guestfs-actions.pod:4706
14017 msgid "guestfs_mount"
14021 #: ../src/guestfs-actions.pod:4708
14025 " guestfs_mount (guestfs_h *g,\n"
14026 " const char *device,\n"
14027 " const char *mountpoint);\n"
14032 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3183
14034 "Mount a guest disk at a position in the filesystem. Block devices are named "
14035 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14036 "those block devices contain partitions, they will have the usual names (eg. "
14037 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14041 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3189
14043 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14044 "mounted on C</> before others can be mounted. Other filesystems can only be "
14045 "mounted on directories which already exist."
14049 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3194
14051 "The mounted filesystem is writable, if we have sufficient permissions on the "
14052 "underlying device."
14056 #: ../src/guestfs-actions.pod:4727
14058 "B<Important note:> When you use this call, the filesystem options C<sync> "
14059 "and C<noatime> are set implicitly. This was originally done because we "
14060 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14061 "very large negative performance impact and negligible effect on "
14062 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14063 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14064 "(use an empty string for the first parameter if you don't want any options)."
14068 #: ../src/guestfs-actions.pod:4741
14069 msgid "guestfs_mount_loop"
14073 #: ../src/guestfs-actions.pod:4743
14077 " guestfs_mount_loop (guestfs_h *g,\n"
14078 " const char *file,\n"
14079 " const char *mountpoint);\n"
14084 #: ../src/guestfs-actions.pod:4748 ../fish/guestfish-actions.pod:3211
14086 "This command lets you mount C<file> (a filesystem image in a file) on a "
14087 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14092 #: ../src/guestfs-actions.pod:4756
14093 msgid "guestfs_mount_options"
14097 #: ../src/guestfs-actions.pod:4758
14101 " guestfs_mount_options (guestfs_h *g,\n"
14102 " const char *options,\n"
14103 " const char *device,\n"
14104 " const char *mountpoint);\n"
14109 #: ../src/guestfs-actions.pod:4764
14111 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14112 "the mount options as for the L<mount(8)> I<-o> flag."
14116 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3223
14118 "If the C<options> parameter is an empty string, then no options are passed "
14119 "(all options default to whatever the filesystem uses)."
14123 #: ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4788
14124 #: ../src/guestfs-actions.pod:4805
14125 msgid "(Added in 1.0.10)"
14129 #: ../src/guestfs-actions.pod:4776
14130 msgid "guestfs_mount_ro"
14134 #: ../src/guestfs-actions.pod:4778
14138 " guestfs_mount_ro (guestfs_h *g,\n"
14139 " const char *device,\n"
14140 " const char *mountpoint);\n"
14145 #: ../src/guestfs-actions.pod:4783
14147 "This is the same as the C<guestfs_mount> command, but it mounts the "
14148 "filesystem with the read-only (I<-o ro>) flag."
14152 #: ../src/guestfs-actions.pod:4790
14153 msgid "guestfs_mount_vfs"
14157 #: ../src/guestfs-actions.pod:4792
14161 " guestfs_mount_vfs (guestfs_h *g,\n"
14162 " const char *options,\n"
14163 " const char *vfstype,\n"
14164 " const char *device,\n"
14165 " const char *mountpoint);\n"
14170 #: ../src/guestfs-actions.pod:4799
14172 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14173 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14178 #: ../src/guestfs-actions.pod:4807
14179 msgid "guestfs_mountpoints"
14183 #: ../src/guestfs-actions.pod:4809
14187 " guestfs_mountpoints (guestfs_h *g);\n"
14192 #: ../src/guestfs-actions.pod:4812
14194 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14195 "devices. This one returns a hash table (map) of device name to directory "
14196 "where the device is mounted."
14200 #: ../src/guestfs-actions.pod:4824
14201 msgid "guestfs_mounts"
14205 #: ../src/guestfs-actions.pod:4826
14209 " guestfs_mounts (guestfs_h *g);\n"
14214 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3254
14216 "This returns the list of currently mounted filesystems. It returns the list "
14217 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14221 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3257
14222 msgid "Some internal mounts are not shown."
14226 #: ../src/guestfs-actions.pod:4834
14227 msgid "See also: C<guestfs_mountpoints>"
14231 #: ../src/guestfs-actions.pod:4842
14236 #: ../src/guestfs-actions.pod:4844
14240 " guestfs_mv (guestfs_h *g,\n"
14241 " const char *src,\n"
14242 " const char *dest);\n"
14247 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3265
14249 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14250 "destination filename or destination directory."
14254 #: ../src/guestfs-actions.pod:4856
14255 msgid "guestfs_ntfs_3g_probe"
14259 #: ../src/guestfs-actions.pod:4858
14263 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14265 " const char *device);\n"
14270 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3272
14272 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14273 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14274 "write, and some cannot be mounted at all)."
14278 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3276
14280 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14281 "can be mounted read-write. Set it to false if you want to test if the "
14282 "volume can be mounted read-only."
14286 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3280
14288 "The return value is an integer which C<0> if the operation would succeed, or "
14289 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14293 #: ../src/guestfs-actions.pod:4877
14294 msgid "(Added in 1.0.43)"
14298 #: ../src/guestfs-actions.pod:4879
14299 msgid "guestfs_ntfsresize"
14303 #: ../src/guestfs-actions.pod:4881
14307 " guestfs_ntfsresize (guestfs_h *g,\n"
14308 " const char *device);\n"
14313 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3288
14315 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14316 "size of the underlying device. See also L<ntfsresize(8)>."
14320 #: ../src/guestfs-actions.pod:4893
14321 msgid "guestfs_ntfsresize_size"
14325 #: ../src/guestfs-actions.pod:4895
14329 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14330 " const char *device,\n"
14331 " int64_t size);\n"
14336 #: ../src/guestfs-actions.pod:4900
14338 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14339 "to specify the new size (in bytes) explicitly."
14343 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:5341
14344 #: ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5680
14345 #: ../src/guestfs-actions.pod:7251
14346 msgid "(Added in 1.3.14)"
14350 #: ../src/guestfs-actions.pod:4907
14351 msgid "guestfs_part_add"
14355 #: ../src/guestfs-actions.pod:4909
14359 " guestfs_part_add (guestfs_h *g,\n"
14360 " const char *device,\n"
14361 " const char *prlogex,\n"
14362 " int64_t startsect,\n"
14363 " int64_t endsect);\n"
14368 #: ../src/guestfs-actions.pod:4916
14370 "This command adds a partition to C<device>. If there is no partition table "
14371 "on the device, call C<guestfs_part_init> first."
14375 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3306
14377 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14378 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14379 "C<logical>) and C<e> (or C<extended>) partition types."
14383 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3311
14385 "C<startsect> and C<endsect> are the start and end of the partition in "
14386 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14387 "from the end of the disk (C<-1> is the last sector)."
14391 #: ../src/guestfs-actions.pod:4928
14393 "Creating a partition which covers the whole disk is not so easy. Use "
14394 "C<guestfs_part_disk> to do that."
14398 #: ../src/guestfs-actions.pod:4933 ../src/guestfs-actions.pod:4971
14399 #: ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5102
14400 #: ../src/guestfs-actions.pod:5140 ../src/guestfs-actions.pod:5159
14401 #: ../src/guestfs-actions.pod:5199
14402 msgid "(Added in 1.0.78)"
14406 #: ../src/guestfs-actions.pod:4935
14407 msgid "guestfs_part_del"
14411 #: ../src/guestfs-actions.pod:4937
14415 " guestfs_part_del (guestfs_h *g,\n"
14416 " const char *device,\n"
14422 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3322
14423 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14427 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3324
14429 "Note that in the case of MBR partitioning, deleting an extended partition "
14430 "also deletes any logical partitions it contains."
14434 #: ../src/guestfs-actions.pod:4952
14435 msgid "guestfs_part_disk"
14439 #: ../src/guestfs-actions.pod:4954
14443 " guestfs_part_disk (guestfs_h *g,\n"
14444 " const char *device,\n"
14445 " const char *parttype);\n"
14450 #: ../src/guestfs-actions.pod:4959
14452 "This command is simply a combination of C<guestfs_part_init> followed by "
14453 "C<guestfs_part_add> to create a single primary partition covering the whole "
14458 #: ../src/guestfs-actions.pod:4963
14460 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14461 "possible values are described in C<guestfs_part_init>."
14465 #: ../src/guestfs-actions.pod:4973
14466 msgid "guestfs_part_get_bootable"
14470 #: ../src/guestfs-actions.pod:4975
14474 " guestfs_part_get_bootable (guestfs_h *g,\n"
14475 " const char *device,\n"
14481 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3346
14483 "This command returns true if the partition C<partnum> on C<device> has the "
14484 "bootable flag set."
14488 #: ../src/guestfs-actions.pod:4983
14489 msgid "See also C<guestfs_part_set_bootable>."
14493 #: ../src/guestfs-actions.pod:4989
14494 msgid "guestfs_part_get_mbr_id"
14498 #: ../src/guestfs-actions.pod:4991
14502 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14503 " const char *device,\n"
14509 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3355
14511 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14512 "partition C<partnum>."
14516 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
14518 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14519 "undefined results for other partition table types (see "
14520 "C<guestfs_part_get_parttype>)."
14524 #: ../src/guestfs-actions.pod:5007
14525 msgid "guestfs_part_get_parttype"
14529 #: ../src/guestfs-actions.pod:5009
14533 " guestfs_part_get_parttype (guestfs_h *g,\n"
14534 " const char *device);\n"
14539 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3366
14541 "This command examines the partition table on C<device> and returns the "
14542 "partition table type (format) being used."
14546 #: ../src/guestfs-actions.pod:5016
14548 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14549 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14550 "possible, although unusual. See C<guestfs_part_init> for a full list."
14554 #: ../src/guestfs-actions.pod:5026
14555 msgid "guestfs_part_init"
14559 #: ../src/guestfs-actions.pod:5028
14563 " guestfs_part_init (guestfs_h *g,\n"
14564 " const char *device,\n"
14565 " const char *parttype);\n"
14570 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3378
14572 "This creates an empty partition table on C<device> of one of the partition "
14573 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14574 "(for large disks)."
14578 #: ../src/guestfs-actions.pod:5037
14580 "Initially there are no partitions. Following this, you should call "
14581 "C<guestfs_part_add> for each partition required."
14585 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3385
14586 msgid "Possible values for C<parttype> are:"
14590 #: ../src/guestfs-actions.pod:5044 ../fish/guestfish-actions.pod:3389
14591 msgid "B<efi> | B<gpt>"
14595 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3391
14596 msgid "Intel EFI / GPT partition table."
14600 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3393
14602 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14603 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14604 "the C<mbr> format."
14608 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3397
14609 msgid "B<mbr> | B<msdos>"
14613 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3399
14615 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14616 "Windows. This partition type will B<only> work for device sizes up to 2 "
14617 "TB. For large disks we recommend using C<gpt>."
14621 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3406
14623 "Other partition table types that may work but are not supported include:"
14627 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3411
14632 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3413
14633 msgid "AIX disk labels."
14637 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3415
14638 msgid "B<amiga> | B<rdb>"
14642 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3417
14643 msgid "Amiga \"Rigid Disk Block\" format."
14647 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3419
14652 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3421
14653 msgid "BSD disk labels."
14657 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3423
14662 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3425
14663 msgid "DASD, used on IBM mainframes."
14667 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3427
14672 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3429
14673 msgid "MIPS/SGI volumes."
14677 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3431
14682 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3433
14683 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14687 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3435
14692 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3437
14693 msgid "NEC PC-98 format, common in Japan apparently."
14697 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3439
14702 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3441
14703 msgid "Sun disk labels."
14707 #: ../src/guestfs-actions.pod:5104
14708 msgid "guestfs_part_list"
14712 #: ../src/guestfs-actions.pod:5106
14715 " struct guestfs_partition_list *\n"
14716 " guestfs_part_list (guestfs_h *g,\n"
14717 " const char *device);\n"
14722 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3449
14724 "This command parses the partition table on C<device> and returns the list of "
14725 "partitions found."
14729 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3452
14730 msgid "The fields in the returned structure are:"
14734 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3456
14735 msgid "B<part_num>"
14739 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3458
14740 msgid "Partition number, counting from 1."
14744 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3460
14745 msgid "B<part_start>"
14749 #: ../src/guestfs-actions.pod:5123
14751 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14752 "the device's sector size, see C<guestfs_blockdev_getss>."
14756 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3465
14757 msgid "B<part_end>"
14761 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3467
14762 msgid "End of the partition in bytes."
14766 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3469
14767 msgid "B<part_size>"
14771 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3471
14772 msgid "Size of the partition in bytes."
14776 #: ../src/guestfs-actions.pod:5136
14778 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14779 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14784 #: ../src/guestfs-actions.pod:5142
14785 msgid "guestfs_part_set_bootable"
14789 #: ../src/guestfs-actions.pod:5144
14793 " guestfs_part_set_bootable (guestfs_h *g,\n"
14794 " const char *device,\n"
14796 " int bootable);\n"
14801 #: ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:3479
14803 "This sets the bootable flag on partition numbered C<partnum> on device "
14804 "C<device>. Note that partitions are numbered from 1."
14808 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3482
14810 "The bootable flag is used by some operating systems (notably Windows) to "
14811 "determine which partition to boot from. It is by no means universally "
14816 #: ../src/guestfs-actions.pod:5161
14817 msgid "guestfs_part_set_mbr_id"
14821 #: ../src/guestfs-actions.pod:5163
14825 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14826 " const char *device,\n"
14833 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3490
14835 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14836 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14837 "documentation are in fact hexadecimal numbers, but usually documented "
14838 "without any leading \"0x\" which might be confusing."
14842 #: ../src/guestfs-actions.pod:5183
14843 msgid "guestfs_part_set_name"
14847 #: ../src/guestfs-actions.pod:5185
14851 " guestfs_part_set_name (guestfs_h *g,\n"
14852 " const char *device,\n"
14854 " const char *name);\n"
14859 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:3504
14861 "This sets the partition name on partition numbered C<partnum> on device "
14862 "C<device>. Note that partitions are numbered from 1."
14866 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:3507
14868 "The partition name can only be set on certain types of partition table. "
14869 "This works on C<gpt> but not on C<mbr> partitions."
14873 #: ../src/guestfs-actions.pod:5201
14874 msgid "guestfs_part_to_dev"
14878 #: ../src/guestfs-actions.pod:5203
14882 " guestfs_part_to_dev (guestfs_h *g,\n"
14883 " const char *partition);\n"
14888 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3514
14890 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14891 "partition number, returning the device name (eg. \"/dev/sdb\")."
14895 #: ../src/guestfs-actions.pod:5211
14897 "The named partition must exist, for example as a string returned from "
14898 "C<guestfs_list_partitions>."
14902 #: ../src/guestfs-actions.pod:5219
14903 msgid "guestfs_ping_daemon"
14907 #: ../src/guestfs-actions.pod:5221
14911 " guestfs_ping_daemon (guestfs_h *g);\n"
14916 #: ../src/guestfs-actions.pod:5224 ../fish/guestfish-actions.pod:3525
14918 "This is a test probe into the guestfs daemon running inside the qemu "
14919 "subprocess. Calling this function checks that the daemon responds to the "
14920 "ping message, without affecting the daemon or attached block device(s) in "
14925 #: ../src/guestfs-actions.pod:5233
14926 msgid "guestfs_pread"
14930 #: ../src/guestfs-actions.pod:5235
14934 " guestfs_pread (guestfs_h *g,\n"
14935 " const char *path,\n"
14937 " int64_t offset,\n"
14938 " size_t *size_r);\n"
14943 #: ../src/guestfs-actions.pod:5242 ../fish/guestfish-actions.pod:3534
14945 "This command lets you read part of a file. It reads C<count> bytes of the "
14946 "file, starting at C<offset>, from file C<path>."
14950 #: ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5271
14951 #: ../fish/guestfish-actions.pod:3537 ../fish/guestfish-actions.pod:3552
14953 "This may read fewer bytes than requested. For further details see the "
14954 "L<pread(2)> system call."
14958 #: ../src/guestfs-actions.pod:5248
14959 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14963 #: ../src/guestfs-actions.pod:5259
14964 msgid "guestfs_pread_device"
14968 #: ../src/guestfs-actions.pod:5261
14972 " guestfs_pread_device (guestfs_h *g,\n"
14973 " const char *device,\n"
14975 " int64_t offset,\n"
14976 " size_t *size_r);\n"
14981 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3549
14983 "This command lets you read part of a file. It reads C<count> bytes of "
14984 "C<device>, starting at C<offset>."
14988 #: ../src/guestfs-actions.pod:5274
14989 msgid "See also C<guestfs_pread>."
14993 #: ../src/guestfs-actions.pod:5283
14994 msgid "(Added in 1.5.21)"
14998 #: ../src/guestfs-actions.pod:5285
14999 msgid "guestfs_pvcreate"
15003 #: ../src/guestfs-actions.pod:5287
15007 " guestfs_pvcreate (guestfs_h *g,\n"
15008 " const char *device);\n"
15013 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3564
15015 "This creates an LVM physical volume on the named C<device>, where C<device> "
15016 "should usually be a partition name such as C</dev/sda1>."
15020 #: ../src/guestfs-actions.pod:5299
15021 msgid "guestfs_pvremove"
15025 #: ../src/guestfs-actions.pod:5301
15029 " guestfs_pvremove (guestfs_h *g,\n"
15030 " const char *device);\n"
15035 #: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:3572
15037 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15042 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3575
15044 "The implementation uses the C<pvremove> command which refuses to wipe "
15045 "physical volumes that contain any volume groups, so you have to remove those "
15050 #: ../src/guestfs-actions.pod:5316
15051 msgid "guestfs_pvresize"
15055 #: ../src/guestfs-actions.pod:5318
15059 " guestfs_pvresize (guestfs_h *g,\n"
15060 " const char *device);\n"
15065 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3583
15067 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15068 "the new size of the underlying device."
15072 #: ../src/guestfs-actions.pod:5329
15073 msgid "guestfs_pvresize_size"
15077 #: ../src/guestfs-actions.pod:5331
15081 " guestfs_pvresize_size (guestfs_h *g,\n"
15082 " const char *device,\n"
15083 " int64_t size);\n"
15088 #: ../src/guestfs-actions.pod:5336
15090 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15091 "specify the new size (in bytes) explicitly."
15095 #: ../src/guestfs-actions.pod:5343
15096 msgid "guestfs_pvs"
15100 #: ../src/guestfs-actions.pod:5345
15104 " guestfs_pvs (guestfs_h *g);\n"
15109 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3597
15111 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15116 #: ../src/guestfs-actions.pod:5351 ../fish/guestfish-actions.pod:3600
15118 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15123 #: ../src/guestfs-actions.pod:5354
15124 msgid "See also C<guestfs_pvs_full>."
15128 #: ../src/guestfs-actions.pod:5362
15129 msgid "guestfs_pvs_full"
15133 #: ../src/guestfs-actions.pod:5364
15136 " struct guestfs_lvm_pv_list *\n"
15137 " guestfs_pvs_full (guestfs_h *g);\n"
15142 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3609
15144 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15145 "(8)> command. The \"full\" version includes all fields."
15149 #: ../src/guestfs-actions.pod:5370
15151 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15152 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15156 #: ../src/guestfs-actions.pod:5376
15157 msgid "guestfs_pvuuid"
15161 #: ../src/guestfs-actions.pod:5378
15165 " guestfs_pvuuid (guestfs_h *g,\n"
15166 " const char *device);\n"
15171 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3616
15172 msgid "This command returns the UUID of the LVM PV C<device>."
15176 #: ../src/guestfs-actions.pod:5389
15177 msgid "guestfs_pwrite"
15181 #: ../src/guestfs-actions.pod:5391
15185 " guestfs_pwrite (guestfs_h *g,\n"
15186 " const char *path,\n"
15187 " const char *content,\n"
15188 " size_t content_size,\n"
15189 " int64_t offset);\n"
15194 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3622
15196 "This command writes to part of a file. It writes the data buffer C<content> "
15197 "to the file C<path> starting at offset C<offset>."
15201 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3625
15203 "This command implements the L<pwrite(2)> system call, and like that system "
15204 "call it may not write the full data requested. The return value is the "
15205 "number of bytes that were actually written to the file. This could even be "
15206 "0, although short writes are unlikely for regular files in ordinary "
15211 #: ../src/guestfs-actions.pod:5407
15212 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15216 #: ../src/guestfs-actions.pod:5416
15217 msgid "guestfs_pwrite_device"
15221 #: ../src/guestfs-actions.pod:5418
15225 " guestfs_pwrite_device (guestfs_h *g,\n"
15226 " const char *device,\n"
15227 " const char *content,\n"
15228 " size_t content_size,\n"
15229 " int64_t offset);\n"
15234 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3640
15236 "This command writes to part of a device. It writes the data buffer "
15237 "C<content> to C<device> starting at offset C<offset>."
15241 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3643
15243 "This command implements the L<pwrite(2)> system call, and like that system "
15244 "call it may not write the full data requested (although short writes to disk "
15245 "devices and partitions are probably impossible with standard Linux kernels)."
15249 #: ../src/guestfs-actions.pod:5433
15250 msgid "See also C<guestfs_pwrite>."
15254 #: ../src/guestfs-actions.pod:5440
15255 msgid "(Added in 1.5.20)"
15259 #: ../src/guestfs-actions.pod:5442
15260 msgid "guestfs_read_file"
15264 #: ../src/guestfs-actions.pod:5444
15268 " guestfs_read_file (guestfs_h *g,\n"
15269 " const char *path,\n"
15270 " size_t *size_r);\n"
15275 #: ../src/guestfs-actions.pod:5449 ../fish/guestfish-actions.pod:3657
15276 msgid "This calls returns the contents of the file C<path> as a buffer."
15280 #: ../src/guestfs-actions.pod:5452
15282 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15283 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15284 "function is limited in the total size of file that can be handled."
15288 #: ../src/guestfs-actions.pod:5464
15289 msgid "(Added in 1.0.63)"
15293 #: ../src/guestfs-actions.pod:5466
15294 msgid "guestfs_read_lines"
15298 #: ../src/guestfs-actions.pod:5468
15302 " guestfs_read_lines (guestfs_h *g,\n"
15303 " const char *path);\n"
15308 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3674
15310 "The file contents are returned as a list of lines. Trailing C<LF> and "
15311 "C<CRLF> character sequences are I<not> returned."
15315 #: ../src/guestfs-actions.pod:5477
15317 "Note that this function cannot correctly handle binary files (specifically, "
15318 "files containing C<\\0> character which is treated as end of line). For "
15319 "those you need to use the C<guestfs_read_file> function which has a more "
15320 "complex interface."
15324 #: ../src/guestfs-actions.pod:5488
15325 msgid "guestfs_readdir"
15329 #: ../src/guestfs-actions.pod:5490
15332 " struct guestfs_dirent_list *\n"
15333 " guestfs_readdir (guestfs_h *g,\n"
15334 " const char *dir);\n"
15339 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3686
15340 msgid "This returns the list of directory entries in directory C<dir>."
15344 #: ../src/guestfs-actions.pod:5496 ../fish/guestfish-actions.pod:3688
15346 "All entries in the directory are returned, including C<.> and C<..>. The "
15347 "entries are I<not> sorted, but returned in the same order as the underlying "
15352 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
15354 "Also this call returns basic file type information about each file. The "
15355 "C<ftyp> field will contain one of the following characters:"
15359 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3697
15364 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3699
15365 msgid "Block special"
15369 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3701
15374 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3703
15375 msgid "Char special"
15379 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3705
15384 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3707
15389 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3709
15394 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3711
15395 msgid "FIFO (named pipe)"
15399 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3713
15404 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3715
15405 msgid "Symbolic link"
15409 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3717
15414 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3719
15415 msgid "Regular file"
15419 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3721
15424 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3723
15429 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3725
15434 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3727
15435 msgid "Unknown file type"
15439 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3729
15444 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3731
15446 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15450 #: ../src/guestfs-actions.pod:5544
15452 "This function is primarily intended for use by programs. To get a simple "
15453 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15454 "consumption, use C<guestfs_ll>."
15458 #: ../src/guestfs-actions.pod:5548
15460 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15461 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15465 #: ../src/guestfs-actions.pod:5554
15466 msgid "guestfs_readlink"
15470 #: ../src/guestfs-actions.pod:5556
15474 " guestfs_readlink (guestfs_h *g,\n"
15475 " const char *path);\n"
15480 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3744
15481 msgid "This command reads the target of a symbolic link."
15485 #: ../src/guestfs-actions.pod:5567
15486 msgid "guestfs_readlinklist"
15490 #: ../src/guestfs-actions.pod:5569
15494 " guestfs_readlinklist (guestfs_h *g,\n"
15495 " const char *path,\n"
15496 " char *const *names);\n"
15501 #: ../src/guestfs-actions.pod:5574 ../fish/guestfish-actions.pod:3750
15503 "This call allows you to do a C<readlink> operation on multiple files, where "
15504 "all files are in the directory C<path>. C<names> is the list of files from "
15509 #: ../src/guestfs-actions.pod:5578 ../fish/guestfish-actions.pod:3754
15511 "On return you get a list of strings, with a one-to-one correspondence to the "
15512 "C<names> list. Each string is the value of the symbolic link."
15516 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3758
15518 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15519 "result string is the empty string C<\"\">. However the whole operation is "
15520 "completed even if there were C<readlink(2)> errors, and so you can call this "
15521 "function with names where you don't know if they are symbolic links already "
15522 "(albeit slightly less efficient)."
15526 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3765
15528 "This call is intended for programs that want to efficiently list a directory "
15529 "contents without making many round-trips. Very long directory listings "
15530 "might cause the protocol message size to be exceeded, causing this call to "
15531 "fail. The caller must split up such requests into smaller groups of names."
15535 #: ../src/guestfs-actions.pod:5602
15536 msgid "guestfs_realpath"
15540 #: ../src/guestfs-actions.pod:5604
15544 " guestfs_realpath (guestfs_h *g,\n"
15545 " const char *path);\n"
15550 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3776
15552 "Return the canonicalized absolute pathname of C<path>. The returned path "
15553 "has no C<.>, C<..> or symbolic link path elements."
15557 #: ../src/guestfs-actions.pod:5616
15558 msgid "guestfs_removexattr"
15562 #: ../src/guestfs-actions.pod:5618
15566 " guestfs_removexattr (guestfs_h *g,\n"
15567 " const char *xattr,\n"
15568 " const char *path);\n"
15573 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3783
15575 "This call removes the extended attribute named C<xattr> of the file C<path>."
15579 #: ../src/guestfs-actions.pod:5626
15580 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15584 #: ../src/guestfs-actions.pod:5632
15585 msgid "guestfs_resize2fs"
15589 #: ../src/guestfs-actions.pod:5634
15593 " guestfs_resize2fs (guestfs_h *g,\n"
15594 " const char *device);\n"
15599 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3792
15601 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15602 "underlying device."
15606 #: ../src/guestfs-actions.pod:5641
15608 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15609 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15610 "sometimes gives an error about this and sometimes not. In any case, it is "
15611 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15615 #: ../src/guestfs-actions.pod:5651
15616 msgid "guestfs_resize2fs_M"
15620 #: ../src/guestfs-actions.pod:5653
15624 " guestfs_resize2fs_M (guestfs_h *g,\n"
15625 " const char *device);\n"
15630 #: ../src/guestfs-actions.pod:5657
15632 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15633 "resized to its minimum size. This works like the I<-M> option to the "
15634 "C<resize2fs> command."
15638 #: ../src/guestfs-actions.pod:5661
15640 "To get the resulting size of the filesystem you should call "
15641 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15642 "These two numbers, multiplied together, give the resulting size of the "
15643 "minimal filesystem in bytes."
15647 #: ../src/guestfs-actions.pod:5668
15648 msgid "guestfs_resize2fs_size"
15652 #: ../src/guestfs-actions.pod:5670
15656 " guestfs_resize2fs_size (guestfs_h *g,\n"
15657 " const char *device,\n"
15658 " int64_t size);\n"
15663 #: ../src/guestfs-actions.pod:5675
15665 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15666 "to specify the new size (in bytes) explicitly."
15670 #: ../src/guestfs-actions.pod:5682
15675 #: ../src/guestfs-actions.pod:5684
15679 " guestfs_rm (guestfs_h *g,\n"
15680 " const char *path);\n"
15685 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3825
15686 msgid "Remove the single file C<path>."
15690 #: ../src/guestfs-actions.pod:5694
15691 msgid "guestfs_rm_rf"
15695 #: ../src/guestfs-actions.pod:5696
15699 " guestfs_rm_rf (guestfs_h *g,\n"
15700 " const char *path);\n"
15705 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3831
15707 "Remove the file or directory C<path>, recursively removing the contents if "
15708 "its a directory. This is like the C<rm -rf> shell command."
15712 #: ../src/guestfs-actions.pod:5708
15713 msgid "guestfs_rmdir"
15717 #: ../src/guestfs-actions.pod:5710
15721 " guestfs_rmdir (guestfs_h *g,\n"
15722 " const char *path);\n"
15727 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3839
15728 msgid "Remove the single directory C<path>."
15732 #: ../src/guestfs-actions.pod:5720
15733 msgid "guestfs_rmmountpoint"
15737 #: ../src/guestfs-actions.pod:5722
15741 " guestfs_rmmountpoint (guestfs_h *g,\n"
15742 " const char *exemptpath);\n"
15747 #: ../src/guestfs-actions.pod:5726
15749 "This calls removes a mountpoint that was previously created with "
15750 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15754 #: ../src/guestfs-actions.pod:5734
15755 msgid "guestfs_scrub_device"
15759 #: ../src/guestfs-actions.pod:5736
15763 " guestfs_scrub_device (guestfs_h *g,\n"
15764 " const char *device);\n"
15769 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3853
15771 "This command writes patterns over C<device> to make data retrieval more "
15776 #: ../src/guestfs-actions.pod:5743 ../src/guestfs-actions.pod:5764
15777 #: ../src/guestfs-actions.pod:5783 ../fish/guestfish-actions.pod:3856
15778 #: ../fish/guestfish-actions.pod:3871 ../fish/guestfish-actions.pod:3884
15780 "It is an interface to the L<scrub(1)> program. See that manual page for "
15785 #: ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5769
15786 #: ../src/guestfs-actions.pod:5788
15787 msgid "(Added in 1.0.52)"
15791 #: ../src/guestfs-actions.pod:5753
15792 msgid "guestfs_scrub_file"
15796 #: ../src/guestfs-actions.pod:5755
15800 " guestfs_scrub_file (guestfs_h *g,\n"
15801 " const char *file);\n"
15806 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3866
15808 "This command writes patterns over a file to make data retrieval more "
15813 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3869
15814 msgid "The file is I<removed> after scrubbing."
15818 #: ../src/guestfs-actions.pod:5771
15819 msgid "guestfs_scrub_freespace"
15823 #: ../src/guestfs-actions.pod:5773
15827 " guestfs_scrub_freespace (guestfs_h *g,\n"
15828 " const char *dir);\n"
15833 #: ../src/guestfs-actions.pod:5777
15835 "This command creates the directory C<dir> and then fills it with files until "
15836 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15837 "and deletes them. The intention is to scrub any free space on the partition "
15838 "containing C<dir>."
15842 #: ../src/guestfs-actions.pod:5790
15843 msgid "guestfs_set_append"
15847 #: ../src/guestfs-actions.pod:5792
15851 " guestfs_set_append (guestfs_h *g,\n"
15852 " const char *append);\n"
15857 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3893
15859 "This function is used to add additional options to the guest kernel command "
15864 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3896
15866 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15867 "environment variable."
15871 #: ../src/guestfs-actions.pod:5802 ../fish/guestfish-actions.pod:3899
15873 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15874 "(libguestfs always adds a few of its own)."
15878 #: ../src/guestfs-actions.pod:5809
15879 msgid "guestfs_set_attach_method"
15883 #: ../src/guestfs-actions.pod:5811
15887 " guestfs_set_attach_method (guestfs_h *g,\n"
15888 " const char *attachmethod);\n"
15893 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3908
15895 "Set the method that libguestfs uses to connect to the back end guestfsd "
15896 "daemon. Possible methods are:"
15900 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3915
15902 "Launch an appliance and connect to it. This is the ordinary method and the "
15907 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3918
15908 msgid "C<unix:I<path>>"
15912 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3920
15913 msgid "Connect to the Unix domain socket I<path>."
15917 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3922
15919 "This method lets you connect to an existing daemon or (using virtio-serial) "
15920 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15921 "RUNNING DAEMONS>."
15925 #: ../src/guestfs-actions.pod:5837
15926 msgid "guestfs_set_autosync"
15930 #: ../src/guestfs-actions.pod:5839
15934 " guestfs_set_autosync (guestfs_h *g,\n"
15935 " int autosync);\n"
15940 #: ../src/guestfs-actions.pod:5843 ../fish/guestfish-actions.pod:3934
15942 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15943 "effort attempt to make filesystems consistent and synchronized when the "
15944 "handle is closed (also if the program exits without closing handles)."
15948 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3939
15950 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15951 "disabled by default)."
15955 #: ../src/guestfs-actions.pod:5855
15956 msgid "guestfs_set_direct"
15960 #: ../src/guestfs-actions.pod:5857
15964 " guestfs_set_direct (guestfs_h *g,\n"
15970 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3948
15972 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15973 "passed directly through to the appliance once it is launched."
15977 #: ../src/guestfs-actions.pod:5865
15979 "One consequence of this is that log messages aren't caught by the library "
15980 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15985 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3956
15986 msgid "You probably don't want to use this unless you know what you are doing."
15990 #: ../src/guestfs-actions.pod:5872 ../fish/guestfish-actions.pod:3959
15991 msgid "The default is disabled."
15995 #: ../src/guestfs-actions.pod:5878
15996 msgid "guestfs_set_e2label"
16000 #: ../src/guestfs-actions.pod:5880
16004 " guestfs_set_e2label (guestfs_h *g,\n"
16005 " const char *device,\n"
16006 " const char *label);\n"
16011 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3965
16013 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16014 "C<label>. Filesystem labels are limited to 16 characters."
16018 #: ../src/guestfs-actions.pod:5889
16020 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16021 "the existing label on a filesystem."
16025 #: ../src/guestfs-actions.pod:5896
16026 msgid "guestfs_set_e2uuid"
16030 #: ../src/guestfs-actions.pod:5898
16034 " guestfs_set_e2uuid (guestfs_h *g,\n"
16035 " const char *device,\n"
16036 " const char *uuid);\n"
16041 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3976
16043 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16044 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16045 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16049 #: ../src/guestfs-actions.pod:5908
16051 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16052 "the existing UUID of a filesystem."
16056 #: ../src/guestfs-actions.pod:5915
16057 msgid "guestfs_set_memsize"
16061 #: ../src/guestfs-actions.pod:5917
16065 " guestfs_set_memsize (guestfs_h *g,\n"
16071 #: ../src/guestfs-actions.pod:5921
16073 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16074 "This only has any effect if called before C<guestfs_launch>."
16078 #: ../src/guestfs-actions.pod:5925 ../fish/guestfish-actions.pod:3994
16080 "You can also change this by setting the environment variable "
16081 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16085 #: ../src/guestfs-actions.pod:5936
16086 msgid "guestfs_set_network"
16090 #: ../src/guestfs-actions.pod:5938
16094 " guestfs_set_network (guestfs_h *g,\n"
16100 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:4007
16102 "If C<network> is true, then the network is enabled in the libguestfs "
16103 "appliance. The default is false."
16107 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:4010
16109 "This affects whether commands are able to access the network (see L<guestfs"
16110 "(3)/RUNNING COMMANDS>)."
16114 #: ../src/guestfs-actions.pod:5948
16116 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16121 #: ../src/guestfs-actions.pod:5955
16122 msgid "guestfs_set_path"
16126 #: ../src/guestfs-actions.pod:5957
16130 " guestfs_set_path (guestfs_h *g,\n"
16131 " const char *searchpath);\n"
16136 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4022
16137 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16141 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:4024
16143 "The default is C<$libdir/guestfs> unless overridden by setting "
16144 "C<LIBGUESTFS_PATH> environment variable."
16148 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4027
16149 msgid "Setting C<path> to C<NULL> restores the default path."
16153 #: ../src/guestfs-actions.pod:5972
16154 msgid "guestfs_set_qemu"
16158 #: ../src/guestfs-actions.pod:5974
16162 " guestfs_set_qemu (guestfs_h *g,\n"
16163 " const char *qemu);\n"
16168 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4035
16169 msgid "Set the qemu binary that we will use."
16173 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4037
16175 "The default is chosen when the library was compiled by the configure script."
16179 #: ../src/guestfs-actions.pod:5983 ../fish/guestfish-actions.pod:4040
16181 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16186 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:4043
16187 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16191 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:4045
16193 "Note that you should call this function as early as possible after creating "
16194 "the handle. This is because some pre-launch operations depend on testing "
16195 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16196 "don't retest features, and so you might see inconsistent results. Using the "
16197 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16198 "the qemu binary at the same time as the handle is created."
16202 #: ../src/guestfs-actions.pod:6000
16203 msgid "guestfs_set_recovery_proc"
16207 #: ../src/guestfs-actions.pod:6002
16211 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16212 " int recoveryproc);\n"
16217 #: ../src/guestfs-actions.pod:6006
16219 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16220 "not create a recovery process. The purpose of the recovery process is to "
16221 "stop runaway qemu processes in the case where the main program aborts "
16226 #: ../src/guestfs-actions.pod:6011
16228 "This only has any effect if called before C<guestfs_launch>, and the default "
16233 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4067
16235 "About the only time when you would want to disable this is if the main "
16236 "process will fork itself into the background (\"daemonize\" itself). In "
16237 "this case the recovery process thinks that the main program has disappeared "
16238 "and so kills qemu, which is not very helpful."
16242 #: ../src/guestfs-actions.pod:6024
16243 msgid "guestfs_set_selinux"
16247 #: ../src/guestfs-actions.pod:6026
16251 " guestfs_set_selinux (guestfs_h *g,\n"
16257 #: ../src/guestfs-actions.pod:6030 ../fish/guestfish-actions.pod:4079
16259 "This sets the selinux flag that is passed to the appliance at boot time. "
16260 "The default is C<selinux=0> (disabled)."
16264 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4082
16266 "Note that if SELinux is enabled, it is always in Permissive mode "
16267 "(C<enforcing=0>)."
16271 #: ../src/guestfs-actions.pod:6043
16272 msgid "guestfs_set_trace"
16276 #: ../src/guestfs-actions.pod:6045
16280 " guestfs_set_trace (guestfs_h *g,\n"
16286 #: ../src/guestfs-actions.pod:6049 ../fish/guestfish-actions.pod:4094
16288 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16289 "return values are traced."
16293 #: ../src/guestfs-actions.pod:6052 ../fish/guestfish-actions.pod:4097
16295 "If you want to trace C API calls into libguestfs (and other libraries) then "
16296 "possibly a better way is to use the external ltrace(1) command."
16300 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4101
16302 "Command traces are disabled unless the environment variable "
16303 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16307 #: ../src/guestfs-actions.pod:6059
16309 "Trace messages are normally sent to C<stderr>, unless you register a "
16310 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16314 #: ../src/guestfs-actions.pod:6067
16315 msgid "guestfs_set_verbose"
16319 #: ../src/guestfs-actions.pod:6069
16323 " guestfs_set_verbose (guestfs_h *g,\n"
16329 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4114
16330 msgid "If C<verbose> is true, this turns on verbose messages."
16334 #: ../src/guestfs-actions.pod:6075 ../fish/guestfish-actions.pod:4116
16336 "Verbose messages are disabled unless the environment variable "
16337 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16341 #: ../src/guestfs-actions.pod:6078
16343 "Verbose messages are normally sent to C<stderr>, unless you register a "
16344 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16348 #: ../src/guestfs-actions.pod:6086
16349 msgid "guestfs_setcon"
16353 #: ../src/guestfs-actions.pod:6088
16357 " guestfs_setcon (guestfs_h *g,\n"
16358 " const char *context);\n"
16363 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4127
16365 "This sets the SELinux security context of the daemon to the string "
16370 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4130
16371 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16375 #: ../src/guestfs-actions.pod:6101
16376 msgid "guestfs_setxattr"
16380 #: ../src/guestfs-actions.pod:6103
16384 " guestfs_setxattr (guestfs_h *g,\n"
16385 " const char *xattr,\n"
16386 " const char *val,\n"
16388 " const char *path);\n"
16393 #: ../src/guestfs-actions.pod:6110 ../fish/guestfish-actions.pod:4136
16395 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16396 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16400 #: ../src/guestfs-actions.pod:6114
16401 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16405 #: ../src/guestfs-actions.pod:6120
16406 msgid "guestfs_sfdisk"
16410 #: ../src/guestfs-actions.pod:6122
16414 " guestfs_sfdisk (guestfs_h *g,\n"
16415 " const char *device,\n"
16419 " char *const *lines);\n"
16424 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4146
16426 "This is a direct interface to the L<sfdisk(8)> program for creating "
16427 "partitions on block devices."
16431 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4149
16432 msgid "C<device> should be a block device, for example C</dev/sda>."
16436 #: ../src/guestfs-actions.pod:6135 ../fish/guestfish-actions.pod:4151
16438 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16439 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16440 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16441 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16442 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16443 "the kernel) cannot work out the right geometry and you will need to tell it."
16447 #: ../src/guestfs-actions.pod:6143 ../fish/guestfish-actions.pod:4159
16449 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16450 "refer to the L<sfdisk(8)> manpage."
16454 #: ../src/guestfs-actions.pod:6146 ../fish/guestfish-actions.pod:4162
16456 "To create a single partition occupying the whole disk, you would pass "
16457 "C<lines> as a single element list, when the single element being the string "
16462 #: ../src/guestfs-actions.pod:6150
16464 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16468 #: ../src/guestfs-actions.pod:6160
16469 msgid "guestfs_sfdiskM"
16473 #: ../src/guestfs-actions.pod:6162
16477 " guestfs_sfdiskM (guestfs_h *g,\n"
16478 " const char *device,\n"
16479 " char *const *lines);\n"
16484 #: ../src/guestfs-actions.pod:6167
16486 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16487 "partition sizes are specified in megabytes only (rounded to the nearest "
16488 "cylinder) and you don't need to specify the cyls, heads and sectors "
16489 "parameters which were rarely if ever used anyway."
16493 #: ../src/guestfs-actions.pod:6173
16495 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16496 "C<guestfs_part_disk>"
16500 #: ../src/guestfs-actions.pod:6183
16501 msgid "guestfs_sfdisk_N"
16505 #: ../src/guestfs-actions.pod:6185
16509 " guestfs_sfdisk_N (guestfs_h *g,\n"
16510 " const char *device,\n"
16515 " const char *line);\n"
16520 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4192
16522 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16523 "(note: C<n> counts from 1)."
16527 #: ../src/guestfs-actions.pod:6197
16529 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16530 "for the cyls/heads/sectors parameters."
16534 #: ../src/guestfs-actions.pod:6200
16535 msgid "See also: C<guestfs_part_add>"
16539 #: ../src/guestfs-actions.pod:6209
16540 msgid "guestfs_sfdisk_disk_geometry"
16544 #: ../src/guestfs-actions.pod:6211
16548 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16549 " const char *device);\n"
16554 #: ../src/guestfs-actions.pod:6215
16556 "This displays the disk geometry of C<device> read from the partition table. "
16557 "Especially in the case where the underlying block device has been resized, "
16558 "this can be different from the kernel's idea of the geometry (see "
16559 "C<guestfs_sfdisk_kernel_geometry>)."
16563 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
16564 #: ../fish/guestfish-actions.pod:4212 ../fish/guestfish-actions.pod:4221
16565 msgid "The result is in human-readable format, and not designed to be parsed."
16569 #: ../src/guestfs-actions.pod:6228
16570 msgid "guestfs_sfdisk_kernel_geometry"
16574 #: ../src/guestfs-actions.pod:6230
16578 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16579 " const char *device);\n"
16584 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4219
16585 msgid "This displays the kernel's idea of the geometry of C<device>."
16589 #: ../src/guestfs-actions.pod:6244
16590 msgid "guestfs_sfdisk_l"
16594 #: ../src/guestfs-actions.pod:6246
16598 " guestfs_sfdisk_l (guestfs_h *g,\n"
16599 " const char *device);\n"
16604 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4228
16606 "This displays the partition table on C<device>, in the human-readable output "
16607 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16611 #: ../src/guestfs-actions.pod:6254
16612 msgid "See also: C<guestfs_part_list>"
16616 #: ../src/guestfs-actions.pod:6261
16621 #: ../src/guestfs-actions.pod:6263
16625 " guestfs_sh (guestfs_h *g,\n"
16626 " const char *command);\n"
16631 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4238
16633 "This call runs a command from the guest filesystem via the guest's C</bin/"
16638 #: ../src/guestfs-actions.pod:6270
16639 msgid "This is like C<guestfs_command>, but passes the command to:"
16643 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4243
16646 " /bin/sh -c \"command\"\n"
16651 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4245
16653 "Depending on the guest's shell, this usually results in wildcards being "
16654 "expanded, shell expressions being interpolated and so on."
16658 #: ../src/guestfs-actions.pod:6278
16659 msgid "All the provisos about C<guestfs_command> apply to this call."
16663 #: ../src/guestfs-actions.pod:6285
16664 msgid "guestfs_sh_lines"
16668 #: ../src/guestfs-actions.pod:6287
16672 " guestfs_sh_lines (guestfs_h *g,\n"
16673 " const char *command);\n"
16678 #: ../src/guestfs-actions.pod:6291
16680 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16685 #: ../src/guestfs-actions.pod:6294
16686 msgid "See also: C<guestfs_command_lines>"
16690 #: ../src/guestfs-actions.pod:6302
16691 msgid "guestfs_sleep"
16695 #: ../src/guestfs-actions.pod:6304
16699 " guestfs_sleep (guestfs_h *g,\n"
16705 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4264
16706 msgid "Sleep for C<secs> seconds."
16710 #: ../src/guestfs-actions.pod:6312
16711 msgid "(Added in 1.0.41)"
16715 #: ../src/guestfs-actions.pod:6314 ../src/guestfs-structs.pod:109
16716 msgid "guestfs_stat"
16720 #: ../src/guestfs-actions.pod:6316
16723 " struct guestfs_stat *\n"
16724 " guestfs_stat (guestfs_h *g,\n"
16725 " const char *path);\n"
16730 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4272
16731 msgid "This is the same as the C<stat(2)> system call."
16735 #: ../src/guestfs-actions.pod:6330 ../src/guestfs-structs.pod:135
16736 msgid "guestfs_statvfs"
16740 #: ../src/guestfs-actions.pod:6332
16743 " struct guestfs_statvfs *\n"
16744 " guestfs_statvfs (guestfs_h *g,\n"
16745 " const char *path);\n"
16750 #: ../src/guestfs-actions.pod:6336 ../fish/guestfish-actions.pod:4278
16752 "Returns file system statistics for any mounted file system. C<path> should "
16753 "be a file or directory in the mounted file system (typically it is the mount "
16754 "point itself, but it doesn't need to be)."
16758 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4282
16759 msgid "This is the same as the C<statvfs(2)> system call."
16763 #: ../src/guestfs-actions.pod:6342
16765 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16766 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16770 #: ../src/guestfs-actions.pod:6348
16771 msgid "guestfs_strings"
16775 #: ../src/guestfs-actions.pod:6350
16779 " guestfs_strings (guestfs_h *g,\n"
16780 " const char *path);\n"
16785 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4288
16787 "This runs the L<strings(1)> command on a file and returns the list of "
16788 "printable strings found."
16792 #: ../src/guestfs-actions.pod:6366
16793 msgid "guestfs_strings_e"
16797 #: ../src/guestfs-actions.pod:6368
16801 " guestfs_strings_e (guestfs_h *g,\n"
16802 " const char *encoding,\n"
16803 " const char *path);\n"
16808 #: ../src/guestfs-actions.pod:6373
16810 "This is like the C<guestfs_strings> command, but allows you to specify the "
16811 "encoding of strings that are looked for in the source file C<path>."
16815 #: ../src/guestfs-actions.pod:6377 ../fish/guestfish-actions.pod:4302
16816 msgid "Allowed encodings are:"
16820 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4306
16825 #: ../src/guestfs-actions.pod:6383
16827 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16828 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16832 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4311
16837 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4313
16838 msgid "Single 8-bit-byte characters."
16842 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4315
16847 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4317
16848 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16852 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4320
16853 msgid "l (lower case letter L)"
16857 #: ../src/guestfs-actions.pod:6397 ../fish/guestfish-actions.pod:4322
16859 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16860 "examining binaries in Windows guests."
16864 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4325
16869 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4327
16870 msgid "32-bit big endian such as UCS-4BE."
16874 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4329
16879 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4331
16880 msgid "32-bit little endian such as UCS-4LE."
16884 #: ../src/guestfs-actions.pod:6410 ../fish/guestfish-actions.pod:4335
16885 msgid "The returned strings are transcoded to UTF-8."
16889 #: ../src/guestfs-actions.pod:6421
16890 msgid "guestfs_swapoff_device"
16894 #: ../src/guestfs-actions.pod:6423
16898 " guestfs_swapoff_device (guestfs_h *g,\n"
16899 " const char *device);\n"
16904 #: ../src/guestfs-actions.pod:6427
16906 "This command disables the libguestfs appliance swap device or partition "
16907 "named C<device>. See C<guestfs_swapon_device>."
16911 #: ../src/guestfs-actions.pod:6435
16912 msgid "guestfs_swapoff_file"
16916 #: ../src/guestfs-actions.pod:6437
16920 " guestfs_swapoff_file (guestfs_h *g,\n"
16921 " const char *file);\n"
16926 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4352
16927 msgid "This command disables the libguestfs appliance swap on file."
16931 #: ../src/guestfs-actions.pod:6447
16932 msgid "guestfs_swapoff_label"
16936 #: ../src/guestfs-actions.pod:6449
16940 " guestfs_swapoff_label (guestfs_h *g,\n"
16941 " const char *label);\n"
16946 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4358
16948 "This command disables the libguestfs appliance swap on labeled swap "
16953 #: ../src/guestfs-actions.pod:6460
16954 msgid "guestfs_swapoff_uuid"
16958 #: ../src/guestfs-actions.pod:6462
16962 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16963 " const char *uuid);\n"
16968 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4365
16970 "This command disables the libguestfs appliance swap partition with the given "
16975 #: ../src/guestfs-actions.pod:6473
16976 msgid "guestfs_swapon_device"
16980 #: ../src/guestfs-actions.pod:6475
16984 " guestfs_swapon_device (guestfs_h *g,\n"
16985 " const char *device);\n"
16990 #: ../src/guestfs-actions.pod:6479
16992 "This command enables the libguestfs appliance to use the swap device or "
16993 "partition named C<device>. The increased memory is made available for all "
16994 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16998 #: ../src/guestfs-actions.pod:6484 ../fish/guestfish-actions.pod:4377
17000 "Note that you should not swap to existing guest swap partitions unless you "
17001 "know what you are doing. They may contain hibernation information, or other "
17002 "information that the guest doesn't want you to trash. You also risk leaking "
17003 "information about the host to the guest this way. Instead, attach a new "
17004 "host device to the guest and swap on that."
17008 #: ../src/guestfs-actions.pod:6495
17009 msgid "guestfs_swapon_file"
17013 #: ../src/guestfs-actions.pod:6497
17017 " guestfs_swapon_file (guestfs_h *g,\n"
17018 " const char *file);\n"
17023 #: ../src/guestfs-actions.pod:6501
17025 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17030 #: ../src/guestfs-actions.pod:6508
17031 msgid "guestfs_swapon_label"
17035 #: ../src/guestfs-actions.pod:6510
17039 " guestfs_swapon_label (guestfs_h *g,\n"
17040 " const char *label);\n"
17045 #: ../src/guestfs-actions.pod:6514
17047 "This command enables swap to a labeled swap partition. See "
17048 "C<guestfs_swapon_device> for other notes."
17052 #: ../src/guestfs-actions.pod:6521
17053 msgid "guestfs_swapon_uuid"
17057 #: ../src/guestfs-actions.pod:6523
17061 " guestfs_swapon_uuid (guestfs_h *g,\n"
17062 " const char *uuid);\n"
17067 #: ../src/guestfs-actions.pod:6527
17069 "This command enables swap to a swap partition with the given UUID. See "
17070 "C<guestfs_swapon_device> for other notes."
17074 #: ../src/guestfs-actions.pod:6534
17075 msgid "guestfs_sync"
17079 #: ../src/guestfs-actions.pod:6536
17083 " guestfs_sync (guestfs_h *g);\n"
17088 #: ../src/guestfs-actions.pod:6539 ../fish/guestfish-actions.pod:4409
17090 "This syncs the disk, so that any writes are flushed through to the "
17091 "underlying disk image."
17095 #: ../src/guestfs-actions.pod:6542 ../fish/guestfish-actions.pod:4412
17097 "You should always call this if you have modified a disk image, before "
17098 "closing the handle."
17102 #: ../src/guestfs-actions.pod:6549
17103 msgid "guestfs_tail"
17107 #: ../src/guestfs-actions.pod:6551
17111 " guestfs_tail (guestfs_h *g,\n"
17112 " const char *path);\n"
17117 #: ../src/guestfs-actions.pod:6555 ../fish/guestfish-actions.pod:4419
17119 "This command returns up to the last 10 lines of a file as a list of strings."
17123 #: ../src/guestfs-actions.pod:6567
17124 msgid "guestfs_tail_n"
17128 #: ../src/guestfs-actions.pod:6569
17132 " guestfs_tail_n (guestfs_h *g,\n"
17134 " const char *path);\n"
17139 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4429
17141 "If the parameter C<nrlines> is a positive number, this returns the last "
17142 "C<nrlines> lines of the file C<path>."
17146 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4432
17148 "If the parameter C<nrlines> is a negative number, this returns lines from "
17149 "the file C<path>, starting with the C<-nrlines>th line."
17153 #: ../src/guestfs-actions.pod:6591
17154 msgid "guestfs_tar_in"
17158 #: ../src/guestfs-actions.pod:6593
17162 " guestfs_tar_in (guestfs_h *g,\n"
17163 " const char *tarfile,\n"
17164 " const char *directory);\n"
17169 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4444
17171 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17172 "tar file) into C<directory>."
17176 #: ../src/guestfs-actions.pod:6601
17178 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17182 #: ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:6623
17183 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6655
17184 msgid "(Added in 1.0.3)"
17188 #: ../src/guestfs-actions.pod:6608
17189 msgid "guestfs_tar_out"
17193 #: ../src/guestfs-actions.pod:6610
17197 " guestfs_tar_out (guestfs_h *g,\n"
17198 " const char *directory,\n"
17199 " const char *tarfile);\n"
17204 #: ../src/guestfs-actions.pod:6615 ../fish/guestfish-actions.pod:4456
17206 "This command packs the contents of C<directory> and downloads it to local "
17211 #: ../src/guestfs-actions.pod:6618
17213 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17214 "C<guestfs_txz_out>."
17218 #: ../src/guestfs-actions.pod:6625
17219 msgid "guestfs_tgz_in"
17223 #: ../src/guestfs-actions.pod:6627
17227 " guestfs_tgz_in (guestfs_h *g,\n"
17228 " const char *tarball,\n"
17229 " const char *directory);\n"
17234 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4468
17236 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17237 "tar file) into C<directory>."
17241 #: ../src/guestfs-actions.pod:6635
17242 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17246 #: ../src/guestfs-actions.pod:6641
17247 msgid "guestfs_tgz_out"
17251 #: ../src/guestfs-actions.pod:6643
17255 " guestfs_tgz_out (guestfs_h *g,\n"
17256 " const char *directory,\n"
17257 " const char *tarball);\n"
17262 #: ../src/guestfs-actions.pod:6648 ../fish/guestfish-actions.pod:4479
17264 "This command packs the contents of C<directory> and downloads it to local "
17269 #: ../src/guestfs-actions.pod:6651
17270 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17274 #: ../src/guestfs-actions.pod:6657
17275 msgid "guestfs_touch"
17279 #: ../src/guestfs-actions.pod:6659
17283 " guestfs_touch (guestfs_h *g,\n"
17284 " const char *path);\n"
17289 #: ../src/guestfs-actions.pod:6663 ../fish/guestfish-actions.pod:4490
17291 "Touch acts like the L<touch(1)> command. It can be used to update the "
17292 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17297 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4494
17299 "This command only works on regular files, and will fail on other file types "
17300 "such as directories, symbolic links, block special etc."
17304 #: ../src/guestfs-actions.pod:6674
17305 msgid "guestfs_truncate"
17309 #: ../src/guestfs-actions.pod:6676
17313 " guestfs_truncate (guestfs_h *g,\n"
17314 " const char *path);\n"
17319 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4501
17321 "This command truncates C<path> to a zero-length file. The file must exist "
17326 #: ../src/guestfs-actions.pod:6687
17327 msgid "guestfs_truncate_size"
17331 #: ../src/guestfs-actions.pod:6689
17335 " guestfs_truncate_size (guestfs_h *g,\n"
17336 " const char *path,\n"
17337 " int64_t size);\n"
17342 #: ../src/guestfs-actions.pod:6694 ../fish/guestfish-actions.pod:4508
17344 "This command truncates C<path> to size C<size> bytes. The file must exist "
17349 #: ../src/guestfs-actions.pod:6697
17351 "If the current file size is less than C<size> then the file is extended to "
17352 "the required size with zero bytes. This creates a sparse file (ie. disk "
17353 "blocks are not allocated for the file until you write to it). To create a "
17354 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17358 #: ../src/guestfs-actions.pod:6707
17359 msgid "guestfs_tune2fs_l"
17363 #: ../src/guestfs-actions.pod:6709
17367 " guestfs_tune2fs_l (guestfs_h *g,\n"
17368 " const char *device);\n"
17373 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4521
17375 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17380 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4524
17382 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17383 "for more details. The list of fields returned isn't clearly defined, and "
17384 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17385 "and the filesystem itself."
17389 #: ../src/guestfs-actions.pod:6729
17390 msgid "guestfs_txz_in"
17394 #: ../src/guestfs-actions.pod:6731
17398 " guestfs_txz_in (guestfs_h *g,\n"
17399 " const char *tarball,\n"
17400 " const char *directory);\n"
17405 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4533
17407 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17408 "tar file) into C<directory>."
17412 #: ../src/guestfs-actions.pod:6743
17413 msgid "guestfs_txz_out"
17417 #: ../src/guestfs-actions.pod:6745
17421 " guestfs_txz_out (guestfs_h *g,\n"
17422 " const char *directory,\n"
17423 " const char *tarball);\n"
17428 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4542
17430 "This command packs the contents of C<directory> and downloads it to local "
17431 "file C<tarball> (as an xz compressed tar archive)."
17435 #: ../src/guestfs-actions.pod:6757
17436 msgid "guestfs_umask"
17440 #: ../src/guestfs-actions.pod:6759
17444 " guestfs_umask (guestfs_h *g,\n"
17450 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4551
17452 "This function sets the mask used for creating new files and device nodes to "
17457 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4554
17459 "Typical umask values would be C<022> which creates new files with "
17460 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17461 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17465 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4559
17467 "The default umask is C<022>. This is important because it means that "
17468 "directories and device nodes will be created with C<0644> or C<0755> mode "
17469 "even if you specify C<0777>."
17473 #: ../src/guestfs-actions.pod:6775
17475 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17476 "C<guestfs_mkdir>."
17480 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4566
17481 msgid "This call returns the previous umask."
17485 #: ../src/guestfs-actions.pod:6784
17486 msgid "guestfs_umount"
17490 #: ../src/guestfs-actions.pod:6786
17494 " guestfs_umount (guestfs_h *g,\n"
17495 " const char *pathordevice);\n"
17500 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4574
17502 "This unmounts the given filesystem. The filesystem may be specified either "
17503 "by its mountpoint (path) or the device which contains the filesystem."
17507 #: ../src/guestfs-actions.pod:6798
17508 msgid "guestfs_umount_all"
17512 #: ../src/guestfs-actions.pod:6800
17516 " guestfs_umount_all (guestfs_h *g);\n"
17521 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4584
17522 msgid "This unmounts all mounted filesystems."
17526 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4586
17527 msgid "Some internal mounts are not unmounted by this call."
17531 #: ../src/guestfs-actions.pod:6811
17532 msgid "guestfs_upload"
17536 #: ../src/guestfs-actions.pod:6813
17540 " guestfs_upload (guestfs_h *g,\n"
17541 " const char *filename,\n"
17542 " const char *remotefilename);\n"
17547 #: ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:6842
17548 #: ../fish/guestfish-actions.pod:4592 ../fish/guestfish-actions.pod:4605
17549 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17553 #: ../src/guestfs-actions.pod:6823
17554 msgid "See also C<guestfs_download>."
17558 #: ../src/guestfs-actions.pod:6834
17559 msgid "guestfs_upload_offset"
17563 #: ../src/guestfs-actions.pod:6836
17567 " guestfs_upload_offset (guestfs_h *g,\n"
17568 " const char *filename,\n"
17569 " const char *remotefilename,\n"
17570 " int64_t offset);\n"
17575 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4608
17577 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17578 "The intention is to overwrite parts of existing files or devices, although "
17579 "if a non-existant file is specified then it is created with a \"hole\" "
17580 "before C<offset>. The size of the data written is implicit in the size of "
17581 "the source C<filename>."
17585 #: ../src/guestfs-actions.pod:6852
17587 "Note that there is no limit on the amount of data that can be uploaded with "
17588 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17589 "full amount unless an error occurs."
17593 #: ../src/guestfs-actions.pod:6857
17594 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17598 #: ../src/guestfs-actions.pod:6868
17599 msgid "guestfs_utimens"
17603 #: ../src/guestfs-actions.pod:6870
17607 " guestfs_utimens (guestfs_h *g,\n"
17608 " const char *path,\n"
17609 " int64_t atsecs,\n"
17610 " int64_t atnsecs,\n"
17611 " int64_t mtsecs,\n"
17612 " int64_t mtnsecs);\n"
17617 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4628
17618 msgid "This command sets the timestamps of a file with nanosecond precision."
17622 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4631
17624 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17629 #: ../src/guestfs-actions.pod:6884 ../fish/guestfish-actions.pod:4634
17631 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17632 "nanoseconds from the epoch."
17636 #: ../src/guestfs-actions.pod:6887 ../fish/guestfish-actions.pod:4637
17638 "If the C<*nsecs> field contains the special value C<-1> then the "
17639 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17640 "ignored in this case)."
17644 #: ../src/guestfs-actions.pod:6891 ../fish/guestfish-actions.pod:4641
17646 "If the C<*nsecs> field contains the special value C<-2> then the "
17647 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17652 #: ../src/guestfs-actions.pod:6899 ../src/guestfs-structs.pod:175
17653 msgid "guestfs_version"
17657 #: ../src/guestfs-actions.pod:6901
17660 " struct guestfs_version *\n"
17661 " guestfs_version (guestfs_h *g);\n"
17666 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4649
17668 "Return the libguestfs version number that the program is linked against."
17672 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4652
17674 "Note that because of dynamic linking this is not necessarily the version of "
17675 "libguestfs that you compiled against. You can compile the program, and then "
17676 "at runtime dynamically link against a completely different C<libguestfs.so> "
17681 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4657
17683 "This call was added in version C<1.0.58>. In previous versions of "
17684 "libguestfs there was no way to get the version number. From C code you can "
17685 "use dynamic linker functions to find out if this symbol exists (if it "
17686 "doesn't, then it's an earlier version)."
17690 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4663
17692 "The call returns a structure with four elements. The first three (C<major>, "
17693 "C<minor> and C<release>) are numbers and correspond to the usual version "
17694 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17695 "but may be used for distro-specific information."
17699 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4669
17701 "To construct the original version string: C<$major.$minor.$release$extra>"
17705 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:4672
17706 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17710 #: ../src/guestfs-actions.pod:6929
17712 "I<Note:> Don't use this call to test for availability of features. In "
17713 "enterprise distributions we backport features from later versions into "
17714 "earlier versions, making this an unreliable way to test for features. Use "
17715 "C<guestfs_available> instead."
17719 #: ../src/guestfs-actions.pod:6935
17721 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17722 "error. I<The caller must call C<guestfs_free_version> after use>."
17726 #: ../src/guestfs-actions.pod:6939
17727 msgid "(Added in 1.0.58)"
17731 #: ../src/guestfs-actions.pod:6941
17732 msgid "guestfs_vfs_label"
17736 #: ../src/guestfs-actions.pod:6943
17740 " guestfs_vfs_label (guestfs_h *g,\n"
17741 " const char *device);\n"
17746 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4684
17747 msgid "This returns the filesystem label of the filesystem on C<device>."
17751 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4687
17752 msgid "If the filesystem is unlabeled, this returns the empty string."
17756 #: ../src/guestfs-actions.pod:6952
17757 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17761 #: ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:6994
17762 msgid "(Added in 1.3.18)"
17766 #: ../src/guestfs-actions.pod:6959
17767 msgid "guestfs_vfs_type"
17771 #: ../src/guestfs-actions.pod:6961
17775 " guestfs_vfs_type (guestfs_h *g,\n"
17776 " const char *device);\n"
17781 #: ../src/guestfs-actions.pod:6965 ../fish/guestfish-actions.pod:4695
17783 "This command gets the filesystem type corresponding to the filesystem on "
17788 #: ../src/guestfs-actions.pod:6968 ../fish/guestfish-actions.pod:4698
17790 "For most filesystems, the result is the name of the Linux VFS module which "
17791 "would be used to mount this filesystem if you mounted it without specifying "
17792 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17796 #: ../src/guestfs-actions.pod:6978
17797 msgid "guestfs_vfs_uuid"
17801 #: ../src/guestfs-actions.pod:6980
17805 " guestfs_vfs_uuid (guestfs_h *g,\n"
17806 " const char *device);\n"
17811 #: ../src/guestfs-actions.pod:6984 ../fish/guestfish-actions.pod:4707
17812 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17816 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4710
17817 msgid "If the filesystem does not have a UUID, this returns the empty string."
17821 #: ../src/guestfs-actions.pod:6989
17822 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17826 #: ../src/guestfs-actions.pod:6996
17827 msgid "guestfs_vg_activate"
17831 #: ../src/guestfs-actions.pod:6998
17835 " guestfs_vg_activate (guestfs_h *g,\n"
17837 " char *const *volgroups);\n"
17842 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4718
17844 "This command activates or (if C<activate> is false) deactivates all logical "
17845 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17846 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17847 "deactivated, then those devices disappear."
17851 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4724
17852 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17856 #: ../src/guestfs-actions.pod:7011 ../fish/guestfish-actions.pod:4726
17858 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17859 "activated or deactivated."
17863 #: ../src/guestfs-actions.pod:7018
17864 msgid "guestfs_vg_activate_all"
17868 #: ../src/guestfs-actions.pod:7020
17872 " guestfs_vg_activate_all (guestfs_h *g,\n"
17873 " int activate);\n"
17878 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4733
17880 "This command activates or (if C<activate> is false) deactivates all logical "
17881 "volumes in all volume groups. If activated, then they are made known to the "
17882 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17883 "those devices disappear."
17887 #: ../src/guestfs-actions.pod:7030 ../fish/guestfish-actions.pod:4739
17888 msgid "This command is the same as running C<vgchange -a y|n>"
17892 #: ../src/guestfs-actions.pod:7036
17893 msgid "guestfs_vgcreate"
17897 #: ../src/guestfs-actions.pod:7038
17901 " guestfs_vgcreate (guestfs_h *g,\n"
17902 " const char *volgroup,\n"
17903 " char *const *physvols);\n"
17908 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4745
17910 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17911 "of physical volumes C<physvols>."
17915 #: ../src/guestfs-actions.pod:7050
17916 msgid "guestfs_vglvuuids"
17920 #: ../src/guestfs-actions.pod:7052
17924 " guestfs_vglvuuids (guestfs_h *g,\n"
17925 " const char *vgname);\n"
17930 #: ../src/guestfs-actions.pod:7056 ../fish/guestfish-actions.pod:4752
17932 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17933 "volumes created in this volume group."
17937 #: ../src/guestfs-actions.pod:7059
17939 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17940 "associate logical volumes and volume groups."
17944 #: ../src/guestfs-actions.pod:7062
17945 msgid "See also C<guestfs_vgpvuuids>."
17949 #: ../src/guestfs-actions.pod:7070
17950 msgid "guestfs_vgpvuuids"
17954 #: ../src/guestfs-actions.pod:7072
17958 " guestfs_vgpvuuids (guestfs_h *g,\n"
17959 " const char *vgname);\n"
17964 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4764
17966 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17967 "volumes that this volume group resides on."
17971 #: ../src/guestfs-actions.pod:7079
17973 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17974 "associate physical volumes and volume groups."
17978 #: ../src/guestfs-actions.pod:7082
17979 msgid "See also C<guestfs_vglvuuids>."
17983 #: ../src/guestfs-actions.pod:7090
17984 msgid "guestfs_vgremove"
17988 #: ../src/guestfs-actions.pod:7092
17992 " guestfs_vgremove (guestfs_h *g,\n"
17993 " const char *vgname);\n"
17998 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4776
17999 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18003 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4778
18005 "This also forcibly removes all logical volumes in the volume group (if any)."
18009 #: ../src/guestfs-actions.pod:7105
18010 msgid "guestfs_vgrename"
18014 #: ../src/guestfs-actions.pod:7107
18018 " guestfs_vgrename (guestfs_h *g,\n"
18019 " const char *volgroup,\n"
18020 " const char *newvolgroup);\n"
18025 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4785
18026 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18030 #: ../src/guestfs-actions.pod:7118
18031 msgid "guestfs_vgs"
18035 #: ../src/guestfs-actions.pod:7120
18039 " guestfs_vgs (guestfs_h *g);\n"
18044 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4791
18046 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18051 #: ../src/guestfs-actions.pod:7126 ../fish/guestfish-actions.pod:4794
18053 "This returns a list of just the volume group names that were detected (eg. "
18058 #: ../src/guestfs-actions.pod:7129
18059 msgid "See also C<guestfs_vgs_full>."
18063 #: ../src/guestfs-actions.pod:7137
18064 msgid "guestfs_vgs_full"
18068 #: ../src/guestfs-actions.pod:7139
18071 " struct guestfs_lvm_vg_list *\n"
18072 " guestfs_vgs_full (guestfs_h *g);\n"
18077 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4803
18079 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18080 "> command. The \"full\" version includes all fields."
18084 #: ../src/guestfs-actions.pod:7145
18086 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18087 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18091 #: ../src/guestfs-actions.pod:7151
18092 msgid "guestfs_vgscan"
18096 #: ../src/guestfs-actions.pod:7153
18100 " guestfs_vgscan (guestfs_h *g);\n"
18105 #: ../src/guestfs-actions.pod:7156 ../fish/guestfish-actions.pod:4810
18107 "This rescans all block devices and rebuilds the list of LVM physical "
18108 "volumes, volume groups and logical volumes."
18112 #: ../src/guestfs-actions.pod:7163
18113 msgid "guestfs_vguuid"
18117 #: ../src/guestfs-actions.pod:7165
18121 " guestfs_vguuid (guestfs_h *g,\n"
18122 " const char *vgname);\n"
18127 #: ../src/guestfs-actions.pod:7169 ../fish/guestfish-actions.pod:4817
18128 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18132 #: ../src/guestfs-actions.pod:7176
18133 msgid "guestfs_wait_ready"
18137 #: ../src/guestfs-actions.pod:7178
18141 " guestfs_wait_ready (guestfs_h *g);\n"
18146 #: ../src/guestfs-actions.pod:7181
18147 msgid "This function is a no op."
18151 #: ../src/guestfs-actions.pod:7183
18153 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18154 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18155 "is no longer necessary because C<guestfs_launch> now does the waiting."
18159 #: ../src/guestfs-actions.pod:7188
18161 "If you see any calls to this function in code then you can just remove them, "
18162 "unless you want to retain compatibility with older versions of the API."
18166 #: ../src/guestfs-actions.pod:7196
18167 msgid "guestfs_wc_c"
18171 #: ../src/guestfs-actions.pod:7198
18175 " guestfs_wc_c (guestfs_h *g,\n"
18176 " const char *path);\n"
18181 #: ../src/guestfs-actions.pod:7202 ../fish/guestfish-actions.pod:4823
18183 "This command counts the characters in a file, using the C<wc -c> external "
18188 #: ../src/guestfs-actions.pod:7209
18189 msgid "guestfs_wc_l"
18193 #: ../src/guestfs-actions.pod:7211
18197 " guestfs_wc_l (guestfs_h *g,\n"
18198 " const char *path);\n"
18203 #: ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4830
18205 "This command counts the lines in a file, using the C<wc -l> external command."
18209 #: ../src/guestfs-actions.pod:7222
18210 msgid "guestfs_wc_w"
18214 #: ../src/guestfs-actions.pod:7224
18218 " guestfs_wc_w (guestfs_h *g,\n"
18219 " const char *path);\n"
18224 #: ../src/guestfs-actions.pod:7228 ../fish/guestfish-actions.pod:4837
18226 "This command counts the words in a file, using the C<wc -w> external command."
18230 #: ../src/guestfs-actions.pod:7235
18231 msgid "guestfs_write"
18235 #: ../src/guestfs-actions.pod:7237
18239 " guestfs_write (guestfs_h *g,\n"
18240 " const char *path,\n"
18241 " const char *content,\n"
18242 " size_t content_size);\n"
18247 #: ../src/guestfs-actions.pod:7243 ../fish/guestfish-actions.pod:4844
18249 "This call creates a file called C<path>. The content of the file is the "
18250 "string C<content> (which can contain any 8 bit data)."
18254 #: ../src/guestfs-actions.pod:7253
18255 msgid "guestfs_write_file"
18259 #: ../src/guestfs-actions.pod:7255
18263 " guestfs_write_file (guestfs_h *g,\n"
18264 " const char *path,\n"
18265 " const char *content,\n"
18271 #: ../src/guestfs-actions.pod:7261 ../fish/guestfish-actions.pod:4854
18273 "This call creates a file called C<path>. The contents of the file is the "
18274 "string C<content> (which can contain any 8 bit data), with length C<size>."
18278 #: ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:4858
18280 "As a special case, if C<size> is C<0> then the length is calculated using "
18281 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18285 #: ../src/guestfs-actions.pod:7269 ../fish/guestfish-actions.pod:4862
18287 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18288 "I<not> work, even if the length is specified."
18292 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4868
18294 "This function is deprecated. In new code, use the C<write> call instead."
18298 #: ../src/guestfs-actions.pod:7286
18299 msgid "guestfs_zegrep"
18303 #: ../src/guestfs-actions.pod:7288
18307 " guestfs_zegrep (guestfs_h *g,\n"
18308 " const char *regex,\n"
18309 " const char *path);\n"
18314 #: ../src/guestfs-actions.pod:7293 ../fish/guestfish-actions.pod:4879
18316 "This calls the external C<zegrep> program and returns the matching lines."
18320 #: ../src/guestfs-actions.pod:7305
18321 msgid "guestfs_zegrepi"
18325 #: ../src/guestfs-actions.pod:7307
18329 " guestfs_zegrepi (guestfs_h *g,\n"
18330 " const char *regex,\n"
18331 " const char *path);\n"
18336 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4889
18338 "This calls the external C<zegrep -i> program and returns the matching lines."
18342 #: ../src/guestfs-actions.pod:7324
18343 msgid "guestfs_zero"
18347 #: ../src/guestfs-actions.pod:7326
18351 " guestfs_zero (guestfs_h *g,\n"
18352 " const char *device);\n"
18357 #: ../src/guestfs-actions.pod:7330 ../fish/guestfish-actions.pod:4899
18358 msgid "This command writes zeroes over the first few blocks of C<device>."
18362 #: ../src/guestfs-actions.pod:7332 ../fish/guestfish-actions.pod:4901
18364 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18365 "securely wipe the device). It should be sufficient to remove any partition "
18366 "tables, filesystem superblocks and so on."
18370 #: ../src/guestfs-actions.pod:7336
18371 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18375 #: ../src/guestfs-actions.pod:7347
18376 msgid "guestfs_zero_device"
18380 #: ../src/guestfs-actions.pod:7349
18384 " guestfs_zero_device (guestfs_h *g,\n"
18385 " const char *device);\n"
18390 #: ../src/guestfs-actions.pod:7353
18392 "This command writes zeroes over the entire C<device>. Compare with "
18393 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18397 #: ../src/guestfs-actions.pod:7367
18398 msgid "(Added in 1.3.1)"
18402 #: ../src/guestfs-actions.pod:7369
18403 msgid "guestfs_zerofree"
18407 #: ../src/guestfs-actions.pod:7371
18411 " guestfs_zerofree (guestfs_h *g,\n"
18412 " const char *device);\n"
18417 #: ../src/guestfs-actions.pod:7375 ../fish/guestfish-actions.pod:4922
18419 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18420 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18421 "possible to compress the filesystem more effectively."
18425 #: ../src/guestfs-actions.pod:7380 ../fish/guestfish-actions.pod:4927
18426 msgid "You should B<not> run this program if the filesystem is mounted."
18430 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4930
18432 "It is possible that using this program can damage the filesystem or data on "
18437 #: ../src/guestfs-actions.pod:7390
18438 msgid "guestfs_zfgrep"
18442 #: ../src/guestfs-actions.pod:7392
18446 " guestfs_zfgrep (guestfs_h *g,\n"
18447 " const char *pattern,\n"
18448 " const char *path);\n"
18453 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:4937
18455 "This calls the external C<zfgrep> program and returns the matching lines."
18459 #: ../src/guestfs-actions.pod:7409
18460 msgid "guestfs_zfgrepi"
18464 #: ../src/guestfs-actions.pod:7411
18468 " guestfs_zfgrepi (guestfs_h *g,\n"
18469 " const char *pattern,\n"
18470 " const char *path);\n"
18475 #: ../src/guestfs-actions.pod:7416 ../fish/guestfish-actions.pod:4947
18477 "This calls the external C<zfgrep -i> program and returns the matching lines."
18481 #: ../src/guestfs-actions.pod:7428
18482 msgid "guestfs_zfile"
18486 #: ../src/guestfs-actions.pod:7430
18490 " guestfs_zfile (guestfs_h *g,\n"
18491 " const char *meth,\n"
18492 " const char *path);\n"
18497 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:4957
18499 "This command runs C<file> after first decompressing C<path> using C<method>."
18503 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4960
18504 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18508 #: ../src/guestfs-actions.pod:7440
18510 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18515 #: ../src/guestfs-actions.pod:7446 ../fish/guestfish-actions.pod:4965
18517 "This function is deprecated. In new code, use the C<file> call instead."
18521 #: ../src/guestfs-actions.pod:7455
18522 msgid "guestfs_zgrep"
18526 #: ../src/guestfs-actions.pod:7457
18530 " guestfs_zgrep (guestfs_h *g,\n"
18531 " const char *regex,\n"
18532 " const char *path);\n"
18537 #: ../src/guestfs-actions.pod:7462 ../fish/guestfish-actions.pod:4976
18539 "This calls the external C<zgrep> program and returns the matching lines."
18543 #: ../src/guestfs-actions.pod:7474
18544 msgid "guestfs_zgrepi"
18548 #: ../src/guestfs-actions.pod:7476
18552 " guestfs_zgrepi (guestfs_h *g,\n"
18553 " const char *regex,\n"
18554 " const char *path);\n"
18559 #: ../src/guestfs-actions.pod:7481 ../fish/guestfish-actions.pod:4986
18561 "This calls the external C<zgrep -i> program and returns the matching lines."
18565 #: ../src/guestfs-availability.pod:3
18570 #: ../src/guestfs-availability.pod:5
18572 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18573 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18574 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18575 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18576 "L</guestfs_aug_save> L</guestfs_aug_set>"
18580 #: ../src/guestfs-availability.pod:21
18585 #: ../src/guestfs-availability.pod:23
18587 "The following functions: L</guestfs_inotify_add_watch> L</"
18588 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18589 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18593 #: ../src/guestfs-availability.pod:31
18594 msgid "B<linuxfsuuid>"
18598 #: ../src/guestfs-availability.pod:33
18600 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18601 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18605 #: ../src/guestfs-availability.pod:40
18606 msgid "B<linuxmodules>"
18610 #: ../src/guestfs-availability.pod:42
18611 msgid "The following functions: L</guestfs_modprobe>"
18615 #: ../src/guestfs-availability.pod:45
18616 msgid "B<linuxxattrs>"
18620 #: ../src/guestfs-availability.pod:47
18622 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18623 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18624 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18625 "guestfs_setxattr>"
18629 #: ../src/guestfs-availability.pod:58
18634 #: ../src/guestfs-availability.pod:60
18636 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18637 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18638 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18642 #: ../src/guestfs-availability.pod:69
18647 #: ../src/guestfs-availability.pod:71
18649 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18650 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18651 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18652 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18653 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18654 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18655 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18659 #: ../src/guestfs-availability.pod:94
18664 #: ../src/guestfs-availability.pod:96
18666 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18667 "guestfs_mknod_b> L</guestfs_mknod_c>"
18671 #: ../src/guestfs-availability.pod:102
18676 #: ../src/guestfs-availability.pod:104
18677 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18681 #: ../src/guestfs-availability.pod:107
18682 msgid "B<ntfsprogs>"
18686 #: ../src/guestfs-availability.pod:109
18688 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18692 #: ../src/guestfs-availability.pod:113
18693 msgid "B<realpath>"
18697 #: ../src/guestfs-availability.pod:115
18698 msgid "The following functions: L</guestfs_realpath>"
18702 #: ../src/guestfs-availability.pod:118
18707 #: ../src/guestfs-availability.pod:120
18709 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18710 "guestfs_scrub_freespace>"
18714 #: ../src/guestfs-availability.pod:125
18719 #: ../src/guestfs-availability.pod:127
18720 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18724 #: ../src/guestfs-availability.pod:131
18729 #: ../src/guestfs-availability.pod:133
18730 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18734 #: ../src/guestfs-availability.pod:137
18735 msgid "B<zerofree>"
18739 #: ../src/guestfs-availability.pod:139
18740 msgid "The following functions: L</guestfs_zerofree>"
18744 #: ../src/guestfs-structs.pod:1
18745 msgid "guestfs_int_bool"
18749 #: ../src/guestfs-structs.pod:3
18752 " struct guestfs_int_bool {\n"
18760 #: ../src/guestfs-structs.pod:8
18763 " struct guestfs_int_bool_list {\n"
18764 " uint32_t len; /* Number of elements in list. */\n"
18765 " struct guestfs_int_bool *val; /* Elements. */\n"
18771 #: ../src/guestfs-structs.pod:13
18774 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18775 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18780 #: ../src/guestfs-structs.pod:16
18781 msgid "guestfs_lvm_pv"
18785 #: ../src/guestfs-structs.pod:18
18788 " struct guestfs_lvm_pv {\n"
18789 " char *pv_name;\n"
18790 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18791 " char pv_uuid[32];\n"
18793 " uint64_t pv_size;\n"
18794 " uint64_t dev_size;\n"
18795 " uint64_t pv_free;\n"
18796 " uint64_t pv_used;\n"
18797 " char *pv_attr;\n"
18798 " int64_t pv_pe_count;\n"
18799 " int64_t pv_pe_alloc_count;\n"
18800 " char *pv_tags;\n"
18801 " uint64_t pe_start;\n"
18802 " int64_t pv_mda_count;\n"
18803 " uint64_t pv_mda_free;\n"
18809 #: ../src/guestfs-structs.pod:36
18812 " struct guestfs_lvm_pv_list {\n"
18813 " uint32_t len; /* Number of elements in list. */\n"
18814 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18820 #: ../src/guestfs-structs.pod:41
18823 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18824 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18829 #: ../src/guestfs-structs.pod:44
18830 msgid "guestfs_lvm_vg"
18834 #: ../src/guestfs-structs.pod:46
18837 " struct guestfs_lvm_vg {\n"
18838 " char *vg_name;\n"
18839 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18840 " char vg_uuid[32];\n"
18842 " char *vg_attr;\n"
18843 " uint64_t vg_size;\n"
18844 " uint64_t vg_free;\n"
18845 " char *vg_sysid;\n"
18846 " uint64_t vg_extent_size;\n"
18847 " int64_t vg_extent_count;\n"
18848 " int64_t vg_free_count;\n"
18849 " int64_t max_lv;\n"
18850 " int64_t max_pv;\n"
18851 " int64_t pv_count;\n"
18852 " int64_t lv_count;\n"
18853 " int64_t snap_count;\n"
18854 " int64_t vg_seqno;\n"
18855 " char *vg_tags;\n"
18856 " int64_t vg_mda_count;\n"
18857 " uint64_t vg_mda_free;\n"
18863 #: ../src/guestfs-structs.pod:69
18866 " struct guestfs_lvm_vg_list {\n"
18867 " uint32_t len; /* Number of elements in list. */\n"
18868 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18874 #: ../src/guestfs-structs.pod:74
18877 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18878 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18883 #: ../src/guestfs-structs.pod:77
18884 msgid "guestfs_lvm_lv"
18888 #: ../src/guestfs-structs.pod:79
18891 " struct guestfs_lvm_lv {\n"
18892 " char *lv_name;\n"
18893 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18894 " char lv_uuid[32];\n"
18895 " char *lv_attr;\n"
18896 " int64_t lv_major;\n"
18897 " int64_t lv_minor;\n"
18898 " int64_t lv_kernel_major;\n"
18899 " int64_t lv_kernel_minor;\n"
18900 " uint64_t lv_size;\n"
18901 " int64_t seg_count;\n"
18903 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18904 " float snap_percent;\n"
18905 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18906 " float copy_percent;\n"
18907 " char *move_pv;\n"
18908 " char *lv_tags;\n"
18909 " char *mirror_log;\n"
18910 " char *modules;\n"
18916 #: ../src/guestfs-structs.pod:101
18919 " struct guestfs_lvm_lv_list {\n"
18920 " uint32_t len; /* Number of elements in list. */\n"
18921 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18927 #: ../src/guestfs-structs.pod:106
18930 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18931 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18936 #: ../src/guestfs-structs.pod:111
18939 " struct guestfs_stat {\n"
18943 " int64_t nlink;\n"
18948 " int64_t blksize;\n"
18949 " int64_t blocks;\n"
18950 " int64_t atime;\n"
18951 " int64_t mtime;\n"
18952 " int64_t ctime;\n"
18958 #: ../src/guestfs-structs.pod:127
18961 " struct guestfs_stat_list {\n"
18962 " uint32_t len; /* Number of elements in list. */\n"
18963 " struct guestfs_stat *val; /* Elements. */\n"
18969 #: ../src/guestfs-structs.pod:132
18972 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18973 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18978 #: ../src/guestfs-structs.pod:137
18981 " struct guestfs_statvfs {\n"
18982 " int64_t bsize;\n"
18983 " int64_t frsize;\n"
18984 " int64_t blocks;\n"
18985 " int64_t bfree;\n"
18986 " int64_t bavail;\n"
18987 " int64_t files;\n"
18988 " int64_t ffree;\n"
18989 " int64_t favail;\n"
18992 " int64_t namemax;\n"
18998 #: ../src/guestfs-structs.pod:151
19001 " struct guestfs_statvfs_list {\n"
19002 " uint32_t len; /* Number of elements in list. */\n"
19003 " struct guestfs_statvfs *val; /* Elements. */\n"
19009 #: ../src/guestfs-structs.pod:156
19012 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19013 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19018 #: ../src/guestfs-structs.pod:159
19019 msgid "guestfs_dirent"
19023 #: ../src/guestfs-structs.pod:161
19026 " struct guestfs_dirent {\n"
19035 #: ../src/guestfs-structs.pod:167
19038 " struct guestfs_dirent_list {\n"
19039 " uint32_t len; /* Number of elements in list. */\n"
19040 " struct guestfs_dirent *val; /* Elements. */\n"
19046 #: ../src/guestfs-structs.pod:172
19049 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19050 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19055 #: ../src/guestfs-structs.pod:177
19058 " struct guestfs_version {\n"
19059 " int64_t major;\n"
19060 " int64_t minor;\n"
19061 " int64_t release;\n"
19068 #: ../src/guestfs-structs.pod:184
19071 " struct guestfs_version_list {\n"
19072 " uint32_t len; /* Number of elements in list. */\n"
19073 " struct guestfs_version *val; /* Elements. */\n"
19079 #: ../src/guestfs-structs.pod:189
19082 " void guestfs_free_version (struct guestfs_free_version *);\n"
19083 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19088 #: ../src/guestfs-structs.pod:192
19089 msgid "guestfs_xattr"
19093 #: ../src/guestfs-structs.pod:194
19096 " struct guestfs_xattr {\n"
19097 " char *attrname;\n"
19098 " /* The next two fields describe a byte array. */\n"
19099 " uint32_t attrval_len;\n"
19100 " char *attrval;\n"
19106 #: ../src/guestfs-structs.pod:201
19109 " struct guestfs_xattr_list {\n"
19110 " uint32_t len; /* Number of elements in list. */\n"
19111 " struct guestfs_xattr *val; /* Elements. */\n"
19117 #: ../src/guestfs-structs.pod:206
19120 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19121 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19126 #: ../src/guestfs-structs.pod:209
19127 msgid "guestfs_inotify_event"
19131 #: ../src/guestfs-structs.pod:211
19134 " struct guestfs_inotify_event {\n"
19135 " int64_t in_wd;\n"
19136 " uint32_t in_mask;\n"
19137 " uint32_t in_cookie;\n"
19138 " char *in_name;\n"
19144 #: ../src/guestfs-structs.pod:218
19147 " struct guestfs_inotify_event_list {\n"
19148 " uint32_t len; /* Number of elements in list. */\n"
19149 " struct guestfs_inotify_event *val; /* Elements. */\n"
19155 #: ../src/guestfs-structs.pod:223
19158 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19159 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19164 #: ../src/guestfs-structs.pod:226
19165 msgid "guestfs_partition"
19169 #: ../src/guestfs-structs.pod:228
19172 " struct guestfs_partition {\n"
19173 " int32_t part_num;\n"
19174 " uint64_t part_start;\n"
19175 " uint64_t part_end;\n"
19176 " uint64_t part_size;\n"
19182 #: ../src/guestfs-structs.pod:235
19185 " struct guestfs_partition_list {\n"
19186 " uint32_t len; /* Number of elements in list. */\n"
19187 " struct guestfs_partition *val; /* Elements. */\n"
19193 #: ../src/guestfs-structs.pod:240
19196 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19197 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19202 #: ../src/guestfs-structs.pod:243
19203 msgid "guestfs_application"
19207 #: ../src/guestfs-structs.pod:245
19210 " struct guestfs_application {\n"
19211 " char *app_name;\n"
19212 " char *app_display_name;\n"
19213 " int32_t app_epoch;\n"
19214 " char *app_version;\n"
19215 " char *app_release;\n"
19216 " char *app_install_path;\n"
19217 " char *app_trans_path;\n"
19218 " char *app_publisher;\n"
19219 " char *app_url;\n"
19220 " char *app_source_package;\n"
19221 " char *app_summary;\n"
19222 " char *app_description;\n"
19228 #: ../src/guestfs-structs.pod:260
19231 " struct guestfs_application_list {\n"
19232 " uint32_t len; /* Number of elements in list. */\n"
19233 " struct guestfs_application *val; /* Elements. */\n"
19239 #: ../src/guestfs-structs.pod:265
19242 " void guestfs_free_application (struct guestfs_free_application *);\n"
19243 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19248 #: ../fish/guestfish.pod:5
19249 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19253 #: ../fish/guestfish.pod:9
19256 " guestfish [--options] [commands]\n"
19261 #: ../fish/guestfish.pod:11
19269 #: ../fish/guestfish.pod:13
19272 " guestfish [--ro|--rw] -a disk.img\n"
19277 #: ../fish/guestfish.pod:15
19280 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19285 #: ../fish/guestfish.pod:17
19288 " guestfish -d libvirt-domain\n"
19293 #: ../fish/guestfish.pod:19
19296 " guestfish [--ro|--rw] -a disk.img -i\n"
19301 #: ../fish/guestfish.pod:21
19304 " guestfish -d libvirt-domain -i\n"
19309 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
19310 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19315 #: ../fish/guestfish.pod:25
19317 "Using guestfish in read/write mode on live virtual machines can be "
19318 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19319 "option to use guestfish safely if the disk image or virtual machine might be "
19324 #: ../fish/guestfish.pod:32
19326 "Guestfish is a shell and command-line tool for examining and modifying "
19327 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19328 "functionality of the guestfs API, see L<guestfs(3)>."
19332 #: ../fish/guestfish.pod:36
19334 "Guestfish gives you structured access to the libguestfs API, from shell "
19335 "scripts or the command line or interactively. If you want to rescue a "
19336 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19341 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
19342 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19347 #: ../fish/guestfish.pod:43
19348 msgid "As an interactive shell"
19352 #: ../fish/guestfish.pod:45
19360 #: ../fish/guestfish.pod:47
19363 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19364 " editing virtual machine filesystems.\n"
19369 #: ../fish/guestfish.pod:50
19372 " Type: 'help' for a list of commands\n"
19373 " 'man' to read the manual\n"
19374 " 'quit' to quit the shell\n"
19379 #: ../fish/guestfish.pod:54
19382 " ><fs> add-ro disk.img\n"
19384 " ><fs> list-filesystems\n"
19385 " /dev/sda1: ext4\n"
19386 " /dev/vg_guest/lv_root: ext4\n"
19387 " /dev/vg_guest/lv_swap: swap\n"
19388 " ><fs> mount /dev/vg_guest/lv_root /\n"
19389 " ><fs> cat /etc/fstab\n"
19391 " # Created by anaconda\n"
19398 #: ../fish/guestfish.pod:67
19399 msgid "From shell scripts"
19403 #: ../fish/guestfish.pod:69
19404 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19408 #: ../fish/guestfish.pod:71
19411 " guestfish <<_EOF_\n"
19414 " mount /dev/vg_guest/lv_root /\n"
19415 " write /etc/motd \"Welcome, new users\"\n"
19421 #: ../fish/guestfish.pod:78
19422 msgid "List the LVM logical volumes in a disk image:"
19426 #: ../fish/guestfish.pod:80
19429 " guestfish -a disk.img --ro <<_EOF_\n"
19437 #: ../fish/guestfish.pod:85
19438 msgid "List all the filesystems in a disk image:"
19442 #: ../fish/guestfish.pod:87
19445 " guestfish -a disk.img --ro <<_EOF_\n"
19447 " list-filesystems\n"
19453 #: ../fish/guestfish.pod:92
19454 msgid "On one command line"
19458 #: ../fish/guestfish.pod:94
19459 msgid "Update C</etc/resolv.conf> in a guest:"
19463 #: ../fish/guestfish.pod:96
19467 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19468 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19473 #: ../fish/guestfish.pod:100
19474 msgid "Edit C</boot/grub/grub.conf> interactively:"
19478 #: ../fish/guestfish.pod:102
19481 " guestfish --rw --add disk.img \\\n"
19482 " --mount /dev/vg_guest/lv_root \\\n"
19483 " --mount /dev/sda1:/boot \\\n"
19484 " edit /boot/grub/grub.conf\n"
19489 #: ../fish/guestfish.pod:107
19490 msgid "Mount disks automatically"
19494 #: ../fish/guestfish.pod:109
19496 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19500 #: ../fish/guestfish.pod:112
19503 " guestfish --ro -a disk.img -i cat /etc/group\n"
19508 #: ../fish/guestfish.pod:114
19511 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19516 #: ../fish/guestfish.pod:116
19517 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19521 #: ../fish/guestfish.pod:118
19524 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19529 #: ../fish/guestfish.pod:120
19530 msgid "As a script interpreter"
19534 #: ../fish/guestfish.pod:122
19535 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19539 #: ../fish/guestfish.pod:124
19542 " #!/usr/bin/guestfish -f\n"
19543 " sparse test1.img 100M\n"
19545 " part-disk /dev/sda mbr\n"
19546 " mkfs ext2 /dev/sda1\n"
19551 #: ../fish/guestfish.pod:130
19552 msgid "Start with a prepared disk"
19556 #: ../fish/guestfish.pod:132
19558 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19559 "single ext2-formatted partition:"
19563 #: ../fish/guestfish.pod:135
19566 " guestfish -N fs\n"
19571 #: ../fish/guestfish.pod:137
19572 msgid "To list what is available do:"
19576 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19579 " guestfish -N help | less\n"
19584 #: ../fish/guestfish.pod:141
19585 msgid "Remote control"
19589 #: ../fish/guestfish.pod:143
19592 " eval \"`guestfish --listen`\"\n"
19593 " guestfish --remote add-ro disk.img\n"
19594 " guestfish --remote run\n"
19595 " guestfish --remote lvs\n"
19600 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19601 #: ../fuse/guestmount.pod:73 ../tools/virt-win-reg.pl:96
19602 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
19603 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19608 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:133
19609 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
19610 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
19611 #: ../tools/virt-list-partitions.pl:62
19616 #: ../fish/guestfish.pod:154
19617 msgid "Displays general help on options."
19621 #: ../fish/guestfish.pod:156
19626 #: ../fish/guestfish.pod:158
19627 msgid "B<--cmd-help>"
19631 #: ../fish/guestfish.pod:160
19632 msgid "Lists all available guestfish commands."
19636 #: ../fish/guestfish.pod:162
19641 #: ../fish/guestfish.pod:164
19642 msgid "B<--cmd-help cmd>"
19646 #: ../fish/guestfish.pod:166
19647 msgid "Displays detailed help on a single command C<cmd>."
19651 #: ../fish/guestfish.pod:168
19652 msgid "B<-a image>"
19656 #: ../fish/guestfish.pod:170
19657 msgid "B<--add image>"
19661 #: ../fish/guestfish.pod:172
19662 msgid "Add a block device or virtual machine image to the shell."
19666 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19668 "The format of the disk image is auto-detected. To override this and force a "
19669 "particular format use the I<--format=..> option."
19673 #: ../fish/guestfish.pod:177
19675 "Using this flag is mostly equivalent to using the C<add> command, with "
19676 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19677 "the I<--format=...> flag was given."
19681 #: ../fish/guestfish.pod:181
19686 #: ../fish/guestfish.pod:183
19687 msgid "B<--connect URI>"
19691 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19693 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19694 "URI to use. The default is to use the default libvirt connection."
19698 #: ../fish/guestfish.pod:189
19703 #: ../fish/guestfish.pod:191
19705 "If using the I<--listen> option and a csh-like shell, use this option. See "
19706 "section L</REMOTE CONTROL AND CSH> below."
19710 #: ../fish/guestfish.pod:194
19711 msgid "B<-d libvirt-domain>"
19715 #: ../fish/guestfish.pod:196
19716 msgid "B<--domain libvirt-domain>"
19720 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19722 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19723 "used, then any libvirt domain can be used. However in write mode, only "
19724 "libvirt domains which are shut down can be named here."
19728 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:96
19729 msgid "Domain UUIDs can be used instead of names."
19733 #: ../fish/guestfish.pod:204
19735 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19736 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19737 "if the I<--format:...> flag was given."
19741 #: ../fish/guestfish.pod:208
19746 #: ../fish/guestfish.pod:210
19747 msgid "B<--no-dest-paths>"
19751 #: ../fish/guestfish.pod:212
19753 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19754 "to hit the tab key to complete paths on the guest filesystem, but this "
19755 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19756 "allow this feature to be disabled."
19760 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19761 msgid "B<--echo-keys>"
19765 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:112
19767 "When prompting for keys and passphrases, guestfish normally turns echoing "
19768 "off so you cannot see what you are typing. If you are not worried about "
19769 "Tempest attacks and there is no one else in the room you can specify this "
19770 "flag to see what you are typing."
19774 #: ../fish/guestfish.pod:224
19779 #: ../fish/guestfish.pod:226
19780 msgid "B<--file file>"
19784 #: ../fish/guestfish.pod:228
19785 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19789 #: ../fish/guestfish.pod:231
19792 " #!/usr/bin/guestfish -f\n"
19797 #: ../fish/guestfish.pod:233
19798 msgid "B<--format=raw|qcow2|..>"
19802 #: ../fish/guestfish.pod:235
19803 msgid "B<--format>"
19807 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:119
19809 "The default for the I<-a> option is to auto-detect the format of the disk "
19810 "image. Using this forces the disk format for I<-a> options which follow on "
19811 "the command line. Using I<--format> with no argument switches back to auto-"
19812 "detection for subsequent I<-a> options."
19816 #: ../fish/guestfish.pod:244
19819 " guestfish --format=raw -a disk.img\n"
19824 #: ../fish/guestfish.pod:246
19825 msgid "forces raw format (no auto-detection) for C<disk.img>."
19829 #: ../fish/guestfish.pod:248
19832 " guestfish --format=raw -a disk.img --format -a another.img\n"
19837 #: ../fish/guestfish.pod:250
19839 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19840 "detection for C<another.img>."
19844 #: ../fish/guestfish.pod:253
19846 "If you have untrusted raw-format guest disk images, you should use this "
19847 "option to specify the disk format. This avoids a possible security problem "
19848 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19852 #: ../fish/guestfish.pod:258
19857 #: ../fish/guestfish.pod:260
19858 msgid "B<--inspector>"
19862 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:139
19864 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19865 "system and mount filesystems as they would be mounted on the real virtual "
19870 #: ../fish/guestfish.pod:266
19871 msgid "Typical usage is either:"
19875 #: ../fish/guestfish.pod:268
19878 " guestfish -d myguest -i\n"
19883 #: ../fish/guestfish.pod:270
19884 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19888 #: ../fish/guestfish.pod:272
19891 " guestfish --ro -d myguest -i\n"
19896 #: ../fish/guestfish.pod:274
19897 msgid "(for active domains, readonly), or specify the block device directly:"
19901 #: ../fish/guestfish.pod:276
19904 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19909 #: ../fish/guestfish.pod:278
19911 "Note that the command line syntax changed slightly over older versions of "
19912 "guestfish. You can still use the old syntax:"
19916 #: ../fish/guestfish.pod:281
19919 " guestfish [--ro] -i disk.img\n"
19924 #: ../fish/guestfish.pod:283
19927 " guestfish [--ro] -i libvirt-domain\n"
19932 #: ../fish/guestfish.pod:285
19934 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19935 "then using other commands to mount the filesystems that were found."
19939 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19940 msgid "B<--keys-from-stdin>"
19944 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:145
19946 "Read key or passphrase parameters from stdin. The default is to try to read "
19947 "passphrases from the user by opening C</dev/tty>."
19951 #: ../fish/guestfish.pod:294
19952 msgid "B<--listen>"
19956 #: ../fish/guestfish.pod:296
19958 "Fork into the background and listen for remote commands. See section L</"
19959 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19963 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19968 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:150
19970 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19971 "ATTACHING TO RUNNING DAEMONS>)."
19975 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19976 msgid "B<-m dev[:mountpoint[:options]]>"
19980 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:155
19981 msgid "B<--mount dev[:mountpoint[:options]]>"
19985 #: ../fish/guestfish.pod:308
19986 msgid "Mount the named partition or logical volume on the given mountpoint."
19990 #: ../fish/guestfish.pod:310
19991 msgid "If the mountpoint is omitted, it defaults to C</>."
19995 #: ../fish/guestfish.pod:312
19996 msgid "You have to mount something on C</> before most commands will work."
20000 #: ../fish/guestfish.pod:314
20002 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20007 #: ../fish/guestfish.pod:317
20009 "If you don't know what filesystems a disk image contains, you can either run "
20010 "guestfish without this option, then list the partitions, filesystems and LVs "
20011 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20012 "commands), or you can use the L<virt-filesystems(1)> program."
20016 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:163
20018 "The third (and rarely used) part of the mount parameter is the list of mount "
20019 "options used to mount the underlying filesystem. If this is not given, then "
20020 "the mount options are either the empty string or C<ro> (the latter if the "
20021 "I<--ro> flag is used). By specifying the mount options, you override this "
20022 "default choice. Probably the only time you would use this is to enable ACLs "
20023 "and/or extended attributes if the filesystem can support them:"
20027 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:171
20030 " -m /dev/sda1:/:acl,user_xattr\n"
20035 #: ../fish/guestfish.pod:333
20036 msgid "Using this flag is equivalent to using the C<mount-options> command."
20040 #: ../fish/guestfish.pod:335
20045 #: ../fish/guestfish.pod:337
20046 msgid "B<--no-sync>"
20050 #: ../fish/guestfish.pod:339
20052 "Disable autosync. This is enabled by default. See the discussion of "
20053 "autosync in the L<guestfs(3)> manpage."
20057 #: ../fish/guestfish.pod:342
20062 #: ../fish/guestfish.pod:344
20063 msgid "B<--new type>"
20067 #: ../fish/guestfish.pod:346
20072 #: ../fish/guestfish.pod:348
20074 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20075 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20076 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20081 #: ../fish/guestfish.pod:353
20082 msgid "B<--progress-bars>"
20086 #: ../fish/guestfish.pod:355
20087 msgid "Enable progress bars, even when guestfish is used non-interactively."
20091 #: ../fish/guestfish.pod:357
20093 "Progress bars are enabled by default when guestfish is used as an "
20094 "interactive shell."
20098 #: ../fish/guestfish.pod:360
20099 msgid "B<--no-progress-bars>"
20103 #: ../fish/guestfish.pod:362
20104 msgid "Disable progress bars."
20108 #: ../fish/guestfish.pod:364
20109 msgid "B<--remote[=pid]>"
20113 #: ../fish/guestfish.pod:366
20115 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20116 "CONTROL GUESTFISH OVER A SOCKET> below."
20120 #: ../fish/guestfish.pod:369
20125 #: ../fish/guestfish.pod:371
20130 #: ../fish/guestfish.pod:373
20132 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20133 "mounts are done read-only."
20137 #: ../fish/guestfish.pod:376
20139 "The option must always be used if the disk image or virtual machine might be "
20140 "running, and is generally recommended in cases where you don't need write "
20141 "access to the disk."
20145 #: ../fish/guestfish.pod:380
20147 "Note that prepared disk images created with I<-N> are not affected by this "
20148 "option. Also commands like C<add> are not affected - you have to specify "
20149 "the C<readonly:true> option explicitly if you need it."
20153 #: ../fish/guestfish.pod:384
20154 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20158 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:227
20159 msgid "B<--selinux>"
20163 #: ../fish/guestfish.pod:388
20164 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20168 #: ../fish/guestfish.pod:390
20173 #: ../fish/guestfish.pod:392
20174 msgid "B<--verbose>"
20178 #: ../fish/guestfish.pod:394
20180 "Enable very verbose messages. This is particularly useful if you find a bug."
20184 #: ../fish/guestfish.pod:397
20189 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
20190 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
20191 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
20192 msgid "B<--version>"
20196 #: ../fish/guestfish.pod:401
20197 msgid "Display the guestfish / libguestfs version number and exit."
20201 #: ../fish/guestfish.pod:403
20206 #: ../fish/guestfish.pod:405
20211 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:241
20213 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20214 "mounts are done read-write."
20218 #: ../fish/guestfish.pod:410
20219 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20223 #: ../fish/guestfish.pod:412
20228 #: ../fish/guestfish.pod:414
20229 msgid "Echo each command before executing it."
20233 #: ../fish/guestfish.pod:418
20234 msgid "COMMANDS ON COMMAND LINE"
20238 #: ../fish/guestfish.pod:420
20240 "Any additional (non-option) arguments are treated as commands to execute."
20244 #: ../fish/guestfish.pod:423
20246 "Commands to execute should be separated by a colon (C<:>), where the colon "
20247 "is a separate parameter. Thus:"
20251 #: ../fish/guestfish.pod:426
20254 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20259 #: ../fish/guestfish.pod:428
20261 "If there are no additional arguments, then we enter a shell, either an "
20262 "interactive shell with a prompt (if the input is a terminal) or a non-"
20263 "interactive shell."
20267 #: ../fish/guestfish.pod:432
20269 "In either command line mode or non-interactive shell, the first command that "
20270 "gives an error causes the whole shell to exit. In interactive mode (with a "
20271 "prompt) if a command fails, you can continue to enter commands."
20275 #: ../fish/guestfish.pod:437
20276 msgid "USING launch (OR run)"
20280 #: ../fish/guestfish.pod:439
20282 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20283 "then launch it, then mount any disks you need, and finally issue actions/"
20284 "commands. So the general order of the day is:"
20288 #: ../fish/guestfish.pod:447
20289 msgid "add or -a/--add"
20293 #: ../fish/guestfish.pod:451
20294 msgid "launch (aka run)"
20298 #: ../fish/guestfish.pod:455
20299 msgid "mount or -m/--mount"
20303 #: ../fish/guestfish.pod:459
20304 msgid "any other commands"
20308 #: ../fish/guestfish.pod:463
20310 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20311 "guest before mounting or performing any other commands."
20315 #: ../fish/guestfish.pod:466
20317 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20318 "I<--new> options were given then C<run> is done automatically, simply "
20319 "because guestfish can't perform the action you asked for without doing this."
20323 #: ../fish/guestfish.pod:471
20324 msgid "OPENING DISKS FOR READ AND WRITE"
20328 #: ../fish/guestfish.pod:473
20330 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20331 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20332 "I<-i> and I<-m> open disk images read-only or for writing."
20336 #: ../fish/guestfish.pod:478
20338 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20339 "opening disk images supplied on the command line for write. To open a disk "
20340 "image read-only you have to do I<-a image --ro>."
20344 #: ../fish/guestfish.pod:482
20346 "This matters: If you accidentally open a live VM disk image writable then "
20347 "you will cause irreversible disk corruption."
20351 #: ../fish/guestfish.pod:485
20353 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20354 "images will be opened read-only. You will have to either specify "
20355 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20356 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20357 "access for disk images specified by those other command line options."
20361 #: ../fish/guestfish.pod:492
20363 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20364 "which does nothing (it is already the default). However it is highly "
20365 "recommended that you use this option to indicate that you need write access, "
20366 "and prepare your scripts for the day when this option will be required for "
20371 #: ../fish/guestfish.pod:498
20373 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20374 "other libguestfs program apart from guestfish and guestmount."
20378 #: ../fish/guestfish.pod:501
20383 #: ../fish/guestfish.pod:503
20385 "You can quote ordinary parameters using either single or double quotes. For "
20390 #: ../fish/guestfish.pod:506
20393 " add \"file with a space.img\"\n"
20398 #: ../fish/guestfish.pod:508
20401 " rm '/file name'\n"
20406 #: ../fish/guestfish.pod:510
20414 #: ../fish/guestfish.pod:512
20416 "A few commands require a list of strings to be passed. For these, use a "
20417 "whitespace-separated list, enclosed in quotes. Strings containing "
20418 "whitespace to be passed through must be enclosed in single quotes. A "
20419 "literal single quote must be escaped with a backslash."
20423 #: ../fish/guestfish.pod:517
20426 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20427 " command \"/bin/echo 'foo bar'\"\n"
20428 " command \"/bin/echo \\'foo\\'\"\n"
20433 #: ../fish/guestfish.pod:521
20434 msgid "OPTIONAL ARGUMENTS"
20438 #: ../fish/guestfish.pod:523
20440 "Some commands take optional arguments. These arguments appear in this "
20441 "documentation as C<[argname:..]>. You can use them as in these examples:"
20445 #: ../fish/guestfish.pod:527
20448 " add-drive-opts filename\n"
20453 #: ../fish/guestfish.pod:529
20456 " add-drive-opts filename readonly:true\n"
20461 #: ../fish/guestfish.pod:531
20464 " add-drive-opts filename format:qcow2 readonly:false\n"
20469 #: ../fish/guestfish.pod:533
20471 "Each optional argument can appear at most once. All optional arguments must "
20472 "appear after the required ones."
20476 #: ../fish/guestfish.pod:536
20481 #: ../fish/guestfish.pod:538
20483 "This section applies to all commands which can take integers as parameters."
20487 #: ../fish/guestfish.pod:541
20488 msgid "SIZE SUFFIX"
20492 #: ../fish/guestfish.pod:543
20494 "When the command takes a parameter measured in bytes, you can use one of the "
20495 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20499 #: ../fish/guestfish.pod:549
20500 msgid "B<k> or B<K> or B<KiB>"
20504 #: ../fish/guestfish.pod:551
20505 msgid "The size in kilobytes (multiplied by 1024)."
20509 #: ../fish/guestfish.pod:553
20514 #: ../fish/guestfish.pod:555
20515 msgid "The size in SI 1000 byte units."
20519 #: ../fish/guestfish.pod:557
20520 msgid "B<M> or B<MiB>"
20524 #: ../fish/guestfish.pod:559
20525 msgid "The size in megabytes (multiplied by 1048576)."
20529 #: ../fish/guestfish.pod:561
20534 #: ../fish/guestfish.pod:563
20535 msgid "The size in SI 1000000 byte units."
20539 #: ../fish/guestfish.pod:565
20540 msgid "B<G> or B<GiB>"
20544 #: ../fish/guestfish.pod:567
20545 msgid "The size in gigabytes (multiplied by 2**30)."
20549 #: ../fish/guestfish.pod:569
20554 #: ../fish/guestfish.pod:571
20555 msgid "The size in SI 10**9 byte units."
20559 #: ../fish/guestfish.pod:573
20560 msgid "B<T> or B<TiB>"
20564 #: ../fish/guestfish.pod:575
20565 msgid "The size in terabytes (multiplied by 2**40)."
20569 #: ../fish/guestfish.pod:577
20574 #: ../fish/guestfish.pod:579
20575 msgid "The size in SI 10**12 byte units."
20579 #: ../fish/guestfish.pod:581
20580 msgid "B<P> or B<PiB>"
20584 #: ../fish/guestfish.pod:583
20585 msgid "The size in petabytes (multiplied by 2**50)."
20589 #: ../fish/guestfish.pod:585
20594 #: ../fish/guestfish.pod:587
20595 msgid "The size in SI 10**15 byte units."
20599 #: ../fish/guestfish.pod:589
20600 msgid "B<E> or B<EiB>"
20604 #: ../fish/guestfish.pod:591
20605 msgid "The size in exabytes (multiplied by 2**60)."
20609 #: ../fish/guestfish.pod:593
20614 #: ../fish/guestfish.pod:595
20615 msgid "The size in SI 10**18 byte units."
20619 #: ../fish/guestfish.pod:597
20620 msgid "B<Z> or B<ZiB>"
20624 #: ../fish/guestfish.pod:599
20625 msgid "The size in zettabytes (multiplied by 2**70)."
20629 #: ../fish/guestfish.pod:601
20634 #: ../fish/guestfish.pod:603
20635 msgid "The size in SI 10**21 byte units."
20639 #: ../fish/guestfish.pod:605
20640 msgid "B<Y> or B<YiB>"
20644 #: ../fish/guestfish.pod:607
20645 msgid "The size in yottabytes (multiplied by 2**80)."
20649 #: ../fish/guestfish.pod:609
20654 #: ../fish/guestfish.pod:611
20655 msgid "The size in SI 10**24 byte units."
20659 #: ../fish/guestfish.pod:617
20662 " truncate-size /file 1G\n"
20667 #: ../fish/guestfish.pod:619
20668 msgid "would truncate the file to 1 gigabyte."
20672 #: ../fish/guestfish.pod:621
20674 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20675 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20676 "suffix will probably not do what you expect."
20680 #: ../fish/guestfish.pod:625
20681 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20685 #: ../fish/guestfish.pod:627
20687 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20688 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20692 #: ../fish/guestfish.pod:630
20695 " 1234 decimal number 1234\n"
20696 " 02322 octal number, equivalent to decimal 1234\n"
20697 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20702 #: ../fish/guestfish.pod:634
20704 "When using the C<chmod> command, you almost always want to specify an octal "
20705 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20706 "L<chmod(1)> program):"
20710 #: ../fish/guestfish.pod:638
20713 " chmod 0777 /public # OK\n"
20714 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20719 #: ../fish/guestfish.pod:641
20721 "Commands that return numbers usually print them in decimal, but some "
20722 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20723 "octal, preceeded by C<0>)."
20727 #: ../fish/guestfish.pod:645
20728 msgid "WILDCARDS AND GLOBBING"
20732 #: ../fish/guestfish.pod:647
20734 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20735 "(globbing) by default. So for example the following will not do what you "
20740 #: ../fish/guestfish.pod:651
20748 #: ../fish/guestfish.pod:653
20750 "Assuming you don't have a directory called literally C</home/*> then the "
20751 "above command will return an error."
20755 #: ../fish/guestfish.pod:656
20756 msgid "To perform wildcard expansion, use the C<glob> command."
20760 #: ../fish/guestfish.pod:658
20763 " glob rm-rf /home/*\n"
20768 #: ../fish/guestfish.pod:660
20770 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20771 "many times), equivalent to:"
20775 #: ../fish/guestfish.pod:663
20778 " rm-rf /home/jim\n"
20779 " rm-rf /home/joe\n"
20780 " rm-rf /home/mary\n"
20785 #: ../fish/guestfish.pod:667
20786 msgid "C<glob> only works on simple guest paths and not on device names."
20790 #: ../fish/guestfish.pod:669
20792 "If you have several parameters, each containing a wildcard, then glob will "
20793 "perform a Cartesian product."
20797 #: ../fish/guestfish.pod:672
20802 #: ../fish/guestfish.pod:674
20804 "Any line which starts with a I<#> character is treated as a comment and "
20805 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20806 "a command. For example:"
20810 #: ../fish/guestfish.pod:678
20813 " # this is a comment\n"
20814 " # this is a comment\n"
20815 " foo # NOT a comment\n"
20820 #: ../fish/guestfish.pod:682
20821 msgid "Blank lines are also ignored."
20825 #: ../fish/guestfish.pod:684
20826 msgid "RUNNING COMMANDS LOCALLY"
20830 #: ../fish/guestfish.pod:686
20832 "Any line which starts with a I<!> character is treated as a command sent to "
20833 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20837 #: ../fish/guestfish.pod:690
20841 " tgz-out /remote local/remote-data.tar.gz\n"
20846 #: ../fish/guestfish.pod:693
20848 "will create a directory C<local> on the host, and then export the contents "
20849 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20850 "(See C<tgz-out>)."
20854 #: ../fish/guestfish.pod:697
20856 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20857 "effect, due to the way that subprocesses work in Unix."
20861 #: ../fish/guestfish.pod:700
20862 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20866 #: ../fish/guestfish.pod:702
20868 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20869 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20870 "and executed as guestfish commands."
20874 #: ../fish/guestfish.pod:706
20876 "Thus you can use shell script to construct arbitrary guestfish commands "
20877 "which are then parsed by guestfish."
20881 #: ../fish/guestfish.pod:709
20883 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20884 "through C</foo.100>) using guestfish commands alone. However this is simple "
20885 "if we use a shell script to create the guestfish commands for us:"
20889 #: ../fish/guestfish.pod:714
20892 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20897 #: ../fish/guestfish.pod:716
20898 msgid "or with names like C</foo.001>:"
20902 #: ../fish/guestfish.pod:718
20905 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20910 #: ../fish/guestfish.pod:720
20912 "When using guestfish interactively it can be helpful to just run the shell "
20913 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20914 "ordinary I<!> local command), see what guestfish commands it would run, and "
20915 "when you are happy with those prepend the C<E<lt>> character to run the "
20916 "guestfish commands for real."
20920 #: ../fish/guestfish.pod:726
20925 #: ../fish/guestfish.pod:728
20927 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20928 "command (a guestfish command) to the second command (any host command). For "
20933 #: ../fish/guestfish.pod:732
20936 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20941 #: ../fish/guestfish.pod:734
20943 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20944 "program). The above command would list all accounts in the guest filesystem "
20945 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20949 #: ../fish/guestfish.pod:739
20952 " hexdump /bin/ls | head\n"
20953 " list-devices | tail -1\n"
20954 " tgz-out / - | tar ztf -\n"
20959 #: ../fish/guestfish.pod:743
20961 "The space before the pipe symbol is required, any space after the pipe "
20962 "symbol is optional. Everything after the pipe symbol is just passed "
20963 "straight to the host shell, so it can contain redirections, globs and "
20964 "anything else that makes sense on the host side."
20968 #: ../fish/guestfish.pod:748
20970 "To use a literal argument which begins with a pipe symbol, you have to quote "
20975 #: ../fish/guestfish.pod:751
20983 #: ../fish/guestfish.pod:753
20984 msgid "HOME DIRECTORIES"
20988 #: ../fish/guestfish.pod:755
20990 "If a parameter starts with the character C<~> then the tilde may be expanded "
20991 "as a home directory path (either C<~> for the current user's home directory, "
20992 "or C<~user> for another user)."
20996 #: ../fish/guestfish.pod:759
20998 "Note that home directory expansion happens for users known I<on the host>, "
20999 "not in the guest filesystem."
21003 #: ../fish/guestfish.pod:762
21005 "To use a literal argument which begins with a tilde, you have to quote it, "
21010 #: ../fish/guestfish.pod:765
21018 #: ../fish/guestfish.pod:769
21020 "Libguestfs has some support for Linux guests encrypted according to the "
21021 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21022 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21023 "LUKS is supported."
21027 #: ../fish/guestfish.pod:774
21028 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21032 #: ../fish/guestfish.pod:776
21035 " ><fs> vfs-type /dev/sda2\n"
21041 #: ../fish/guestfish.pod:779
21043 "Then open those devices using L</luks-open>. This creates a device-mapper "
21044 "device called C</dev/mapper/luksdev>."
21048 #: ../fish/guestfish.pod:782
21051 " ><fs> luks-open /dev/sda2 luksdev\n"
21052 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21057 #: ../fish/guestfish.pod:785
21059 "Finally you have to tell LVM to scan for volume groups on the newly created "
21064 #: ../fish/guestfish.pod:788
21068 " vg-activate-all true\n"
21073 #: ../fish/guestfish.pod:791
21074 msgid "The logical volume(s) can now be mounted in the usual way."
21078 #: ../fish/guestfish.pod:793
21080 "Before closing a LUKS device you must unmount any logical volumes on it and "
21081 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21082 "one. Then you can close the mapper device:"
21086 #: ../fish/guestfish.pod:797
21089 " vg-activate false /dev/VG\n"
21090 " luks-close /dev/mapper/luksdev\n"
21095 #: ../fish/guestfish.pod:800
21096 msgid "WINDOWS PATHS"
21100 #: ../fish/guestfish.pod:802
21102 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21103 "letters and paths (with some limitations). The following commands are "
21108 #: ../fish/guestfish.pod:806
21111 " file /WINDOWS/system32/config/system.LOG\n"
21116 #: ../fish/guestfish.pod:808
21119 " file win:\\windows\\system32\\config\\system.log\n"
21124 #: ../fish/guestfish.pod:810
21127 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21132 #: ../fish/guestfish.pod:812
21134 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21135 "where the drive is mounted, prepending that to the path, changing all "
21136 "backslash characters to forward slash, then resolving the result using L</"
21137 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21138 "the parameter might be rewritten like this:"
21142 #: ../fish/guestfish.pod:818
21145 " win:e:\\foo\\bar => /e/FOO/bar\n"
21150 #: ../fish/guestfish.pod:820
21151 msgid "This only works in argument positions that expect a path."
21155 #: ../fish/guestfish.pod:822
21156 msgid "UPLOADING AND DOWNLOADING FILES"
21160 #: ../fish/guestfish.pod:824
21162 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21163 "others which upload from or download to a local file, you can use the "
21164 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21168 #: ../fish/guestfish.pod:828
21176 #: ../fish/guestfish.pod:830
21178 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21182 #: ../fish/guestfish.pod:833
21185 " tar-out /etc - | tar tf -\n"
21190 #: ../fish/guestfish.pod:835
21192 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21193 "command (see L</PIPES>)."
21197 #: ../fish/guestfish.pod:838
21199 "When using C<-> to read from stdin, the input is read up to the end of "
21200 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21201 "some arbitrary end marker:"
21205 #: ../fish/guestfish.pod:842
21208 " upload -<<END /foo\n"
21217 #: ../fish/guestfish.pod:848
21219 "Any string of characters can be used instead of C<END>. The end marker must "
21220 "appear on a line of its own, without any preceeding or following characters "
21221 "(not even spaces)."
21225 #: ../fish/guestfish.pod:852
21227 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21228 "upload local files (so-called \"FileIn\" parameters in the generator)."
21232 #: ../fish/guestfish.pod:855
21233 msgid "EXIT ON ERROR BEHAVIOUR"
21237 #: ../fish/guestfish.pod:857
21239 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21240 "taking commands from a human over a tty), and will exit on the first error "
21241 "in non-interactive mode (scripts, commands given on the command line)."
21245 #: ../fish/guestfish.pod:862
21247 "If you prefix a command with a I<-> character, then that command will not "
21248 "cause guestfish to exit, even if that (one) command returns an error."
21252 #: ../fish/guestfish.pod:866
21253 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21257 #: ../fish/guestfish.pod:868
21259 "Guestfish can be remote-controlled over a socket. This is useful "
21260 "particularly in shell scripts where you want to make several different "
21261 "changes to a filesystem, but you don't want the overhead of starting up a "
21262 "guestfish process each time."
21266 #: ../fish/guestfish.pod:873
21267 msgid "Start a guestfish server process using:"
21271 #: ../fish/guestfish.pod:875
21274 " eval \"`guestfish --listen`\"\n"
21279 #: ../fish/guestfish.pod:877
21280 msgid "and then send it commands by doing:"
21284 #: ../fish/guestfish.pod:879
21287 " guestfish --remote cmd [...]\n"
21292 #: ../fish/guestfish.pod:881
21293 msgid "To cause the server to exit, send it the exit command:"
21297 #: ../fish/guestfish.pod:883
21300 " guestfish --remote exit\n"
21305 #: ../fish/guestfish.pod:885
21307 "Note that the server will normally exit if there is an error in a command. "
21308 "You can change this in the usual way. See section L</EXIT ON ERROR "
21313 #: ../fish/guestfish.pod:889
21314 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21318 #: ../fish/guestfish.pod:891
21320 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21321 "is how the I<--remote> option knows where to send the commands. You can "
21322 "have several guestfish listener processes running using:"
21326 #: ../fish/guestfish.pod:895
21329 " eval \"`guestfish --listen`\"\n"
21330 " pid1=$GUESTFISH_PID\n"
21331 " eval \"`guestfish --listen`\"\n"
21332 " pid2=$GUESTFISH_PID\n"
21334 " guestfish --remote=$pid1 cmd\n"
21335 " guestfish --remote=$pid2 cmd\n"
21340 #: ../fish/guestfish.pod:903
21341 msgid "REMOTE CONTROL AND CSH"
21345 #: ../fish/guestfish.pod:905
21347 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21352 #: ../fish/guestfish.pod:908
21355 " eval \"`guestfish --listen --csh`\"\n"
21360 #: ../fish/guestfish.pod:910
21361 msgid "REMOTE CONTROL DETAILS"
21365 #: ../fish/guestfish.pod:912
21367 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21368 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21369 "and C<$PID> is the process ID of the server."
21373 #: ../fish/guestfish.pod:916
21374 msgid "Guestfish client and server versions must match exactly."
21378 #: ../fish/guestfish.pod:918
21379 msgid "PREPARED DISK IMAGES"
21383 #: ../fish/guestfish.pod:920
21385 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21386 "preformatted disk images that guestfish can make for you to save typing. "
21387 "This is particularly useful for testing purposes. This option is used "
21388 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21389 "can be mixed with I<-a>)."
21393 #: ../fish/guestfish.pod:926
21395 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21396 "the second and so on. Existing files in the current directory are "
21401 #: ../fish/guestfish.pod:930
21403 "The type briefly describes how the disk should be sized, partitioned, how "
21404 "filesystem(s) should be created, and how content should be added. "
21405 "Optionally the type can be followed by extra parameters, separated by C<:> "
21406 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21407 "allocated disk, containing a single partition, with the partition formatted "
21408 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21413 #: ../fish/guestfish.pod:938
21414 msgid "To list the available types and any extra parameters they take, run:"
21418 #: ../fish/guestfish.pod:942
21420 "Note that the prepared filesystem is not mounted. You would usually have to "
21421 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21425 #: ../fish/guestfish.pod:946
21427 "If any I<-N> or I<--new> options are given, the guest is automatically "
21432 #: ../fish/guestfish.pod:951
21433 msgid "Create a 100MB disk with an ext4-formatted partition:"
21437 #: ../fish/guestfish.pod:953
21440 " guestfish -N fs:ext4\n"
21445 #: ../fish/guestfish.pod:955
21446 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21450 #: ../fish/guestfish.pod:957
21453 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21458 #: ../fish/guestfish.pod:959
21459 msgid "Create a blank 200MB disk:"
21463 #: ../fish/guestfish.pod:961
21466 " guestfish -N disk:200M\n"
21471 #: ../fish/guestfish.pod:963
21472 msgid "PROGRESS BARS"
21476 #: ../fish/guestfish.pod:965
21478 "Some (not all) long-running commands send progress notification messages as "
21479 "they are running. Guestfish turns these messages into progress bars."
21483 #: ../fish/guestfish.pod:969
21485 "When a command that supports progress bars takes longer than two seconds to "
21486 "run, and if progress bars are enabled, then you will see one appearing below "
21491 #: ../fish/guestfish.pod:973
21494 " ><fs> copy-size /large-file /another-file 2048M\n"
21495 " / 10% [#####-----------------------------------------] 00:30\n"
21500 #: ../fish/guestfish.pod:976
21502 "The spinner on the left hand side moves round once for every progress "
21503 "notification received from the backend. This is a (reasonably) golden "
21504 "assurance that the command is \"doing something\" even if the progress bar "
21505 "is not moving, because the command is able to send the progress "
21506 "notifications. When the bar reaches 100% and the command finishes, the "
21507 "spinner disappears."
21511 #: ../fish/guestfish.pod:983
21513 "Progress bars are enabled by default when guestfish is used interactively. "
21514 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21515 "and you can disable them completely using I<--no-progress-bars>."
21519 #: ../fish/guestfish.pod:988
21520 msgid "GUESTFISH COMMANDS"
21524 #: ../fish/guestfish.pod:990
21526 "The commands in this section are guestfish convenience commands, in other "
21527 "words, they are not part of the L<guestfs(3)> API."
21531 #: ../fish/guestfish.pod:993
21536 #: ../fish/guestfish.pod:995
21545 #: ../fish/guestfish.pod:998
21546 msgid "Without any parameter, this provides general help."
21550 #: ../fish/guestfish.pod:1000
21551 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21555 #: ../fish/guestfish.pod:1002
21556 msgid "quit | exit"
21560 #: ../fish/guestfish.pod:1004
21561 msgid "This exits guestfish. You can also use C<^D> key."
21565 #: ../fish/guestfish.pod:1006
21566 msgid "@FISH_COMMANDS@"
21570 #: ../fish/guestfish.pod:1008
21575 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21580 #: ../fish/guestfish.pod:1014
21582 "guestfish returns 0 if the commands completed without error, or 1 if there "
21587 #: ../fish/guestfish.pod:1021
21592 #: ../fish/guestfish.pod:1023
21594 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21599 #: ../fish/guestfish.pod:1026
21600 msgid "GUESTFISH_PID"
21604 #: ../fish/guestfish.pod:1028
21606 "Used with the I<--remote> option to specify the remote guestfish process to "
21607 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21611 #: ../fish/guestfish.pod:1032
21616 #: ../fish/guestfish.pod:1034
21618 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21619 "not specified, the external L<hexedit(1)> program is used."
21623 #: ../fish/guestfish.pod:1038
21628 #: ../fish/guestfish.pod:1040
21630 "If compiled with GNU readline support, various files in the home directory "
21631 "can be used. See L</FILES>."
21635 #: ../fish/guestfish.pod:1049
21637 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21638 "effect as using the B<-v> option."
21642 #: ../fish/guestfish.pod:1061
21644 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21645 "the discussion of paths in L<guestfs(3)>."
21649 #: ../fish/guestfish.pod:1072
21650 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21654 #: ../fish/guestfish.pod:1074
21659 #: ../fish/guestfish.pod:1076
21661 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21666 #: ../fish/guestfish.pod:1092 ../fuse/guestmount.pod:254
21671 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21672 msgid "$HOME/.libguestfs-tools.rc"
21676 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21677 msgid "/etc/libguestfs-tools.conf"
21681 #: ../fish/guestfish.pod:1100 ../fuse/guestmount.pod:262
21683 "This configuration file controls the default read-only or read-write mode "
21684 "(I<--ro> or I<--rw>)."
21688 #: ../fish/guestfish.pod:1103
21689 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21693 #: ../fish/guestfish.pod:1105
21694 msgid "$HOME/.guestfish"
21698 #: ../fish/guestfish.pod:1107
21700 "If compiled with GNU readline support, then the command history is saved in "
21705 #: ../fish/guestfish.pod:1110
21706 msgid "$HOME/.inputrc"
21710 #: ../fish/guestfish.pod:1112
21711 msgid "/etc/inputrc"
21715 #: ../fish/guestfish.pod:1114
21717 "If compiled with GNU readline support, then these files can be used to "
21718 "configure readline. For further information, please see L<readline(3)/"
21719 "INITIALIZATION FILE>."
21723 #: ../fish/guestfish.pod:1118
21724 msgid "To write rules which only apply to guestfish, use:"
21728 #: ../fish/guestfish.pod:1120
21738 #: ../fish/guestfish.pod:1124
21740 "Variables that you can set in inputrc that change the behaviour of guestfish "
21741 "in useful ways include:"
21745 #: ../fish/guestfish.pod:1129
21746 msgid "completion-ignore-case (default: on)"
21750 #: ../fish/guestfish.pod:1131
21752 "By default, guestfish will ignore case when tab-completing paths on the "
21757 #: ../fish/guestfish.pod:1134
21760 " set completion-ignore-case off\n"
21765 #: ../fish/guestfish.pod:1136
21766 msgid "to make guestfish case sensitive."
21770 #: ../fish/guestfish.pod:1140
21775 #: ../fish/guestfish.pod:1142
21776 msgid "test2.img (etc)"
21780 #: ../fish/guestfish.pod:1144
21782 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21783 "will be created in the file C<test1.img> in the current directory. The "
21784 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21785 "the same name will be overwritten."
21789 #: ../fish/guestfish.pod:1153
21791 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21792 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21793 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21794 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21795 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21796 ">, L<hexedit(1)>."
21800 #: ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:102
21801 #: ../fuse/guestmount.pod:289 ../tools/virt-win-reg.pl:606
21802 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
21803 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21805 "This program is free software; you can redistribute it and/or modify it "
21806 "under the terms of the GNU General Public License as published by the Free "
21807 "Software Foundation; either version 2 of the License, or (at your option) "
21808 "any later version."
21812 #: ../fish/guestfish.pod:1188 ../test-tool/libguestfs-test-tool.pod:107
21813 #: ../fuse/guestmount.pod:294 ../tools/virt-win-reg.pl:611
21814 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
21815 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21817 "This program is distributed in the hope that it will be useful, but WITHOUT "
21818 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21819 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21824 #: ../fish/guestfish.pod:1193 ../test-tool/libguestfs-test-tool.pod:112
21825 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:616
21826 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
21827 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21829 "You should have received a copy of the GNU General Public License along with "
21830 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21831 "Ave, Cambridge, MA 02139, USA."
21835 #: ../fish/guestfish-actions.pod:1
21840 #: ../fish/guestfish-actions.pod:3
21843 " add-cdrom filename\n"
21848 #: ../fish/guestfish-actions.pod:15
21850 "This call checks for the existence of C<filename>. This stops you from "
21851 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21852 "and C<http:> URLs. To specify those, use the general L</config> call "
21857 #: ../fish/guestfish-actions.pod:22
21859 "If you just want to add an ISO file (often you use this as an efficient way "
21860 "to transfer large files into the guest), then you should probably use L</add-"
21861 "drive-ro> instead."
21865 #: ../fish/guestfish-actions.pod:35
21870 #: ../fish/guestfish-actions.pod:37
21875 #: ../fish/guestfish-actions.pod:39
21878 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
21883 #: ../fish/guestfish-actions.pod:41
21885 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21886 "It works by connecting to libvirt, requesting the domain and domain XML from "
21887 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21891 #: ../fish/guestfish-actions.pod:76
21893 "The other optional parameters are passed directly through to L</add-drive-"
21898 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
21899 #: ../fish/guestfish-actions.pod:3052
21901 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21905 #: ../fish/guestfish-actions.pod:81
21910 #: ../fish/guestfish-actions.pod:83
21913 " add-drive filename\n"
21918 #: ../fish/guestfish-actions.pod:85
21920 "This function is the equivalent of calling L</add-drive-opts> with no "
21921 "optional parameters, so the disk is added writable, with the format being "
21922 "detected automatically."
21926 #: ../fish/guestfish-actions.pod:89
21928 "Automatic detection of the format opens you up to a potential security hole "
21929 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21930 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21931 "you should think about replacing calls to this function with calls to L</add-"
21932 "drive-opts>, and specifying the format."
21936 #: ../fish/guestfish-actions.pod:96
21937 msgid "add-drive-opts"
21941 #: ../fish/guestfish-actions.pod:98
21946 #: ../fish/guestfish-actions.pod:100
21949 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21954 #: ../fish/guestfish-actions.pod:127
21956 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21957 "add-drive-ro>) then the format is automatically detected. Possible formats "
21958 "include C<raw> and C<qcow2>."
21962 #: ../fish/guestfish-actions.pod:138
21964 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21965 "add-drive-with-if> call (q.v.)"
21969 #: ../fish/guestfish-actions.pod:145
21970 msgid "add-drive-ro"
21974 #: ../fish/guestfish-actions.pod:147
21979 #: ../fish/guestfish-actions.pod:149
21982 " add-drive-ro filename\n"
21987 #: ../fish/guestfish-actions.pod:151
21989 "This function is the equivalent of calling L</add-drive-opts> with the "
21990 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21991 "is added read-only, with the format being detected automatically."
21995 #: ../fish/guestfish-actions.pod:156
21996 msgid "add-drive-ro-with-if"
22000 #: ../fish/guestfish-actions.pod:158
22003 " add-drive-ro-with-if filename iface\n"
22008 #: ../fish/guestfish-actions.pod:160
22010 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22011 "interface emulation to use at run time."
22015 #: ../fish/guestfish-actions.pod:170
22016 msgid "add-drive-with-if"
22020 #: ../fish/guestfish-actions.pod:172
22023 " add-drive-with-if filename iface\n"
22028 #: ../fish/guestfish-actions.pod:174
22030 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22031 "interface emulation to use at run time."
22035 #: ../fish/guestfish-actions.pod:184
22040 #: ../fish/guestfish-actions.pod:186
22043 " aug-clear augpath\n"
22048 #: ../fish/guestfish-actions.pod:191
22053 #: ../fish/guestfish-actions.pod:193
22061 #: ../fish/guestfish-actions.pod:195
22063 "Close the current Augeas handle and free up any resources used by it. After "
22064 "calling this, you have to call L</aug-init> again before you can use any "
22065 "other Augeas functions."
22069 #: ../fish/guestfish-actions.pod:200
22070 msgid "aug-defnode"
22074 #: ../fish/guestfish-actions.pod:202
22077 " aug-defnode name expr val\n"
22082 #: ../fish/guestfish-actions.pod:207
22084 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22085 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22086 "containing that single node."
22090 #: ../fish/guestfish-actions.pod:215
22095 #: ../fish/guestfish-actions.pod:217
22098 " aug-defvar name expr\n"
22103 #: ../fish/guestfish-actions.pod:226
22108 #: ../fish/guestfish-actions.pod:228
22111 " aug-get augpath\n"
22116 #: ../fish/guestfish-actions.pod:233
22121 #: ../fish/guestfish-actions.pod:235
22124 " aug-init root flags\n"
22129 #: ../fish/guestfish-actions.pod:241
22130 msgid "You must call this before using any other L</aug-*> commands."
22134 #: ../fish/guestfish-actions.pod:276
22135 msgid "Do not load the tree in L</aug-init>."
22139 #: ../fish/guestfish-actions.pod:280
22140 msgid "To close the handle, you can call L</aug-close>."
22144 #: ../fish/guestfish-actions.pod:284
22149 #: ../fish/guestfish-actions.pod:286
22152 " aug-insert augpath label true|false\n"
22157 #: ../fish/guestfish-actions.pod:296
22162 #: ../fish/guestfish-actions.pod:298
22170 #: ../fish/guestfish-actions.pod:305
22175 #: ../fish/guestfish-actions.pod:307
22178 " aug-ls augpath\n"
22183 #: ../fish/guestfish-actions.pod:309
22185 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22186 "resulting nodes into alphabetical order."
22190 #: ../fish/guestfish-actions.pod:312
22195 #: ../fish/guestfish-actions.pod:314
22198 " aug-match augpath\n"
22203 #: ../fish/guestfish-actions.pod:320
22208 #: ../fish/guestfish-actions.pod:322
22211 " aug-mv src dest\n"
22216 #: ../fish/guestfish-actions.pod:327
22221 #: ../fish/guestfish-actions.pod:329
22224 " aug-rm augpath\n"
22229 #: ../fish/guestfish-actions.pod:335
22234 #: ../fish/guestfish-actions.pod:337
22242 #: ../fish/guestfish-actions.pod:341
22244 "The flags which were passed to L</aug-init> affect exactly how files are "
22249 #: ../fish/guestfish-actions.pod:344
22254 #: ../fish/guestfish-actions.pod:346
22257 " aug-set augpath val\n"
22262 #: ../fish/guestfish-actions.pod:350
22264 "In the Augeas API, it is possible to clear a node by setting the value to "
22265 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22266 "this call. Instead you must use the L</aug-clear> call."
22270 #: ../fish/guestfish-actions.pod:355
22275 #: ../fish/guestfish-actions.pod:357
22278 " available 'groups ...'\n"
22283 #: ../fish/guestfish-actions.pod:363
22285 "The libguestfs groups, and the functions that those groups correspond to, "
22286 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22287 "runtime by calling L</available-all-groups>."
22291 #: ../fish/guestfish-actions.pod:387
22292 msgid "You must call L</launch> before calling this function."
22296 #: ../fish/guestfish-actions.pod:409
22298 "This call was added in version C<1.0.80>. In previous versions of "
22299 "libguestfs all you could do would be to speculatively execute a command to "
22300 "find out if the daemon implemented it. See also L</version>."
22304 #: ../fish/guestfish-actions.pod:416
22305 msgid "available-all-groups"
22309 #: ../fish/guestfish-actions.pod:418
22312 " available-all-groups\n"
22317 #: ../fish/guestfish-actions.pod:420
22319 "This command returns a list of all optional groups that this daemon knows "
22320 "about. Note this returns both supported and unsupported groups. To find "
22321 "out which ones the daemon can actually support you have to call L</"
22322 "available> on each member of the returned list."
22326 #: ../fish/guestfish-actions.pod:426
22327 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22331 #: ../fish/guestfish-actions.pod:428
22336 #: ../fish/guestfish-actions.pod:430
22339 " base64-in (base64file|-) filename\n"
22344 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22345 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22346 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1233
22347 #: ../fish/guestfish-actions.pod:4450 ../fish/guestfish-actions.pod:4462
22348 #: ../fish/guestfish-actions.pod:4473 ../fish/guestfish-actions.pod:4484
22349 #: ../fish/guestfish-actions.pod:4536 ../fish/guestfish-actions.pod:4545
22350 #: ../fish/guestfish-actions.pod:4599 ../fish/guestfish-actions.pod:4622
22351 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22355 #: ../fish/guestfish-actions.pod:437
22360 #: ../fish/guestfish-actions.pod:439
22363 " base64-out filename (base64file|-)\n"
22368 #: ../fish/guestfish-actions.pod:446
22369 msgid "blockdev-flushbufs"
22373 #: ../fish/guestfish-actions.pod:448
22376 " blockdev-flushbufs device\n"
22381 #: ../fish/guestfish-actions.pod:455
22382 msgid "blockdev-getbsz"
22386 #: ../fish/guestfish-actions.pod:457
22389 " blockdev-getbsz device\n"
22394 #: ../fish/guestfish-actions.pod:466
22395 msgid "blockdev-getro"
22399 #: ../fish/guestfish-actions.pod:468
22402 " blockdev-getro device\n"
22407 #: ../fish/guestfish-actions.pod:475
22408 msgid "blockdev-getsize64"
22412 #: ../fish/guestfish-actions.pod:477
22415 " blockdev-getsize64 device\n"
22420 #: ../fish/guestfish-actions.pod:481
22421 msgid "See also L</blockdev-getsz>."
22425 #: ../fish/guestfish-actions.pod:485
22426 msgid "blockdev-getss"
22430 #: ../fish/guestfish-actions.pod:487
22433 " blockdev-getss device\n"
22438 #: ../fish/guestfish-actions.pod:492
22440 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22444 #: ../fish/guestfish-actions.pod:497
22445 msgid "blockdev-getsz"
22449 #: ../fish/guestfish-actions.pod:499
22452 " blockdev-getsz device\n"
22457 #: ../fish/guestfish-actions.pod:504
22459 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22460 "blockdev-getsize64> for the more useful I<size in bytes>."
22464 #: ../fish/guestfish-actions.pod:510
22465 msgid "blockdev-rereadpt"
22469 #: ../fish/guestfish-actions.pod:512
22472 " blockdev-rereadpt device\n"
22477 #: ../fish/guestfish-actions.pod:518
22478 msgid "blockdev-setbsz"
22482 #: ../fish/guestfish-actions.pod:520
22485 " blockdev-setbsz device blocksize\n"
22490 #: ../fish/guestfish-actions.pod:529
22491 msgid "blockdev-setro"
22495 #: ../fish/guestfish-actions.pod:531
22498 " blockdev-setro device\n"
22503 #: ../fish/guestfish-actions.pod:537
22504 msgid "blockdev-setrw"
22508 #: ../fish/guestfish-actions.pod:539
22511 " blockdev-setrw device\n"
22516 #: ../fish/guestfish-actions.pod:545
22517 msgid "case-sensitive-path"
22521 #: ../fish/guestfish-actions.pod:547
22524 " case-sensitive-path path\n"
22529 #: ../fish/guestfish-actions.pod:571
22531 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22532 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22533 "the directories were originally created under Windows)."
22537 #: ../fish/guestfish-actions.pod:579
22538 msgid "See also L</realpath>."
22542 #: ../fish/guestfish-actions.pod:581
22547 #: ../fish/guestfish-actions.pod:583
22555 #: ../fish/guestfish-actions.pod:587
22557 "Note that this function cannot correctly handle binary files (specifically, "
22558 "files containing C<\\0> character which is treated as end of string). For "
22559 "those you need to use the L</read-file> or L</download> functions which have "
22560 "a more complex interface."
22564 #: ../fish/guestfish-actions.pod:595
22569 #: ../fish/guestfish-actions.pod:597
22572 " checksum csumtype path\n"
22577 #: ../fish/guestfish-actions.pod:640
22578 msgid "To get the checksum for a device, use L</checksum-device>."
22582 #: ../fish/guestfish-actions.pod:642
22583 msgid "To get the checksums for many files, use L</checksums-out>."
22587 #: ../fish/guestfish-actions.pod:644
22588 msgid "checksum-device"
22592 #: ../fish/guestfish-actions.pod:646
22595 " checksum-device csumtype device\n"
22600 #: ../fish/guestfish-actions.pod:648
22602 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22603 "device named C<device>. For the types of checksums supported see the L</"
22604 "checksum> command."
22608 #: ../fish/guestfish-actions.pod:652
22609 msgid "checksums-out"
22613 #: ../fish/guestfish-actions.pod:654
22616 " checksums-out csumtype directory (sumsfile|-)\n"
22621 #: ../fish/guestfish-actions.pod:670
22626 #: ../fish/guestfish-actions.pod:672
22629 " chmod mode path\n"
22634 #: ../fish/guestfish-actions.pod:683
22639 #: ../fish/guestfish-actions.pod:685
22642 " chown owner group path\n"
22647 #: ../fish/guestfish-actions.pod:693
22652 #: ../fish/guestfish-actions.pod:695
22655 " command 'arguments ...'\n"
22660 #: ../fish/guestfish-actions.pod:702
22662 "The single parameter is an argv-style list of arguments. The first element "
22663 "is the name of the program to run. Subsequent elements are parameters. The "
22664 "list must be non-empty (ie. must contain a program name). Note that the "
22665 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22669 #: ../fish/guestfish-actions.pod:730
22670 msgid "command-lines"
22674 #: ../fish/guestfish-actions.pod:732
22677 " command-lines 'arguments ...'\n"
22682 #: ../fish/guestfish-actions.pod:734
22684 "This is the same as L</command>, but splits the result into a list of lines."
22688 #: ../fish/guestfish-actions.pod:737
22689 msgid "See also: L</sh-lines>"
22693 #: ../fish/guestfish-actions.pod:742
22698 #: ../fish/guestfish-actions.pod:744
22701 " config qemuparam qemuvalue\n"
22706 #: ../fish/guestfish-actions.pod:755
22711 #: ../fish/guestfish-actions.pod:757
22714 " copy-size src dest size\n"
22719 #: ../fish/guestfish-actions.pod:765
22724 #: ../fish/guestfish-actions.pod:767
22732 #: ../fish/guestfish-actions.pod:772
22737 #: ../fish/guestfish-actions.pod:774
22745 #: ../fish/guestfish-actions.pod:779
22750 #: ../fish/guestfish-actions.pod:781
22758 #: ../fish/guestfish-actions.pod:788
22760 "If the destination is a device, it must be as large or larger than the "
22761 "source file or device, otherwise the copy will fail. This command cannot do "
22762 "partial copies (see L</copy-size>)."
22766 #: ../fish/guestfish-actions.pod:792
22771 #: ../fish/guestfish-actions.pod:794
22779 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22781 "This command is mostly useful for interactive sessions. It is I<not> "
22782 "intended that you try to parse the output string. Use L</statvfs> from "
22787 #: ../fish/guestfish-actions.pod:802
22792 #: ../fish/guestfish-actions.pod:804
22800 #: ../fish/guestfish-actions.pod:813
22805 #: ../fish/guestfish-actions.pod:815
22813 #: ../fish/guestfish-actions.pod:821
22815 "Another way to get the same information is to enable verbose messages with "
22816 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22817 "before running the program."
22821 #: ../fish/guestfish-actions.pod:826
22826 #: ../fish/guestfish-actions.pod:828
22829 " download remotefilename (filename|-)\n"
22834 #: ../fish/guestfish-actions.pod:835
22835 msgid "See also L</upload>, L</cat>."
22839 #: ../fish/guestfish-actions.pod:839
22840 msgid "download-offset"
22844 #: ../fish/guestfish-actions.pod:841
22847 " download-offset remotefilename (filename|-) offset size\n"
22852 #: ../fish/guestfish-actions.pod:849
22854 "Note that there is no limit on the amount of data that can be downloaded "
22855 "with this call, unlike with L</pread>, and this call always reads the full "
22856 "amount unless an error occurs."
22860 #: ../fish/guestfish-actions.pod:854
22861 msgid "See also L</download>, L</pread>."
22865 #: ../fish/guestfish-actions.pod:858
22866 msgid "drop-caches"
22870 #: ../fish/guestfish-actions.pod:860
22873 " drop-caches whattodrop\n"
22878 #: ../fish/guestfish-actions.pod:872
22883 #: ../fish/guestfish-actions.pod:874
22891 #: ../fish/guestfish-actions.pod:886
22896 #: ../fish/guestfish-actions.pod:888
22899 " e2fsck-f device\n"
22904 #: ../fish/guestfish-actions.pod:894
22906 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22907 "should use L</fsck>."
22911 #: ../fish/guestfish-actions.pod:897
22912 msgid "echo-daemon"
22916 #: ../fish/guestfish-actions.pod:899
22919 " echo-daemon 'words ...'\n"
22924 #: ../fish/guestfish-actions.pod:906
22925 msgid "See also L</ping-daemon>."
22929 #: ../fish/guestfish-actions.pod:908
22934 #: ../fish/guestfish-actions.pod:910
22937 " egrep regex path\n"
22942 #: ../fish/guestfish-actions.pod:918
22947 #: ../fish/guestfish-actions.pod:920
22950 " egrepi regex path\n"
22955 #: ../fish/guestfish-actions.pod:928
22960 #: ../fish/guestfish-actions.pod:930
22963 " equal file1 file2\n"
22968 #: ../fish/guestfish-actions.pod:937
22973 #: ../fish/guestfish-actions.pod:939
22981 #: ../fish/guestfish-actions.pod:944
22982 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22986 #: ../fish/guestfish-actions.pod:946
22991 #: ../fish/guestfish-actions.pod:948
22994 " fallocate path len\n"
22999 #: ../fish/guestfish-actions.pod:965
23000 msgid "fallocate64"
23004 #: ../fish/guestfish-actions.pod:967
23007 " fallocate64 path len\n"
23012 #: ../fish/guestfish-actions.pod:973
23014 "Note that this call allocates disk blocks for the file. To create a sparse "
23015 "file use L</truncate-size> instead."
23019 #: ../fish/guestfish-actions.pod:976
23021 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23022 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23023 "maximum size of files created through that call to 1GB."
23027 #: ../fish/guestfish-actions.pod:985
23032 #: ../fish/guestfish-actions.pod:987
23035 " fgrep pattern path\n"
23040 #: ../fish/guestfish-actions.pod:995
23045 #: ../fish/guestfish-actions.pod:997
23048 " fgrepi pattern path\n"
23053 #: ../fish/guestfish-actions.pod:1005
23058 #: ../fish/guestfish-actions.pod:1007
23066 #: ../fish/guestfish-actions.pod:1019
23068 "This command can also be used on C</dev/> devices (and partitions, LV "
23069 "names). You can for example use this to determine if a device contains a "
23070 "filesystem, although it's usually better to use L</vfs-type>."
23074 #: ../fish/guestfish-actions.pod:1029
23075 msgid "file-architecture"
23079 #: ../fish/guestfish-actions.pod:1031
23082 " file-architecture filename\n"
23087 #: ../fish/guestfish-actions.pod:1134
23092 #: ../fish/guestfish-actions.pod:1136
23100 #: ../fish/guestfish-actions.pod:1140
23102 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23103 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23107 #: ../fish/guestfish-actions.pod:1144
23112 #: ../fish/guestfish-actions.pod:1146
23115 " fill c len path\n"
23120 #: ../fish/guestfish-actions.pod:1152
23122 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23123 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23124 "L</fill-pattern>."
23128 #: ../fish/guestfish-actions.pod:1157
23129 msgid "fill-pattern"
23133 #: ../fish/guestfish-actions.pod:1159
23136 " fill-pattern pattern len path\n"
23141 #: ../fish/guestfish-actions.pod:1161
23143 "This function is like L</fill> except that it creates a new file of length "
23144 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23145 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23150 #: ../fish/guestfish-actions.pod:1166
23155 #: ../fish/guestfish-actions.pod:1168
23158 " find directory\n"
23163 #: ../fish/guestfish-actions.pod:1182
23164 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23168 #: ../fish/guestfish-actions.pod:1195
23169 msgid "See also L</find0>."
23173 #: ../fish/guestfish-actions.pod:1200
23178 #: ../fish/guestfish-actions.pod:1202
23181 " find0 directory (files|-)\n"
23186 #: ../fish/guestfish-actions.pod:1208
23188 "This command works the same way as L</find> with the following exceptions:"
23192 #: ../fish/guestfish-actions.pod:1235
23193 msgid "findfs-label"
23197 #: ../fish/guestfish-actions.pod:1237
23200 " findfs-label label\n"
23205 #: ../fish/guestfish-actions.pod:1243
23206 msgid "To find the label of a filesystem, use L</vfs-label>."
23210 #: ../fish/guestfish-actions.pod:1245
23211 msgid "findfs-uuid"
23215 #: ../fish/guestfish-actions.pod:1247
23218 " findfs-uuid uuid\n"
23223 #: ../fish/guestfish-actions.pod:1253
23224 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23228 #: ../fish/guestfish-actions.pod:1255
23233 #: ../fish/guestfish-actions.pod:1257
23236 " fsck fstype device\n"
23241 #: ../fish/guestfish-actions.pod:1287
23246 #: ../fish/guestfish-actions.pod:1289
23254 #: ../fish/guestfish-actions.pod:1296
23255 msgid "get-attach-method"
23259 #: ../fish/guestfish-actions.pod:1298
23262 " get-attach-method\n"
23267 #: ../fish/guestfish-actions.pod:1300
23268 msgid "Return the current attach method. See L</set-attach-method>."
23272 #: ../fish/guestfish-actions.pod:1302
23273 msgid "get-autosync"
23277 #: ../fish/guestfish-actions.pod:1304
23285 #: ../fish/guestfish-actions.pod:1308
23290 #: ../fish/guestfish-actions.pod:1310
23298 #: ../fish/guestfish-actions.pod:1314
23299 msgid "get-e2label"
23303 #: ../fish/guestfish-actions.pod:1316
23306 " get-e2label device\n"
23311 #: ../fish/guestfish-actions.pod:1328
23316 #: ../fish/guestfish-actions.pod:1330
23319 " get-e2uuid device\n"
23324 #: ../fish/guestfish-actions.pod:1342
23325 msgid "get-memsize"
23329 #: ../fish/guestfish-actions.pod:1344
23337 #: ../fish/guestfish-actions.pod:1349
23339 "If L</set-memsize> was not called on this handle, and if "
23340 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23341 "value for memsize."
23345 #: ../fish/guestfish-actions.pod:1356
23346 msgid "get-network"
23350 #: ../fish/guestfish-actions.pod:1358
23358 #: ../fish/guestfish-actions.pod:1362
23363 #: ../fish/guestfish-actions.pod:1364
23371 #: ../fish/guestfish-actions.pod:1371
23376 #: ../fish/guestfish-actions.pod:1373
23381 #: ../fish/guestfish-actions.pod:1375
23389 #: ../fish/guestfish-actions.pod:1382
23394 #: ../fish/guestfish-actions.pod:1384
23402 #: ../fish/guestfish-actions.pod:1391
23403 msgid "get-recovery-proc"
23407 #: ../fish/guestfish-actions.pod:1393
23410 " get-recovery-proc\n"
23415 #: ../fish/guestfish-actions.pod:1397
23416 msgid "get-selinux"
23420 #: ../fish/guestfish-actions.pod:1399
23428 #: ../fish/guestfish-actions.pod:1401
23430 "This returns the current setting of the selinux flag which is passed to the "
23431 "appliance at boot time. See L</set-selinux>."
23435 #: ../fish/guestfish-actions.pod:1407
23440 #: ../fish/guestfish-actions.pod:1409
23448 #: ../fish/guestfish-actions.pod:1416
23453 #: ../fish/guestfish-actions.pod:1418
23461 #: ../fish/guestfish-actions.pod:1422
23466 #: ../fish/guestfish-actions.pod:1424
23474 #: ../fish/guestfish-actions.pod:1426
23476 "Return the current umask. By default the umask is C<022> unless it has been "
23477 "set by calling L</umask>."
23481 #: ../fish/guestfish-actions.pod:1429
23482 msgid "get-verbose"
23486 #: ../fish/guestfish-actions.pod:1431
23494 #: ../fish/guestfish-actions.pod:1435
23499 #: ../fish/guestfish-actions.pod:1437
23507 #: ../fish/guestfish-actions.pod:1441
23508 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23512 #: ../fish/guestfish-actions.pod:1444
23517 #: ../fish/guestfish-actions.pod:1446
23520 " getxattr path name\n"
23525 #: ../fish/guestfish-actions.pod:1448
23527 "Get a single extended attribute from file C<path> named C<name>. This call "
23528 "follows symlinks. If you want to lookup an extended attribute for the "
23529 "symlink itself, use L</lgetxattr>."
23533 #: ../fish/guestfish-actions.pod:1452 ../fish/guestfish-actions.pod:2458
23535 "Normally it is better to get all extended attributes from a file in one go "
23536 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23537 "buggy and do not provide a way to list out attributes. For these "
23538 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23539 "attributes you want in advance and call this function."
23543 #: ../fish/guestfish-actions.pod:1462
23544 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23548 #: ../fish/guestfish-actions.pod:1464
23553 #: ../fish/guestfish-actions.pod:1466
23556 " getxattrs path\n"
23561 #: ../fish/guestfish-actions.pod:1474
23562 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23566 #: ../fish/guestfish-actions.pod:1476
23567 msgid "glob-expand"
23571 #: ../fish/guestfish-actions.pod:1478
23574 " glob-expand pattern\n"
23579 #: ../fish/guestfish-actions.pod:1491
23584 #: ../fish/guestfish-actions.pod:1493
23587 " grep regex path\n"
23592 #: ../fish/guestfish-actions.pod:1501
23597 #: ../fish/guestfish-actions.pod:1503
23600 " grepi regex path\n"
23605 #: ../fish/guestfish-actions.pod:1511
23606 msgid "grub-install"
23610 #: ../fish/guestfish-actions.pod:1513
23613 " grub-install root device\n"
23618 #: ../fish/guestfish-actions.pod:1529
23623 #: ../fish/guestfish-actions.pod:1531
23631 #: ../fish/guestfish-actions.pod:1539
23636 #: ../fish/guestfish-actions.pod:1541
23639 " head-n nrlines path\n"
23644 #: ../fish/guestfish-actions.pod:1554
23649 #: ../fish/guestfish-actions.pod:1556
23657 #: ../fish/guestfish-actions.pod:1564
23662 #: ../fish/guestfish-actions.pod:1566
23665 " initrd-cat initrdpath filename\n"
23670 #: ../fish/guestfish-actions.pod:1578
23671 msgid "See also L</initrd-list>."
23675 #: ../fish/guestfish-actions.pod:1583
23676 msgid "initrd-list"
23680 #: ../fish/guestfish-actions.pod:1585
23683 " initrd-list path\n"
23688 #: ../fish/guestfish-actions.pod:1597
23689 msgid "inotify-add-watch"
23693 #: ../fish/guestfish-actions.pod:1599
23696 " inotify-add-watch path mask\n"
23701 #: ../fish/guestfish-actions.pod:1611
23702 msgid "inotify-close"
23706 #: ../fish/guestfish-actions.pod:1613
23714 #: ../fish/guestfish-actions.pod:1619
23715 msgid "inotify-files"
23719 #: ../fish/guestfish-actions.pod:1621
23727 #: ../fish/guestfish-actions.pod:1623
23729 "This function is a helpful wrapper around L</inotify-read> which just "
23730 "returns a list of pathnames of objects that were touched. The returned "
23731 "pathnames are sorted and deduplicated."
23735 #: ../fish/guestfish-actions.pod:1627
23736 msgid "inotify-init"
23740 #: ../fish/guestfish-actions.pod:1629
23743 " inotify-init maxevents\n"
23748 #: ../fish/guestfish-actions.pod:1635
23750 "C<maxevents> is the maximum number of events which will be queued up between "
23751 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23752 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23753 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23754 "but records the fact that it threw them away by setting a flag "
23755 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23759 #: ../fish/guestfish-actions.pod:1645
23761 "Before any events are generated, you have to add some watches to the "
23762 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23763 "L</inotify-watch-all>."
23767 #: ../fish/guestfish-actions.pod:1651
23769 "Queued up events should be read periodically by calling L</inotify-read> (or "
23770 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23771 "If you don't read the events out often enough then you risk the internal "
23772 "queue overflowing."
23776 #: ../fish/guestfish-actions.pod:1658
23778 "The handle should be closed after use by calling L</inotify-close>. This "
23779 "also removes any watches automatically."
23783 #: ../fish/guestfish-actions.pod:1667
23784 msgid "inotify-read"
23788 #: ../fish/guestfish-actions.pod:1669
23796 #: ../fish/guestfish-actions.pod:1682
23797 msgid "inotify-rm-watch"
23801 #: ../fish/guestfish-actions.pod:1684
23804 " inotify-rm-watch wd\n"
23809 #: ../fish/guestfish-actions.pod:1686
23810 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23814 #: ../fish/guestfish-actions.pod:1689
23815 msgid "inspect-get-arch"
23819 #: ../fish/guestfish-actions.pod:1691
23822 " inspect-get-arch root\n"
23827 #: ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1709
23828 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1831
23829 #: ../fish/guestfish-actions.pod:1849 ../fish/guestfish-actions.pod:1883
23830 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1919
23831 #: ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1967
23832 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2013
23833 #: ../fish/guestfish-actions.pod:2030 ../fish/guestfish-actions.pod:2073
23834 #: ../fish/guestfish-actions.pod:2108 ../fish/guestfish-actions.pod:2124
23835 #: ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153
23836 #: ../fish/guestfish-actions.pod:2166 ../fish/guestfish-actions.pod:2181
23838 "This function should only be called with a root device string as returned by "
23843 #: ../fish/guestfish-actions.pod:1696
23845 "This returns the architecture of the inspected operating system. The "
23846 "possible return values are listed under L</file-architecture>."
23850 #: ../fish/guestfish-actions.pod:1705
23851 msgid "inspect-get-distro"
23855 #: ../fish/guestfish-actions.pod:1707
23858 " inspect-get-distro root\n"
23863 #: ../fish/guestfish-actions.pod:1791
23864 msgid "inspect-get-drive-mappings"
23868 #: ../fish/guestfish-actions.pod:1793
23871 " inspect-get-drive-mappings root\n"
23876 #: ../fish/guestfish-actions.pod:1823
23878 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23879 "get-mountpoints>, L</inspect-get-filesystems>."
23883 #: ../fish/guestfish-actions.pod:1827
23884 msgid "inspect-get-filesystems"
23888 #: ../fish/guestfish-actions.pod:1829
23891 " inspect-get-filesystems root\n"
23896 #: ../fish/guestfish-actions.pod:1842
23898 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23899 "get-mountpoints>."
23903 #: ../fish/guestfish-actions.pod:1845
23904 msgid "inspect-get-format"
23908 #: ../fish/guestfish-actions.pod:1847
23911 " inspect-get-format root\n"
23916 #: ../fish/guestfish-actions.pod:1879
23917 msgid "inspect-get-hostname"
23921 #: ../fish/guestfish-actions.pod:1881
23924 " inspect-get-hostname root\n"
23929 #: ../fish/guestfish-actions.pod:1894
23930 msgid "inspect-get-major-version"
23934 #: ../fish/guestfish-actions.pod:1896
23937 " inspect-get-major-version root\n"
23942 #: ../fish/guestfish-actions.pod:1915
23943 msgid "inspect-get-minor-version"
23947 #: ../fish/guestfish-actions.pod:1917
23950 " inspect-get-minor-version root\n"
23955 #: ../fish/guestfish-actions.pod:1927
23957 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23958 "get-major-version>."
23962 #: ../fish/guestfish-actions.pod:1930
23963 msgid "inspect-get-mountpoints"
23967 #: ../fish/guestfish-actions.pod:1932
23970 " inspect-get-mountpoints root\n"
23975 #: ../fish/guestfish-actions.pod:1954
23977 "For operating systems like Windows which still use drive letters, this call "
23978 "will only return an entry for the first drive \"mounted on\" C</>. For "
23979 "information about the mapping of drive letters to partitions, see L</inspect-"
23980 "get-drive-mappings>."
23984 #: ../fish/guestfish-actions.pod:1960
23986 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23987 "get-filesystems>."
23991 #: ../fish/guestfish-actions.pod:1963
23992 msgid "inspect-get-package-format"
23996 #: ../fish/guestfish-actions.pod:1965
23999 " inspect-get-package-format root\n"
24004 #: ../fish/guestfish-actions.pod:1970
24006 "This function and L</inspect-get-package-management> return the package "
24007 "format and package management tool used by the inspected operating system. "
24008 "For example for Fedora these functions would return C<rpm> (package format) "
24009 "and C<yum> (package management)."
24013 #: ../fish/guestfish-actions.pod:1985
24014 msgid "inspect-get-package-management"
24018 #: ../fish/guestfish-actions.pod:1987
24021 " inspect-get-package-management root\n"
24026 #: ../fish/guestfish-actions.pod:1992
24028 "L</inspect-get-package-format> and this function return the package format "
24029 "and package management tool used by the inspected operating system. For "
24030 "example for Fedora these functions would return C<rpm> (package format) and "
24031 "C<yum> (package management)."
24035 #: ../fish/guestfish-actions.pod:2009
24036 msgid "inspect-get-product-name"
24040 #: ../fish/guestfish-actions.pod:2011
24043 " inspect-get-product-name root\n"
24048 #: ../fish/guestfish-actions.pod:2026
24049 msgid "inspect-get-product-variant"
24053 #: ../fish/guestfish-actions.pod:2028
24056 " inspect-get-product-variant root\n"
24061 #: ../fish/guestfish-actions.pod:2052
24063 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24064 "get-product-name>, L</inspect-get-major-version>."
24068 #: ../fish/guestfish-actions.pod:2056
24069 msgid "inspect-get-roots"
24073 #: ../fish/guestfish-actions.pod:2058
24076 " inspect-get-roots\n"
24081 #: ../fish/guestfish-actions.pod:2060
24083 "This function is a convenient way to get the list of root devices, as "
24084 "returned from a previous call to L</inspect-os>, but without redoing the "
24085 "whole inspection process."
24089 #: ../fish/guestfish-actions.pod:2064
24091 "This returns an empty list if either no root devices were found or the "
24092 "caller has not called L</inspect-os>."
24096 #: ../fish/guestfish-actions.pod:2069
24097 msgid "inspect-get-type"
24101 #: ../fish/guestfish-actions.pod:2071
24104 " inspect-get-type root\n"
24109 #: ../fish/guestfish-actions.pod:2104
24110 msgid "inspect-get-windows-current-control-set"
24114 #: ../fish/guestfish-actions.pod:2106
24117 " inspect-get-windows-current-control-set root\n"
24122 #: ../fish/guestfish-actions.pod:2120
24123 msgid "inspect-get-windows-systemroot"
24127 #: ../fish/guestfish-actions.pod:2122
24130 " inspect-get-windows-systemroot root\n"
24135 #: ../fish/guestfish-actions.pod:2136
24136 msgid "inspect-is-live"
24140 #: ../fish/guestfish-actions.pod:2138
24143 " inspect-is-live root\n"
24148 #: ../fish/guestfish-actions.pod:2143
24150 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24151 "then this returns true if a live image was detected on the disk."
24155 #: ../fish/guestfish-actions.pod:2149
24156 msgid "inspect-is-multipart"
24160 #: ../fish/guestfish-actions.pod:2151
24163 " inspect-is-multipart root\n"
24168 #: ../fish/guestfish-actions.pod:2156
24170 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24171 "then this returns true if the disk is part of a set."
24175 #: ../fish/guestfish-actions.pod:2162
24176 msgid "inspect-is-netinst"
24180 #: ../fish/guestfish-actions.pod:2164
24183 " inspect-is-netinst root\n"
24188 #: ../fish/guestfish-actions.pod:2169
24190 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24191 "then this returns true if the disk is a network installer, ie. not a self-"
24192 "contained install CD but one which is likely to require network access to "
24193 "complete the install."
24197 #: ../fish/guestfish-actions.pod:2177
24198 msgid "inspect-list-applications"
24202 #: ../fish/guestfish-actions.pod:2179
24205 " inspect-list-applications root\n"
24210 #: ../fish/guestfish-actions.pod:2186
24212 "I<Note:> This call works differently from other parts of the inspection "
24213 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24214 "then mount up the disks, before calling this. Listing applications is a "
24215 "significantly more difficult operation which requires access to the full "
24216 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24217 "are just returning data cached in the libguestfs handle, this call actually "
24218 "reads parts of the mounted filesystems during the call."
24222 #: ../fish/guestfish-actions.pod:2276
24227 #: ../fish/guestfish-actions.pod:2278
24235 #: ../fish/guestfish-actions.pod:2293
24237 "You can pass the root string(s) returned to other L</inspect-get-*> "
24238 "functions in order to query further information about each operating system, "
24239 "such as the name and version."
24243 #: ../fish/guestfish-actions.pod:2298
24245 "This function uses other libguestfs features such as L</mount-ro> and L</"
24246 "umount-all> in order to mount and unmount filesystems and look at the "
24247 "contents. This should be called with no disks currently mounted. The "
24248 "function may also use Augeas, so any existing Augeas handle will be closed."
24252 #: ../fish/guestfish-actions.pod:2310 ../fish/guestfish-actions.pod:2486
24253 #: ../fish/guestfish-actions.pod:2532
24254 msgid "See also L</list-filesystems>."
24258 #: ../fish/guestfish-actions.pod:2312
24259 msgid "is-blockdev"
24263 #: ../fish/guestfish-actions.pod:2314
24266 " is-blockdev path\n"
24271 #: ../fish/guestfish-actions.pod:2319 ../fish/guestfish-actions.pod:2337
24272 #: ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2365
24273 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2409
24274 #: ../fish/guestfish-actions.pod:2418
24275 msgid "See also L</stat>."
24279 #: ../fish/guestfish-actions.pod:2321
24284 #: ../fish/guestfish-actions.pod:2323
24292 #: ../fish/guestfish-actions.pod:2330
24297 #: ../fish/guestfish-actions.pod:2332
24300 " is-chardev path\n"
24305 #: ../fish/guestfish-actions.pod:2339
24310 #: ../fish/guestfish-actions.pod:2341
24318 #: ../fish/guestfish-actions.pod:2348
24323 #: ../fish/guestfish-actions.pod:2350
24331 #: ../fish/guestfish-actions.pod:2358
24336 #: ../fish/guestfish-actions.pod:2360
24344 #: ../fish/guestfish-actions.pod:2367
24349 #: ../fish/guestfish-actions.pod:2369
24357 #: ../fish/guestfish-actions.pod:2377
24358 msgid "is-launching"
24362 #: ../fish/guestfish-actions.pod:2379
24370 #: ../fish/guestfish-actions.pod:2386
24375 #: ../fish/guestfish-actions.pod:2388
24383 #: ../fish/guestfish-actions.pod:2393
24388 #: ../fish/guestfish-actions.pod:2395
24396 #: ../fish/guestfish-actions.pod:2402
24401 #: ../fish/guestfish-actions.pod:2404
24404 " is-socket path\n"
24409 #: ../fish/guestfish-actions.pod:2411
24414 #: ../fish/guestfish-actions.pod:2413
24417 " is-symlink path\n"
24422 #: ../fish/guestfish-actions.pod:2420
24423 msgid "kill-subprocess"
24427 #: ../fish/guestfish-actions.pod:2422
24430 " kill-subprocess\n"
24435 #: ../fish/guestfish-actions.pod:2426
24440 #: ../fish/guestfish-actions.pod:2428
24445 #: ../fish/guestfish-actions.pod:2430
24453 #: ../fish/guestfish-actions.pod:2438
24458 #: ../fish/guestfish-actions.pod:2440
24461 " lchown owner group path\n"
24466 #: ../fish/guestfish-actions.pod:2442
24468 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24469 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24474 #: ../fish/guestfish-actions.pod:2450
24479 #: ../fish/guestfish-actions.pod:2452
24482 " lgetxattr path name\n"
24487 #: ../fish/guestfish-actions.pod:2468
24488 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24492 #: ../fish/guestfish-actions.pod:2470
24497 #: ../fish/guestfish-actions.pod:2472
24500 " lgetxattrs path\n"
24505 #: ../fish/guestfish-actions.pod:2474
24507 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24508 "it returns the extended attributes of the link itself."
24512 #: ../fish/guestfish-actions.pod:2478
24513 msgid "list-devices"
24517 #: ../fish/guestfish-actions.pod:2480
24525 #: ../fish/guestfish-actions.pod:2488
24526 msgid "list-filesystems"
24530 #: ../fish/guestfish-actions.pod:2490
24533 " list-filesystems\n"
24538 #: ../fish/guestfish-actions.pod:2509
24540 "This command runs other libguestfs commands, which might include L</mount> "
24541 "and L</umount>, and therefore you should use this soon after launch and only "
24542 "when nothing is mounted."
24546 #: ../fish/guestfish-actions.pod:2513
24548 "Not all of the filesystems returned will be mountable. In particular, swap "
24549 "partitions are returned in the list. Also this command does not check that "
24550 "each filesystem found is valid and mountable, and some filesystems might be "
24551 "mountable but require special options. Filesystems may not all belong to a "
24552 "single logical operating system (use L</inspect-os> to look for OSes)."
24556 #: ../fish/guestfish-actions.pod:2521
24557 msgid "list-partitions"
24561 #: ../fish/guestfish-actions.pod:2523
24564 " list-partitions\n"
24569 #: ../fish/guestfish-actions.pod:2529
24571 "This does not return logical volumes. For that you will need to call L</"
24576 #: ../fish/guestfish-actions.pod:2534
24581 #: ../fish/guestfish-actions.pod:2536
24589 #: ../fish/guestfish-actions.pod:2544
24594 #: ../fish/guestfish-actions.pod:2546
24597 " ln target linkname\n"
24602 #: ../fish/guestfish-actions.pod:2550
24607 #: ../fish/guestfish-actions.pod:2552
24610 " ln-f target linkname\n"
24615 #: ../fish/guestfish-actions.pod:2557
24620 #: ../fish/guestfish-actions.pod:2559
24623 " ln-s target linkname\n"
24628 #: ../fish/guestfish-actions.pod:2563
24633 #: ../fish/guestfish-actions.pod:2565
24636 " ln-sf target linkname\n"
24641 #: ../fish/guestfish-actions.pod:2570
24642 msgid "lremovexattr"
24646 #: ../fish/guestfish-actions.pod:2572
24649 " lremovexattr xattr path\n"
24654 #: ../fish/guestfish-actions.pod:2574
24656 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24657 "it removes an extended attribute of the link itself."
24661 #: ../fish/guestfish-actions.pod:2578
24666 #: ../fish/guestfish-actions.pod:2580
24674 #: ../fish/guestfish-actions.pod:2586
24676 "This command is mostly useful for interactive sessions. Programs should "
24677 "probably use L</readdir> instead."
24681 #: ../fish/guestfish-actions.pod:2589
24686 #: ../fish/guestfish-actions.pod:2591
24689 " lsetxattr xattr val vallen path\n"
24694 #: ../fish/guestfish-actions.pod:2593
24696 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24697 "sets an extended attribute of the link itself."
24701 #: ../fish/guestfish-actions.pod:2597
24706 #: ../fish/guestfish-actions.pod:2599
24714 #: ../fish/guestfish-actions.pod:2603
24716 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24717 "the link is stat-ed, not the file it refers to."
24721 #: ../fish/guestfish-actions.pod:2609
24726 #: ../fish/guestfish-actions.pod:2611
24729 " lstatlist path 'names ...'\n"
24734 #: ../fish/guestfish-actions.pod:2613
24736 "This call allows you to perform the L</lstat> operation on multiple files, "
24737 "where all files are in the directory C<path>. C<names> is the list of files "
24738 "from this directory."
24742 #: ../fish/guestfish-actions.pod:2622
24744 "This call is intended for programs that want to efficiently list a directory "
24745 "contents without making many round-trips. See also L</lxattrlist> for a "
24746 "similarly efficient call for getting extended attributes. Very long "
24747 "directory listings might cause the protocol message size to be exceeded, "
24748 "causing this call to fail. The caller must split up such requests into "
24749 "smaller groups of names."
24753 #: ../fish/guestfish-actions.pod:2630
24754 msgid "luks-add-key"
24758 #: ../fish/guestfish-actions.pod:2632
24761 " luks-add-key device keyslot\n"
24766 #: ../fish/guestfish-actions.pod:2639
24768 "Note that if C<keyslot> already contains a key, then this command will "
24769 "fail. You have to use L</luks-kill-slot> first to remove that key."
24773 #: ../fish/guestfish-actions.pod:2643 ../fish/guestfish-actions.pod:2665
24774 #: ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2692
24775 #: ../fish/guestfish-actions.pod:2715 ../fish/guestfish-actions.pod:2725
24777 "This command has one or more key or passphrase parameters. Guestfish will "
24778 "prompt for these separately."
24782 #: ../fish/guestfish-actions.pod:2646
24787 #: ../fish/guestfish-actions.pod:2648
24790 " luks-close device\n"
24795 #: ../fish/guestfish-actions.pod:2650
24797 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24798 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24799 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24804 #: ../fish/guestfish-actions.pod:2656
24805 msgid "luks-format"
24809 #: ../fish/guestfish-actions.pod:2658
24812 " luks-format device keyslot\n"
24817 #: ../fish/guestfish-actions.pod:2671
24818 msgid "luks-format-cipher"
24822 #: ../fish/guestfish-actions.pod:2673
24825 " luks-format-cipher device keyslot cipher\n"
24830 #: ../fish/guestfish-actions.pod:2675
24832 "This command is the same as L</luks-format> but it also allows you to set "
24833 "the C<cipher> used."
24837 #: ../fish/guestfish-actions.pod:2684
24838 msgid "luks-kill-slot"
24842 #: ../fish/guestfish-actions.pod:2686
24845 " luks-kill-slot device keyslot\n"
24850 #: ../fish/guestfish-actions.pod:2695
24855 #: ../fish/guestfish-actions.pod:2697
24858 " luks-open device mapname\n"
24863 #: ../fish/guestfish-actions.pod:2711
24865 "If this block device contains LVM volume groups, then calling L</vgscan> "
24866 "followed by L</vg-activate-all> will make them visible."
24870 #: ../fish/guestfish-actions.pod:2718
24871 msgid "luks-open-ro"
24875 #: ../fish/guestfish-actions.pod:2720
24878 " luks-open-ro device mapname\n"
24883 #: ../fish/guestfish-actions.pod:2722
24885 "This is the same as L</luks-open> except that a read-only mapping is created."
24889 #: ../fish/guestfish-actions.pod:2728
24894 #: ../fish/guestfish-actions.pod:2730
24897 " lvcreate logvol volgroup mbytes\n"
24902 #: ../fish/guestfish-actions.pod:2735
24903 msgid "lvm-canonical-lv-name"
24907 #: ../fish/guestfish-actions.pod:2737
24910 " lvm-canonical-lv-name lvname\n"
24915 #: ../fish/guestfish-actions.pod:2746
24916 msgid "See also L</is-lv>."
24920 #: ../fish/guestfish-actions.pod:2748
24921 msgid "lvm-clear-filter"
24925 #: ../fish/guestfish-actions.pod:2750
24928 " lvm-clear-filter\n"
24933 #: ../fish/guestfish-actions.pod:2752
24935 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24940 #: ../fish/guestfish-actions.pod:2758
24941 msgid "lvm-remove-all"
24945 #: ../fish/guestfish-actions.pod:2760
24948 " lvm-remove-all\n"
24953 #: ../fish/guestfish-actions.pod:2768
24954 msgid "lvm-set-filter"
24958 #: ../fish/guestfish-actions.pod:2770
24961 " lvm-set-filter 'devices ...'\n"
24966 #: ../fish/guestfish-actions.pod:2795
24971 #: ../fish/guestfish-actions.pod:2797
24974 " lvremove device\n"
24979 #: ../fish/guestfish-actions.pod:2805
24984 #: ../fish/guestfish-actions.pod:2807
24987 " lvrename logvol newlogvol\n"
24992 #: ../fish/guestfish-actions.pod:2811
24997 #: ../fish/guestfish-actions.pod:2813
25000 " lvresize device mbytes\n"
25005 #: ../fish/guestfish-actions.pod:2819
25006 msgid "lvresize-free"
25010 #: ../fish/guestfish-actions.pod:2821
25013 " lvresize-free lv percent\n"
25018 #: ../fish/guestfish-actions.pod:2829
25023 #: ../fish/guestfish-actions.pod:2831
25031 #: ../fish/guestfish-actions.pod:2839
25032 msgid "See also L</lvs-full>, L</list-filesystems>."
25036 #: ../fish/guestfish-actions.pod:2841
25041 #: ../fish/guestfish-actions.pod:2843
25049 #: ../fish/guestfish-actions.pod:2848
25054 #: ../fish/guestfish-actions.pod:2850
25062 #: ../fish/guestfish-actions.pod:2854
25067 #: ../fish/guestfish-actions.pod:2856
25070 " lxattrlist path 'names ...'\n"
25075 #: ../fish/guestfish-actions.pod:2872
25077 "This call is intended for programs that want to efficiently list a directory "
25078 "contents without making many round-trips. See also L</lstatlist> for a "
25079 "similarly efficient call for getting standard stats. Very long directory "
25080 "listings might cause the protocol message size to be exceeded, causing this "
25081 "call to fail. The caller must split up such requests into smaller groups of "
25086 #: ../fish/guestfish-actions.pod:2880
25091 #: ../fish/guestfish-actions.pod:2882
25099 #: ../fish/guestfish-actions.pod:2886
25104 #: ../fish/guestfish-actions.pod:2888
25107 " mkdir-mode path mode\n"
25112 #: ../fish/guestfish-actions.pod:2897
25113 msgid "See also L</mkdir>, L</umask>"
25117 #: ../fish/guestfish-actions.pod:2899
25122 #: ../fish/guestfish-actions.pod:2901
25130 #: ../fish/guestfish-actions.pod:2906
25135 #: ../fish/guestfish-actions.pod:2908
25138 " mkdtemp template\n"
25143 #: ../fish/guestfish-actions.pod:2929
25148 #: ../fish/guestfish-actions.pod:2931
25151 " mke2fs-J fstype blocksize device journal\n"
25156 #: ../fish/guestfish-actions.pod:2939
25157 msgid "See also L</mke2journal>."
25161 #: ../fish/guestfish-actions.pod:2941
25166 #: ../fish/guestfish-actions.pod:2943
25169 " mke2fs-JL fstype blocksize device label\n"
25174 #: ../fish/guestfish-actions.pod:2948
25175 msgid "See also L</mke2journal-L>."
25179 #: ../fish/guestfish-actions.pod:2950
25184 #: ../fish/guestfish-actions.pod:2952
25187 " mke2fs-JU fstype blocksize device uuid\n"
25192 #: ../fish/guestfish-actions.pod:2957
25193 msgid "See also L</mke2journal-U>."
25197 #: ../fish/guestfish-actions.pod:2959
25198 msgid "mke2journal"
25202 #: ../fish/guestfish-actions.pod:2961
25205 " mke2journal blocksize device\n"
25210 #: ../fish/guestfish-actions.pod:2968
25211 msgid "mke2journal-L"
25215 #: ../fish/guestfish-actions.pod:2970
25218 " mke2journal-L blocksize label device\n"
25223 #: ../fish/guestfish-actions.pod:2974
25224 msgid "mke2journal-U"
25228 #: ../fish/guestfish-actions.pod:2976
25231 " mke2journal-U blocksize uuid device\n"
25236 #: ../fish/guestfish-actions.pod:2980
25241 #: ../fish/guestfish-actions.pod:2982
25244 " mkfifo mode path\n"
25249 #: ../fish/guestfish-actions.pod:2984
25251 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25252 "is just a convenient wrapper around L</mknod>."
25256 #: ../fish/guestfish-actions.pod:2990
25261 #: ../fish/guestfish-actions.pod:2992
25264 " mkfs fstype device\n"
25269 #: ../fish/guestfish-actions.pod:2998
25274 #: ../fish/guestfish-actions.pod:3000
25277 " mkfs-b fstype blocksize device\n"
25282 #: ../fish/guestfish-actions.pod:3002
25284 "This call is similar to L</mkfs>, but it allows you to control the block "
25285 "size of the resulting filesystem. Supported block sizes depend on the "
25286 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25290 #: ../fish/guestfish-actions.pod:3017
25295 #: ../fish/guestfish-actions.pod:3019
25298 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25303 #: ../fish/guestfish-actions.pod:3054
25304 msgid "mkmountpoint"
25308 #: ../fish/guestfish-actions.pod:3056
25311 " mkmountpoint exemptpath\n"
25316 #: ../fish/guestfish-actions.pod:3058
25318 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25319 "to create extra mountpoints before mounting the first filesystem."
25323 #: ../fish/guestfish-actions.pod:3082
25325 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25326 "unexpected errors if you try to mix these calls. It is safest to manually "
25327 "unmount filesystems and remove mountpoints after use."
25331 #: ../fish/guestfish-actions.pod:3086
25333 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25334 "for this to work for manual mountpoints, you must ensure that the innermost "
25335 "mountpoints have the longest pathnames, as in the example code above."
25339 #: ../fish/guestfish-actions.pod:3093
25341 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25342 "L</umount-all> to be called when the handle is closed which can also trigger "
25347 #: ../fish/guestfish-actions.pod:3097
25352 #: ../fish/guestfish-actions.pod:3099
25355 " mknod mode devmajor devminor path\n"
25360 #: ../fish/guestfish-actions.pod:3109
25362 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25363 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25364 "regular file). These constants are available in the standard Linux header "
25365 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25366 "wrappers around this command which bitwise OR in the appropriate constant "
25371 #: ../fish/guestfish-actions.pod:3119
25376 #: ../fish/guestfish-actions.pod:3121
25379 " mknod-b mode devmajor devminor path\n"
25384 #: ../fish/guestfish-actions.pod:3123
25386 "This call creates a block device node called C<path> with mode C<mode> and "
25387 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25388 "wrapper around L</mknod>."
25392 #: ../fish/guestfish-actions.pod:3129
25397 #: ../fish/guestfish-actions.pod:3131
25400 " mknod-c mode devmajor devminor path\n"
25405 #: ../fish/guestfish-actions.pod:3133
25407 "This call creates a char device node called C<path> with mode C<mode> and "
25408 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25409 "wrapper around L</mknod>."
25413 #: ../fish/guestfish-actions.pod:3139
25418 #: ../fish/guestfish-actions.pod:3141
25426 #: ../fish/guestfish-actions.pod:3145
25431 #: ../fish/guestfish-actions.pod:3147
25434 " mkswap-L label device\n"
25439 #: ../fish/guestfish-actions.pod:3155
25444 #: ../fish/guestfish-actions.pod:3157
25447 " mkswap-U uuid device\n"
25452 #: ../fish/guestfish-actions.pod:3161
25453 msgid "mkswap-file"
25457 #: ../fish/guestfish-actions.pod:3163
25460 " mkswap-file path\n"
25465 #: ../fish/guestfish-actions.pod:3167
25467 "This command just writes a swap file signature to an existing file. To "
25468 "create the file itself, use something like L</fallocate>."
25472 #: ../fish/guestfish-actions.pod:3170
25477 #: ../fish/guestfish-actions.pod:3172
25480 " modprobe modulename\n"
25485 #: ../fish/guestfish-actions.pod:3179
25490 #: ../fish/guestfish-actions.pod:3181
25493 " mount device mountpoint\n"
25498 #: ../fish/guestfish-actions.pod:3197
25500 "B<Important note:> When you use this call, the filesystem options C<sync> "
25501 "and C<noatime> are set implicitly. This was originally done because we "
25502 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25503 "very large negative performance impact and negligible effect on "
25504 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25505 "code that needs performance, and instead use L</mount-options> (use an empty "
25506 "string for the first parameter if you don't want any options)."
25510 #: ../fish/guestfish-actions.pod:3207
25515 #: ../fish/guestfish-actions.pod:3209
25518 " mount-loop file mountpoint\n"
25523 #: ../fish/guestfish-actions.pod:3215
25524 msgid "mount-options"
25528 #: ../fish/guestfish-actions.pod:3217
25531 " mount-options options device mountpoint\n"
25536 #: ../fish/guestfish-actions.pod:3219
25538 "This is the same as the L</mount> command, but it allows you to set the "
25539 "mount options as for the L<mount(8)> I<-o> flag."
25543 #: ../fish/guestfish-actions.pod:3227
25548 #: ../fish/guestfish-actions.pod:3229
25551 " mount-ro device mountpoint\n"
25556 #: ../fish/guestfish-actions.pod:3231
25558 "This is the same as the L</mount> command, but it mounts the filesystem with "
25559 "the read-only (I<-o ro>) flag."
25563 #: ../fish/guestfish-actions.pod:3234
25568 #: ../fish/guestfish-actions.pod:3236
25571 " mount-vfs options vfstype device mountpoint\n"
25576 #: ../fish/guestfish-actions.pod:3238
25578 "This is the same as the L</mount> command, but it allows you to set both the "
25579 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25583 #: ../fish/guestfish-actions.pod:3242
25584 msgid "mountpoints"
25588 #: ../fish/guestfish-actions.pod:3244
25596 #: ../fish/guestfish-actions.pod:3246
25598 "This call is similar to L</mounts>. That call returns a list of devices. "
25599 "This one returns a hash table (map) of device name to directory where the "
25600 "device is mounted."
25604 #: ../fish/guestfish-actions.pod:3250
25609 #: ../fish/guestfish-actions.pod:3252
25617 #: ../fish/guestfish-actions.pod:3259
25618 msgid "See also: L</mountpoints>"
25622 #: ../fish/guestfish-actions.pod:3261
25627 #: ../fish/guestfish-actions.pod:3263
25635 #: ../fish/guestfish-actions.pod:3268
25636 msgid "ntfs-3g-probe"
25640 #: ../fish/guestfish-actions.pod:3270
25643 " ntfs-3g-probe true|false device\n"
25648 #: ../fish/guestfish-actions.pod:3284
25653 #: ../fish/guestfish-actions.pod:3286
25656 " ntfsresize device\n"
25661 #: ../fish/guestfish-actions.pod:3292
25662 msgid "ntfsresize-size"
25666 #: ../fish/guestfish-actions.pod:3294
25669 " ntfsresize-size device size\n"
25674 #: ../fish/guestfish-actions.pod:3296
25676 "This command is the same as L</ntfsresize> except that it allows you to "
25677 "specify the new size (in bytes) explicitly."
25681 #: ../fish/guestfish-actions.pod:3299
25686 #: ../fish/guestfish-actions.pod:3301
25689 " part-add device prlogex startsect endsect\n"
25694 #: ../fish/guestfish-actions.pod:3303
25696 "This command adds a partition to C<device>. If there is no partition table "
25697 "on the device, call L</part-init> first."
25701 #: ../fish/guestfish-actions.pod:3315
25703 "Creating a partition which covers the whole disk is not so easy. Use L</"
25704 "part-disk> to do that."
25708 #: ../fish/guestfish-actions.pod:3318
25713 #: ../fish/guestfish-actions.pod:3320
25716 " part-del device partnum\n"
25721 #: ../fish/guestfish-actions.pod:3328
25726 #: ../fish/guestfish-actions.pod:3330
25729 " part-disk device parttype\n"
25734 #: ../fish/guestfish-actions.pod:3332
25736 "This command is simply a combination of L</part-init> followed by L</part-"
25737 "add> to create a single primary partition covering the whole disk."
25741 #: ../fish/guestfish-actions.pod:3336
25743 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25744 "possible values are described in L</part-init>."
25748 #: ../fish/guestfish-actions.pod:3342
25749 msgid "part-get-bootable"
25753 #: ../fish/guestfish-actions.pod:3344
25756 " part-get-bootable device partnum\n"
25761 #: ../fish/guestfish-actions.pod:3349
25762 msgid "See also L</part-set-bootable>."
25766 #: ../fish/guestfish-actions.pod:3351
25767 msgid "part-get-mbr-id"
25771 #: ../fish/guestfish-actions.pod:3353
25774 " part-get-mbr-id device partnum\n"
25779 #: ../fish/guestfish-actions.pod:3358 ../fish/guestfish-actions.pod:3496
25781 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25782 "undefined results for other partition table types (see L</part-get-"
25787 #: ../fish/guestfish-actions.pod:3362
25788 msgid "part-get-parttype"
25792 #: ../fish/guestfish-actions.pod:3364
25795 " part-get-parttype device\n"
25800 #: ../fish/guestfish-actions.pod:3369
25802 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25803 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25804 "possible, although unusual. See L</part-init> for a full list."
25808 #: ../fish/guestfish-actions.pod:3374
25813 #: ../fish/guestfish-actions.pod:3376
25816 " part-init device parttype\n"
25821 #: ../fish/guestfish-actions.pod:3382
25823 "Initially there are no partitions. Following this, you should call L</part-"
25824 "add> for each partition required."
25828 #: ../fish/guestfish-actions.pod:3445
25833 #: ../fish/guestfish-actions.pod:3447
25836 " part-list device\n"
25841 #: ../fish/guestfish-actions.pod:3462
25843 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25844 "the device's sector size, see L</blockdev-getss>."
25848 #: ../fish/guestfish-actions.pod:3475
25849 msgid "part-set-bootable"
25853 #: ../fish/guestfish-actions.pod:3477
25856 " part-set-bootable device partnum true|false\n"
25861 #: ../fish/guestfish-actions.pod:3486
25862 msgid "part-set-mbr-id"
25866 #: ../fish/guestfish-actions.pod:3488
25869 " part-set-mbr-id device partnum idbyte\n"
25874 #: ../fish/guestfish-actions.pod:3500
25875 msgid "part-set-name"
25879 #: ../fish/guestfish-actions.pod:3502
25882 " part-set-name device partnum name\n"
25887 #: ../fish/guestfish-actions.pod:3510
25888 msgid "part-to-dev"
25892 #: ../fish/guestfish-actions.pod:3512
25895 " part-to-dev partition\n"
25900 #: ../fish/guestfish-actions.pod:3518
25902 "The named partition must exist, for example as a string returned from L</"
25903 "list-partitions>."
25907 #: ../fish/guestfish-actions.pod:3521
25908 msgid "ping-daemon"
25912 #: ../fish/guestfish-actions.pod:3523
25920 #: ../fish/guestfish-actions.pod:3530
25925 #: ../fish/guestfish-actions.pod:3532
25928 " pread path count offset\n"
25933 #: ../fish/guestfish-actions.pod:3540
25934 msgid "See also L</pwrite>, L</pread-device>."
25938 #: ../fish/guestfish-actions.pod:3545
25939 msgid "pread-device"
25943 #: ../fish/guestfish-actions.pod:3547
25946 " pread-device device count offset\n"
25951 #: ../fish/guestfish-actions.pod:3555
25952 msgid "See also L</pread>."
25956 #: ../fish/guestfish-actions.pod:3560
25961 #: ../fish/guestfish-actions.pod:3562
25964 " pvcreate device\n"
25969 #: ../fish/guestfish-actions.pod:3568
25974 #: ../fish/guestfish-actions.pod:3570
25977 " pvremove device\n"
25982 #: ../fish/guestfish-actions.pod:3579
25987 #: ../fish/guestfish-actions.pod:3581
25990 " pvresize device\n"
25995 #: ../fish/guestfish-actions.pod:3586
25996 msgid "pvresize-size"
26000 #: ../fish/guestfish-actions.pod:3588
26003 " pvresize-size device size\n"
26008 #: ../fish/guestfish-actions.pod:3590
26010 "This command is the same as L</pvresize> except that it allows you to "
26011 "specify the new size (in bytes) explicitly."
26015 #: ../fish/guestfish-actions.pod:3593
26020 #: ../fish/guestfish-actions.pod:3595
26028 #: ../fish/guestfish-actions.pod:3603
26029 msgid "See also L</pvs-full>."
26033 #: ../fish/guestfish-actions.pod:3605
26038 #: ../fish/guestfish-actions.pod:3607
26046 #: ../fish/guestfish-actions.pod:3612
26051 #: ../fish/guestfish-actions.pod:3614
26059 #: ../fish/guestfish-actions.pod:3618
26064 #: ../fish/guestfish-actions.pod:3620
26067 " pwrite path content offset\n"
26072 #: ../fish/guestfish-actions.pod:3631
26073 msgid "See also L</pread>, L</pwrite-device>."
26077 #: ../fish/guestfish-actions.pod:3636
26078 msgid "pwrite-device"
26082 #: ../fish/guestfish-actions.pod:3638
26085 " pwrite-device device content offset\n"
26090 #: ../fish/guestfish-actions.pod:3648
26091 msgid "See also L</pwrite>."
26095 #: ../fish/guestfish-actions.pod:3653
26100 #: ../fish/guestfish-actions.pod:3655
26103 " read-file path\n"
26108 #: ../fish/guestfish-actions.pod:3660
26110 "Unlike L</cat>, this function can correctly handle files that contain "
26111 "embedded ASCII NUL characters. However unlike L</download>, this function "
26112 "is limited in the total size of file that can be handled."
26116 #: ../fish/guestfish-actions.pod:3668
26121 #: ../fish/guestfish-actions.pod:3670
26124 " read-lines path\n"
26129 #: ../fish/guestfish-actions.pod:3677
26131 "Note that this function cannot correctly handle binary files (specifically, "
26132 "files containing C<\\0> character which is treated as end of line). For "
26133 "those you need to use the L</read-file> function which has a more complex "
26138 #: ../fish/guestfish-actions.pod:3682
26143 #: ../fish/guestfish-actions.pod:3684
26151 #: ../fish/guestfish-actions.pod:3736
26153 "This function is primarily intended for use by programs. To get a simple "
26154 "list of names, use L</ls>. To get a printable directory for human "
26155 "consumption, use L</ll>."
26159 #: ../fish/guestfish-actions.pod:3740
26164 #: ../fish/guestfish-actions.pod:3742
26172 #: ../fish/guestfish-actions.pod:3746
26173 msgid "readlinklist"
26177 #: ../fish/guestfish-actions.pod:3748
26180 " readlinklist path 'names ...'\n"
26185 #: ../fish/guestfish-actions.pod:3772
26190 #: ../fish/guestfish-actions.pod:3774
26198 #: ../fish/guestfish-actions.pod:3779
26199 msgid "removexattr"
26203 #: ../fish/guestfish-actions.pod:3781
26206 " removexattr xattr path\n"
26211 #: ../fish/guestfish-actions.pod:3786
26212 msgid "See also: L</lremovexattr>, L<attr(5)>."
26216 #: ../fish/guestfish-actions.pod:3788
26221 #: ../fish/guestfish-actions.pod:3790
26224 " resize2fs device\n"
26229 #: ../fish/guestfish-actions.pod:3795
26231 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26232 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26233 "gives an error about this and sometimes not. In any case, it is always safe "
26234 "to call L</e2fsck-f> before calling this function."
26238 #: ../fish/guestfish-actions.pod:3801
26239 msgid "resize2fs-M"
26243 #: ../fish/guestfish-actions.pod:3803
26246 " resize2fs-M device\n"
26251 #: ../fish/guestfish-actions.pod:3805
26253 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26254 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26259 #: ../fish/guestfish-actions.pod:3809
26261 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26262 "and read the C<Block size> and C<Block count> values. These two numbers, "
26263 "multiplied together, give the resulting size of the minimal filesystem in "
26268 #: ../fish/guestfish-actions.pod:3814
26269 msgid "resize2fs-size"
26273 #: ../fish/guestfish-actions.pod:3816
26276 " resize2fs-size device size\n"
26281 #: ../fish/guestfish-actions.pod:3818
26283 "This command is the same as L</resize2fs> except that it allows you to "
26284 "specify the new size (in bytes) explicitly."
26288 #: ../fish/guestfish-actions.pod:3821
26293 #: ../fish/guestfish-actions.pod:3823
26301 #: ../fish/guestfish-actions.pod:3827
26306 #: ../fish/guestfish-actions.pod:3829
26314 #: ../fish/guestfish-actions.pod:3835
26319 #: ../fish/guestfish-actions.pod:3837
26327 #: ../fish/guestfish-actions.pod:3841
26328 msgid "rmmountpoint"
26332 #: ../fish/guestfish-actions.pod:3843
26335 " rmmountpoint exemptpath\n"
26340 #: ../fish/guestfish-actions.pod:3845
26342 "This calls removes a mountpoint that was previously created with L</"
26343 "mkmountpoint>. See L</mkmountpoint> for full details."
26347 #: ../fish/guestfish-actions.pod:3849
26348 msgid "scrub-device"
26352 #: ../fish/guestfish-actions.pod:3851
26355 " scrub-device device\n"
26360 #: ../fish/guestfish-actions.pod:3862
26365 #: ../fish/guestfish-actions.pod:3864
26368 " scrub-file file\n"
26373 #: ../fish/guestfish-actions.pod:3874
26374 msgid "scrub-freespace"
26378 #: ../fish/guestfish-actions.pod:3876
26381 " scrub-freespace dir\n"
26386 #: ../fish/guestfish-actions.pod:3878
26388 "This command creates the directory C<dir> and then fills it with files until "
26389 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26390 "deletes them. The intention is to scrub any free space on the partition "
26391 "containing C<dir>."
26395 #: ../fish/guestfish-actions.pod:3887
26400 #: ../fish/guestfish-actions.pod:3889
26405 #: ../fish/guestfish-actions.pod:3891
26408 " set-append append\n"
26413 #: ../fish/guestfish-actions.pod:3902
26414 msgid "set-attach-method"
26418 #: ../fish/guestfish-actions.pod:3904
26419 msgid "attach-method"
26423 #: ../fish/guestfish-actions.pod:3906
26426 " set-attach-method attachmethod\n"
26431 #: ../fish/guestfish-actions.pod:3928
26432 msgid "set-autosync"
26436 #: ../fish/guestfish-actions.pod:3930
26441 #: ../fish/guestfish-actions.pod:3932
26444 " set-autosync true|false\n"
26449 #: ../fish/guestfish-actions.pod:3942
26454 #: ../fish/guestfish-actions.pod:3944
26459 #: ../fish/guestfish-actions.pod:3946
26462 " set-direct true|false\n"
26467 #: ../fish/guestfish-actions.pod:3952
26469 "One consequence of this is that log messages aren't caught by the library "
26470 "and handled by L</set-log-message-callback>, but go straight to stdout."
26474 #: ../fish/guestfish-actions.pod:3961
26475 msgid "set-e2label"
26479 #: ../fish/guestfish-actions.pod:3963
26482 " set-e2label device label\n"
26487 #: ../fish/guestfish-actions.pod:3969
26489 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26490 "label on a filesystem."
26494 #: ../fish/guestfish-actions.pod:3972
26499 #: ../fish/guestfish-actions.pod:3974
26502 " set-e2uuid device uuid\n"
26507 #: ../fish/guestfish-actions.pod:3981
26509 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26510 "UUID of a filesystem."
26514 #: ../fish/guestfish-actions.pod:3984
26515 msgid "set-memsize"
26519 #: ../fish/guestfish-actions.pod:3986
26524 #: ../fish/guestfish-actions.pod:3988
26527 " set-memsize memsize\n"
26532 #: ../fish/guestfish-actions.pod:3990
26534 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26535 "This only has any effect if called before L</launch>."
26539 #: ../fish/guestfish-actions.pod:4001
26540 msgid "set-network"
26544 #: ../fish/guestfish-actions.pod:4003
26549 #: ../fish/guestfish-actions.pod:4005
26552 " set-network true|false\n"
26557 #: ../fish/guestfish-actions.pod:4013
26559 "You must call this before calling L</launch>, otherwise it has no effect."
26563 #: ../fish/guestfish-actions.pod:4016
26568 #: ../fish/guestfish-actions.pod:4018
26573 #: ../fish/guestfish-actions.pod:4020
26576 " set-path searchpath\n"
26581 #: ../fish/guestfish-actions.pod:4029
26586 #: ../fish/guestfish-actions.pod:4031
26591 #: ../fish/guestfish-actions.pod:4033
26599 #: ../fish/guestfish-actions.pod:4053
26600 msgid "set-recovery-proc"
26604 #: ../fish/guestfish-actions.pod:4055
26605 msgid "recovery-proc"
26609 #: ../fish/guestfish-actions.pod:4057
26612 " set-recovery-proc true|false\n"
26617 #: ../fish/guestfish-actions.pod:4059
26619 "If this is called with the parameter C<false> then L</launch> does not "
26620 "create a recovery process. The purpose of the recovery process is to stop "
26621 "runaway qemu processes in the case where the main program aborts abruptly."
26625 #: ../fish/guestfish-actions.pod:4064
26627 "This only has any effect if called before L</launch>, and the default is "
26632 #: ../fish/guestfish-actions.pod:4073
26633 msgid "set-selinux"
26637 #: ../fish/guestfish-actions.pod:4075
26642 #: ../fish/guestfish-actions.pod:4077
26645 " set-selinux true|false\n"
26650 #: ../fish/guestfish-actions.pod:4088
26655 #: ../fish/guestfish-actions.pod:4090
26660 #: ../fish/guestfish-actions.pod:4092
26663 " set-trace true|false\n"
26668 #: ../fish/guestfish-actions.pod:4104
26670 "Trace messages are normally sent to C<stderr>, unless you register a "
26671 "callback to send them somewhere else (see L</set-event-callback>)."
26675 #: ../fish/guestfish-actions.pod:4108
26676 msgid "set-verbose"
26680 #: ../fish/guestfish-actions.pod:4110
26685 #: ../fish/guestfish-actions.pod:4112
26688 " set-verbose true|false\n"
26693 #: ../fish/guestfish-actions.pod:4119
26695 "Verbose messages are normally sent to C<stderr>, unless you register a "
26696 "callback to send them somewhere else (see L</set-event-callback>)."
26700 #: ../fish/guestfish-actions.pod:4123
26705 #: ../fish/guestfish-actions.pod:4125
26708 " setcon context\n"
26713 #: ../fish/guestfish-actions.pod:4132
26718 #: ../fish/guestfish-actions.pod:4134
26721 " setxattr xattr val vallen path\n"
26726 #: ../fish/guestfish-actions.pod:4140
26727 msgid "See also: L</lsetxattr>, L<attr(5)>."
26731 #: ../fish/guestfish-actions.pod:4142
26736 #: ../fish/guestfish-actions.pod:4144
26739 " sfdisk device cyls heads sectors 'lines ...'\n"
26744 #: ../fish/guestfish-actions.pod:4166
26745 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26749 #: ../fish/guestfish-actions.pod:4172
26754 #: ../fish/guestfish-actions.pod:4174
26757 " sfdiskM device 'lines ...'\n"
26762 #: ../fish/guestfish-actions.pod:4176
26764 "This is a simplified interface to the L</sfdisk> command, where partition "
26765 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26766 "you don't need to specify the cyls, heads and sectors parameters which were "
26767 "rarely if ever used anyway."
26771 #: ../fish/guestfish-actions.pod:4182
26772 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26776 #: ../fish/guestfish-actions.pod:4188
26781 #: ../fish/guestfish-actions.pod:4190
26784 " sfdisk-N device partnum cyls heads sectors line\n"
26789 #: ../fish/guestfish-actions.pod:4195
26791 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26792 "cyls/heads/sectors parameters."
26796 #: ../fish/guestfish-actions.pod:4198
26797 msgid "See also: L</part-add>"
26801 #: ../fish/guestfish-actions.pod:4203
26802 msgid "sfdisk-disk-geometry"
26806 #: ../fish/guestfish-actions.pod:4205
26809 " sfdisk-disk-geometry device\n"
26814 #: ../fish/guestfish-actions.pod:4207
26816 "This displays the disk geometry of C<device> read from the partition table. "
26817 "Especially in the case where the underlying block device has been resized, "
26818 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26819 "kernel-geometry>)."
26823 #: ../fish/guestfish-actions.pod:4215
26824 msgid "sfdisk-kernel-geometry"
26828 #: ../fish/guestfish-actions.pod:4217
26831 " sfdisk-kernel-geometry device\n"
26836 #: ../fish/guestfish-actions.pod:4224
26841 #: ../fish/guestfish-actions.pod:4226
26844 " sfdisk-l device\n"
26849 #: ../fish/guestfish-actions.pod:4232
26850 msgid "See also: L</part-list>"
26854 #: ../fish/guestfish-actions.pod:4234
26859 #: ../fish/guestfish-actions.pod:4236
26867 #: ../fish/guestfish-actions.pod:4241
26868 msgid "This is like L</command>, but passes the command to:"
26872 #: ../fish/guestfish-actions.pod:4249
26873 msgid "All the provisos about L</command> apply to this call."
26877 #: ../fish/guestfish-actions.pod:4251
26882 #: ../fish/guestfish-actions.pod:4253
26885 " sh-lines command\n"
26890 #: ../fish/guestfish-actions.pod:4255
26891 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26895 #: ../fish/guestfish-actions.pod:4258
26896 msgid "See also: L</command-lines>"
26900 #: ../fish/guestfish-actions.pod:4260
26905 #: ../fish/guestfish-actions.pod:4262
26913 #: ../fish/guestfish-actions.pod:4266
26918 #: ../fish/guestfish-actions.pod:4268
26926 #: ../fish/guestfish-actions.pod:4274
26931 #: ../fish/guestfish-actions.pod:4276
26939 #: ../fish/guestfish-actions.pod:4284
26944 #: ../fish/guestfish-actions.pod:4286
26952 #: ../fish/guestfish-actions.pod:4294
26957 #: ../fish/guestfish-actions.pod:4296
26960 " strings-e encoding path\n"
26965 #: ../fish/guestfish-actions.pod:4298
26967 "This is like the L</strings> command, but allows you to specify the encoding "
26968 "of strings that are looked for in the source file C<path>."
26972 #: ../fish/guestfish-actions.pod:4308
26974 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26975 "ISO-8859-X (this is what L</strings> uses)."
26979 #: ../fish/guestfish-actions.pod:4340
26980 msgid "swapoff-device"
26984 #: ../fish/guestfish-actions.pod:4342
26987 " swapoff-device device\n"
26992 #: ../fish/guestfish-actions.pod:4344
26994 "This command disables the libguestfs appliance swap device or partition "
26995 "named C<device>. See L</swapon-device>."
26999 #: ../fish/guestfish-actions.pod:4348
27000 msgid "swapoff-file"
27004 #: ../fish/guestfish-actions.pod:4350
27007 " swapoff-file file\n"
27012 #: ../fish/guestfish-actions.pod:4354
27013 msgid "swapoff-label"
27017 #: ../fish/guestfish-actions.pod:4356
27020 " swapoff-label label\n"
27025 #: ../fish/guestfish-actions.pod:4361
27026 msgid "swapoff-uuid"
27030 #: ../fish/guestfish-actions.pod:4363
27033 " swapoff-uuid uuid\n"
27038 #: ../fish/guestfish-actions.pod:4368
27039 msgid "swapon-device"
27043 #: ../fish/guestfish-actions.pod:4370
27046 " swapon-device device\n"
27051 #: ../fish/guestfish-actions.pod:4372
27053 "This command enables the libguestfs appliance to use the swap device or "
27054 "partition named C<device>. The increased memory is made available for all "
27055 "commands, for example those run using L</command> or L</sh>."
27059 #: ../fish/guestfish-actions.pod:4384
27060 msgid "swapon-file"
27064 #: ../fish/guestfish-actions.pod:4386
27067 " swapon-file file\n"
27072 #: ../fish/guestfish-actions.pod:4388
27074 "This command enables swap to a file. See L</swapon-device> for other notes."
27078 #: ../fish/guestfish-actions.pod:4391
27079 msgid "swapon-label"
27083 #: ../fish/guestfish-actions.pod:4393
27086 " swapon-label label\n"
27091 #: ../fish/guestfish-actions.pod:4395
27093 "This command enables swap to a labeled swap partition. See L</swapon-"
27094 "device> for other notes."
27098 #: ../fish/guestfish-actions.pod:4398
27099 msgid "swapon-uuid"
27103 #: ../fish/guestfish-actions.pod:4400
27106 " swapon-uuid uuid\n"
27111 #: ../fish/guestfish-actions.pod:4402
27113 "This command enables swap to a swap partition with the given UUID. See L</"
27114 "swapon-device> for other notes."
27118 #: ../fish/guestfish-actions.pod:4405
27123 #: ../fish/guestfish-actions.pod:4407
27131 #: ../fish/guestfish-actions.pod:4415
27136 #: ../fish/guestfish-actions.pod:4417
27144 #: ../fish/guestfish-actions.pod:4425
27149 #: ../fish/guestfish-actions.pod:4427
27152 " tail-n nrlines path\n"
27157 #: ../fish/guestfish-actions.pod:4440
27162 #: ../fish/guestfish-actions.pod:4442
27165 " tar-in (tarfile|-) directory\n"
27170 #: ../fish/guestfish-actions.pod:4447
27171 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27175 #: ../fish/guestfish-actions.pod:4452
27180 #: ../fish/guestfish-actions.pod:4454
27183 " tar-out directory (tarfile|-)\n"
27188 #: ../fish/guestfish-actions.pod:4459
27189 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27193 #: ../fish/guestfish-actions.pod:4464
27198 #: ../fish/guestfish-actions.pod:4466
27201 " tgz-in (tarball|-) directory\n"
27206 #: ../fish/guestfish-actions.pod:4471
27207 msgid "To upload an uncompressed tarball, use L</tar-in>."
27211 #: ../fish/guestfish-actions.pod:4475
27216 #: ../fish/guestfish-actions.pod:4477
27219 " tgz-out directory (tarball|-)\n"
27224 #: ../fish/guestfish-actions.pod:4482
27225 msgid "To download an uncompressed tarball, use L</tar-out>."
27229 #: ../fish/guestfish-actions.pod:4486
27234 #: ../fish/guestfish-actions.pod:4488
27242 #: ../fish/guestfish-actions.pod:4497
27247 #: ../fish/guestfish-actions.pod:4499
27255 #: ../fish/guestfish-actions.pod:4504
27256 msgid "truncate-size"
27260 #: ../fish/guestfish-actions.pod:4506
27263 " truncate-size path size\n"
27268 #: ../fish/guestfish-actions.pod:4511
27270 "If the current file size is less than C<size> then the file is extended to "
27271 "the required size with zero bytes. This creates a sparse file (ie. disk "
27272 "blocks are not allocated for the file until you write to it). To create a "
27273 "non-sparse file of zeroes, use L</fallocate64> instead."
27277 #: ../fish/guestfish-actions.pod:4517
27282 #: ../fish/guestfish-actions.pod:4519
27285 " tune2fs-l device\n"
27290 #: ../fish/guestfish-actions.pod:4529
27295 #: ../fish/guestfish-actions.pod:4531
27298 " txz-in (tarball|-) directory\n"
27303 #: ../fish/guestfish-actions.pod:4538
27308 #: ../fish/guestfish-actions.pod:4540
27311 " txz-out directory (tarball|-)\n"
27316 #: ../fish/guestfish-actions.pod:4547
27321 #: ../fish/guestfish-actions.pod:4549
27329 #: ../fish/guestfish-actions.pod:4563
27330 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27334 #: ../fish/guestfish-actions.pod:4568
27339 #: ../fish/guestfish-actions.pod:4570
27344 #: ../fish/guestfish-actions.pod:4572
27347 " umount pathordevice\n"
27352 #: ../fish/guestfish-actions.pod:4578
27357 #: ../fish/guestfish-actions.pod:4580
27358 msgid "unmount-all"
27362 #: ../fish/guestfish-actions.pod:4582
27370 #: ../fish/guestfish-actions.pod:4588
27375 #: ../fish/guestfish-actions.pod:4590
27378 " upload (filename|-) remotefilename\n"
27383 #: ../fish/guestfish-actions.pod:4597
27384 msgid "See also L</download>."
27388 #: ../fish/guestfish-actions.pod:4601
27389 msgid "upload-offset"
27393 #: ../fish/guestfish-actions.pod:4603
27396 " upload-offset (filename|-) remotefilename offset\n"
27401 #: ../fish/guestfish-actions.pod:4615
27403 "Note that there is no limit on the amount of data that can be uploaded with "
27404 "this call, unlike with L</pwrite>, and this call always writes the full "
27405 "amount unless an error occurs."
27409 #: ../fish/guestfish-actions.pod:4620
27410 msgid "See also L</upload>, L</pwrite>."
27414 #: ../fish/guestfish-actions.pod:4624
27419 #: ../fish/guestfish-actions.pod:4626
27422 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27427 #: ../fish/guestfish-actions.pod:4645
27432 #: ../fish/guestfish-actions.pod:4647
27440 #: ../fish/guestfish-actions.pod:4674
27442 "I<Note:> Don't use this call to test for availability of features. In "
27443 "enterprise distributions we backport features from later versions into "
27444 "earlier versions, making this an unreliable way to test for features. Use "
27445 "L</available> instead."
27449 #: ../fish/guestfish-actions.pod:4680
27454 #: ../fish/guestfish-actions.pod:4682
27457 " vfs-label device\n"
27462 #: ../fish/guestfish-actions.pod:4689
27463 msgid "To find a filesystem from the label, use L</findfs-label>."
27467 #: ../fish/guestfish-actions.pod:4691
27472 #: ../fish/guestfish-actions.pod:4693
27475 " vfs-type device\n"
27480 #: ../fish/guestfish-actions.pod:4703
27485 #: ../fish/guestfish-actions.pod:4705
27488 " vfs-uuid device\n"
27493 #: ../fish/guestfish-actions.pod:4712
27494 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27498 #: ../fish/guestfish-actions.pod:4714
27499 msgid "vg-activate"
27503 #: ../fish/guestfish-actions.pod:4716
27506 " vg-activate true|false 'volgroups ...'\n"
27511 #: ../fish/guestfish-actions.pod:4729
27512 msgid "vg-activate-all"
27516 #: ../fish/guestfish-actions.pod:4731
27519 " vg-activate-all true|false\n"
27524 #: ../fish/guestfish-actions.pod:4741
27529 #: ../fish/guestfish-actions.pod:4743
27532 " vgcreate volgroup 'physvols ...'\n"
27537 #: ../fish/guestfish-actions.pod:4748
27542 #: ../fish/guestfish-actions.pod:4750
27545 " vglvuuids vgname\n"
27550 #: ../fish/guestfish-actions.pod:4755
27552 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27553 "logical volumes and volume groups."
27557 #: ../fish/guestfish-actions.pod:4758
27558 msgid "See also L</vgpvuuids>."
27562 #: ../fish/guestfish-actions.pod:4760
27567 #: ../fish/guestfish-actions.pod:4762
27570 " vgpvuuids vgname\n"
27575 #: ../fish/guestfish-actions.pod:4767
27577 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27578 "physical volumes and volume groups."
27582 #: ../fish/guestfish-actions.pod:4770
27583 msgid "See also L</vglvuuids>."
27587 #: ../fish/guestfish-actions.pod:4772
27592 #: ../fish/guestfish-actions.pod:4774
27595 " vgremove vgname\n"
27600 #: ../fish/guestfish-actions.pod:4781
27605 #: ../fish/guestfish-actions.pod:4783
27608 " vgrename volgroup newvolgroup\n"
27613 #: ../fish/guestfish-actions.pod:4787
27618 #: ../fish/guestfish-actions.pod:4789
27626 #: ../fish/guestfish-actions.pod:4797
27627 msgid "See also L</vgs-full>."
27631 #: ../fish/guestfish-actions.pod:4799
27636 #: ../fish/guestfish-actions.pod:4801
27644 #: ../fish/guestfish-actions.pod:4806
27649 #: ../fish/guestfish-actions.pod:4808
27657 #: ../fish/guestfish-actions.pod:4813
27662 #: ../fish/guestfish-actions.pod:4815
27670 #: ../fish/guestfish-actions.pod:4819
27675 #: ../fish/guestfish-actions.pod:4821
27683 #: ../fish/guestfish-actions.pod:4826
27688 #: ../fish/guestfish-actions.pod:4828
27696 #: ../fish/guestfish-actions.pod:4833
27701 #: ../fish/guestfish-actions.pod:4835
27709 #: ../fish/guestfish-actions.pod:4840
27714 #: ../fish/guestfish-actions.pod:4842
27717 " write path content\n"
27722 #: ../fish/guestfish-actions.pod:4850
27727 #: ../fish/guestfish-actions.pod:4852
27730 " write-file path content size\n"
27735 #: ../fish/guestfish-actions.pod:4875
27740 #: ../fish/guestfish-actions.pod:4877
27743 " zegrep regex path\n"
27748 #: ../fish/guestfish-actions.pod:4885
27753 #: ../fish/guestfish-actions.pod:4887
27756 " zegrepi regex path\n"
27761 #: ../fish/guestfish-actions.pod:4895
27766 #: ../fish/guestfish-actions.pod:4897
27774 #: ../fish/guestfish-actions.pod:4905
27775 msgid "See also: L</zero-device>, L</scrub-device>."
27779 #: ../fish/guestfish-actions.pod:4907
27780 msgid "zero-device"
27784 #: ../fish/guestfish-actions.pod:4909
27787 " zero-device device\n"
27792 #: ../fish/guestfish-actions.pod:4911
27794 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27795 "which just zeroes the first few blocks of a device."
27799 #: ../fish/guestfish-actions.pod:4918
27804 #: ../fish/guestfish-actions.pod:4920
27807 " zerofree device\n"
27812 #: ../fish/guestfish-actions.pod:4933
27817 #: ../fish/guestfish-actions.pod:4935
27820 " zfgrep pattern path\n"
27825 #: ../fish/guestfish-actions.pod:4943
27830 #: ../fish/guestfish-actions.pod:4945
27833 " zfgrepi pattern path\n"
27838 #: ../fish/guestfish-actions.pod:4953
27843 #: ../fish/guestfish-actions.pod:4955
27846 " zfile meth path\n"
27851 #: ../fish/guestfish-actions.pod:4962
27853 "Since 1.0.63, use L</file> instead which can now process compressed files."
27857 #: ../fish/guestfish-actions.pod:4972
27862 #: ../fish/guestfish-actions.pod:4974
27865 " zgrep regex path\n"
27870 #: ../fish/guestfish-actions.pod:4982
27875 #: ../fish/guestfish-actions.pod:4984
27878 " zgrepi regex path\n"
27883 #: ../fish/guestfish-commands.pod:1
27888 #: ../fish/guestfish-commands.pod:3
27893 #: ../fish/guestfish-commands.pod:5
27896 " alloc filename size\n"
27901 #: ../fish/guestfish-commands.pod:7
27903 "This creates an empty (zeroed) file of the given size, and then adds so it "
27904 "can be further examined."
27908 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27909 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27913 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27914 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27918 #: ../fish/guestfish-commands.pod:14
27920 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27921 "image, see L</PREPARED DISK IMAGES>."
27925 #: ../fish/guestfish-commands.pod:17
27930 #: ../fish/guestfish-commands.pod:19
27933 " copy-in local [local ...] /remotedir\n"
27938 #: ../fish/guestfish-commands.pod:21
27940 "C<copy-in> copies local files or directories recursively into the disk "
27941 "image, placing them in the directory called C</remotedir> (which must "
27942 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27943 "other commands as necessary."
27947 #: ../fish/guestfish-commands.pod:26
27949 "Multiple local files and directories can be specified, but the last "
27950 "parameter must always be a remote directory. Wildcards cannot be used."
27954 #: ../fish/guestfish-commands.pod:30
27959 #: ../fish/guestfish-commands.pod:32
27962 " copy-out remote [remote ...] localdir\n"
27967 #: ../fish/guestfish-commands.pod:34
27969 "C<copy-out> copies remote files or directories recursively out of the disk "
27970 "image, placing them on the host disk in a local directory called C<localdir> "
27971 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27972 "download>, L</tar-out> and other commands as necessary."
27976 #: ../fish/guestfish-commands.pod:40
27978 "Multiple remote files and directories can be specified, but the last "
27979 "parameter must always be a local directory. To download to the current "
27980 "directory, use C<.> as in:"
27984 #: ../fish/guestfish-commands.pod:44
27987 " copy-out /home .\n"
27992 #: ../fish/guestfish-commands.pod:46
27994 "Wildcards cannot be used in the ordinary command, but you can use them with "
27995 "the help of L</glob> like this:"
27999 #: ../fish/guestfish-commands.pod:49
28002 " glob copy-out /home/* .\n"
28007 #: ../fish/guestfish-commands.pod:51
28012 #: ../fish/guestfish-commands.pod:53
28015 " echo [params ...]\n"
28020 #: ../fish/guestfish-commands.pod:55
28021 msgid "This echos the parameters to the terminal."
28025 #: ../fish/guestfish-commands.pod:57
28030 #: ../fish/guestfish-commands.pod:59
28035 #: ../fish/guestfish-commands.pod:61
28040 #: ../fish/guestfish-commands.pod:63
28048 #: ../fish/guestfish-commands.pod:65
28050 "This is used to edit a file. It downloads the file, edits it locally using "
28051 "your editor, then uploads the result."
28055 #: ../fish/guestfish-commands.pod:68
28057 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28058 "or C<emacs> you will get those corresponding editors."
28062 #: ../fish/guestfish-commands.pod:72
28067 #: ../fish/guestfish-commands.pod:74
28070 " glob command args...\n"
28075 #: ../fish/guestfish-commands.pod:76
28077 "Expand wildcards in any paths in the args list, and run C<command> "
28078 "repeatedly on each matching path."
28082 #: ../fish/guestfish-commands.pod:79
28083 msgid "See L</WILDCARDS AND GLOBBING>."
28087 #: ../fish/guestfish-commands.pod:81
28092 #: ../fish/guestfish-commands.pod:83
28095 " hexedit <filename|device>\n"
28096 " hexedit <filename|device> <max>\n"
28097 " hexedit <filename|device> <start> <max>\n"
28102 #: ../fish/guestfish-commands.pod:87
28104 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28109 #: ../fish/guestfish-commands.pod:90
28111 "This command works by downloading potentially the whole file or device, "
28112 "editing it locally, then uploading it. If the file or device is large, you "
28113 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28114 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28115 "usual modifiers allowed such as C<1M> (1 megabyte)."
28119 #: ../fish/guestfish-commands.pod:97
28120 msgid "For example to edit the first few sectors of a disk you might do:"
28124 #: ../fish/guestfish-commands.pod:100
28127 " hexedit /dev/sda 1M\n"
28132 #: ../fish/guestfish-commands.pod:102
28134 "which would allow you to edit anywhere within the first megabyte of the disk."
28138 #: ../fish/guestfish-commands.pod:105
28139 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28143 #: ../fish/guestfish-commands.pod:107
28146 " hexedit /dev/sda1 0x400 0x400\n"
28151 #: ../fish/guestfish-commands.pod:109
28152 msgid "(assuming the superblock is in the standard location)."
28156 #: ../fish/guestfish-commands.pod:111
28158 "This command requires the external L<hexedit(1)> program. You can specify "
28159 "another program to use by setting the C<HEXEDITOR> environment variable."
28163 #: ../fish/guestfish-commands.pod:115
28164 msgid "See also L</hexdump>."
28168 #: ../fish/guestfish-commands.pod:117
28173 #: ../fish/guestfish-commands.pod:119
28181 #: ../fish/guestfish-commands.pod:121
28183 "Change the local directory, ie. the current directory of guestfish itself."
28187 #: ../fish/guestfish-commands.pod:124
28188 msgid "Note that C<!cd> won't do what you might expect."
28192 #: ../fish/guestfish-commands.pod:126
28197 #: ../fish/guestfish-commands.pod:128
28202 #: ../fish/guestfish-commands.pod:130
28210 #: ../fish/guestfish-commands.pod:132
28211 msgid "Opens the manual page for guestfish."
28215 #: ../fish/guestfish-commands.pod:134
28220 #: ../fish/guestfish-commands.pod:136
28225 #: ../fish/guestfish-commands.pod:138
28233 #: ../fish/guestfish-commands.pod:140
28241 #: ../fish/guestfish-commands.pod:142
28242 msgid "This is used to view a file."
28246 #: ../fish/guestfish-commands.pod:144
28248 "The default viewer is C<$PAGER>. However if you use the alternate command "
28249 "C<less> you will get the C<less> command specifically."
28253 #: ../fish/guestfish-commands.pod:147
28258 #: ../fish/guestfish-commands.pod:149
28266 #: ../fish/guestfish-commands.pod:151
28268 "Close and reopen the libguestfs handle. It is not necessary to use this "
28269 "normally, because the handle is closed properly when guestfish exits. "
28270 "However this is occasionally useful for testing."
28274 #: ../fish/guestfish-commands.pod:155
28279 #: ../fish/guestfish-commands.pod:157
28282 " sparse filename size\n"
28287 #: ../fish/guestfish-commands.pod:159
28289 "This creates an empty sparse file of the given size, and then adds so it can "
28290 "be further examined."
28294 #: ../fish/guestfish-commands.pod:162
28296 "In all respects it works the same as the L</alloc> command, except that the "
28297 "image file is allocated sparsely, which means that disk blocks are not "
28298 "assigned to the file until they are needed. Sparse disk files only use "
28299 "space when written to, but they are slower and there is a danger you could "
28300 "run out of real disk space during a write operation."
28304 #: ../fish/guestfish-commands.pod:172
28309 #: ../fish/guestfish-commands.pod:174
28317 #: ../fish/guestfish-commands.pod:176
28319 "This command returns a list of the optional groups known to the daemon, and "
28320 "indicates which ones are supported by this build of the libguestfs appliance."
28324 #: ../fish/guestfish-commands.pod:180
28325 msgid "See also L<guestfs(3)/AVAILABILITY>."
28329 #: ../fish/guestfish-commands.pod:182
28334 #: ../fish/guestfish-commands.pod:184
28337 " time command args...\n"
28342 #: ../fish/guestfish-commands.pod:186
28344 "Run the command as usual, but print the elapsed time afterwards. This can "
28345 "be useful for benchmarking operations."
28349 #: ../test-tool/libguestfs-test-tool.pod:5
28350 msgid "libguestfs-test-tool - End user tests for libguestfs"
28354 #: ../test-tool/libguestfs-test-tool.pod:9
28357 " libguestfs-test-tool [--options]\n"
28362 #: ../test-tool/libguestfs-test-tool.pod:13
28364 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28365 "and developers, to allow them to check basic libguestfs functionality is "
28366 "working. This is needed because libguestfs occasionally breaks for reasons "
28367 "beyond our control: usually because of changes in the underlying qemu or "
28368 "kernel packages, or the host environment."
28372 #: ../test-tool/libguestfs-test-tool.pod:20
28373 msgid "If you suspect a problem in libguestfs, then just run:"
28377 #: ../test-tool/libguestfs-test-tool.pod:22
28380 " libguestfs-test-tool\n"
28385 #: ../test-tool/libguestfs-test-tool.pod:24
28386 msgid "It will print lots of diagnostic messages."
28390 #: ../test-tool/libguestfs-test-tool.pod:26
28391 msgid "If it runs to completion successfully, you will see this near the end:"
28395 #: ../test-tool/libguestfs-test-tool.pod:28
28398 " ===== TEST FINISHED OK =====\n"
28403 #: ../test-tool/libguestfs-test-tool.pod:30
28404 msgid "and the test tool will exit with code 0."
28408 #: ../test-tool/libguestfs-test-tool.pod:32
28410 "If it fails (and/or exits with non-zero error code), please paste the "
28411 "B<complete, unedited> output of the test tool into a bug report. More "
28412 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28417 #: ../test-tool/libguestfs-test-tool.pod:41
28422 #: ../test-tool/libguestfs-test-tool.pod:43
28423 msgid "Display short usage information and exit."
28427 #: ../test-tool/libguestfs-test-tool.pod:45
28428 msgid "I<--qemu qemu_binary>"
28432 #: ../test-tool/libguestfs-test-tool.pod:47
28434 "If you have downloaded another qemu binary, point this option at the full "
28435 "path of the binary to try it."
28439 #: ../test-tool/libguestfs-test-tool.pod:50
28440 msgid "I<--qemudir qemu_source_dir>"
28444 #: ../test-tool/libguestfs-test-tool.pod:52
28446 "If you have compiled qemu from source, point this option at the source "
28447 "directory to try it."
28451 #: ../test-tool/libguestfs-test-tool.pod:55
28452 msgid "I<--timeout N>"
28456 #: ../test-tool/libguestfs-test-tool.pod:57
28458 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28459 "does not usually need to be adjusted unless your machine is very slow."
28463 #: ../test-tool/libguestfs-test-tool.pod:63
28464 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28468 #: ../test-tool/libguestfs-test-tool.pod:65
28470 "If you have compiled another version of qemu from source and would like to "
28471 "try that, then you can use the I<--qemudir> option to point to the qemu "
28472 "source directory."
28476 #: ../test-tool/libguestfs-test-tool.pod:69
28478 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28479 "option to point to the binary."
28483 #: ../test-tool/libguestfs-test-tool.pod:72
28485 "When using an alternate qemu with libguestfs, usually you would need to "
28486 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28487 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28488 "use either of the I<--qemudir> or I<--qemu> options."
28492 #: ../test-tool/libguestfs-test-tool.pod:79
28494 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28495 "I<1> if there was an error."
28499 #: ../test-tool/libguestfs-test-tool.pod:84
28501 "For the full list of environment variables which may affect libguestfs, "
28502 "please see the L<guestfs(3)> manual page."
28506 #: ../test-tool/libguestfs-test-tool.pod:89
28507 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28511 #: ../fuse/guestmount.pod:5
28513 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28517 #: ../fuse/guestmount.pod:9
28520 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28525 #: ../fuse/guestmount.pod:11
28528 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28533 #: ../fuse/guestmount.pod:13
28536 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28541 #: ../fuse/guestmount.pod:17
28543 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28544 "machines. If you do this, you risk disk corruption in the VM."
28548 #: ../fuse/guestmount.pod:22
28550 "The guestmount program can be used to mount virtual machine filesystems and "
28551 "other disk images on the host. It uses libguestfs for access to the guest "
28552 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28553 "a mountable device."
28557 #: ../fuse/guestmount.pod:27
28559 "Along with other options, you have to give at least one device (I<-a> "
28560 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28561 "option) or use the I<-i> inspection option. How this works is better "
28562 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28567 #: ../fuse/guestmount.pod:33
28569 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28570 "by you, and the filesystem will not be visible to any other users unless you "
28571 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28572 "the filesystem, use the C<fusermount -u> command."
28576 #: ../fuse/guestmount.pod:41
28578 "For a typical Windows guest which has its main filesystem on the first "
28583 #: ../fuse/guestmount.pod:44
28586 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28591 #: ../fuse/guestmount.pod:46
28593 "For a typical Linux guest which has a /boot filesystem on the first "
28594 "partition, and the root filesystem on a logical volume:"
28598 #: ../fuse/guestmount.pod:49
28601 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28606 #: ../fuse/guestmount.pod:51
28607 msgid "To get libguestfs to detect guest mountpoints for you:"
28611 #: ../fuse/guestmount.pod:53
28614 " guestmount -a guest.img -i --ro /mnt\n"
28619 #: ../fuse/guestmount.pod:55
28620 msgid "For a libvirt guest called \"Guest\" you could do:"
28624 #: ../fuse/guestmount.pod:57
28627 " guestmount -d Guest -i --ro /mnt\n"
28632 #: ../fuse/guestmount.pod:59
28634 "If you don't know what filesystems are contained in a guest or disk image, "
28635 "use L<virt-filesystems(1)> first:"
28639 #: ../fuse/guestmount.pod:62
28642 " virt-filesystems MyGuest\n"
28647 #: ../fuse/guestmount.pod:64
28649 "If you want to trace the libguestfs calls but without excessive debugging "
28650 "information, we recommend:"
28654 #: ../fuse/guestmount.pod:67
28657 " guestmount [...] --trace /mnt\n"
28662 #: ../fuse/guestmount.pod:69
28663 msgid "If you want to debug the program, we recommend:"
28667 #: ../fuse/guestmount.pod:71
28670 " guestmount [...] --trace --verbose /mnt\n"
28675 #: ../fuse/guestmount.pod:77
28676 msgid "B<-a image> | B<--add image>"
28680 #: ../fuse/guestmount.pod:79
28681 msgid "Add a block device or virtual machine image."
28685 #: ../fuse/guestmount.pod:84
28686 msgid "B<-c URI> | B<--connect URI>"
28690 #: ../fuse/guestmount.pod:90
28691 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28695 #: ../fuse/guestmount.pod:98
28696 msgid "B<--dir-cache-timeout N>"
28700 #: ../fuse/guestmount.pod:100
28702 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28703 "seconds. The readdir cache [actually, there are several semi-independent "
28704 "caches] is populated after a readdir(2) call with the stat and extended "
28705 "attributes of the files in the directory, in anticipation that they will be "
28706 "requested soon after."
28710 #: ../fuse/guestmount.pod:106
28712 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28713 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28714 "requests, only cache existing ones."
28718 #: ../fuse/guestmount.pod:117
28719 msgid "B<--format=raw|qcow2|..> | B<--format>"
28723 #: ../fuse/guestmount.pod:124
28725 "If you have untrusted raw-format guest disk images, you should use this "
28726 "option to specify the disk format. This avoids a possible security problem "
28727 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28728 "guestfs_add_drive_opts>."
28732 #: ../fuse/guestmount.pod:129
28733 msgid "B<--fuse-help>"
28737 #: ../fuse/guestmount.pod:131
28738 msgid "Display help on special FUSE options (see I<-o> below)."
28742 #: ../fuse/guestmount.pod:135
28743 msgid "Display brief help and exit."
28747 #: ../fuse/guestmount.pod:137
28748 msgid "B<-i> | B<--inspector>"
28752 #: ../fuse/guestmount.pod:157
28754 "Mount the named partition or logical volume on the given mountpoint B<in the "
28755 "guest> (this has nothing to do with mountpoints in the host)."
28759 #: ../fuse/guestmount.pod:160
28761 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28762 "something on C</>."
28766 #: ../fuse/guestmount.pod:173
28767 msgid "B<-n> | B<--no-sync>"
28771 #: ../fuse/guestmount.pod:175
28773 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28774 "unmounted. If you specify this option, then we don't attempt to sync the "
28775 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28779 #: ../fuse/guestmount.pod:180
28780 msgid "B<-o option> | B<--option option>"
28784 #: ../fuse/guestmount.pod:182
28785 msgid "Pass extra options to FUSE."
28789 #: ../fuse/guestmount.pod:184
28791 "To get a list of all the extra options supported by FUSE, use the command "
28792 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28793 "of them are a good idea."
28797 #: ../fuse/guestmount.pod:188
28800 " guestmount --fuse-help\n"
28805 #: ../fuse/guestmount.pod:190
28806 msgid "Some potentially useful FUSE options:"
28810 #: ../fuse/guestmount.pod:194
28811 msgid "B<-o allow_other>"
28815 #: ../fuse/guestmount.pod:196
28816 msgid "Allow other users to see the filesystem."
28820 #: ../fuse/guestmount.pod:198
28821 msgid "B<-o attr_timeout=N>"
28825 #: ../fuse/guestmount.pod:200
28826 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28830 #: ../fuse/guestmount.pod:202
28831 msgid "B<-o kernel_cache>"
28835 #: ../fuse/guestmount.pod:204
28837 "Allow the kernel to cache files (reduces the number of reads that have to go "
28838 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28839 "afford the extra memory usage."
28843 #: ../fuse/guestmount.pod:208
28844 msgid "B<-o uid=N> B<-o gid=N>"
28848 #: ../fuse/guestmount.pod:210
28850 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28851 "the chosen values."
28855 #: ../fuse/guestmount.pod:215
28856 msgid "B<-r> | B<--ro>"
28860 #: ../fuse/guestmount.pod:217
28862 "Add devices and mount everything read-only. Also disallow writes and make "
28863 "the disk appear read-only to FUSE."
28867 #: ../fuse/guestmount.pod:220
28869 "This is highly recommended if you are not going to edit the guest disk. If "
28870 "the guest is running and this option is I<not> supplied, then there is a "
28871 "strong risk of disk corruption in the guest. We try to prevent this from "
28872 "happening, but it is not always possible."
28876 #: ../fuse/guestmount.pod:225
28877 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28881 #: ../fuse/guestmount.pod:229
28882 msgid "Enable SELinux support for the guest."
28886 #: ../fuse/guestmount.pod:231
28887 msgid "B<-v> | B<--verbose>"
28891 #: ../fuse/guestmount.pod:233
28892 msgid "Enable verbose messages from underlying libguestfs."
28896 #: ../fuse/guestmount.pod:235
28897 msgid "B<-V> | B<--version>"
28901 #: ../fuse/guestmount.pod:237
28902 msgid "Display the program version and exit."
28906 #: ../fuse/guestmount.pod:239
28907 msgid "B<-w> | B<--rw>"
28911 #: ../fuse/guestmount.pod:244 ../fuse/guestmount.pod:265
28912 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28916 #: ../fuse/guestmount.pod:246
28917 msgid "B<-x> | B<--trace>"
28921 #: ../fuse/guestmount.pod:248
28922 msgid "Trace libguestfs calls and entry into each FUSE function."
28926 #: ../fuse/guestmount.pod:250
28927 msgid "This also stops the daemon from forking into the background."
28931 #: ../fuse/guestmount.pod:271
28933 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28934 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28939 #: ../fuse/guestmount.pod:286
28940 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28944 #: ../tools/virt-win-reg.pl:37
28946 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
28950 #: ../tools/virt-win-reg.pl:41
28953 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28958 #: ../tools/virt-win-reg.pl:43
28961 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28966 #: ../tools/virt-win-reg.pl:45
28969 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28974 #: ../tools/virt-win-reg.pl:47
28977 " virt-win-reg --merge domname [input.reg ...]\n"
28982 #: ../tools/virt-win-reg.pl:49
28985 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28990 #: ../tools/virt-win-reg.pl:53
28992 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
28993 "virtual machines. If you do this, you I<will> get irreversible disk "
28994 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28995 "but doesn't catch all cases."
28999 #: ../tools/virt-win-reg.pl:58
29001 "Modifying the Windows Registry is an inherently risky operation. The format "
29002 "is deliberately obscure and undocumented, and Registry changes can leave the "
29003 "system unbootable. Therefore when using the I<--merge> option, make sure "
29004 "you have a reliable backup first."
29008 #: ../tools/virt-win-reg.pl:65
29010 "This program can export and merge Windows Registry entries from a Windows "
29015 #: ../tools/virt-win-reg.pl:68
29017 "The first parameter is the libvirt guest name or the raw disk image of a "
29022 #: ../tools/virt-win-reg.pl:71
29024 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29025 "exported (recursively). For example:"
29029 #: ../tools/virt-win-reg.pl:74
29032 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29037 #: ../tools/virt-win-reg.pl:76
29039 "You can also display single values from within registry keys, for example:"
29043 #: ../tools/virt-win-reg.pl:79
29046 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29047 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29048 " Windows 7 Enterprise\n"
29053 #: ../tools/virt-win-reg.pl:83
29055 "With I<--merge>, you can merge a textual regedit file into the Windows "
29060 #: ../tools/virt-win-reg.pl:86
29063 " $ virt-win-reg --merge Windows7 changes.reg\n"
29068 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29073 #: ../tools/virt-win-reg.pl:90
29075 "This program is only meant for simple access to the registry. If you want "
29076 "to do complicated things with the registry, we suggest you download the "
29077 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29078 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29079 "L<hivexregedit(1)>."
29083 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
29084 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
29085 #: ../tools/virt-list-partitions.pl:64
29086 msgid "Display brief help."
29090 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
29091 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
29092 #: ../tools/virt-list-partitions.pl:72
29093 msgid "Display version number and exit."
29097 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29102 #: ../tools/virt-win-reg.pl:122
29103 msgid "Enable debugging messages."
29107 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
29108 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29109 msgid "B<--connect URI> | B<-c URI>"
29113 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
29114 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29116 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29117 "to the default libvirt hypervisor."
29121 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
29122 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29124 "If you specify guest block devices directly, then libvirt is not used at all."
29128 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
29129 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29130 msgid "B<--format> raw"
29134 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
29135 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29137 "Specify the format of disk images given on the command line. If this is "
29138 "omitted then the format is autodetected from the content of the disk image."
29142 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
29143 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29145 "If disk images are requested from libvirt, then this program asks libvirt "
29146 "for this information. In this case, the value of the format parameter is "
29151 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
29152 #: ../tools/virt-tar.pl:149 ../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-win-reg.pl:157
29164 #: ../tools/virt-win-reg.pl:159
29166 "In merge mode, this merges a textual regedit file into the Windows Registry "
29167 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29168 "displays or exports Registry entries instead."
29172 #: ../tools/virt-win-reg.pl:163
29174 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29175 "result in disk corruption. However exporting (without this flag) is always "
29180 #: ../tools/virt-win-reg.pl:171
29181 msgid "B<--encoding> UTF-16LE|ASCII"
29185 #: ../tools/virt-win-reg.pl:173
29187 "When merging (only), you may need to specify the encoding for strings to be "
29188 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29189 "(3)/ENCODING STRINGS>."
29193 #: ../tools/virt-win-reg.pl:177
29195 "The default is to use UTF-16LE, which should work with recent versions of "
29200 #: ../tools/virt-win-reg.pl:402
29201 msgid "SUPPORTED SYSTEMS"
29205 #: ../tools/virt-win-reg.pl:404
29207 "The program currently supports Windows NT-derived guests starting with "
29208 "Windows XP through to at least Windows 7."
29212 #: ../tools/virt-win-reg.pl:407
29214 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29215 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29216 "and C<HKEY_USERS\\.DEFAULT>."
29220 #: ../tools/virt-win-reg.pl:411
29222 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29227 #: ../tools/virt-win-reg.pl:414
29229 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29234 #: ../tools/virt-win-reg.pl:417
29239 #: ../tools/virt-win-reg.pl:419
29241 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29242 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29243 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29244 "Windows-style line endings, you may need to reencode the whole file before "
29245 "or after processing."
29249 #: ../tools/virt-win-reg.pl:425
29251 "To reencode a file from Windows format to Linux (before processing it with "
29252 "the I<--merge> option), you would do something like this:"
29256 #: ../tools/virt-win-reg.pl:428
29259 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29264 #: ../tools/virt-win-reg.pl:430
29266 "To go in the opposite direction, after exporting and before sending the file "
29267 "to a Windows user, do something like this:"
29271 #: ../tools/virt-win-reg.pl:433
29274 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29279 #: ../tools/virt-win-reg.pl:435
29280 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29284 #: ../tools/virt-win-reg.pl:437
29286 "If you are unsure about the current encoding, use the L<file(1)> command. "
29287 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29288 "style (CRLF) line endings, like this:"
29292 #: ../tools/virt-win-reg.pl:441
29295 " $ file software.reg\n"
29296 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29297 " with CRLF line terminators\n"
29302 #: ../tools/virt-win-reg.pl:445
29303 msgid "This file would need conversion before you could I<--merge> it."
29307 #: ../tools/virt-win-reg.pl:447
29308 msgid "CurrentControlSet etc."
29312 #: ../tools/virt-win-reg.pl:449
29314 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29315 "Registry at the level of the hive file, and therefore you cannot modify "
29320 #: ../tools/virt-win-reg.pl:453
29322 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29323 "circumstances it might refer to another control set. The way to find out is "
29324 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29328 #: ../tools/virt-win-reg.pl:457
29331 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29332 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29333 " \"Current\"=dword:00000001\n"
29334 " \"Default\"=dword:00000001\n"
29335 " \"Failed\"=dword:00000000\n"
29336 " \"LastKnownGood\"=dword:00000002\n"
29341 #: ../tools/virt-win-reg.pl:464
29342 msgid "\"Current\" is the one which Windows will choose when it boots."
29346 #: ../tools/virt-win-reg.pl:466
29348 "Similarly, other C<Current...> keys in the path may need to be replaced."
29352 #: ../tools/virt-win-reg.pl:469
29353 msgid "WINDOWS TIPS"
29357 #: ../tools/virt-win-reg.pl:471
29359 "Note that some of these tips modify the guest disk image. The guest I<must> "
29360 "be shut off, else you will get disk corruption."
29364 #: ../tools/virt-win-reg.pl:474
29365 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29369 #: ../tools/virt-win-reg.pl:476
29371 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29372 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29373 "is uploaded into C<C:\\>:"
29377 #: ../tools/virt-win-reg.pl:480
29380 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29385 #: ../tools/virt-win-reg.pl:482
29386 msgid "Prepare a regedit file containing the registry change:"
29390 #: ../tools/virt-win-reg.pl:484
29393 " cat > test.reg <<'EOF'\n"
29394 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29395 " \"Test\"=\"c:\\\\test.bat\"\n"
29401 #: ../tools/virt-win-reg.pl:489
29403 "In this example we use the key C<RunOnce> which means that the script will "
29404 "run precisely once when the first user logs in. If you want it to run every "
29405 "time a user logs in, replace C<RunOnce> with C<Run>."
29409 #: ../tools/virt-win-reg.pl:493
29410 msgid "Now update the registry:"
29414 #: ../tools/virt-win-reg.pl:495
29417 " virt-win-reg --merge WindowsGuest test.reg\n"
29422 #: ../tools/virt-win-reg.pl:497
29423 msgid "INSTALLING A SERVICE"
29427 #: ../tools/virt-win-reg.pl:499
29429 "This section assumes you are familiar with Windows services, and you either "
29430 "have a program which handles the Windows Service Control Protocol directly "
29431 "or you want to run any program using a service wrapper like SrvAny or the "
29436 #: ../tools/virt-win-reg.pl:504
29438 "First upload the program and optionally the service wrapper. In this case "
29439 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29443 #: ../tools/virt-win-reg.pl:508
29446 " guestfish -i -d WindowsGuest <<EOF\n"
29447 " upload rhsrvany.exe /rhsrvany.exe\n"
29448 " upload test.exe /test.exe\n"
29454 #: ../tools/virt-win-reg.pl:513
29456 "Prepare a regedit file containing the registry changes. In this example, "
29457 "the first registry change is needed for the service itself or the service "
29458 "wrapper (if used). The second registry change is only needed because I am "
29459 "using the RHSrvAny service wrapper."
29463 #: ../tools/virt-win-reg.pl:518
29466 " cat > service.reg <<'EOF'\n"
29467 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29468 " \"Type\"=dword:00000010\n"
29469 " \"Start\"=dword:00000002\n"
29470 " \"ErrorControl\"=dword:00000001\n"
29471 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29472 " \"DisplayName\"=\"RHSrvAny\"\n"
29473 " \"ObjectName\"=\"NetworkService\"\n"
29478 #: ../tools/virt-win-reg.pl:527
29481 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29482 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29483 " \"PWD\"=\"c:\\\\Temp\"\n"
29489 #: ../tools/virt-win-reg.pl:538
29491 "For use of C<ControlSet001> see the section above in this manual page. You "
29492 "may need to adjust this according to the control set that is in use by the "
29497 #: ../tools/virt-win-reg.pl:544
29499 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29500 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29501 "privileged account."
29505 #: ../tools/virt-win-reg.pl:550
29507 "For the meaning of the magic numbers, see this Microsoft KB article: "
29508 "L<http://support.microsoft.com/kb/103000>."
29512 #: ../tools/virt-win-reg.pl:555
29513 msgid "Update the registry:"
29517 #: ../tools/virt-win-reg.pl:557
29520 " virt-win-reg --merge WindowsGuest service.reg\n"
29525 #: ../tools/virt-win-reg.pl:559 ../tools/virt-list-filesystems.pl:182
29526 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
29527 #: ../tools/virt-list-partitions.pl:250
29528 msgid "SHELL QUOTING"
29532 #: ../tools/virt-win-reg.pl:561
29534 "Be careful when passing parameters containing C<\\> (backslash) in the "
29535 "shell. Usually you will have to use 'single quotes' or double backslashes "
29536 "(but not both) to protect them from the shell."
29540 #: ../tools/virt-win-reg.pl:565
29541 msgid "Paths and value names are case-insensitive."
29545 #: ../tools/virt-win-reg.pl:567 ../tools/virt-list-filesystems.pl:184
29546 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
29547 #: ../tools/virt-list-partitions.pl:252
29549 "Libvirt guest names can contain arbitrary characters, some of which have "
29550 "meaning to the shell such as C<#> and space. You may need to quote or "
29551 "escape these characters on the command line. See the shell manual page L<sh"
29552 "(1)> for details."
29556 #: ../tools/virt-win-reg.pl:574
29558 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
29559 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
29560 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29564 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29566 "When reporting bugs, please enable debugging and capture the I<complete> "
29571 #: ../tools/virt-win-reg.pl:592
29574 " export LIBGUESTFS_DEBUG=1\n"
29575 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29580 #: ../tools/virt-win-reg.pl:595
29582 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
29587 #: ../tools/virt-win-reg.pl:598 ../tools/virt-list-filesystems.pl:202
29588 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
29589 #: ../tools/virt-list-partitions.pl:269
29594 #: ../tools/virt-win-reg.pl:600 ../tools/virt-list-filesystems.pl:204
29595 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
29596 #: ../tools/virt-list-partitions.pl:271
29597 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29601 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29602 msgid "Copyright (C) 2010 Red Hat Inc."
29606 #: ../tools/virt-list-filesystems.pl:32
29608 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29612 #: ../tools/virt-list-filesystems.pl:36
29615 " virt-list-filesystems [--options] domname\n"
29620 #: ../tools/virt-list-filesystems.pl:38
29623 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29628 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29630 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29635 #: ../tools/virt-list-filesystems.pl:45
29637 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29638 "are contained in a virtual machine or disk image."
29642 #: ../tools/virt-list-filesystems.pl:49
29644 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29645 "functionality. For more complex cases you should look at the L<guestfish(1)"
29650 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29651 msgid "B<-l> | B<--long>"
29655 #: ../tools/virt-list-filesystems.pl:108
29657 "With this option, C<virt-list-filesystems> displays the type of each "
29658 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29662 #: ../tools/virt-list-filesystems.pl:115
29663 msgid "B<-a> | B<--all>"
29667 #: ../tools/virt-list-filesystems.pl:117
29669 "Normally we only show mountable filesystems. If this option is given then "
29670 "swap devices are shown too."
29674 #: ../tools/virt-list-filesystems.pl:191
29676 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
29677 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
29678 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29682 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29683 msgid "Copyright (C) 2009 Red Hat Inc."
29687 #: ../tools/virt-tar.pl:33
29688 msgid "virt-tar - Extract or upload files to a virtual machine"
29692 #: ../tools/virt-tar.pl:37
29695 " virt-tar [--options] -x domname directory tarball\n"
29700 #: ../tools/virt-tar.pl:39
29703 " virt-tar [--options] -u domname tarball directory\n"
29708 #: ../tools/virt-tar.pl:41
29711 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29716 #: ../tools/virt-tar.pl:43
29719 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29724 #: ../tools/virt-tar.pl:47
29726 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
29727 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
29731 #: ../tools/virt-tar.pl:52
29732 msgid "Download C</home> from the VM into a local tarball:"
29736 #: ../tools/virt-tar.pl:54
29739 " virt-tar -x domname /home home.tar\n"
29744 #: ../tools/virt-tar.pl:56
29747 " virt-tar -zx domname /home home.tar.gz\n"
29752 #: ../tools/virt-tar.pl:58
29753 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29757 #: ../tools/virt-tar.pl:60
29760 " virt-tar -u domname uploadstuff.tar /tmp\n"
29765 #: ../tools/virt-tar.pl:62
29768 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29773 #: ../tools/virt-tar.pl:66
29775 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29776 "virtual machines. If you do this, you risk disk corruption in the VM. "
29777 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29781 #: ../tools/virt-tar.pl:71
29783 "You can use I<-x> (extract) on live virtual machines, but you might get "
29784 "inconsistent results or errors if there is filesystem activity inside the "
29785 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29786 "work, but the only way to guarantee consistent results is if the virtual "
29787 "machine is shut down."
29791 #: ../tools/virt-tar.pl:79
29793 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29794 "parts of a guest filesystem. There are many possibilities: making backups, "
29795 "uploading data files, snooping on guest activity, fixing or customizing "
29800 #: ../tools/virt-tar.pl:84
29802 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29803 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29804 "should look at the L<guestfish(1)> tool."
29808 #: ../tools/virt-tar.pl:88
29810 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29811 "its contents (recursively) from the virtual machine into a local tarball. "
29812 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29813 "virtual machine. You cannot use these two options together."
29817 #: ../tools/virt-tar.pl:94
29819 "In addition, you may need to use the I<-z> (gZip) option to enable "
29820 "compression. When uploading, you have to specify I<-z> if the upload file "
29821 "is compressed because virt-tar won't detect this on its own."
29825 #: ../tools/virt-tar.pl:98
29827 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29828 "example it cannot do PKZip files or bzip2 compression. If you want that "
29829 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29830 "the L<libguestfs(3)> API)."
29834 #: ../tools/virt-tar.pl:156
29835 msgid "B<-x> | B<--extract> | B<--download>"
29839 #: ../tools/virt-tar.pl:158
29840 msgid "B<-u> | B<--upload>"
29844 #: ../tools/virt-tar.pl:160
29846 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29851 #: ../tools/virt-tar.pl:163
29853 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29854 "Please read the L</WARNING> section above before using this option."
29858 #: ../tools/virt-tar.pl:167
29859 msgid "You must specify exactly one of these options."
29863 #: ../tools/virt-tar.pl:173
29864 msgid "B<-z> | B<--gzip>"
29868 #: ../tools/virt-tar.pl:175
29869 msgid "Specify that the input or output tarball is gzip-compressed."
29873 #: ../tools/virt-tar.pl:288
29875 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
29876 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
29877 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
29882 #: ../tools/virt-make-fs.pl:37
29883 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29887 #: ../tools/virt-make-fs.pl:41
29890 " virt-make-fs [--options] input.tar output.img\n"
29895 #: ../tools/virt-make-fs.pl:43
29898 " virt-make-fs [--options] input.tar.gz output.img\n"
29903 #: ../tools/virt-make-fs.pl:45
29906 " virt-make-fs [--options] directory output.img\n"
29911 #: ../tools/virt-make-fs.pl:49
29913 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29914 "archive or some files in a directory. It is similar to tools like L<mkisofs"
29915 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
29916 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
29917 "you want to attach these filesystems to existing virtual machines (eg. to "
29918 "import large amounts of read-only data to a VM)."
29922 #: ../tools/virt-make-fs.pl:57
29923 msgid "Basic usage is:"
29927 #: ../tools/virt-make-fs.pl:59
29930 " virt-make-fs input output\n"
29935 #: ../tools/virt-make-fs.pl:61
29937 "where C<input> is either a directory containing files that you want to add, "
29938 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29939 "C<output> is a disk image. The input type is detected automatically. The "
29940 "output disk image defaults to a raw ext2 image unless you specify extra "
29941 "flags (see L</OPTIONS> below)."
29945 #: ../tools/virt-make-fs.pl:67
29946 msgid "EXTRA SPACE"
29950 #: ../tools/virt-make-fs.pl:69
29952 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29953 "the files that it contains, but might have extra space. Depending on how "
29954 "you are going to use the output, you might think this extra space is wasted "
29955 "and want to minimize it, or you might want to leave space so that more files "
29956 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29957 "but you can use the I<--size> flag to leave space in the filesystem if you "
29962 #: ../tools/virt-make-fs.pl:77
29964 "An alternative way to leave extra space but not make the output image any "
29965 "bigger is to use an alternative disk image format (instead of the default "
29966 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29967 "image format (check your hypervisor supports this before using it). This "
29968 "allows you to choose a large I<--size> but the extra space won't actually be "
29969 "allocated in the image until you try to store something in it."
29973 #: ../tools/virt-make-fs.pl:85
29975 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29976 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29977 "to build another image from scratch."
29981 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
29982 #: ../tools/virt-make-fs.pl:142
29987 #: ../tools/virt-make-fs.pl:91
29990 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29995 #: ../tools/virt-make-fs.pl:93
29996 msgid "FILESYSTEM TYPE"
30000 #: ../tools/virt-make-fs.pl:95
30002 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30003 "libguestfs supports can be used (but I<not> read-only formats like "
30004 "ISO9660). Here are some of the more common choices:"
30008 #: ../tools/virt-make-fs.pl:101
30013 #: ../tools/virt-make-fs.pl:103
30015 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30016 "you are not going to use the filesystem in a way that requires the journal, "
30017 "then this is just wasted overhead."
30021 #: ../tools/virt-make-fs.pl:107
30022 msgid "I<ntfs> or I<vfat>"
30026 #: ../tools/virt-make-fs.pl:109
30027 msgid "Useful if exporting data to a Windows guest."
30031 #: ../tools/virt-make-fs.pl:111
30033 "I<Note for vfat>: The tar archive or local directory must only contain files "
30034 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30035 "program running within libguestfs is unable to change the ownership of non-"
30036 "root files, since vfat itself does not support this."
30040 #: ../tools/virt-make-fs.pl:116
30045 #: ../tools/virt-make-fs.pl:118
30047 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30048 "total filesystem size."
30052 #: ../tools/virt-make-fs.pl:125
30055 " virt-make-fs --type=minix input minixfs.img\n"
30060 #: ../tools/virt-make-fs.pl:127
30061 msgid "TO PARTITION OR NOT TO PARTITION"
30065 #: ../tools/virt-make-fs.pl:129
30066 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30070 #: ../tools/virt-make-fs.pl:131
30072 "Adding a partition can make the disk image more compatible with certain "
30073 "virtualized operating systems which don't expect to see a filesystem "
30074 "directly located on a block device (Linux doesn't care and will happily "
30075 "handle both types)."
30079 #: ../tools/virt-make-fs.pl:136
30081 "On the other hand, if you have a partition table then the output image is no "
30082 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30083 "directly on a partitioned disk image. (However libguestfs tools such as "
30084 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30088 #: ../tools/virt-make-fs.pl:144
30089 msgid "Add an MBR partition:"
30093 #: ../tools/virt-make-fs.pl:146
30096 " virt-make-fs --partition -- input disk.img\n"
30101 #: ../tools/virt-make-fs.pl:148
30103 "If the output disk image could be terabyte-sized or larger, it's better to "
30104 "use an EFI/GPT-compatible partition table:"
30108 #: ../tools/virt-make-fs.pl:151
30111 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30116 #: ../tools/virt-make-fs.pl:179
30117 msgid "Enable debugging information."
30121 #: ../tools/virt-make-fs.pl:185
30122 msgid "B<--size=E<lt>NE<gt>>"
30126 #: ../tools/virt-make-fs.pl:187
30127 msgid "B<--size=+E<lt>NE<gt>>"
30131 #: ../tools/virt-make-fs.pl:189
30132 msgid "B<-s E<lt>NE<gt>>"
30136 #: ../tools/virt-make-fs.pl:191
30137 msgid "B<-s +E<lt>NE<gt>>"
30141 #: ../tools/virt-make-fs.pl:193
30143 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30147 #: ../tools/virt-make-fs.pl:196
30149 "If this option is I<not> given, then the output image will be just large "
30150 "enough to contain all the files, with not much wasted space."
30154 #: ../tools/virt-make-fs.pl:199
30156 "To choose a fixed size output disk, specify an absolute number followed by b/"
30157 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30158 "Petabytes or Exabytes. This must be large enough to contain all the input "
30159 "files, else you will get an error."
30163 #: ../tools/virt-make-fs.pl:204
30165 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30166 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30167 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30168 "the input files, and (approximately) an extra 200 MB free space."
30172 #: ../tools/virt-make-fs.pl:210
30174 "Note that virt-make-fs estimates free space, and therefore will not produce "
30175 "filesystems containing precisely the free space requested. (It is much more "
30176 "expensive and time-consuming to produce a filesystem which has precisely the "
30177 "desired free space)."
30181 #: ../tools/virt-make-fs.pl:219
30182 msgid "B<--format=E<lt>fmtE<gt>>"
30186 #: ../tools/virt-make-fs.pl:221
30187 msgid "B<-F E<lt>fmtE<gt>>"
30191 #: ../tools/virt-make-fs.pl:223
30192 msgid "Choose the output disk image format."
30196 #: ../tools/virt-make-fs.pl:225
30197 msgid "The default is C<raw> (raw disk image)."
30201 #: ../tools/virt-make-fs.pl:227
30203 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30204 "that would really make sense here is C<qcow2>."
30208 #: ../tools/virt-make-fs.pl:234
30209 msgid "B<--type=E<lt>fsE<gt>>"
30213 #: ../tools/virt-make-fs.pl:236
30214 msgid "B<-t E<lt>fsE<gt>>"
30218 #: ../tools/virt-make-fs.pl:238
30219 msgid "Choose the output filesystem type."
30223 #: ../tools/virt-make-fs.pl:240
30224 msgid "The default is C<ext2>."
30228 #: ../tools/virt-make-fs.pl:242
30230 "Any filesystem which is supported read-write by libguestfs can be used here."
30234 #: ../tools/virt-make-fs.pl:249
30235 msgid "B<--partition>"
30239 #: ../tools/virt-make-fs.pl:251
30240 msgid "B<--partition=E<lt>parttypeE<gt>>"
30244 #: ../tools/virt-make-fs.pl:253
30246 "If specified, this flag adds an MBR partition table to the output disk image."
30250 #: ../tools/virt-make-fs.pl:256
30252 "You can change the partition table type, eg. I<--partition=gpt> for large "
30257 #: ../tools/virt-make-fs.pl:259
30259 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30260 "might consider the next parameter to be the partition type. For example:"
30264 #: ../tools/virt-make-fs.pl:263
30267 " virt-make-fs --partition input.tar ...\n"
30272 #: ../tools/virt-make-fs.pl:265
30274 "would cause virt-make-fs to think you wanted to use a partition type of "
30275 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30276 "dash) between options and the input file argument:"
30280 #: ../tools/virt-make-fs.pl:269
30283 " virt-make-fs --partition -- input.tar ...\n"
30288 #: ../tools/virt-make-fs.pl:541
30290 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30291 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30292 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30296 #: ../tools/virt-make-fs.pl:558
30299 " export LIBGUESTFS_DEBUG=1\n"
30300 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30305 #: ../tools/virt-make-fs.pl:561
30307 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30312 #: ../tools/virt-list-partitions.pl:32
30314 "virt-list-partitions - List partitions in a virtual machine or disk image"
30318 #: ../tools/virt-list-partitions.pl:36
30321 " virt-list-partitions [--options] domname\n"
30326 #: ../tools/virt-list-partitions.pl:38
30329 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30334 #: ../tools/virt-list-partitions.pl:45
30336 "C<virt-list-partitions> is a command line tool to list the partitions that "
30337 "are contained in a virtual machine or disk image. It is mainly useful as a "
30338 "first step to using L<virt-resize(1)>."
30342 #: ../tools/virt-list-partitions.pl:50
30344 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30345 "functionality. For more complex cases you should look at the L<guestfish(1)"
30350 #: ../tools/virt-list-partitions.pl:107
30351 msgid "B<-h> | B<--human-readable>"
30355 #: ../tools/virt-list-partitions.pl:109
30356 msgid "Show sizes in human-readable form (eg. \"1G\")."
30360 #: ../tools/virt-list-partitions.pl:117
30362 "With this option, C<virt-list-partitions> displays the type and size of each "
30363 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30367 #: ../tools/virt-list-partitions.pl:124
30368 msgid "B<-t> | B<--total>"
30372 #: ../tools/virt-list-partitions.pl:126
30374 "Display the total size of each block device (as a separate row or rows)."
30378 #: ../tools/virt-list-partitions.pl:259
30380 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30381 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30382 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30386 #: ../tools/virt-list-partitions.pl:275
30387 msgid "Copyright (C) 2009-2010 Red Hat Inc."