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