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