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