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