27f79f48a6818d21d90c0cf063c45e45ce19f0e8
[libguestfs.git] / po-docs / libguestfs-docs.pot
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.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: libguestfs 1.9.7\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-01-30 23:51+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
15 "Language: \n"
16 "MIME-Version: 1.0\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19
20 #. type: =head1
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
22 msgid "NAME"
23 msgstr ""
24
25 #. type: textblock
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
28 msgstr ""
29
30 #. type: =head1
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
32 msgid "SYNOPSIS"
33 msgstr ""
34
35 #. type: verbatim
36 #: ../src/guestfs.pod:9
37 #, no-wrap
38 msgid ""
39 " #include <guestfs.h>\n"
40 " \n"
41 msgstr ""
42
43 #. type: verbatim
44 #: ../src/guestfs.pod:11
45 #, no-wrap
46 msgid ""
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
54 "\n"
55 msgstr ""
56
57 #. type: verbatim
58 #: ../src/guestfs.pod:19
59 #, no-wrap
60 msgid ""
61 " cc prog.c -o prog -lguestfs\n"
62 "or:\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
64 "\n"
65 msgstr ""
66
67 #. type: =head1
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
69 msgid "DESCRIPTION"
70 msgstr ""
71
72 #. type: textblock
73 #: ../src/guestfs.pod:25
74 msgid ""
75 "Libguestfs is a library for accessing and modifying guest disk images.  "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
81 msgstr ""
82
83 #. type: textblock
84 #: ../src/guestfs.pod:33
85 msgid ""
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
89 "qcow2, vmdk."
90 msgstr ""
91
92 #. type: textblock
93 #: ../src/guestfs.pod:38
94 msgid ""
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.).  It can also run commands in the "
97 "context of the guest.  Also you can access filesystems over FUSE."
98 msgstr ""
99
100 #. type: textblock
101 #: ../src/guestfs.pod:43
102 msgid ""
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#).  You can also use it from shell scripts or the command "
106 "line."
107 msgstr ""
108
109 #. type: textblock
110 #: ../src/guestfs.pod:48
111 msgid ""
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
114 msgstr ""
115
116 #. type: textblock
117 #: ../src/guestfs.pod:51
118 msgid ""
119 "Libguestfs is a large API because it can do many things.  For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
121 msgstr ""
122
123 #. type: textblock
124 #: ../src/guestfs.pod:54
125 msgid ""
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
127 "page."
128 msgstr ""
129
130 #. type: =head1
131 #: ../src/guestfs.pod:57
132 msgid "API OVERVIEW"
133 msgstr ""
134
135 #. type: textblock
136 #: ../src/guestfs.pod:59
137 msgid ""
138 "This section provides a gentler overview of the libguestfs API.  We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
141 msgstr ""
142
143 #. type: =head2
144 #: ../src/guestfs.pod:64
145 msgid "HANDLES"
146 msgstr ""
147
148 #. type: textblock
149 #: ../src/guestfs.pod:66
150 msgid ""
151 "Before you can use libguestfs calls, you have to create a handle.  Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle.  By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
156 msgstr ""
157
158 #. type: textblock
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
161 msgstr ""
162
163 #. type: verbatim
164 #: ../src/guestfs.pod:76
165 #, no-wrap
166 msgid ""
167 " guestfs_h *g = guestfs_create ();\n"
168 " \n"
169 msgstr ""
170
171 #. type: verbatim
172 #: ../src/guestfs.pod:78
173 #, no-wrap
174 msgid ""
175 " /* Call guestfs_add_drive additional times if there are\n"
176 "  * multiple disk images.\n"
177 "  */\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
179 " \n"
180 msgstr ""
181
182 #. type: verbatim
183 #: ../src/guestfs.pod:83
184 #, no-wrap
185 msgid ""
186 " /* Most manipulation calls won't work until you've launched\n"
187 "  * the handle 'g'.  You have to do this _after_ adding drives\n"
188 "  * and _before_ other commands.\n"
189 "  */\n"
190 " guestfs_launch (g);\n"
191 " \n"
192 msgstr ""
193
194 #. type: verbatim
195 #: ../src/guestfs.pod:89
196 #, no-wrap
197 msgid ""
198 " /* Now you can examine what partitions, LVs etc are available.\n"
199 "  */\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
202 " \n"
203 msgstr ""
204
205 #. type: verbatim
206 #: ../src/guestfs.pod:94
207 #, no-wrap
208 msgid ""
209 " /* To access a filesystem in the image, you must mount it.\n"
210 "  */\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
212 " \n"
213 msgstr ""
214
215 #. type: verbatim
216 #: ../src/guestfs.pod:98
217 #, no-wrap
218 msgid ""
219 " /* Now you can perform filesystem actions on the guest\n"
220 "  * disk image.\n"
221 "  */\n"
222 " guestfs_touch (g, \"/hello\");\n"
223 "\n"
224 msgstr ""
225
226 #. type: verbatim
227 #: ../src/guestfs.pod:103
228 #, no-wrap
229 msgid ""
230 " /* This is only needed for libguestfs < 1.5.24.  Since then\n"
231 "  * it is done automatically when you close the handle.  See\n"
232 "  * discussion of autosync in this page.\n"
233 "  */\n"
234 " guestfs_sync (g);\n"
235 " \n"
236 msgstr ""
237
238 #. type: verbatim
239 #: ../src/guestfs.pod:109
240 #, no-wrap
241 msgid ""
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
244 "\n"
245 msgstr ""
246
247 #. type: textblock
248 #: ../src/guestfs.pod:112
249 msgid ""
250 "The code above doesn't include any error checking.  In real code you should "
251 "check return values carefully for errors.  In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error.  See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications.  See "
256 "L<guestfs-examples(3)> for fully worked examples."
257 msgstr ""
258
259 #. type: =head2
260 #: ../src/guestfs.pod:121
261 msgid "DISK IMAGES"
262 msgstr ""
263
264 #. type: textblock
265 #: ../src/guestfs.pod:123
266 msgid ""
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>.  Libguestfs lets you do useful things to all "
271 "of these."
272 msgstr ""
273
274 #. type: textblock
275 #: ../src/guestfs.pod:129
276 msgid ""
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>.  To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
280 msgstr ""
281
282 #. type: verbatim
283 #: ../src/guestfs.pod:133
284 #, no-wrap
285 msgid ""
286 " guestfs_add_drive_opts (g, filename,\n"
287 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
288 "                         -1);\n"
289 "\n"
290 msgstr ""
291
292 #. type: textblock
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
295 msgstr ""
296
297 #. type: verbatim
298 #: ../src/guestfs.pod:139
299 #, no-wrap
300 msgid ""
301 " guestfs_add_drive_opts (g, filename,\n"
302 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
304 "                         -1);\n"
305 "\n"
306 msgstr ""
307
308 #. type: textblock
309 #: ../src/guestfs.pod:144
310 msgid ""
311 "or by calling the older function L</guestfs_add_drive_ro>.  In either case "
312 "libguestfs won't modify the file."
313 msgstr ""
314
315 #. type: textblock
316 #: ../src/guestfs.pod:147
317 msgid ""
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine.  Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
321 msgstr ""
322
323 #. type: textblock
324 #: ../src/guestfs.pod:151
325 msgid ""
326 "You must add at least one disk image, and you may add multiple disk images.  "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
329 msgstr ""
330
331 #. type: textblock
332 #: ../src/guestfs.pod:156
333 msgid ""
334 "Once L</guestfs_launch> has been called you cannot add any more images.  You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them.  See also L</BLOCK DEVICE NAMING> below."
337 msgstr ""
338
339 #. type: =head2
340 #: ../src/guestfs.pod:161
341 msgid "MOUNTING"
342 msgstr ""
343
344 #. type: textblock
345 #: ../src/guestfs.pod:163
346 msgid ""
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>.  If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
352 msgstr ""
353
354 #. type: verbatim
355 #: ../src/guestfs.pod:170
356 #, no-wrap
357 msgid ""
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
359 "\n"
360 msgstr ""
361
362 #. type: textblock
363 #: ../src/guestfs.pod:172
364 msgid ""
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>).  If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>).  Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
369 "devices."
370 msgstr ""
371
372 #. type: textblock
373 #: ../src/guestfs.pod:178
374 msgid ""
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out.  Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>.  To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
381 msgstr ""
382
383 #. type: textblock
384 #: ../src/guestfs.pod:186
385 msgid ""
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below).  But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
389 msgstr ""
390
391 #. type: textblock
392 #: ../src/guestfs.pod:191
393 msgid ""
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>.  There are "
395 "several other variations of the C<guestfs_mount_*> call."
396 msgstr ""
397
398 #. type: =head2
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
401 msgstr ""
402
403 #. type: textblock
404 #: ../src/guestfs.pod:196
405 msgid ""
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems.  There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
411 msgstr ""
412
413 #. type: textblock
414 #: ../src/guestfs.pod:202
415 msgid ""
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
417 "mount point."
418 msgstr ""
419
420 #. type: textblock
421 #: ../src/guestfs.pod:205
422 msgid ""
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
425 msgstr ""
426
427 #. type: verbatim
428 #: ../src/guestfs.pod:208
429 #, no-wrap
430 msgid ""
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
432 "\n"
433 msgstr ""
434
435 #. type: textblock
436 #: ../src/guestfs.pod:210
437 msgid ""
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
441 msgstr ""
442
443 #. type: textblock
444 #: ../src/guestfs.pod:214
445 msgid ""
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
448 msgstr ""
449
450 #. type: verbatim
451 #: ../src/guestfs.pod:217
452 #, no-wrap
453 msgid ""
454 " guestfs_mkdir (g, \"/var\");\n"
455 "\n"
456 msgstr ""
457
458 #. type: textblock
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
461 msgstr ""
462
463 #. type: verbatim
464 #: ../src/guestfs.pod:221
465 #, no-wrap
466 msgid ""
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 "               \"/etc/rc3.d/S30portmap\");\n"
469 "\n"
470 msgstr ""
471
472 #. type: textblock
473 #: ../src/guestfs.pod:224
474 msgid ""
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
477 msgstr ""
478
479 #. type: textblock
480 #: ../src/guestfs.pod:227
481 msgid ""
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist.  If you are using the C API (documented here)  you have to "
485 "check for those error conditions after each call.  (Other language bindings "
486 "turn these errors into exceptions)."
487 msgstr ""
488
489 #. type: textblock
490 #: ../src/guestfs.pod:233
491 msgid ""
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022.  See L</UMASK>."
494 msgstr ""
495
496 #. type: =head2
497 #: ../src/guestfs.pod:236
498 msgid "PARTITIONING"
499 msgstr ""
500
501 #. type: textblock
502 #: ../src/guestfs.pod:238
503 msgid ""
504 "Libguestfs contains API calls to read, create and modify partition tables on "
505 "disk images."
506 msgstr ""
507
508 #. type: textblock
509 #: ../src/guestfs.pod:241
510 msgid ""
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
513 msgstr ""
514
515 #. type: verbatim
516 #: ../src/guestfs.pod:245
517 #, no-wrap
518 msgid ""
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 "   parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
523 "\n"
524 msgstr ""
525
526 #. type: textblock
527 #: ../src/guestfs.pod:250
528 msgid ""
529 "Obviously this effectively wipes anything that was on that disk image "
530 "before."
531 msgstr ""
532
533 #. type: =head2
534 #: ../src/guestfs.pod:253
535 msgid "LVM2"
536 msgstr ""
537
538 #. type: textblock
539 #: ../src/guestfs.pod:255
540 msgid ""
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>.  It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
545 msgstr ""
546
547 #. type: textblock
548 #: ../src/guestfs.pod:260
549 msgid ""
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
552 msgstr ""
553
554 #. type: =head2
555 #: ../src/guestfs.pod:263
556 msgid "DOWNLOADING"
557 msgstr ""
558
559 #. type: textblock
560 #: ../src/guestfs.pod:265
561 msgid ""
562 "Use L</guestfs_cat> to download small, text only files.  This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters.  However the API is very simple to use."
565 msgstr ""
566
567 #. type: textblock
568 #: ../src/guestfs.pod:269
569 msgid ""
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair.  However it is still "
572 "limited to \"small\" files, less than 2 MB."
573 msgstr ""
574
575 #. type: textblock
576 #: ../src/guestfs.pod:273
577 msgid ""
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
580 msgstr ""
581
582 #. type: textblock
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
585 msgstr ""
586
587 #. type: =head2
588 #: ../src/guestfs.pod:279
589 msgid "UPLOADING"
590 msgstr ""
591
592 #. type: textblock
593 #: ../src/guestfs.pod:281
594 msgid ""
595 "It's often the case that you want to write a file or files to the disk "
596 "image."
597 msgstr ""
598
599 #. type: textblock
600 #: ../src/guestfs.pod:284
601 msgid ""
602 "To write a small file with fixed content, use L</guestfs_write>.  To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated).  There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
607 msgstr ""
608
609 #. type: textblock
610 #: ../src/guestfs.pod:290
611 msgid ""
612 "To upload a single file, use L</guestfs_upload>.  This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
614 msgstr ""
615
616 #. type: textblock
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
619 msgstr ""
620
621 #. type: textblock
622 #: ../src/guestfs.pod:295
623 msgid ""
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>.  If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>.  Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs.  If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
633 msgstr ""
634
635 #. type: =head2
636 #: ../src/guestfs.pod:306
637 msgid "COPYING"
638 msgstr ""
639
640 #. type: textblock
641 #: ../src/guestfs.pod:308
642 msgid ""
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem.  These are summarised in the table "
645 "below."
646 msgstr ""
647
648 #. type: =item
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
651 msgstr ""
652
653 #. type: textblock
654 #: ../src/guestfs.pod:316
655 msgid ""
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
658 msgstr ""
659
660 #. type: =item
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
663 msgstr ""
664
665 #. type: textblock
666 #: ../src/guestfs.pod:321
667 msgid ""
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
670 msgstr ""
671
672 #. type: textblock
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
675 msgstr ""
676
677 #. type: verbatim
678 #: ../src/guestfs.pod:326
679 #, no-wrap
680 msgid ""
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
682 "\n"
683 msgstr ""
684
685 #. type: textblock
686 #: ../src/guestfs.pod:328
687 msgid ""
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>).  To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
691 msgstr ""
692
693 #. type: =item
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
696 msgstr ""
697
698 #. type: textblock
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>.  See L</UPLOADING> above."
701 msgstr ""
702
703 #. type: =item
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
706 msgstr ""
707
708 #. type: textblock
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>.  See L</DOWNLOADING> above."
711 msgstr ""
712
713 #. type: =head2
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
716 msgstr ""
717
718 #. type: textblock
719 #: ../src/guestfs.pod:344
720 msgid ""
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files.  However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
727 msgstr ""
728
729 #. type: textblock
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
732 msgstr ""
733
734 #. type: verbatim
735 #: ../src/guestfs.pod:355
736 #, no-wrap
737 msgid ""
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
739 "\n"
740 msgstr ""
741
742 #. type: textblock
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a pipe C<fd> by doing:"
745 msgstr ""
746
747 #. type: verbatim
748 #: ../src/guestfs.pod:359
749 #, no-wrap
750 msgid ""
751 " char devfd[64];\n"
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
754 "\n"
755 msgstr ""
756
757 #. type: =head2
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
760 msgstr ""
761
762 #. type: textblock
763 #: ../src/guestfs.pod:365
764 msgid ""
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
767 msgstr ""
768
769 #. type: textblock
770 #: ../src/guestfs.pod:368
771 msgid ""
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
774 msgstr ""
775
776 #. type: textblock
777 #: ../src/guestfs.pod:371
778 msgid ""
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one.  It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
782 msgstr ""
783
784 #. type: textblock
785 #: ../src/guestfs.pod:375
786 msgid ""
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
788 "files."
789 msgstr ""
790
791 #. type: =head2
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
794 msgstr ""
795
796 #. type: textblock
797 #: ../src/guestfs.pod:380
798 msgid ""
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
801 "guests."
802 msgstr ""
803
804 #. type: textblock
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
807 msgstr ""
808
809 #. type: =item
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1031 ../src/guestfs.pod:1035 ../src/guestfs.pod:1039 ../src/guestfs.pod:1044 ../src/guestfs.pod:1052 ../src/guestfs.pod:1071 ../src/guestfs.pod:1079 ../src/guestfs.pod:1101 ../src/guestfs.pod:1105 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1121 ../src/guestfs.pod:1603 ../src/guestfs.pod:1608 ../src/guestfs.pod:1612 ../src/guestfs.pod:1722 ../src/guestfs.pod:1727 ../src/guestfs.pod:1731 ../src/guestfs.pod:2083 ../src/guestfs.pod:2089 ../src/guestfs.pod:2094 ../src/guestfs.pod:2100 ../src/guestfs.pod:2565 ../src/guestfs.pod:2569 ../src/guestfs.pod:2573 ../src/guestfs.pod:2577 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
811 msgid "*"
812 msgstr ""
813
814 #. type: textblock
815 #: ../src/guestfs.pod:390
816 msgid ""
817 "The kernel version that the command runs under will be different from what "
818 "it expects."
819 msgstr ""
820
821 #. type: textblock
822 #: ../src/guestfs.pod:395
823 msgid ""
824 "If the command needs to communicate with daemons, then most likely they "
825 "won't be running."
826 msgstr ""
827
828 #. type: textblock
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
831 msgstr ""
832
833 #. type: textblock
834 #: ../src/guestfs.pod:404
835 msgid ""
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
838 msgstr ""
839
840 #. type: textblock
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
843 msgstr ""
844
845 #. type: textblock
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
848 msgstr ""
849
850 #. type: textblock
851 #: ../src/guestfs.pod:418
852 msgid ""
853 "For SELinux guests, you may need to enable SELinux and load policy first.  "
854 "See L</SELINUX> in this manpage."
855 msgstr ""
856
857 #. type: textblock
858 #: ../src/guestfs.pod:423
859 msgid ""
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests.  These commands may attempt to exploit your program by "
862 "sending unexpected output.  They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance.  They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls.  They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
867 msgstr ""
868
869 #. type: textblock
870 #: ../src/guestfs.pod:432
871 msgid ""
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on.  For information about other security issues, "
876 "see L</SECURITY>."
877 msgstr ""
878
879 #. type: textblock
880 #: ../src/guestfs.pod:440
881 msgid ""
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
884 msgstr ""
885
886 #. type: textblock
887 #: ../src/guestfs.pod:443
888 msgid ""
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
891 msgstr ""
892
893 #. type: =head2
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
896 msgstr ""
897
898 #. type: textblock
899 #: ../src/guestfs.pod:448
900 msgid ""
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas.  For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
905 msgstr ""
906
907 #. type: textblock
908 #: ../src/guestfs.pod:453
909 msgid ""
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
913 msgstr ""
914
915 #. type: textblock
916 #: ../src/guestfs.pod:457
917 msgid ""
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
920 "iterate over."
921 msgstr ""
922
923 #. type: =head2
924 #: ../src/guestfs.pod:461
925 msgid "SELINUX"
926 msgstr ""
927
928 #. type: textblock
929 #: ../src/guestfs.pod:463
930 msgid ""
931 "We support SELinux guests.  To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
933 msgstr ""
934
935 #. type: =item
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1224 ../src/guestfs.pod:1355 ../src/guestfs.pod:2128
937 msgid "1."
938 msgstr ""
939
940 #. type: textblock
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
943 msgstr ""
944
945 #. type: verbatim
946 #: ../src/guestfs.pod:473
947 #, no-wrap
948 msgid ""
949 " guestfs_set_selinux (g, 1);\n"
950 "\n"
951 msgstr ""
952
953 #. type: =item
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1228 ../src/guestfs.pod:1359 ../src/guestfs.pod:2153
955 msgid "2."
956 msgstr ""
957
958 #. type: textblock
959 #: ../src/guestfs.pod:477
960 msgid ""
961 "After mounting the guest's filesystem(s), load the policy.  This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
963 msgstr ""
964
965 #. type: verbatim
966 #: ../src/guestfs.pod:481
967 #, no-wrap
968 msgid ""
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
970 "\n"
971 msgstr ""
972
973 #. type: textblock
974 #: ../src/guestfs.pod:483
975 msgid ""
976 "(Older versions of C<load_policy> require you to specify the name of the "
977 "policy file)."
978 msgstr ""
979
980 #. type: =item
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1365
982 msgid "3."
983 msgstr ""
984
985 #. type: textblock
986 #: ../src/guestfs.pod:488
987 msgid ""
988 "Optionally, set the security context for the API.  The correct security "
989 "context to use can only be known by inspecting the guest.  As an example:"
990 msgstr ""
991
992 #. type: verbatim
993 #: ../src/guestfs.pod:492
994 #, no-wrap
995 msgid ""
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
997 "\n"
998 msgstr ""
999
1000 #. type: textblock
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1003 msgstr ""
1004
1005 #. type: textblock
1006 #: ../src/guestfs.pod:498
1007 msgid ""
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1010 msgstr ""
1011
1012 #. type: =head2
1013 #: ../src/guestfs.pod:502
1014 msgid "UMASK"
1015 msgstr ""
1016
1017 #. type: textblock
1018 #: ../src/guestfs.pod:504
1019 msgid ""
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\").  In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1024 "that you supply."
1025 msgstr ""
1026
1027 #. type: textblock
1028 #: ../src/guestfs.pod:510
1029 msgid ""
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1032 msgstr ""
1033
1034 #. type: textblock
1035 #: ../src/guestfs.pod:513
1036 msgid ""
1037 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching).  Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1040 msgstr ""
1041
1042 #. type: textblock
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1045 msgstr ""
1046
1047 #. type: =head1
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:746
1049 msgid "ENCRYPTED DISKS"
1050 msgstr ""
1051
1052 #. type: textblock
1053 #: ../src/guestfs.pod:521
1054 msgid ""
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard.  This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1059 msgstr ""
1060
1061 #. type: textblock
1062 #: ../src/guestfs.pod:527
1063 msgid ""
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1066 msgstr ""
1067
1068 #. type: textblock
1069 #: ../src/guestfs.pod:530
1070 msgid ""
1071 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
1072 "will require the passphrase!"
1073 msgstr ""
1074
1075 #. type: textblock
1076 #: ../src/guestfs.pod:533
1077 msgid ""
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>).  Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1082 msgstr ""
1083
1084 #. type: textblock
1085 #: ../src/guestfs.pod:539
1086 msgid ""
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
1089 "volume(s) can now be mounted in the usual way."
1090 msgstr ""
1091
1092 #. type: textblock
1093 #: ../src/guestfs.pod:543
1094 msgid ""
1095 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>.  Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1100 msgstr ""
1101
1102 #. type: =head2
1103 #: ../src/guestfs.pod:550
1104 msgid "INSPECTION"
1105 msgstr ""
1106
1107 #. type: textblock
1108 #: ../src/guestfs.pod:552
1109 msgid ""
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD.  (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1115 msgstr ""
1116
1117 #. type: textblock
1118 #: ../src/guestfs.pod:559
1119 msgid ""
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1122 msgstr ""
1123
1124 #. type: textblock
1125 #: ../src/guestfs.pod:562
1126 msgid ""
1127 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found.  An empty list means none were found.  A single element is the root "
1130 "filesystem of the operating system.  For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system.  (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1135 msgstr ""
1136
1137 #. type: textblock
1138 #: ../src/guestfs.pod:571
1139 msgid ""
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system.  For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1144 msgstr ""
1145
1146 #. type: textblock
1147 #: ../src/guestfs.pod:577
1148 msgid ""
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>).  The inspection rules are able to detect how "
1152 "filesystems correspond to mount points.  Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
1154 "hash table like this example:"
1155 msgstr ""
1156
1157 #. type: verbatim
1158 #: ../src/guestfs.pod:584
1159 #, no-wrap
1160 msgid ""
1161 " /boot => /dev/sda1\n"
1162 " /     => /dev/vg_guest/lv_root\n"
1163 " /usr  => /dev/vg_guest/lv_usr\n"
1164 "\n"
1165 msgstr ""
1166
1167 #. type: textblock
1168 #: ../src/guestfs.pod:588
1169 msgid ""
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1172 msgstr ""
1173
1174 #. type: textblock
1175 #: ../src/guestfs.pod:591
1176 msgid ""
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>).  Sorting the keys of the hash by length, shortest first, should "
1179 "work."
1180 msgstr ""
1181
1182 #. type: textblock
1183 #: ../src/guestfs.pod:595
1184 msgid ""
1185 "Inspection currently only works for some common operating systems.  "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1188 msgstr ""
1189
1190 #. type: textblock
1191 #: ../src/guestfs.pod:599
1192 msgid ""
1193 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
1194 "for more details.  The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1196 msgstr ""
1197
1198 #. type: textblock
1199 #: ../src/guestfs.pod:603
1200 msgid ""
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle.  Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks.  If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again.  "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks.  See documentation for that function "
1208 "for details)."
1209 msgstr ""
1210
1211 #. type: =head3
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1214 msgstr ""
1215
1216 #. type: textblock
1217 #: ../src/guestfs.pod:614
1218 msgid ""
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1220 "CDs and more."
1221 msgstr ""
1222
1223 #. type: textblock
1224 #: ../src/guestfs.pod:617
1225 msgid ""
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1229 msgstr ""
1230
1231 #. type: textblock
1232 #: ../src/guestfs.pod:621
1233 msgid ""
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1237 "etc."
1238 msgstr ""
1239
1240 #. type: textblock
1241 #: ../src/guestfs.pod:626
1242 msgid ""
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1246 msgstr ""
1247
1248 #. type: =head2
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1251 msgstr ""
1252
1253 #. type: textblock
1254 #: ../src/guestfs.pod:633
1255 msgid ""
1256 "Libguestfs can mount NTFS partitions.  It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1258 msgstr ""
1259
1260 #. type: =head3
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1263 msgstr ""
1264
1265 #. type: textblock
1266 #: ../src/guestfs.pod:638
1267 msgid ""
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1273 msgstr ""
1274
1275 #. type: textblock
1276 #: ../src/guestfs.pod:644
1277 msgid ""
1278 "Drive letter mappings are outside the scope of libguestfs.  You have to use "
1279 "libguestfs to read the appropriate Windows Registry and configuration files, "
1280 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1281 "L<virt-inspector(1)>)."
1282 msgstr ""
1283
1284 #. type: textblock
1285 #: ../src/guestfs.pod:649
1286 msgid ""
1287 "Replacing backslash characters with forward slash characters is also outside "
1288 "the scope of libguestfs, but something that you can easily do."
1289 msgstr ""
1290
1291 #. type: textblock
1292 #: ../src/guestfs.pod:652
1293 msgid ""
1294 "Where we can help is in resolving the case insensitivity of paths.  For "
1295 "this, call L</guestfs_case_sensitive_path>."
1296 msgstr ""
1297
1298 #. type: =head3
1299 #: ../src/guestfs.pod:655
1300 msgid "ACCESSING THE WINDOWS REGISTRY"
1301 msgstr ""
1302
1303 #. type: textblock
1304 #: ../src/guestfs.pod:657
1305 msgid ""
1306 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1307 "files, through the library C<hivex> which is part of the libguestfs project "
1308 "although ships as a separate tarball.  You have to locate and download the "
1309 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
1310 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1311 "L<virt-win-reg(1)> for more help on this issue."
1312 msgstr ""
1313
1314 #. type: =head3
1315 #: ../src/guestfs.pod:665
1316 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1317 msgstr ""
1318
1319 #. type: textblock
1320 #: ../src/guestfs.pod:667
1321 msgid ""
1322 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1323 "provide something which looks like a Linux symlink.  The way it tries to do "
1324 "the rewriting is described here:"
1325 msgstr ""
1326
1327 #. type: textblock
1328 #: ../src/guestfs.pod:671
1329 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1330 msgstr ""
1331
1332 #. type: textblock
1333 #: ../src/guestfs.pod:673
1334 msgid ""
1335 "The essential problem is that ntfs-3g simply does not have enough "
1336 "information to do a correct job.  NTFS links can contain drive letters and "
1337 "references to external device GUIDs that ntfs-3g has no way of resolving.  "
1338 "It is almost certainly the case that libguestfs callers should ignore what "
1339 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1340 msgstr ""
1341
1342 #. type: textblock
1343 #: ../src/guestfs.pod:680
1344 msgid ""
1345 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1346 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1347 "attribute, and read the raw reparse data from that (you can find the format "
1348 "documented in various places around the web)."
1349 msgstr ""
1350
1351 #. type: =head3
1352 #: ../src/guestfs.pod:685
1353 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1354 msgstr ""
1355
1356 #. type: textblock
1357 #: ../src/guestfs.pod:687
1358 msgid ""
1359 "There are other useful extended attributes that can be read from ntfs-3g "
1360 "filesystems (using L</guestfs_getxattr>).  See:"
1361 msgstr ""
1362
1363 #. type: textblock
1364 #: ../src/guestfs.pod:690
1365 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1366 msgstr ""
1367
1368 #. type: =head2
1369 #: ../src/guestfs.pod:692
1370 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1371 msgstr ""
1372
1373 #. type: textblock
1374 #: ../src/guestfs.pod:694
1375 msgid ""
1376 "Although we don't want to discourage you from using the C API, we will "
1377 "mention here that the same API is also available in other languages."
1378 msgstr ""
1379
1380 #. type: textblock
1381 #: ../src/guestfs.pod:697
1382 msgid ""
1383 "The API is broadly identical in all supported languages.  This means that "
1384 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1385 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1386 "OCaml.  In other words, a straightforward, predictable isomorphism between "
1387 "each language."
1388 msgstr ""
1389
1390 #. type: textblock
1391 #: ../src/guestfs.pod:703
1392 msgid ""
1393 "Error messages are automatically transformed into exceptions if the language "
1394 "supports it."
1395 msgstr ""
1396
1397 #. type: textblock
1398 #: ../src/guestfs.pod:706
1399 msgid ""
1400 "We don't try to \"object orientify\" parts of the API in OO languages, "
1401 "although contributors are welcome to write higher level APIs above what we "
1402 "provide in their favourite languages if they wish."
1403 msgstr ""
1404
1405 #. type: =item
1406 #: ../src/guestfs.pod:712
1407 msgid "B<C++>"
1408 msgstr ""
1409
1410 #. type: textblock
1411 #: ../src/guestfs.pod:714
1412 msgid ""
1413 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
1414 "identical to the C API.  C++ classes and exceptions are not used."
1415 msgstr ""
1416
1417 #. type: =item
1418 #: ../src/guestfs.pod:718
1419 msgid "B<C#>"
1420 msgstr ""
1421
1422 #. type: textblock
1423 #: ../src/guestfs.pod:720
1424 msgid ""
1425 "The C# bindings are highly experimental.  Please read the warnings at the "
1426 "top of C<csharp/Libguestfs.cs>."
1427 msgstr ""
1428
1429 #. type: =item
1430 #: ../src/guestfs.pod:723
1431 msgid "B<Haskell>"
1432 msgstr ""
1433
1434 #. type: textblock
1435 #: ../src/guestfs.pod:725
1436 msgid ""
1437 "This is the only language binding that is working but incomplete.  Only "
1438 "calls which return simple integers have been bound in Haskell, and we are "
1439 "looking for help to complete this binding."
1440 msgstr ""
1441
1442 #. type: =item
1443 #: ../src/guestfs.pod:729
1444 msgid "B<Java>"
1445 msgstr ""
1446
1447 #. type: textblock
1448 #: ../src/guestfs.pod:731
1449 msgid ""
1450 "Full documentation is contained in the Javadoc which is distributed with "
1451 "libguestfs."
1452 msgstr ""
1453
1454 #. type: =item
1455 #: ../src/guestfs.pod:734
1456 msgid "B<OCaml>"
1457 msgstr ""
1458
1459 #. type: textblock
1460 #: ../src/guestfs.pod:736
1461 msgid "See L<guestfs-ocaml(3)>."
1462 msgstr ""
1463
1464 #. type: =item
1465 #: ../src/guestfs.pod:738
1466 msgid "B<Perl>"
1467 msgstr ""
1468
1469 #. type: textblock
1470 #: ../src/guestfs.pod:740
1471 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1472 msgstr ""
1473
1474 #. type: =item
1475 #: ../src/guestfs.pod:742
1476 msgid "B<PHP>"
1477 msgstr ""
1478
1479 #. type: textblock
1480 #: ../src/guestfs.pod:744
1481 msgid ""
1482 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1483 "the php-libguestfs package for your distribution."
1484 msgstr ""
1485
1486 #. type: textblock
1487 #: ../src/guestfs.pod:747
1488 msgid "The PHP binding only works correctly on 64 bit machines."
1489 msgstr ""
1490
1491 #. type: =item
1492 #: ../src/guestfs.pod:749
1493 msgid "B<Python>"
1494 msgstr ""
1495
1496 #. type: textblock
1497 #: ../src/guestfs.pod:751
1498 msgid "See L<guestfs-python(3)>."
1499 msgstr ""
1500
1501 #. type: =item
1502 #: ../src/guestfs.pod:753
1503 msgid "B<Ruby>"
1504 msgstr ""
1505
1506 #. type: textblock
1507 #: ../src/guestfs.pod:755
1508 msgid "See L<guestfs-ruby(3)>."
1509 msgstr ""
1510
1511 #. type: =item
1512 #: ../src/guestfs.pod:757
1513 msgid "B<shell scripts>"
1514 msgstr ""
1515
1516 #. type: textblock
1517 #: ../src/guestfs.pod:759
1518 msgid "See L<guestfish(1)>."
1519 msgstr ""
1520
1521 #. type: =head2
1522 #: ../src/guestfs.pod:763
1523 msgid "LIBGUESTFS GOTCHAS"
1524 msgstr ""
1525
1526 #. type: textblock
1527 #: ../src/guestfs.pod:765
1528 msgid ""
1529 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1530 "system [...] that works in the way it is documented but is counterintuitive "
1531 "and almost invites mistakes.\""
1532 msgstr ""
1533
1534 #. type: textblock
1535 #: ../src/guestfs.pod:769
1536 msgid ""
1537 "Since we developed libguestfs and the associated tools, there are several "
1538 "things we would have designed differently, but are now stuck with for "
1539 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
1540 "release, you can expect these to change.  Beware of them."
1541 msgstr ""
1542
1543 #. type: =item
1544 #: ../src/guestfs.pod:777
1545 msgid "Autosync / forgetting to sync."
1546 msgstr ""
1547
1548 #. type: textblock
1549 #: ../src/guestfs.pod:779
1550 msgid ""
1551 "When modifying a filesystem from C or another language, you B<must> unmount "
1552 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1553 "libguestfs handle.  You can also call:"
1554 msgstr ""
1555
1556 #. type: verbatim
1557 #: ../src/guestfs.pod:783
1558 #, no-wrap
1559 msgid ""
1560 " guestfs_set_autosync (g, 1);\n"
1561 "\n"
1562 msgstr ""
1563
1564 #. type: textblock
1565 #: ../src/guestfs.pod:785
1566 msgid ""
1567 "to have the unmount/sync done automatically for you when the handle 'g' is "
1568 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
1569 "q.v.)"
1570 msgstr ""
1571
1572 #. type: textblock
1573 #: ../src/guestfs.pod:789
1574 msgid ""
1575 "If you forget to do this, then it is entirely possible that your changes "
1576 "won't be written out, or will be partially written, or (very rarely) that "
1577 "you'll get disk corruption."
1578 msgstr ""
1579
1580 #. type: textblock
1581 #: ../src/guestfs.pod:793
1582 msgid ""
1583 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
1584 "guestfish scripts that forget to sync will work just fine, which can make "
1585 "this very puzzling if you are trying to debug a problem."
1586 msgstr ""
1587
1588 #. type: textblock
1589 #: ../src/guestfs.pod:797
1590 msgid ""
1591 "Update: Autosync is enabled by default for all API users starting from "
1592 "libguestfs 1.5.24."
1593 msgstr ""
1594
1595 #. type: =item
1596 #: ../src/guestfs.pod:800
1597 msgid "Mount option C<-o sync> should not be the default."
1598 msgstr ""
1599
1600 #. type: textblock
1601 #: ../src/guestfs.pod:802
1602 msgid ""
1603 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
1604 "However C<-o sync> does not add any reliability benefit, but does have a "
1605 "very large performance impact."
1606 msgstr ""
1607
1608 #. type: textblock
1609 #: ../src/guestfs.pod:806
1610 msgid ""
1611 "The work around is to use L</guestfs_mount_options> and set the mount "
1612 "options that you actually want to use."
1613 msgstr ""
1614
1615 #. type: =item
1616 #: ../src/guestfs.pod:809
1617 msgid "Read-only should be the default."
1618 msgstr ""
1619
1620 #. type: textblock
1621 #: ../src/guestfs.pod:811
1622 msgid ""
1623 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1624 "specify I<--rw> if you want to make changes to the image."
1625 msgstr ""
1626
1627 #. type: textblock
1628 #: ../src/guestfs.pod:814
1629 msgid "This would reduce the potential to corrupt live VM images."
1630 msgstr ""
1631
1632 #. type: textblock
1633 #: ../src/guestfs.pod:816
1634 msgid ""
1635 "Note that many filesystems change the disk when you just mount and unmount, "
1636 "even if you didn't perform any writes.  You need to use "
1637 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1638 msgstr ""
1639
1640 #. type: =item
1641 #: ../src/guestfs.pod:820
1642 msgid "guestfish command line is hard to use."
1643 msgstr ""
1644
1645 #. type: textblock
1646 #: ../src/guestfs.pod:822
1647 msgid ""
1648 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1649 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
1650 "exist, so it fails.  In earlier versions of guestfish the error message was "
1651 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
1652 "we should have used C<guestfish -c command> to run commands."
1653 msgstr ""
1654
1655 #. type: =item
1656 #: ../src/guestfs.pod:829
1657 msgid "guestfish megabyte modifiers don't work right on all commands"
1658 msgstr ""
1659
1660 #. type: textblock
1661 #: ../src/guestfs.pod:831
1662 msgid ""
1663 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1664 "other modifiers).  What guestfish actually does is to multiply the number "
1665 "part by the modifier part and pass the result to the C API.  However this "
1666 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1667 "expecting some other unit (eg. megabytes)."
1668 msgstr ""
1669
1670 #. type: textblock
1671 #: ../src/guestfs.pod:838
1672 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
1673 msgstr ""
1674
1675 #. type: verbatim
1676 #: ../src/guestfs.pod:840
1677 #, no-wrap
1678 msgid ""
1679 " lvcreate LV VG 100M\n"
1680 "\n"
1681 msgstr ""
1682
1683 #. type: textblock
1684 #: ../src/guestfs.pod:842
1685 msgid ""
1686 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
1687 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1688 "megabytes * megabytes) logical volume.  The error message you get from this "
1689 "is also a little obscure."
1690 msgstr ""
1691
1692 #. type: textblock
1693 #: ../src/guestfs.pod:847
1694 msgid ""
1695 "This could be fixed in the generator by specially marking parameters and "
1696 "return values which take bytes or other units."
1697 msgstr ""
1698
1699 #. type: =item
1700 #: ../src/guestfs.pod:850
1701 msgid "Ambiguity between devices and paths"
1702 msgstr ""
1703
1704 #. type: textblock
1705 #: ../src/guestfs.pod:852
1706 msgid ""
1707 "There is a subtle ambiguity in the API between a device name "
1708 "(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
1709 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1710 msgstr ""
1711
1712 #. type: textblock
1713 #: ../src/guestfs.pod:857
1714 msgid ""
1715 "In the current API we usually resolve this ambiguity by having two separate "
1716 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
1717 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1718 "detecting if the path supplied begins with C</dev/>."
1719 msgstr ""
1720
1721 #. type: textblock
1722 #: ../src/guestfs.pod:863
1723 msgid ""
1724 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1725 "make paths/devices into structured names.  One way to do this would be to "
1726 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1727 "aspect of grub.  Another way would be to use a structured type, equivalent "
1728 "to this OCaml type:"
1729 msgstr ""
1730
1731 #. type: verbatim
1732 #: ../src/guestfs.pod:869
1733 #, no-wrap
1734 msgid ""
1735 " type path = Path of string | Device of int | Partition of int * int\n"
1736 "\n"
1737 msgstr ""
1738
1739 #. type: textblock
1740 #: ../src/guestfs.pod:871
1741 msgid "which would allow you to pass arguments like:"
1742 msgstr ""
1743
1744 #. type: verbatim
1745 #: ../src/guestfs.pod:873
1746 #, no-wrap
1747 msgid ""
1748 " Path \"/foo/bar\"\n"
1749 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
1750 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1751 " Path \"/dev/sdb2\"    (* not a device *)\n"
1752 "\n"
1753 msgstr ""
1754
1755 #. type: textblock
1756 #: ../src/guestfs.pod:878
1757 msgid ""
1758 "As you can see there are still problems to resolve even with this "
1759 "representation.  Also consider how it might work in guestfish."
1760 msgstr ""
1761
1762 #. type: =head2
1763 #: ../src/guestfs.pod:883
1764 msgid "PROTOCOL LIMITS"
1765 msgstr ""
1766
1767 #. type: textblock
1768 #: ../src/guestfs.pod:885
1769 msgid ""
1770 "Internally libguestfs uses a message-based protocol to pass API calls and "
1771 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1772 "plenty more detail about this).  The maximum message size used by the "
1773 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
1774 "aware of this limit.  The API calls which may be affected are individually "
1775 "documented, with a link back to this section of the documentation."
1776 msgstr ""
1777
1778 #. type: textblock
1779 #: ../src/guestfs.pod:893
1780 msgid ""
1781 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1782 "a simple string.  Because this string is at some point internally encoded as "
1783 "a message, the maximum size that it can return is slightly under 4 MB.  If "
1784 "the requested file is larger than this then you will get an error."
1785 msgstr ""
1786
1787 #. type: textblock
1788 #: ../src/guestfs.pod:899
1789 msgid ""
1790 "In order to transfer large files into and out of the guest filesystem, you "
1791 "need to use particular calls that support this.  The sections L</UPLOADING> "
1792 "and L</DOWNLOADING> document how to do this."
1793 msgstr ""
1794
1795 #. type: textblock
1796 #: ../src/guestfs.pod:903
1797 msgid ""
1798 "You might also consider mounting the disk image using our FUSE filesystem "
1799 "support (L<guestmount(1)>)."
1800 msgstr ""
1801
1802 #. type: =head2
1803 #: ../src/guestfs.pod:906
1804 msgid "KEYS AND PASSPHRASES"
1805 msgstr ""
1806
1807 #. type: textblock
1808 #: ../src/guestfs.pod:908
1809 msgid ""
1810 "Certain libguestfs calls take a parameter that contains sensitive key "
1811 "material, passed in as a C string."
1812 msgstr ""
1813
1814 #. type: textblock
1815 #: ../src/guestfs.pod:911
1816 msgid ""
1817 "In the future we would hope to change the libguestfs implementation so that "
1818 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1819 "swap.  However this is I<not> done at the moment, because of the complexity "
1820 "of such an implementation."
1821 msgstr ""
1822
1823 #. type: textblock
1824 #: ../src/guestfs.pod:916
1825 msgid ""
1826 "Therefore you should be aware that any key parameter you pass to libguestfs "
1827 "might end up being written out to the swap partition.  If this is a concern, "
1828 "scrub the swap partition or don't use libguestfs on encrypted devices."
1829 msgstr ""
1830
1831 #. type: =head2
1832 #: ../src/guestfs.pod:921
1833 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1834 msgstr ""
1835
1836 #. type: textblock
1837 #: ../src/guestfs.pod:923
1838 msgid ""
1839 "All high-level libguestfs actions are synchronous.  If you want to use "
1840 "libguestfs asynchronously then you must create a thread."
1841 msgstr ""
1842
1843 #. type: textblock
1844 #: ../src/guestfs.pod:926
1845 msgid ""
1846 "Only use the handle from a single thread.  Either use the handle exclusively "
1847 "from one thread, or provide your own mutex so that two threads cannot issue "
1848 "calls on the same handle at the same time."
1849 msgstr ""
1850
1851 #. type: textblock
1852 #: ../src/guestfs.pod:930
1853 msgid ""
1854 "See the graphical program guestfs-browser for one possible architecture for "
1855 "multithreaded programs using libvirt and libguestfs."
1856 msgstr ""
1857
1858 #. type: =head2
1859 #: ../src/guestfs.pod:933
1860 msgid "PATH"
1861 msgstr ""
1862
1863 #. type: textblock
1864 #: ../src/guestfs.pod:935
1865 msgid ""
1866 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1867 "internal path."
1868 msgstr ""
1869
1870 #. type: textblock
1871 #: ../src/guestfs.pod:938
1872 msgid ""
1873 "By default it looks for these in the directory C<$libdir/guestfs> "
1874 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1875 msgstr ""
1876
1877 #. type: textblock
1878 #: ../src/guestfs.pod:941
1879 msgid ""
1880 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1881 "to change the directories that libguestfs will search in.  The value is a "
1882 "colon-separated list of paths.  The current directory is I<not> searched "
1883 "unless the path contains an empty element or C<.>.  For example "
1884 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1885 "then C</usr/lib/guestfs>."
1886 msgstr ""
1887
1888 #. type: =head2
1889 #: ../src/guestfs.pod:948
1890 msgid "QEMU WRAPPERS"
1891 msgstr ""
1892
1893 #. type: textblock
1894 #: ../src/guestfs.pod:950
1895 msgid ""
1896 "If you want to compile your own qemu, run qemu from a non-standard location, "
1897 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1898 "around qemu."
1899 msgstr ""
1900
1901 #. type: textblock
1902 #: ../src/guestfs.pod:954
1903 msgid ""
1904 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1905 "last command in the shell script (so that qemu replaces the shell and "
1906 "becomes the direct child of the libguestfs-using program).  If you don't do "
1907 "this, then the qemu process won't be cleaned up correctly."
1908 msgstr ""
1909
1910 #. type: textblock
1911 #: ../src/guestfs.pod:959
1912 msgid ""
1913 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1914 "source:"
1915 msgstr ""
1916
1917 #. type: verbatim
1918 #: ../src/guestfs.pod:962
1919 #, no-wrap
1920 msgid ""
1921 " #!/bin/sh -\n"
1922 " qemudir=/home/rjones/d/qemu\n"
1923 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1924 "\"$@\"\n"
1925 "\n"
1926 msgstr ""
1927
1928 #. type: textblock
1929 #: ../src/guestfs.pod:966
1930 msgid ""
1931 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1932 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
1933 "example:"
1934 msgstr ""
1935
1936 #. type: verbatim
1937 #: ../src/guestfs.pod:970
1938 #, no-wrap
1939 msgid ""
1940 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1941 "\n"
1942 msgstr ""
1943
1944 #. type: textblock
1945 #: ../src/guestfs.pod:972
1946 msgid ""
1947 "Note that libguestfs also calls qemu with the -help and -version options in "
1948 "order to determine features."
1949 msgstr ""
1950
1951 #. type: =head2
1952 #: ../src/guestfs.pod:975
1953 msgid "ABI GUARANTEE"
1954 msgstr ""
1955
1956 #. type: textblock
1957 #: ../src/guestfs.pod:977
1958 msgid ""
1959 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1960 "actions as outlined in this section.  Although we will deprecate some "
1961 "actions, for example if they get replaced by newer calls, we will keep the "
1962 "old actions forever.  This allows you the developer to program in confidence "
1963 "against the libguestfs API."
1964 msgstr ""
1965
1966 #. type: =head2
1967 #: ../src/guestfs.pod:983
1968 msgid "BLOCK DEVICE NAMING"
1969 msgstr ""
1970
1971 #. type: textblock
1972 #: ../src/guestfs.pod:985
1973 msgid ""
1974 "In the kernel there is now quite a profusion of schemata for naming block "
1975 "devices (in this context, by I<block device> I mean a physical or virtual "
1976 "hard drive).  The original Linux IDE driver used names starting with "
1977 "C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
1978 "C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
1979 "replacement for the old IDE driver (particularly for SATA devices) those "
1980 "devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
1981 "machines with paravirtualized drivers.  This has created several different "
1982 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1983 "Xen PV disks."
1984 msgstr ""
1985
1986 #. type: textblock
1987 #: ../src/guestfs.pod:997
1988 msgid ""
1989 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1990 "Linux kernel to access block devices.  We can run a variety of appliances "
1991 "based on a variety of Linux kernels."
1992 msgstr ""
1993
1994 #. type: textblock
1995 #: ../src/guestfs.pod:1001
1996 msgid ""
1997 "This causes a problem for libguestfs because many API calls use device or "
1998 "partition names.  Working scripts and the recipe (example) scripts that we "
1999 "make available over the internet could fail if the naming scheme changes."
2000 msgstr ""
2001
2002 #. type: textblock
2003 #: ../src/guestfs.pod:1006
2004 msgid ""
2005 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
2006 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2007 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2008 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2009 msgstr ""
2010
2011 #. type: textblock
2012 #: ../src/guestfs.pod:1012
2013 msgid ""
2014 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
2015 "L</guestfs_list_partitions> and similar calls return the true names of the "
2016 "devices and partitions as known to the appliance."
2017 msgstr ""
2018
2019 #. type: =head3
2020 #: ../src/guestfs.pod:1017
2021 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2022 msgstr ""
2023
2024 #. type: textblock
2025 #: ../src/guestfs.pod:1019
2026 msgid ""
2027 "Usually this translation is transparent.  However in some (very rare)  cases "
2028 "you may need to know the exact algorithm.  Such cases include where you use "
2029 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2030 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2031 "devices."
2032 msgstr ""
2033
2034 #. type: textblock
2035 #: ../src/guestfs.pod:1025
2036 msgid ""
2037 "The algorithm is applied only to I<parameters> which are known to be either "
2038 "device or partition names.  Return values from functions such as "
2039 "L</guestfs_list_devices> are never changed."
2040 msgstr ""
2041
2042 #. type: textblock
2043 #: ../src/guestfs.pod:1033
2044 msgid "Is the string a parameter which is a device or partition name?"
2045 msgstr ""
2046
2047 #. type: textblock
2048 #: ../src/guestfs.pod:1037
2049 msgid "Does the string begin with C</dev/sd>?"
2050 msgstr ""
2051
2052 #. type: textblock
2053 #: ../src/guestfs.pod:1041
2054 msgid ""
2055 "Does the named device exist? If so, we use that device.  However if I<not> "
2056 "then we continue with this algorithm."
2057 msgstr ""
2058
2059 #. type: textblock
2060 #: ../src/guestfs.pod:1046
2061 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2062 msgstr ""
2063
2064 #. type: textblock
2065 #: ../src/guestfs.pod:1048
2066 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2067 msgstr ""
2068
2069 #. type: textblock
2070 #: ../src/guestfs.pod:1050
2071 msgid "If that named device exists, use it.  If not, continue."
2072 msgstr ""
2073
2074 #. type: textblock
2075 #: ../src/guestfs.pod:1054
2076 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2077 msgstr ""
2078
2079 #. type: textblock
2080 #: ../src/guestfs.pod:1056
2081 msgid "If that named device exists, use it.  If not, return an error."
2082 msgstr ""
2083
2084 #. type: =head3
2085 #: ../src/guestfs.pod:1060
2086 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2087 msgstr ""
2088
2089 #. type: textblock
2090 #: ../src/guestfs.pod:1062
2091 msgid ""
2092 "Although the standard naming scheme and automatic translation is useful for "
2093 "simple programs and guestfish scripts, for larger programs it is best not to "
2094 "rely on this mechanism."
2095 msgstr ""
2096
2097 #. type: textblock
2098 #: ../src/guestfs.pod:1066
2099 msgid ""
2100 "Where possible for maximum future portability programs using libguestfs "
2101 "should use these future-proof techniques:"
2102 msgstr ""
2103
2104 #. type: textblock
2105 #: ../src/guestfs.pod:1073
2106 msgid ""
2107 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2108 "device names, and then use those names directly."
2109 msgstr ""
2110
2111 #. type: textblock
2112 #: ../src/guestfs.pod:1076
2113 msgid "Since those device names exist by definition, they will never be translated."
2114 msgstr ""
2115
2116 #. type: textblock
2117 #: ../src/guestfs.pod:1081
2118 msgid ""
2119 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2120 "filesystem labels."
2121 msgstr ""
2122
2123 #. type: =head1
2124 #: ../src/guestfs.pod:1086
2125 msgid "SECURITY"
2126 msgstr ""
2127
2128 #. type: textblock
2129 #: ../src/guestfs.pod:1088
2130 msgid ""
2131 "This section discusses security implications of using libguestfs, "
2132 "particularly with untrusted or malicious guests or disk images."
2133 msgstr ""
2134
2135 #. type: =head2
2136 #: ../src/guestfs.pod:1091
2137 msgid "GENERAL SECURITY CONSIDERATIONS"
2138 msgstr ""
2139
2140 #. type: textblock
2141 #: ../src/guestfs.pod:1093
2142 msgid ""
2143 "Be careful with any files or data that you download from a guest (by "
2144 "\"download\" we mean not just the L</guestfs_download> command but any "
2145 "command that reads files, filenames, directories or anything else from a "
2146 "disk image).  An attacker could manipulate the data to fool your program "
2147 "into doing the wrong thing.  Consider cases such as:"
2148 msgstr ""
2149
2150 #. type: textblock
2151 #: ../src/guestfs.pod:1103
2152 msgid "the data (file etc) not being present"
2153 msgstr ""
2154
2155 #. type: textblock
2156 #: ../src/guestfs.pod:1107
2157 msgid "being present but empty"
2158 msgstr ""
2159
2160 #. type: textblock
2161 #: ../src/guestfs.pod:1111
2162 msgid "being much larger than normal"
2163 msgstr ""
2164
2165 #. type: textblock
2166 #: ../src/guestfs.pod:1115
2167 msgid "containing arbitrary 8 bit data"
2168 msgstr ""
2169
2170 #. type: textblock
2171 #: ../src/guestfs.pod:1119
2172 msgid "being in an unexpected character encoding"
2173 msgstr ""
2174
2175 #. type: textblock
2176 #: ../src/guestfs.pod:1123
2177 msgid "containing homoglyphs."
2178 msgstr ""
2179
2180 #. type: =head2
2181 #: ../src/guestfs.pod:1127
2182 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2183 msgstr ""
2184
2185 #. type: textblock
2186 #: ../src/guestfs.pod:1129
2187 msgid ""
2188 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2189 "(VFS) module can sometimes be escalated into exploits by deliberately "
2190 "creating a malicious, malformed filesystem.  These exploits are very severe "
2191 "for two reasons.  Firstly there are very many filesystem drivers in the "
2192 "kernel, and many of them are infrequently used and not much developer "
2193 "attention has been paid to the code.  Linux userspace helps potential "
2194 "crackers by detecting the filesystem type and automatically choosing the "
2195 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2196 "the administrator.  Secondly, a kernel-level exploit is like a local root "
2197 "exploit (worse in some ways), giving immediate and total access to the "
2198 "system right down to the hardware level."
2199 msgstr ""
2200
2201 #. type: textblock
2202 #: ../src/guestfs.pod:1142
2203 msgid ""
2204 "That explains why you should never mount a filesystem from an untrusted "
2205 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
2206 "inside a qemu virtual machine, usually running as a non-root user.  The "
2207 "attacker would need to write a filesystem which first exploited the kernel, "
2208 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2209 "the libguestfs protocol, and finally to be as serious as the host kernel "
2210 "exploit it would need to escalate its privileges to root.  This multi-step "
2211 "escalation, performed by a static piece of data, is thought to be extremely "
2212 "hard to do, although we never say 'never' about security issues."
2213 msgstr ""
2214
2215 #. type: textblock
2216 #: ../src/guestfs.pod:1153
2217 msgid ""
2218 "In any case callers can reduce the attack surface by forcing the filesystem "
2219 "type when mounting (use L</guestfs_mount_vfs>)."
2220 msgstr ""
2221
2222 #. type: =head2
2223 #: ../src/guestfs.pod:1156
2224 msgid "PROTOCOL SECURITY"
2225 msgstr ""
2226
2227 #. type: textblock
2228 #: ../src/guestfs.pod:1158
2229 msgid ""
2230 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
2231 "defined upper message size.  However a program that uses libguestfs must "
2232 "also take care - for example you can write a program that downloads a binary "
2233 "from a disk image and executes it locally, and no amount of protocol "
2234 "security will save you from the consequences."
2235 msgstr ""
2236
2237 #. type: =head2
2238 #: ../src/guestfs.pod:1164
2239 msgid "INSPECTION SECURITY"
2240 msgstr ""
2241
2242 #. type: textblock
2243 #: ../src/guestfs.pod:1166
2244 msgid ""
2245 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2246 "directly from the guest, and these could contain any 8 bit data.  Callers "
2247 "should be careful to escape these before printing them to a structured file "
2248 "(for example, use HTML escaping if creating a web page)."
2249 msgstr ""
2250
2251 #. type: textblock
2252 #: ../src/guestfs.pod:1172
2253 msgid ""
2254 "Guest configuration may be altered in unusual ways by the administrator of "
2255 "the virtual machine, and may not reflect reality (particularly for untrusted "
2256 "or actively malicious guests).  For example we parse the hostname from "
2257 "configuration files like C</etc/sysconfig/network> that we find in the "
2258 "guest, but the guest administrator can easily manipulate these files to "
2259 "provide the wrong hostname."
2260 msgstr ""
2261
2262 #. type: textblock
2263 #: ../src/guestfs.pod:1180
2264 msgid ""
2265 "The inspection API parses guest configuration using two external libraries: "
2266 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
2267 "designed to be robust in the face of malicious data, although denial of "
2268 "service attacks are still possible, for example with oversized configuration "
2269 "files."
2270 msgstr ""
2271
2272 #. type: =head2
2273 #: ../src/guestfs.pod:1186
2274 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2275 msgstr ""
2276
2277 #. type: textblock
2278 #: ../src/guestfs.pod:1188
2279 msgid ""
2280 "Be very cautious about running commands from the guest.  By running a "
2281 "command in the guest, you are giving CPU time to a binary that you do not "
2282 "control, under the same user account as the library, albeit wrapped in qemu "
2283 "virtualization.  More information and alternatives can be found in the "
2284 "section L</RUNNING COMMANDS>."
2285 msgstr ""
2286
2287 #. type: =head2
2288 #: ../src/guestfs.pod:1194
2289 msgid "CVE-2010-3851"
2290 msgstr ""
2291
2292 #. type: textblock
2293 #: ../src/guestfs.pod:1196
2294 msgid "https://bugzilla.redhat.com/642934"
2295 msgstr ""
2296
2297 #. type: textblock
2298 #: ../src/guestfs.pod:1198
2299 msgid ""
2300 "This security bug concerns the automatic disk format detection that qemu "
2301 "does on disk images."
2302 msgstr ""
2303
2304 #. type: textblock
2305 #: ../src/guestfs.pod:1201
2306 msgid ""
2307 "A raw disk image is just the raw bytes, there is no header.  Other disk "
2308 "images like qcow2 contain a special header.  Qemu deals with this by looking "
2309 "for one of the known headers, and if none is found then assuming the disk "
2310 "image must be raw."
2311 msgstr ""
2312
2313 #. type: textblock
2314 #: ../src/guestfs.pod:1206
2315 msgid ""
2316 "This allows a guest which has been given a raw disk image to write some "
2317 "other header.  At next boot (or when the disk image is accessed by "
2318 "libguestfs) qemu would do autodetection and think the disk image format was, "
2319 "say, qcow2 based on the header written by the guest."
2320 msgstr ""
2321
2322 #. type: textblock
2323 #: ../src/guestfs.pod:1211
2324 msgid ""
2325 "This in itself would not be a problem, but qcow2 offers many features, one "
2326 "of which is to allow a disk image to refer to another image (called the "
2327 "\"backing disk\").  It does this by placing the path to the backing disk "
2328 "into the qcow2 header.  This path is not validated and could point to any "
2329 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
2330 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2331 "control of the attacker."
2332 msgstr ""
2333
2334 #. type: textblock
2335 #: ../src/guestfs.pod:1219
2336 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2337 msgstr ""
2338
2339 #. type: textblock
2340 #: ../src/guestfs.pod:1226
2341 msgid "You have enabled the network or have opened the disk in write mode."
2342 msgstr ""
2343
2344 #. type: textblock
2345 #: ../src/guestfs.pod:1230
2346 msgid ""
2347 "You are also running untrusted code from the guest (see L</RUNNING "
2348 "COMMANDS>)."
2349 msgstr ""
2350
2351 #. type: textblock
2352 #: ../src/guestfs.pod:1235
2353 msgid ""
2354 "The way to avoid this is to specify the expected disk format when adding "
2355 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
2356 "should always do this if the disk is raw format, and it's a good idea for "
2357 "other cases too."
2358 msgstr ""
2359
2360 #. type: textblock
2361 #: ../src/guestfs.pod:1240
2362 msgid ""
2363 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2364 "format is fetched from libvirt and passed through."
2365 msgstr ""
2366
2367 #. type: textblock
2368 #: ../src/guestfs.pod:1243
2369 msgid ""
2370 "For libguestfs tools, use the I<--format> command line parameter as "
2371 "appropriate."
2372 msgstr ""
2373
2374 #. type: =head1
2375 #: ../src/guestfs.pod:1246
2376 msgid "CONNECTION MANAGEMENT"
2377 msgstr ""
2378
2379 #. type: =head2
2380 #: ../src/guestfs.pod:1248
2381 msgid "guestfs_h *"
2382 msgstr ""
2383
2384 #. type: textblock
2385 #: ../src/guestfs.pod:1250
2386 msgid ""
2387 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
2388 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
2389 "handle and release all resources used."
2390 msgstr ""
2391
2392 #. type: textblock
2393 #: ../src/guestfs.pod:1254
2394 msgid ""
2395 "For information on using multiple handles and threads, see the section "
2396 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2397 msgstr ""
2398
2399 #. type: =head2
2400 #: ../src/guestfs.pod:1257
2401 msgid "guestfs_create"
2402 msgstr ""
2403
2404 #. type: verbatim
2405 #: ../src/guestfs.pod:1259
2406 #, no-wrap
2407 msgid ""
2408 " guestfs_h *guestfs_create (void);\n"
2409 "\n"
2410 msgstr ""
2411
2412 #. type: textblock
2413 #: ../src/guestfs.pod:1261
2414 msgid "Create a connection handle."
2415 msgstr ""
2416
2417 #. type: textblock
2418 #: ../src/guestfs.pod:1263
2419 msgid ""
2420 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2421 "on the handle at least once."
2422 msgstr ""
2423
2424 #. type: textblock
2425 #: ../src/guestfs.pod:1266
2426 msgid ""
2427 "This function returns a non-NULL pointer to a handle on success or NULL on "
2428 "error."
2429 msgstr ""
2430
2431 #. type: textblock
2432 #: ../src/guestfs.pod:1269
2433 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2434 msgstr ""
2435
2436 #. type: textblock
2437 #: ../src/guestfs.pod:1271
2438 msgid ""
2439 "You may also want to configure error handling for the handle.  See L</ERROR "
2440 "HANDLING> section below."
2441 msgstr ""
2442
2443 #. type: =head2
2444 #: ../src/guestfs.pod:1274
2445 msgid "guestfs_close"
2446 msgstr ""
2447
2448 #. type: verbatim
2449 #: ../src/guestfs.pod:1276
2450 #, no-wrap
2451 msgid ""
2452 " void guestfs_close (guestfs_h *g);\n"
2453 "\n"
2454 msgstr ""
2455
2456 #. type: textblock
2457 #: ../src/guestfs.pod:1278
2458 msgid "This closes the connection handle and frees up all resources used."
2459 msgstr ""
2460
2461 #. type: =head1
2462 #: ../src/guestfs.pod:1280
2463 msgid "ERROR HANDLING"
2464 msgstr ""
2465
2466 #. type: textblock
2467 #: ../src/guestfs.pod:1282
2468 msgid ""
2469 "API functions can return errors.  For example, almost all functions that "
2470 "return C<int> will return C<-1> to indicate an error."
2471 msgstr ""
2472
2473 #. type: textblock
2474 #: ../src/guestfs.pod:1285
2475 msgid ""
2476 "Additional information is available for errors: an error message string and "
2477 "optionally an error number (errno) if the thing that failed was a system "
2478 "call."
2479 msgstr ""
2480
2481 #. type: textblock
2482 #: ../src/guestfs.pod:1289
2483 msgid ""
2484 "You can get at the additional information about the last error on the handle "
2485 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2486 "up an error handler with L</guestfs_set_error_handler>."
2487 msgstr ""
2488
2489 #. type: textblock
2490 #: ../src/guestfs.pod:1294
2491 msgid ""
2492 "When the handle is created, a default error handler is installed which "
2493 "prints the error message string to C<stderr>.  For small short-running "
2494 "command line programs it is sufficient to do:"
2495 msgstr ""
2496
2497 #. type: verbatim
2498 #: ../src/guestfs.pod:1298
2499 #, no-wrap
2500 msgid ""
2501 " if (guestfs_launch (g) == -1)\n"
2502 "   exit (EXIT_FAILURE);\n"
2503 "\n"
2504 msgstr ""
2505
2506 #. type: textblock
2507 #: ../src/guestfs.pod:1301
2508 msgid ""
2509 "since the default error handler will ensure that an error message has been "
2510 "printed to C<stderr> before the program exits."
2511 msgstr ""
2512
2513 #. type: textblock
2514 #: ../src/guestfs.pod:1304
2515 msgid ""
2516 "For other programs the caller will almost certainly want to install an "
2517 "alternate error handler or do error handling in-line like this:"
2518 msgstr ""
2519
2520 #. type: verbatim
2521 #: ../src/guestfs.pod:1307
2522 #, no-wrap
2523 msgid ""
2524 " g = guestfs_create ();\n"
2525 " \n"
2526 msgstr ""
2527
2528 #. type: verbatim
2529 #: ../src/guestfs.pod:1309
2530 #, no-wrap
2531 msgid ""
2532 " /* This disables the default behaviour of printing errors\n"
2533 "    on stderr. */\n"
2534 " guestfs_set_error_handler (g, NULL, NULL);\n"
2535 " \n"
2536 msgstr ""
2537
2538 #. type: verbatim
2539 #: ../src/guestfs.pod:1313
2540 #, no-wrap
2541 msgid ""
2542 " if (guestfs_launch (g) == -1) {\n"
2543 "   /* Examine the error message and print it etc. */\n"
2544 "   char *msg = guestfs_last_error (g);\n"
2545 "   int errnum = guestfs_last_errno (g);\n"
2546 "   fprintf (stderr, \"%s\\n\", msg);\n"
2547 "   /* ... */\n"
2548 "  }\n"
2549 "\n"
2550 msgstr ""
2551
2552 #. type: textblock
2553 #: ../src/guestfs.pod:1321
2554 msgid ""
2555 "Out of memory errors are handled differently.  The default action is to call "
2556 "L<abort(3)>.  If this is undesirable, then you can set a handler using "
2557 "L</guestfs_set_out_of_memory_handler>."
2558 msgstr ""
2559
2560 #. type: textblock
2561 #: ../src/guestfs.pod:1325
2562 msgid ""
2563 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2564 "because there is no handle if this happens there is no way to get additional "
2565 "error information.  However L</guestfs_create> is supposed to be a "
2566 "lightweight operation which can only fail because of insufficient memory (it "
2567 "returns NULL in this case)."
2568 msgstr ""
2569
2570 #. type: =head2
2571 #: ../src/guestfs.pod:1331
2572 msgid "guestfs_last_error"
2573 msgstr ""
2574
2575 #. type: verbatim
2576 #: ../src/guestfs.pod:1333
2577 #, no-wrap
2578 msgid ""
2579 " const char *guestfs_last_error (guestfs_h *g);\n"
2580 "\n"
2581 msgstr ""
2582
2583 #. type: textblock
2584 #: ../src/guestfs.pod:1335
2585 msgid ""
2586 "This returns the last error message that happened on C<g>.  If there has not "
2587 "been an error since the handle was created, then this returns C<NULL>."
2588 msgstr ""
2589
2590 #. type: textblock
2591 #: ../src/guestfs.pod:1339
2592 msgid ""
2593 "The lifetime of the returned string is until the next error occurs, or "
2594 "L</guestfs_close> is called."
2595 msgstr ""
2596
2597 #. type: =head2
2598 #: ../src/guestfs.pod:1342
2599 msgid "guestfs_last_errno"
2600 msgstr ""
2601
2602 #. type: verbatim
2603 #: ../src/guestfs.pod:1344
2604 #, no-wrap
2605 msgid ""
2606 " int guestfs_last_errno (guestfs_h *g);\n"
2607 "\n"
2608 msgstr ""
2609
2610 #. type: textblock
2611 #: ../src/guestfs.pod:1346
2612 msgid "This returns the last error number (errno) that happened on C<g>."
2613 msgstr ""
2614
2615 #. type: textblock
2616 #: ../src/guestfs.pod:1348
2617 msgid "If successful, an errno integer not equal to zero is returned."
2618 msgstr ""
2619
2620 #. type: textblock
2621 #: ../src/guestfs.pod:1350
2622 msgid "If no error, this returns 0.  This call can return 0 in three situations:"
2623 msgstr ""
2624
2625 #. type: textblock
2626 #: ../src/guestfs.pod:1357
2627 msgid "There has not been any error on the handle."
2628 msgstr ""
2629
2630 #. type: textblock
2631 #: ../src/guestfs.pod:1361
2632 msgid ""
2633 "There has been an error but the errno was meaningless.  This corresponds to "
2634 "the case where the error did not come from a failed system call, but for "
2635 "some other reason."
2636 msgstr ""
2637
2638 #. type: textblock
2639 #: ../src/guestfs.pod:1367
2640 msgid ""
2641 "There was an error from a failed system call, but for some reason the errno "
2642 "was not captured and returned.  This usually indicates a bug in libguestfs."
2643 msgstr ""
2644
2645 #. type: textblock
2646 #: ../src/guestfs.pod:1373
2647 msgid ""
2648 "Libguestfs tries to convert the errno from inside the applicance into a "
2649 "corresponding errno for the caller (not entirely trivial: the appliance "
2650 "might be running a completely different operating system from the library "
2651 "and error numbers are not standardized across Un*xen).  If this could not be "
2652 "done, then the error is translated to C<EINVAL>.  In practice this should "
2653 "only happen in very rare circumstances."
2654 msgstr ""
2655
2656 #. type: =head2
2657 #: ../src/guestfs.pod:1381
2658 msgid "guestfs_set_error_handler"
2659 msgstr ""
2660
2661 #. type: verbatim
2662 #: ../src/guestfs.pod:1383
2663 #, no-wrap
2664 msgid ""
2665 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2666 "                                           void *opaque,\n"
2667 "                                           const char *msg);\n"
2668 " void guestfs_set_error_handler (guestfs_h *g,\n"
2669 "                                 guestfs_error_handler_cb cb,\n"
2670 "                                 void *opaque);\n"
2671 "\n"
2672 msgstr ""
2673
2674 #. type: textblock
2675 #: ../src/guestfs.pod:1390
2676 msgid ""
2677 "The callback C<cb> will be called if there is an error.  The parameters "
2678 "passed to the callback are an opaque data pointer and the error message "
2679 "string."
2680 msgstr ""
2681
2682 #. type: textblock
2683 #: ../src/guestfs.pod:1394
2684 msgid ""
2685 "C<errno> is not passed to the callback.  To get that the callback must call "
2686 "L</guestfs_last_errno>."
2687 msgstr ""
2688
2689 #. type: textblock
2690 #: ../src/guestfs.pod:1397
2691 msgid ""
2692 "Note that the message string C<msg> is freed as soon as the callback "
2693 "function returns, so if you want to stash it somewhere you must make your "
2694 "own copy."
2695 msgstr ""
2696
2697 #. type: textblock
2698 #: ../src/guestfs.pod:1401
2699 msgid "The default handler prints messages on C<stderr>."
2700 msgstr ""
2701
2702 #. type: textblock
2703 #: ../src/guestfs.pod:1403
2704 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2705 msgstr ""
2706
2707 #. type: =head2
2708 #: ../src/guestfs.pod:1405
2709 msgid "guestfs_get_error_handler"
2710 msgstr ""
2711
2712 #. type: verbatim
2713 #: ../src/guestfs.pod:1407
2714 #, no-wrap
2715 msgid ""
2716 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2717 "                                                     void **opaque_rtn);\n"
2718 "\n"
2719 msgstr ""
2720
2721 #. type: textblock
2722 #: ../src/guestfs.pod:1410
2723 msgid "Returns the current error handler callback."
2724 msgstr ""
2725
2726 #. type: =head2
2727 #: ../src/guestfs.pod:1412
2728 msgid "guestfs_set_out_of_memory_handler"
2729 msgstr ""
2730
2731 #. type: verbatim
2732 #: ../src/guestfs.pod:1414
2733 #, no-wrap
2734 msgid ""
2735 " typedef void (*guestfs_abort_cb) (void);\n"
2736 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2737 "                                        guestfs_abort_cb);\n"
2738 "\n"
2739 msgstr ""
2740
2741 #. type: textblock
2742 #: ../src/guestfs.pod:1418
2743 msgid ""
2744 "The callback C<cb> will be called if there is an out of memory situation.  "
2745 "I<Note this callback must not return>."
2746 msgstr ""
2747
2748 #. type: textblock
2749 #: ../src/guestfs.pod:1421
2750 msgid "The default is to call L<abort(3)>."
2751 msgstr ""
2752
2753 #. type: textblock
2754 #: ../src/guestfs.pod:1423
2755 msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
2756 msgstr ""
2757
2758 #. type: =head2
2759 #: ../src/guestfs.pod:1426
2760 msgid "guestfs_get_out_of_memory_handler"
2761 msgstr ""
2762
2763 #. type: verbatim
2764 #: ../src/guestfs.pod:1428
2765 #, no-wrap
2766 msgid ""
2767 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2768 "\n"
2769 msgstr ""
2770
2771 #. type: textblock
2772 #: ../src/guestfs.pod:1430
2773 msgid "This returns the current out of memory handler."
2774 msgstr ""
2775
2776 #. type: =head1
2777 #: ../src/guestfs.pod:1432
2778 msgid "API CALLS"
2779 msgstr ""
2780
2781 #. type: textblock
2782 #: ../src/guestfs.pod:1434 ../fish/guestfish.pod:984
2783 msgid "@ACTIONS@"
2784 msgstr ""
2785
2786 #. type: =head1
2787 #: ../src/guestfs.pod:1436
2788 msgid "STRUCTURES"
2789 msgstr ""
2790
2791 #. type: textblock
2792 #: ../src/guestfs.pod:1438
2793 msgid "@STRUCTS@"
2794 msgstr ""
2795
2796 #. type: =head1
2797 #: ../src/guestfs.pod:1440
2798 msgid "AVAILABILITY"
2799 msgstr ""
2800
2801 #. type: =head2
2802 #: ../src/guestfs.pod:1442
2803 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2804 msgstr ""
2805
2806 #. type: textblock
2807 #: ../src/guestfs.pod:1444
2808 msgid ""
2809 "Using L</guestfs_available> you can test availability of the following "
2810 "groups of functions.  This test queries the appliance to see if the "
2811 "appliance you are currently using supports the functionality."
2812 msgstr ""
2813
2814 #. type: textblock
2815 #: ../src/guestfs.pod:1449
2816 msgid "@AVAILABILITY@"
2817 msgstr ""
2818
2819 #. type: =head2
2820 #: ../src/guestfs.pod:1451
2821 msgid "GUESTFISH supported COMMAND"
2822 msgstr ""
2823
2824 #. type: textblock
2825 #: ../src/guestfs.pod:1453
2826 msgid ""
2827 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2828 "prints out the available groups and whether they are supported by this build "
2829 "of libguestfs.  Note however that you have to do C<run> first."
2830 msgstr ""
2831
2832 #. type: =head2
2833 #: ../src/guestfs.pod:1458
2834 msgid "SINGLE CALLS AT COMPILE TIME"
2835 msgstr ""
2836
2837 #. type: textblock
2838 #: ../src/guestfs.pod:1460
2839 msgid ""
2840 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2841 "function, such as:"
2842 msgstr ""
2843
2844 #. type: verbatim
2845 #: ../src/guestfs.pod:1463
2846 #, no-wrap
2847 msgid ""
2848 " #define LIBGUESTFS_HAVE_DD 1\n"
2849 "\n"
2850 msgstr ""
2851
2852 #. type: textblock
2853 #: ../src/guestfs.pod:1465
2854 msgid "if L</guestfs_dd> is available."
2855 msgstr ""
2856
2857 #. type: textblock
2858 #: ../src/guestfs.pod:1467
2859 msgid ""
2860 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2861 "function is available at compile time, we recommended using build tools such "
2862 "as autoconf or cmake.  For example in autotools you could use:"
2863 msgstr ""
2864
2865 #. type: verbatim
2866 #: ../src/guestfs.pod:1472
2867 #, no-wrap
2868 msgid ""
2869 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2870 " AC_CHECK_FUNCS([guestfs_dd])\n"
2871 "\n"
2872 msgstr ""
2873
2874 #. type: textblock
2875 #: ../src/guestfs.pod:1475
2876 msgid ""
2877 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2878 "in your program."
2879 msgstr ""
2880
2881 #. type: =head2
2882 #: ../src/guestfs.pod:1478
2883 msgid "SINGLE CALLS AT RUN TIME"
2884 msgstr ""
2885
2886 #. type: textblock
2887 #: ../src/guestfs.pod:1480
2888 msgid ""
2889 "Testing at compile time doesn't guarantee that a function really exists in "
2890 "the library.  The reason is that you might be dynamically linked against a "
2891 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
2892 "This situation unfortunately results in a segmentation fault, which is a "
2893 "shortcoming of the C dynamic linking system itself."
2894 msgstr ""
2895
2896 #. type: textblock
2897 #: ../src/guestfs.pod:1487
2898 msgid ""
2899 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2900 "in this example program (note that you still need the compile time check as "
2901 "well):"
2902 msgstr ""
2903
2904 #. type: verbatim
2905 #: ../src/guestfs.pod:1491
2906 #, no-wrap
2907 msgid ""
2908 " #include <stdio.h>\n"
2909 " #include <stdlib.h>\n"
2910 " #include <unistd.h>\n"
2911 " #include <dlfcn.h>\n"
2912 " #include <guestfs.h>\n"
2913 " \n"
2914 msgstr ""
2915
2916 #. type: verbatim
2917 #: ../src/guestfs.pod:1497
2918 #, no-wrap
2919 msgid ""
2920 " main ()\n"
2921 " {\n"
2922 " #ifdef LIBGUESTFS_HAVE_DD\n"
2923 "   void *dl;\n"
2924 "   int has_function;\n"
2925 " \n"
2926 msgstr ""
2927
2928 #. type: verbatim
2929 #: ../src/guestfs.pod:1503
2930 #, no-wrap
2931 msgid ""
2932 "   /* Test if the function guestfs_dd is really available. */\n"
2933 "   dl = dlopen (NULL, RTLD_LAZY);\n"
2934 "   if (!dl) {\n"
2935 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2936 "     exit (EXIT_FAILURE);\n"
2937 "   }\n"
2938 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2939 "   dlclose (dl);\n"
2940 " \n"
2941 msgstr ""
2942
2943 #. type: verbatim
2944 #: ../src/guestfs.pod:1512
2945 #, no-wrap
2946 msgid ""
2947 "   if (!has_function)\n"
2948 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2949 "   else {\n"
2950 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2951 "     /* Now it's safe to call\n"
2952 "     guestfs_dd (g, \"foo\", \"bar\");\n"
2953 "     */\n"
2954 "   }\n"
2955 " #else\n"
2956 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2957 " #endif\n"
2958 "  }\n"
2959 "\n"
2960 msgstr ""
2961
2962 #. type: textblock
2963 #: ../src/guestfs.pod:1525
2964 msgid ""
2965 "You may think the above is an awful lot of hassle, and it is.  There are "
2966 "other ways outside of the C linking system to ensure that this kind of "
2967 "incompatibility never arises, such as using package versioning:"
2968 msgstr ""
2969
2970 #. type: verbatim
2971 #: ../src/guestfs.pod:1530
2972 #, no-wrap
2973 msgid ""
2974 " Requires: libguestfs >= 1.0.80\n"
2975 "\n"
2976 msgstr ""
2977
2978 #. type: =head1
2979 #: ../src/guestfs.pod:1532
2980 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2981 msgstr ""
2982
2983 #. type: textblock
2984 #: ../src/guestfs.pod:1534
2985 msgid ""
2986 "A recent feature of the API is the introduction of calls which take optional "
2987 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
2988 "takes variable arguments (ie. C<...>), as in this example:"
2989 msgstr ""
2990
2991 #. type: verbatim
2992 #: ../src/guestfs.pod:1539
2993 #, no-wrap
2994 msgid ""
2995 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2996 "\n"
2997 msgstr ""
2998
2999 #. type: textblock
3000 #: ../src/guestfs.pod:1541
3001 msgid ""
3002 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
3003 "call with no optional arguments specified:"
3004 msgstr ""
3005
3006 #. type: verbatim
3007 #: ../src/guestfs.pod:1544
3008 #, no-wrap
3009 msgid ""
3010 " guestfs_add_drive_opts (g, filename, -1);\n"
3011 "\n"
3012 msgstr ""
3013
3014 #. type: textblock
3015 #: ../src/guestfs.pod:1546
3016 msgid "With a single optional argument:"
3017 msgstr ""
3018
3019 #. type: verbatim
3020 #: ../src/guestfs.pod:1548
3021 #, no-wrap
3022 msgid ""
3023 " guestfs_add_drive_opts (g, filename,\n"
3024 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3025 "                         -1);\n"
3026 "\n"
3027 msgstr ""
3028
3029 #. type: textblock
3030 #: ../src/guestfs.pod:1552
3031 msgid "With two:"
3032 msgstr ""
3033
3034 #. type: verbatim
3035 #: ../src/guestfs.pod:1554
3036 #, no-wrap
3037 msgid ""
3038 " guestfs_add_drive_opts (g, filename,\n"
3039 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3040 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3041 "                         -1);\n"
3042 "\n"
3043 msgstr ""
3044
3045 #. type: textblock
3046 #: ../src/guestfs.pod:1559
3047 msgid ""
3048 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
3049 "happen!"
3050 msgstr ""
3051
3052 #. type: =head2
3053 #: ../src/guestfs.pod:1562
3054 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3055 msgstr ""
3056
3057 #. type: textblock
3058 #: ../src/guestfs.pod:1564
3059 msgid ""
3060 "The second variant has the same name with the suffix C<_va>, which works the "
3061 "same way but takes a C<va_list>.  See the C manual for details.  For the "
3062 "example function, this is declared:"
3063 msgstr ""
3064
3065 #. type: verbatim
3066 #: ../src/guestfs.pod:1568
3067 #, no-wrap
3068 msgid ""
3069 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3070 "                                va_list args);\n"
3071 "\n"
3072 msgstr ""
3073
3074 #. type: =head2
3075 #: ../src/guestfs.pod:1571
3076 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3077 msgstr ""
3078
3079 #. type: textblock
3080 #: ../src/guestfs.pod:1573
3081 msgid ""
3082 "The third variant is useful where you need to construct these calls.  You "
3083 "pass in a structure where you fill in the optional fields.  The structure "
3084 "has a bitmask as the first element which you must set to indicate which "
3085 "fields you have filled in.  For our example function the structure and call "
3086 "are declared:"
3087 msgstr ""
3088
3089 #. type: verbatim
3090 #: ../src/guestfs.pod:1579
3091 #, no-wrap
3092 msgid ""
3093 " struct guestfs_add_drive_opts_argv {\n"
3094 "   uint64_t bitmask;\n"
3095 "   int readonly;\n"
3096 "   const char *format;\n"
3097 "   /* ... */\n"
3098 " };\n"
3099 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3100 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
3101 "\n"
3102 msgstr ""
3103
3104 #. type: textblock
3105 #: ../src/guestfs.pod:1588
3106 msgid "You could call it like this:"
3107 msgstr ""
3108
3109 #. type: verbatim
3110 #: ../src/guestfs.pod:1590
3111 #, no-wrap
3112 msgid ""
3113 " struct guestfs_add_drive_opts_argv optargs = {\n"
3114 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3115 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3116 "   .readonly = 1,\n"
3117 "   .format = \"qcow2\"\n"
3118 " };\n"
3119 " \n"
3120 msgstr ""
3121
3122 #. type: verbatim
3123 #: ../src/guestfs.pod:1597
3124 #, no-wrap
3125 msgid ""
3126 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3127 "\n"
3128 msgstr ""
3129
3130 #. type: textblock
3131 #: ../src/guestfs.pod:1599 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532
3132 msgid "Notes:"
3133 msgstr ""
3134
3135 #. type: textblock
3136 #: ../src/guestfs.pod:1605
3137 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3138 msgstr ""
3139
3140 #. type: textblock
3141 #: ../src/guestfs.pod:1610
3142 msgid "You do not need to fill in all fields of the structure."
3143 msgstr ""
3144
3145 #. type: textblock
3146 #: ../src/guestfs.pod:1614
3147 msgid ""
3148 "There must be a one-to-one correspondence between fields of the structure "
3149 "that are filled in, and bits set in the bitmask."
3150 msgstr ""
3151
3152 #. type: =head2
3153 #: ../src/guestfs.pod:1619
3154 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3155 msgstr ""
3156
3157 #. type: textblock
3158 #: ../src/guestfs.pod:1621
3159 msgid ""
3160 "In other languages, optional arguments are expressed in the way that is "
3161 "natural for that language.  We refer you to the language-specific "
3162 "documentation for more details on that."
3163 msgstr ""
3164
3165 #. type: textblock
3166 #: ../src/guestfs.pod:1625
3167 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3168 msgstr ""
3169
3170 #. type: =head2
3171 #: ../src/guestfs.pod:1627
3172 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3173 msgstr ""
3174
3175 #. type: textblock
3176 #: ../src/guestfs.pod:1629
3177 msgid ""
3178 "The child process generates events in some situations.  Current events "
3179 "include: receiving a log message, the child process exits."
3180 msgstr ""
3181
3182 #. type: textblock
3183 #: ../src/guestfs.pod:1632
3184 msgid ""
3185 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3186 "types of events."
3187 msgstr ""
3188
3189 #. type: textblock
3190 #: ../src/guestfs.pod:1635
3191 msgid ""
3192 "Only I<one callback of each type> can be registered for each handle.  "
3193 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3194 "that type.  Cancel all callbacks of this type by calling this function with "
3195 "C<cb> set to C<NULL>."
3196 msgstr ""
3197
3198 #. type: =head2
3199 #: ../src/guestfs.pod:1640
3200 msgid "guestfs_set_log_message_callback"
3201 msgstr ""
3202
3203 #. type: verbatim
3204 #: ../src/guestfs.pod:1642
3205 #, no-wrap
3206 msgid ""
3207 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3208 "                                         char *buf, int len);\n"
3209 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3210 "                                        guestfs_log_message_cb cb,\n"
3211 "                                        void *opaque);\n"
3212 "\n"
3213 msgstr ""
3214
3215 #. type: textblock
3216 #: ../src/guestfs.pod:1648
3217 msgid ""
3218 "The callback function C<cb> will be called whenever qemu or the guest writes "
3219 "anything to the console."
3220 msgstr ""
3221
3222 #. type: textblock
3223 #: ../src/guestfs.pod:1651
3224 msgid "Use this function to capture kernel messages and similar."
3225 msgstr ""
3226
3227 #. type: textblock
3228 #: ../src/guestfs.pod:1653
3229 msgid ""
3230 "Normally there is no log message handler, and log messages are just "
3231 "discarded."
3232 msgstr ""
3233
3234 #. type: =head2
3235 #: ../src/guestfs.pod:1656
3236 msgid "guestfs_set_subprocess_quit_callback"
3237 msgstr ""
3238
3239 #. type: verbatim
3240 #: ../src/guestfs.pod:1658
3241 #, no-wrap
3242 msgid ""
3243 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3244 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3245 "                                            guestfs_subprocess_quit_cb cb,\n"
3246 "                                            void *opaque);\n"
3247 "\n"
3248 msgstr ""
3249
3250 #. type: textblock
3251 #: ../src/guestfs.pod:1663
3252 msgid ""
3253 "The callback function C<cb> will be called when the child process quits, "
3254 "either asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
3255 "corresponds to a transition from any state to the CONFIG state)."
3256 msgstr ""
3257
3258 #. type: =head2
3259 #: ../src/guestfs.pod:1668
3260 msgid "guestfs_set_launch_done_callback"
3261 msgstr ""
3262
3263 #. type: verbatim
3264 #: ../src/guestfs.pod:1670
3265 #, no-wrap
3266 msgid ""
3267 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3268 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3269 "                                        guestfs_launch_done_cb cb,\n"
3270 "                                        void *opaque);\n"
3271 "\n"
3272 msgstr ""
3273
3274 #. type: textblock
3275 #: ../src/guestfs.pod:1675
3276 msgid ""
3277 "The callback function C<cb> will be called when the child process becomes "
3278 "ready first time after it has been launched.  (This corresponds to a "
3279 "transition from LAUNCHING to the READY state)."
3280 msgstr ""
3281
3282 #. type: =head2
3283 #: ../src/guestfs.pod:1679
3284 msgid "guestfs_set_close_callback"
3285 msgstr ""
3286
3287 #. type: verbatim
3288 #: ../src/guestfs.pod:1681
3289 #, no-wrap
3290 msgid ""
3291 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3292 " void guestfs_set_close_callback (guestfs_h *g,\n"
3293 "                                  guestfs_close_cb cb,\n"
3294 "                                  void *opaque);\n"
3295 "\n"
3296 msgstr ""
3297
3298 #. type: textblock
3299 #: ../src/guestfs.pod:1686
3300 msgid ""
3301 "The callback function C<cb> will be called while the handle is being closed "
3302 "(synchronously from L</guestfs_close>)."
3303 msgstr ""
3304
3305 #. type: textblock
3306 #: ../src/guestfs.pod:1689
3307 msgid ""
3308 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3309 "handles that are open when the program exits.  This means that this callback "
3310 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3311 "problems in higher-level languages (eg. if your HLL interpreter has already "
3312 "been cleaned up by the time this is called, and if your callback then jumps "
3313 "into some HLL function)."
3314 msgstr ""
3315
3316 #. type: =head2
3317 #: ../src/guestfs.pod:1697
3318 msgid "guestfs_set_progress_callback"
3319 msgstr ""
3320
3321 #. type: verbatim
3322 #: ../src/guestfs.pod:1699
3323 #, no-wrap
3324 msgid ""
3325 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3326 "                                      int proc_nr, int serial,\n"
3327 "                                      uint64_t position, uint64_t total);\n"
3328 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3329 "                                     guestfs_progress_cb cb,\n"
3330 "                                     void *opaque);\n"
3331 "\n"
3332 msgstr ""
3333
3334 #. type: textblock
3335 #: ../src/guestfs.pod:1706
3336 msgid ""
3337 "Some long-running operations can generate progress messages.  If this "
3338 "callback is registered, then it will be called each time a progress message "
3339 "is generated (usually two seconds after the operation started, and three "
3340 "times per second thereafter until it completes, although the frequency may "
3341 "change in future versions)."
3342 msgstr ""
3343
3344 #. type: textblock
3345 #: ../src/guestfs.pod:1712
3346 msgid ""
3347 "The callback receives two numbers: C<position> and C<total>.  The units of "
3348 "C<total> are not defined, although for some operations C<total> may relate "
3349 "in some way to the amount of data to be transferred (eg. in bytes or "
3350 "megabytes), and C<position> may be the portion which has been transferred."
3351 msgstr ""
3352
3353 #. type: textblock
3354 #: ../src/guestfs.pod:1718
3355 msgid "The only defined and stable parts of the API are:"
3356 msgstr ""
3357
3358 #. type: textblock
3359 #: ../src/guestfs.pod:1724
3360 msgid ""
3361 "The callback can display to the user some type of progress bar or indicator "
3362 "which shows the ratio of C<position>:C<total>."
3363 msgstr ""
3364
3365 #. type: textblock
3366 #: ../src/guestfs.pod:1729
3367 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3368 msgstr ""
3369
3370 #. type: textblock
3371 #: ../src/guestfs.pod:1733
3372 msgid ""
3373 "If any progress notification is sent during a call, then a final progress "
3374 "notification is always sent when C<position> = C<total>."
3375 msgstr ""
3376
3377 #. type: textblock
3378 #: ../src/guestfs.pod:1736
3379 msgid ""
3380 "This is to simplify caller code, so callers can easily set the progress "
3381 "indicator to \"100%\" at the end of the operation, without requiring special "
3382 "code to detect this case."
3383 msgstr ""
3384
3385 #. type: textblock
3386 #: ../src/guestfs.pod:1742
3387 msgid ""
3388 "The callback also receives the procedure number and serial number of the "
3389 "call.  These are only useful for debugging protocol issues, and the callback "
3390 "can normally ignore them.  The callback may want to print these numbers in "
3391 "error messages or debugging messages."
3392 msgstr ""
3393
3394 #. type: =head1
3395 #: ../src/guestfs.pod:1747
3396 msgid "PRIVATE DATA AREA"
3397 msgstr ""
3398
3399 #. type: textblock
3400 #: ../src/guestfs.pod:1749
3401 msgid ""
3402 "You can attach named pieces of private data to the libguestfs handle, and "
3403 "fetch them by name for the lifetime of the handle.  This is called the "
3404 "private data area and is only available from the C API."
3405 msgstr ""
3406
3407 #. type: textblock
3408 #: ../src/guestfs.pod:1753
3409 msgid "To attach a named piece of data, use the following call:"
3410 msgstr ""
3411
3412 #. type: verbatim
3413 #: ../src/guestfs.pod:1755
3414 #, no-wrap
3415 msgid ""
3416 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3417 "\n"
3418 msgstr ""
3419
3420 #. type: textblock
3421 #: ../src/guestfs.pod:1757
3422 msgid ""
3423 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3424 "pointer (which can be C<NULL>).  Any previous item with the same name is "
3425 "overwritten."
3426 msgstr ""
3427
3428 #. type: textblock
3429 #: ../src/guestfs.pod:1761
3430 msgid ""
3431 "You can use any C<key> you want, but names beginning with an underscore "
3432 "character are reserved for internal libguestfs purposes (for implementing "
3433 "language bindings).  It is recommended to prefix the name with some unique "
3434 "string to avoid collisions with other users."
3435 msgstr ""
3436
3437 #. type: textblock
3438 #: ../src/guestfs.pod:1766
3439 msgid "To retrieve the pointer, use:"
3440 msgstr ""
3441
3442 #. type: verbatim
3443 #: ../src/guestfs.pod:1768
3444 #, no-wrap
3445 msgid ""
3446 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3447 "\n"
3448 msgstr ""
3449
3450 #. type: textblock
3451 #: ../src/guestfs.pod:1770
3452 msgid ""
3453 "This function returns C<NULL> if either no data is found associated with "
3454 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3455 "C<NULL>."
3456 msgstr ""
3457
3458 #. type: textblock
3459 #: ../src/guestfs.pod:1774
3460 msgid ""
3461 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3462 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
3463 "all.  In particular, libguestfs does I<not> try to free the data when the "
3464 "handle is closed.  If the data must be freed, then the caller must either "
3465 "free it before calling L</guestfs_close> or must set up a close callback to "
3466 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3467 "can be registered for a handle)."
3468 msgstr ""
3469
3470 #. type: textblock
3471 #: ../src/guestfs.pod:1782
3472 msgid ""
3473 "The private data area is implemented using a hash table, and should be "
3474 "reasonably efficient for moderate numbers of keys."
3475 msgstr ""
3476
3477 #. type: =end
3478 #: ../src/guestfs.pod:1785 ../src/guestfs.pod:1790
3479 msgid "html"
3480 msgstr ""
3481
3482 #. type: textblock
3483 #: ../src/guestfs.pod:1787
3484 msgid ""
3485 "<!-- old anchor for the next section --> <a "
3486 "name=\"state_machine_and_low_level_event_api\"/>"
3487 msgstr ""
3488
3489 #. type: =head1
3490 #: ../src/guestfs.pod:1792
3491 msgid "ARCHITECTURE"
3492 msgstr ""
3493
3494 #. type: textblock
3495 #: ../src/guestfs.pod:1794
3496 msgid ""
3497 "Internally, libguestfs is implemented by running an appliance (a special "
3498 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
3499 "process of the main program."
3500 msgstr ""
3501
3502 #. type: verbatim
3503 #: ../src/guestfs.pod:1798
3504 #, no-wrap
3505 msgid ""
3506 "  ___________________\n"
3507 " /                   \\\n"
3508 " | main program      |\n"
3509 " |                   |\n"
3510 " |                   |           child process / appliance\n"
3511 " |                   |           __________________________\n"
3512 " |                   |          / qemu                     \\\n"
3513 " +-------------------+   RPC    |      +-----------------+ |\n"
3514 " | libguestfs     <--------------------> guestfsd        | |\n"
3515 " |                   |          |      +-----------------+ |\n"
3516 " \\___________________/          |      | Linux kernel    | |\n"
3517 "                                |      +--^--------------+ |\n"
3518 "                                \\_________|________________/\n"
3519 "                                          |\n"
3520 "                                   _______v______\n"
3521 "                                  /              \\\n"
3522 "                                  | Device or    |\n"
3523 "                                  | disk image   |\n"
3524 "                                  \\______________/\n"
3525 "\n"
3526 msgstr ""
3527
3528 #. type: textblock
3529 #: ../src/guestfs.pod:1818
3530 msgid ""
3531 "The library, linked to the main program, creates the child process and hence "
3532 "the appliance in the L</guestfs_launch> function."
3533 msgstr ""
3534
3535 #. type: textblock
3536 #: ../src/guestfs.pod:1821
3537 msgid ""
3538 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3539 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3540 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
3541 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
3542 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
3543 "attached to the qemu process which translates device access by the "
3544 "appliance's Linux kernel into accesses to the image."
3545 msgstr ""
3546
3547 #. type: textblock
3548 #: ../src/guestfs.pod:1830
3549 msgid ""
3550 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
3551 "Although the disk image you are attached to might also be used by some "
3552 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
3553 "care if both libguestfs's qemu process and your virtual machine are trying "
3554 "to update the disk image at the same time, since these usually results in "
3555 "massive disk corruption)."
3556 msgstr ""
3557
3558 #. type: =head1
3559 #: ../src/guestfs.pod:1837
3560 msgid "STATE MACHINE"
3561 msgstr ""
3562
3563 #. type: textblock
3564 #: ../src/guestfs.pod:1839
3565 msgid "libguestfs uses a state machine to model the child process:"
3566 msgstr ""
3567
3568 #. type: verbatim
3569 #: ../src/guestfs.pod:1841
3570 #, no-wrap
3571 msgid ""
3572 "                         |\n"
3573 "                    guestfs_create\n"
3574 "                         |\n"
3575 "                         |\n"
3576 "                     ____V_____\n"
3577 "                    /          \\\n"
3578 "                    |  CONFIG  |\n"
3579 "                    \\__________/\n"
3580 "                     ^ ^   ^  \\\n"
3581 "                    /  |    \\  \\ guestfs_launch\n"
3582 "                   /   |    _\\__V______\n"
3583 "                  /    |   /           \\\n"
3584 "                 /     |   | LAUNCHING |\n"
3585 "                /      |   \\___________/\n"
3586 "               /       |       /\n"
3587 "              /        |  guestfs_launch\n"
3588 "             /         |     /\n"
3589 "    ______  /        __|____V\n"
3590 "   /      \\ ------> /        \\\n"
3591 "   | BUSY |         | READY  |\n"
3592 "   \\______/ <------ \\________/\n"
3593 "\n"
3594 msgstr ""
3595
3596 #. type: textblock
3597 #: ../src/guestfs.pod:1863
3598 msgid ""
3599 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3600 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3601 "(3) alternating between READY and BUSY as commands are issued to, and "
3602 "carried out by, the child process."
3603 msgstr ""
3604
3605 #. type: textblock
3606 #: ../src/guestfs.pod:1868
3607 msgid ""
3608 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3609 "asynchronously at any time (eg. due to some internal error), and that causes "
3610 "the state to transition back to CONFIG."
3611 msgstr ""
3612
3613 #. type: textblock
3614 #: ../src/guestfs.pod:1872
3615 msgid ""
3616 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3617 "issued when in the CONFIG state."
3618 msgstr ""
3619
3620 #. type: textblock
3621 #: ../src/guestfs.pod:1875
3622 msgid ""
3623 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
3624 "L</guestfs_launch> blocks until the child process is READY to accept "
3625 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
3626 "moves the state from CONFIG to LAUNCHING while it is running."
3627 msgstr ""
3628
3629 #. type: textblock
3630 #: ../src/guestfs.pod:1881
3631 msgid ""
3632 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3633 "state.  These API calls block waiting for the command to be carried out "
3634 "(ie. the state to transition to BUSY and then back to READY).  There are no "
3635 "non-blocking versions, and no way to issue more than one command per handle "
3636 "at the same time."
3637 msgstr ""
3638
3639 #. type: textblock
3640 #: ../src/guestfs.pod:1887
3641 msgid ""
3642 "Finally, the child process sends asynchronous messages back to the main "
3643 "program, such as kernel log messages.  You can register a callback to "
3644 "receive these messages."
3645 msgstr ""
3646
3647 #. type: =head1
3648 #: ../src/guestfs.pod:1891
3649 msgid "INTERNALS"
3650 msgstr ""
3651
3652 #. type: =head2
3653 #: ../src/guestfs.pod:1893
3654 msgid "COMMUNICATION PROTOCOL"
3655 msgstr ""
3656
3657 #. type: textblock
3658 #: ../src/guestfs.pod:1895
3659 msgid ""
3660 "Don't rely on using this protocol directly.  This section documents how it "
3661 "currently works, but it may change at any time."
3662 msgstr ""
3663
3664 #. type: textblock
3665 #: ../src/guestfs.pod:1898
3666 msgid ""
3667 "The protocol used to talk between the library and the daemon running inside "
3668 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3669 "1014, RFC 1832, RFC 4506)."
3670 msgstr ""
3671
3672 #. type: textblock
3673 #: ../src/guestfs.pod:1902
3674 msgid ""
3675 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3676 "this file is automatically generated)."
3677 msgstr ""
3678
3679 #. type: textblock
3680 #: ../src/guestfs.pod:1905
3681 msgid ""
3682 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3683 "and C<FileOut> parameters, which are handled with very simple request/reply "
3684 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
3685 "parameters, which use the same request and reply messages, but they may also "
3686 "be followed by files sent using a chunked encoding."
3687 msgstr ""
3688
3689 #. type: =head3
3690 #: ../src/guestfs.pod:1912
3691 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3692 msgstr ""
3693
3694 #. type: textblock
3695 #: ../src/guestfs.pod:1914
3696 msgid "For ordinary functions, the request message is:"
3697 msgstr ""
3698
3699 #. type: verbatim
3700 #: ../src/guestfs.pod:1916
3701 #, no-wrap
3702 msgid ""
3703 " total length (header + arguments,\n"
3704 "      but not including the length word itself)\n"
3705 " struct guestfs_message_header (encoded as XDR)\n"
3706 " struct guestfs_<foo>_args (encoded as XDR)\n"
3707 "\n"
3708 msgstr ""
3709
3710 #. type: textblock
3711 #: ../src/guestfs.pod:1921
3712 msgid ""
3713 "The total length field allows the daemon to allocate a fixed size buffer "
3714 "into which it slurps the rest of the message.  As a result, the total length "
3715 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3716 "effective size of any request is limited to somewhere under this size."
3717 msgstr ""
3718
3719 #. type: textblock
3720 #: ../src/guestfs.pod:1927
3721 msgid ""
3722 "Note also that many functions don't take any arguments, in which case the "
3723 "C<guestfs_I<foo>_args> is completely omitted."
3724 msgstr ""
3725
3726 #. type: textblock
3727 #: ../src/guestfs.pod:1930
3728 msgid ""
3729 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3730 "receiver knows what type of args structure to expect, or none at all."
3731 msgstr ""
3732
3733 #. type: textblock
3734 #: ../src/guestfs.pod:1934
3735 msgid ""
3736 "For functions that take optional arguments, the optional arguments are "
3737 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3738 "arguments.  A bitmask in the header indicates which optional arguments are "
3739 "meaningful.  The bitmask is also checked to see if it contains bits set "
3740 "which the daemon does not know about (eg. if more optional arguments were "
3741 "added in a later version of the library), and this causes the call to be "
3742 "rejected."
3743 msgstr ""
3744
3745 #. type: textblock
3746 #: ../src/guestfs.pod:1942
3747 msgid "The reply message for ordinary functions is:"
3748 msgstr ""
3749
3750 #. type: verbatim
3751 #: ../src/guestfs.pod:1944
3752 #, no-wrap
3753 msgid ""
3754 " total length (header + ret,\n"
3755 "      but not including the length word itself)\n"
3756 " struct guestfs_message_header (encoded as XDR)\n"
3757 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3758 "\n"
3759 msgstr ""
3760
3761 #. type: textblock
3762 #: ../src/guestfs.pod:1949
3763 msgid ""
3764 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3765 "functions that return no formal return values."
3766 msgstr ""
3767
3768 #. type: textblock
3769 #: ../src/guestfs.pod:1952
3770 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3771 msgstr ""
3772
3773 #. type: textblock
3774 #: ../src/guestfs.pod:1955
3775 msgid ""
3776 "In the case of an error, a flag is set in the header, and the reply message "
3777 "is slightly changed:"
3778 msgstr ""
3779
3780 #. type: verbatim
3781 #: ../src/guestfs.pod:1958
3782 #, no-wrap
3783 msgid ""
3784 " total length (header + error,\n"
3785 "      but not including the length word itself)\n"
3786 " struct guestfs_message_header (encoded as XDR)\n"
3787 " struct guestfs_message_error (encoded as XDR)\n"
3788 "\n"
3789 msgstr ""
3790
3791 #. type: textblock
3792 #: ../src/guestfs.pod:1963
3793 msgid ""
3794 "The C<guestfs_message_error> structure contains the error message as a "
3795 "string."
3796 msgstr ""
3797
3798 #. type: =head3
3799 #: ../src/guestfs.pod:1966
3800 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3801 msgstr ""
3802
3803 #. type: textblock
3804 #: ../src/guestfs.pod:1968
3805 msgid ""
3806 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
3807 "The normal request message is sent (see above).  However this is followed by "
3808 "a sequence of file chunks."
3809 msgstr ""
3810
3811 #. type: verbatim
3812 #: ../src/guestfs.pod:1972
3813 #, no-wrap
3814 msgid ""
3815 " total length (header + arguments,\n"
3816 "      but not including the length word itself,\n"
3817 "      and not including the chunks)\n"
3818 " struct guestfs_message_header (encoded as XDR)\n"
3819 " struct guestfs_<foo>_args (encoded as XDR)\n"
3820 " sequence of chunks for FileIn param #0\n"
3821 " sequence of chunks for FileIn param #1 etc.\n"
3822 "\n"
3823 msgstr ""
3824
3825 #. type: textblock
3826 #: ../src/guestfs.pod:1980
3827 msgid "The \"sequence of chunks\" is:"
3828 msgstr ""
3829
3830 #. type: verbatim
3831 #: ../src/guestfs.pod:1982
3832 #, no-wrap
3833 msgid ""
3834 " length of chunk (not including length word itself)\n"
3835 " struct guestfs_chunk (encoded as XDR)\n"
3836 " length of chunk\n"
3837 " struct guestfs_chunk (encoded as XDR)\n"
3838 "   ...\n"
3839 " length of chunk\n"
3840 " struct guestfs_chunk (with data.data_len == 0)\n"
3841 "\n"
3842 msgstr ""
3843
3844 #. type: textblock
3845 #: ../src/guestfs.pod:1990
3846 msgid ""
3847 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
3848 "is set in the final chunk to indicate either successful completion or early "