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