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