8deb477d7a7bef79ab5e6690e1f04da2256ff01e
[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-02-06 17:14+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:1088
922 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
923 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
924 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
925 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
926 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
927 #: ../src/guestfs.pod:1779 ../src/guestfs.pod:1784 ../src/guestfs.pod:1788
928 #: ../src/guestfs.pod:2140 ../src/guestfs.pod:2146 ../src/guestfs.pod:2151
929 #: ../src/guestfs.pod:2157 ../src/guestfs.pod:2622 ../src/guestfs.pod:2626
930 #: ../src/guestfs.pod:2630 ../src/guestfs.pod:2634
931 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
932 #: ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585
933 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599
934 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
935 #: ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607
936 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1619
937 #: ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1633
938 #: ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1641
939 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1783
940 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
941 #: ../src/guestfs-actions.pod:1854 ../src/guestfs-actions.pod:1858
942 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish.pod:432
943 #: ../fish/guestfish.pod:436 ../fish/guestfish.pod:440
944 #: ../fish/guestfish.pod:444 ../fish/guestfish-actions.pod:13
945 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380
946 #: ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395
947 #: ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072
948 #: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080
949 #: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092
950 #: ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100
951 #: ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114
952 #: ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208
953 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217
954 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264
955 #: ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273
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:1281 ../src/guestfs.pod:1412
1104 #: ../src/guestfs.pod:2185
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:1285 ../src/guestfs.pod:1416
1126 #: ../src/guestfs.pod:2210
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:1422
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:751
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 #: ../src/guestfs.pod:975
2250 msgid "ATTACHING TO RUNNING DAEMONS"
2251 msgstr ""
2252
2253 #. type: textblock
2254 #: ../src/guestfs.pod:977
2255 msgid ""
2256 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2257 "babies.  Use with caution."
2258 msgstr ""
2259
2260 #. type: textblock
2261 #: ../src/guestfs.pod:980
2262 msgid ""
2263 "I<Note (2):> This section explains how to attach to a running daemon from a "
2264 "low level perspective.  For most users, simply using virt tools such as "
2265 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2266 msgstr ""
2267
2268 #. type: =head3
2269 #: ../src/guestfs.pod:984
2270 msgid "Using guestfs_set_attach_method"
2271 msgstr ""
2272
2273 #. type: textblock
2274 #: ../src/guestfs.pod:986
2275 msgid ""
2276 "By calling L</guestfs_set_attach_method> you can change how the library "
2277 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2278 "ARCHITECTURE> for some background)."
2279 msgstr ""
2280
2281 #. type: textblock
2282 #: ../src/guestfs.pod:990
2283 msgid ""
2284 "The normal attach method is C<appliance>, where a small appliance is created "
2285 "containing the daemon, and then the library connects to this."
2286 msgstr ""
2287
2288 #. type: textblock
2289 #: ../src/guestfs.pod:993
2290 msgid ""
2291 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2292 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2293 "daemon over the Unix domain socket."
2294 msgstr ""
2295
2296 #. type: textblock
2297 #: ../src/guestfs.pod:997
2298 msgid ""
2299 "The normal use for this is to connect to a running virtual machine that "
2300 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2301 "files inside the live virtual machine."
2302 msgstr ""
2303
2304 #. type: =head3
2305 #: ../src/guestfs.pod:1001
2306 msgid "Using guestfs_add_domain with live flag"
2307 msgstr ""
2308
2309 #. type: textblock
2310 #: ../src/guestfs.pod:1003
2311 msgid ""
2312 "L</guestfs_add_domain> provides some help for getting the correct attach "
2313 "method.  If you pass the C<live> option to this function, then (if the "
2314 "virtual machine is running) it will examine the libvirt XML looking for a "
2315 "virtio-serial channel to connect to:"
2316 msgstr ""
2317
2318 #. type: verbatim
2319 #: ../src/guestfs.pod:1009
2320 #, no-wrap
2321 msgid ""
2322 " <domain>\n"
2323 "   ...\n"
2324 "   <devices>\n"
2325 "     ...\n"
2326 "     <channel type='unix'>\n"
2327 "       <source mode='bind' path='/path/to/socket'/>\n"
2328 "       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2329 "     </channel>\n"
2330 "     ...\n"
2331 "   </devices>\n"
2332 " </domain>\n"
2333 "\n"
2334 msgstr ""
2335
2336 #. type: textblock
2337 #: ../src/guestfs.pod:1021
2338 msgid ""
2339 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2340 "method to C<unix:/path/to/socket>."
2341 msgstr ""
2342
2343 #. type: textblock
2344 #: ../src/guestfs.pod:1024
2345 msgid ""
2346 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2347 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2348 "to attach to and modify live virtual machines."
2349 msgstr ""
2350
2351 #. type: textblock
2352 #: ../src/guestfs.pod:1028
2353 msgid ""
2354 "The virtual machine needs to have been set up beforehand so that it has the "
2355 "virtio-serial channel and so that guestfsd is running inside it."
2356 msgstr ""
2357
2358 # type: =head2
2359 #. type: =head2
2360 #: ../src/guestfs.pod:1032
2361 msgid "ABI GUARANTEE"
2362 msgstr ""
2363
2364 # type: textblock
2365 #. type: textblock
2366 #: ../src/guestfs.pod:1034
2367 msgid ""
2368 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2369 "actions as outlined in this section.  Although we will deprecate some "
2370 "actions, for example if they get replaced by newer calls, we will keep the "
2371 "old actions forever.  This allows you the developer to program in confidence "
2372 "against the libguestfs API."
2373 msgstr ""
2374
2375 # type: =head1
2376 #. type: =head2
2377 #: ../src/guestfs.pod:1040
2378 msgid "BLOCK DEVICE NAMING"
2379 msgstr ""
2380
2381 # type: textblock
2382 #. type: textblock
2383 #: ../src/guestfs.pod:1042
2384 msgid ""
2385 "In the kernel there is now quite a profusion of schemata for naming block "
2386 "devices (in this context, by I<block device> I mean a physical or virtual "
2387 "hard drive).  The original Linux IDE driver used names starting with C</dev/"
2388 "hd*>.  SCSI devices have historically used a different naming scheme, C</dev/"
2389 "sd*>.  When the Linux kernel I<libata> driver became a popular replacement "
2390 "for the old IDE driver (particularly for SATA devices) those devices also "
2391 "used the C</dev/sd*> scheme.  Additionally we now have virtual machines with "
2392 "paravirtualized drivers.  This has created several different naming systems, "
2393 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2394 msgstr ""
2395
2396 # type: textblock
2397 #. type: textblock
2398 #: ../src/guestfs.pod:1054
2399 msgid ""
2400 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2401 "Linux kernel to access block devices.  We can run a variety of appliances "
2402 "based on a variety of Linux kernels."
2403 msgstr ""
2404
2405 # type: textblock
2406 #. type: textblock
2407 #: ../src/guestfs.pod:1058
2408 msgid ""
2409 "This causes a problem for libguestfs because many API calls use device or "
2410 "partition names.  Working scripts and the recipe (example) scripts that we "
2411 "make available over the internet could fail if the naming scheme changes."
2412 msgstr ""
2413
2414 # type: textblock
2415 #. type: textblock
2416 #: ../src/guestfs.pod:1063
2417 msgid ""
2418 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
2419 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2420 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2421 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2422 msgstr ""
2423
2424 # type: textblock
2425 #. type: textblock
2426 #: ../src/guestfs.pod:1069
2427 msgid ""
2428 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
2429 "L</guestfs_list_partitions> and similar calls return the true names of the "
2430 "devices and partitions as known to the appliance."
2431 msgstr ""
2432
2433 # type: =head2
2434 #. type: =head3
2435 #: ../src/guestfs.pod:1074
2436 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2437 msgstr ""
2438
2439 # type: textblock
2440 #. type: textblock
2441 #: ../src/guestfs.pod:1076
2442 msgid ""
2443 "Usually this translation is transparent.  However in some (very rare)  cases "
2444 "you may need to know the exact algorithm.  Such cases include where you use "
2445 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2446 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2447 msgstr ""
2448
2449 # type: textblock
2450 #. type: textblock
2451 #: ../src/guestfs.pod:1082
2452 msgid ""
2453 "The algorithm is applied only to I<parameters> which are known to be either "
2454 "device or partition names.  Return values from functions such as L</"
2455 "guestfs_list_devices> are never changed."
2456 msgstr ""
2457
2458 # type: textblock
2459 #. type: textblock
2460 #: ../src/guestfs.pod:1090
2461 msgid "Is the string a parameter which is a device or partition name?"
2462 msgstr ""
2463
2464 # type: textblock
2465 #. type: textblock
2466 #: ../src/guestfs.pod:1094
2467 msgid "Does the string begin with C</dev/sd>?"
2468 msgstr ""
2469
2470 # type: textblock
2471 #. type: textblock
2472 #: ../src/guestfs.pod:1098
2473 msgid ""
2474 "Does the named device exist? If so, we use that device.  However if I<not> "
2475 "then we continue with this algorithm."
2476 msgstr ""
2477
2478 # type: textblock
2479 #. type: textblock
2480 #: ../src/guestfs.pod:1103
2481 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2482 msgstr ""
2483
2484 # type: textblock
2485 #. type: textblock
2486 #: ../src/guestfs.pod:1105
2487 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2488 msgstr ""
2489
2490 # type: textblock
2491 #. type: textblock
2492 #: ../src/guestfs.pod:1107
2493 msgid "If that named device exists, use it.  If not, continue."
2494 msgstr ""
2495
2496 # type: textblock
2497 #. type: textblock
2498 #: ../src/guestfs.pod:1111
2499 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2500 msgstr ""
2501
2502 # type: textblock
2503 #. type: textblock
2504 #: ../src/guestfs.pod:1113
2505 msgid "If that named device exists, use it.  If not, return an error."
2506 msgstr ""
2507
2508 # type: =head3
2509 #. type: =head3
2510 #: ../src/guestfs.pod:1117
2511 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2512 msgstr ""
2513
2514 # type: textblock
2515 #. type: textblock
2516 #: ../src/guestfs.pod:1119
2517 msgid ""
2518 "Although the standard naming scheme and automatic translation is useful for "
2519 "simple programs and guestfish scripts, for larger programs it is best not to "
2520 "rely on this mechanism."
2521 msgstr ""
2522
2523 # type: textblock
2524 #. type: textblock
2525 #: ../src/guestfs.pod:1123
2526 msgid ""
2527 "Where possible for maximum future portability programs using libguestfs "
2528 "should use these future-proof techniques:"
2529 msgstr ""
2530
2531 # type: textblock
2532 #. type: textblock
2533 #: ../src/guestfs.pod:1130
2534 msgid ""
2535 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2536 "device names, and then use those names directly."
2537 msgstr ""
2538
2539 # type: textblock
2540 #. type: textblock
2541 #: ../src/guestfs.pod:1133
2542 msgid ""
2543 "Since those device names exist by definition, they will never be translated."
2544 msgstr ""
2545
2546 # type: textblock
2547 #. type: textblock
2548 #: ../src/guestfs.pod:1138
2549 msgid ""
2550 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2551 "filesystem labels."
2552 msgstr ""
2553
2554 # type: =head1
2555 #. type: =head1
2556 #: ../src/guestfs.pod:1143
2557 msgid "SECURITY"
2558 msgstr ""
2559
2560 # type: textblock
2561 #. type: textblock
2562 #: ../src/guestfs.pod:1145
2563 msgid ""
2564 "This section discusses security implications of using libguestfs, "
2565 "particularly with untrusted or malicious guests or disk images."
2566 msgstr ""
2567
2568 # type: =head2
2569 #. type: =head2
2570 #: ../src/guestfs.pod:1148
2571 msgid "GENERAL SECURITY CONSIDERATIONS"
2572 msgstr ""
2573
2574 # type: textblock
2575 #. type: textblock
2576 #: ../src/guestfs.pod:1150
2577 msgid ""
2578 "Be careful with any files or data that you download from a guest (by "
2579 "\"download\" we mean not just the L</guestfs_download> command but any "
2580 "command that reads files, filenames, directories or anything else from a "
2581 "disk image).  An attacker could manipulate the data to fool your program "
2582 "into doing the wrong thing.  Consider cases such as:"
2583 msgstr ""
2584
2585 # type: textblock
2586 #. type: textblock
2587 #: ../src/guestfs.pod:1160
2588 msgid "the data (file etc) not being present"
2589 msgstr ""
2590
2591 # type: textblock
2592 #. type: textblock
2593 #: ../src/guestfs.pod:1164
2594 msgid "being present but empty"
2595 msgstr ""
2596
2597 # type: textblock
2598 #. type: textblock
2599 #: ../src/guestfs.pod:1168
2600 msgid "being much larger than normal"
2601 msgstr ""
2602
2603 # type: textblock
2604 #. type: textblock
2605 #: ../src/guestfs.pod:1172
2606 msgid "containing arbitrary 8 bit data"
2607 msgstr ""
2608
2609 # type: textblock
2610 #. type: textblock
2611 #: ../src/guestfs.pod:1176
2612 msgid "being in an unexpected character encoding"
2613 msgstr ""
2614
2615 # type: textblock
2616 #. type: textblock
2617 #: ../src/guestfs.pod:1180
2618 msgid "containing homoglyphs."
2619 msgstr ""
2620
2621 # type: =head2
2622 #. type: =head2
2623 #: ../src/guestfs.pod:1184
2624 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2625 msgstr ""
2626
2627 # type: textblock
2628 #. type: textblock
2629 #: ../src/guestfs.pod:1186
2630 msgid ""
2631 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2632 "(VFS) module can sometimes be escalated into exploits by deliberately "
2633 "creating a malicious, malformed filesystem.  These exploits are very severe "
2634 "for two reasons.  Firstly there are very many filesystem drivers in the "
2635 "kernel, and many of them are infrequently used and not much developer "
2636 "attention has been paid to the code.  Linux userspace helps potential "
2637 "crackers by detecting the filesystem type and automatically choosing the "
2638 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2639 "the administrator.  Secondly, a kernel-level exploit is like a local root "
2640 "exploit (worse in some ways), giving immediate and total access to the "
2641 "system right down to the hardware level."
2642 msgstr ""
2643
2644 # type: textblock
2645 #. type: textblock
2646 #: ../src/guestfs.pod:1199
2647 msgid ""
2648 "That explains why you should never mount a filesystem from an untrusted "
2649 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
2650 "inside a qemu virtual machine, usually running as a non-root user.  The "
2651 "attacker would need to write a filesystem which first exploited the kernel, "
2652 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2653 "the libguestfs protocol, and finally to be as serious as the host kernel "
2654 "exploit it would need to escalate its privileges to root.  This multi-step "
2655 "escalation, performed by a static piece of data, is thought to be extremely "
2656 "hard to do, although we never say 'never' about security issues."
2657 msgstr ""
2658
2659 # type: textblock
2660 #. type: textblock
2661 #: ../src/guestfs.pod:1210
2662 msgid ""
2663 "In any case callers can reduce the attack surface by forcing the filesystem "
2664 "type when mounting (use L</guestfs_mount_vfs>)."
2665 msgstr ""
2666
2667 # type: =head2
2668 #. type: =head2
2669 #: ../src/guestfs.pod:1213
2670 msgid "PROTOCOL SECURITY"
2671 msgstr ""
2672
2673 # type: textblock
2674 #. type: textblock
2675 #: ../src/guestfs.pod:1215
2676 msgid ""
2677 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
2678 "defined upper message size.  However a program that uses libguestfs must "
2679 "also take care - for example you can write a program that downloads a binary "
2680 "from a disk image and executes it locally, and no amount of protocol "
2681 "security will save you from the consequences."
2682 msgstr ""
2683
2684 # type: =head2
2685 #. type: =head2
2686 #: ../src/guestfs.pod:1221
2687 msgid "INSPECTION SECURITY"
2688 msgstr ""
2689
2690 # type: textblock
2691 #. type: textblock
2692 #: ../src/guestfs.pod:1223
2693 msgid ""
2694 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2695 "directly from the guest, and these could contain any 8 bit data.  Callers "
2696 "should be careful to escape these before printing them to a structured file "
2697 "(for example, use HTML escaping if creating a web page)."
2698 msgstr ""
2699
2700 # type: textblock
2701 #. type: textblock
2702 #: ../src/guestfs.pod:1229
2703 msgid ""
2704 "Guest configuration may be altered in unusual ways by the administrator of "
2705 "the virtual machine, and may not reflect reality (particularly for untrusted "
2706 "or actively malicious guests).  For example we parse the hostname from "
2707 "configuration files like C</etc/sysconfig/network> that we find in the "
2708 "guest, but the guest administrator can easily manipulate these files to "
2709 "provide the wrong hostname."
2710 msgstr ""
2711
2712 # type: textblock
2713 #. type: textblock
2714 #: ../src/guestfs.pod:1237
2715 msgid ""
2716 "The inspection API parses guest configuration using two external libraries: "
2717 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
2718 "designed to be robust in the face of malicious data, although denial of "
2719 "service attacks are still possible, for example with oversized configuration "
2720 "files."
2721 msgstr ""
2722
2723 # type: =head2
2724 #. type: =head2
2725 #: ../src/guestfs.pod:1243
2726 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2727 msgstr ""
2728
2729 # type: textblock
2730 #. type: textblock
2731 #: ../src/guestfs.pod:1245
2732 msgid ""
2733 "Be very cautious about running commands from the guest.  By running a "
2734 "command in the guest, you are giving CPU time to a binary that you do not "
2735 "control, under the same user account as the library, albeit wrapped in qemu "
2736 "virtualization.  More information and alternatives can be found in the "
2737 "section L</RUNNING COMMANDS>."
2738 msgstr ""
2739
2740 # type: =head2
2741 #. type: =head2
2742 #: ../src/guestfs.pod:1251
2743 msgid "CVE-2010-3851"
2744 msgstr ""
2745
2746 # type: textblock
2747 #. type: textblock
2748 #: ../src/guestfs.pod:1253
2749 msgid "https://bugzilla.redhat.com/642934"
2750 msgstr ""
2751
2752 # type: textblock
2753 #. type: textblock
2754 #: ../src/guestfs.pod:1255
2755 msgid ""
2756 "This security bug concerns the automatic disk format detection that qemu "
2757 "does on disk images."
2758 msgstr ""
2759
2760 # type: textblock
2761 #. type: textblock
2762 #: ../src/guestfs.pod:1258
2763 msgid ""
2764 "A raw disk image is just the raw bytes, there is no header.  Other disk "
2765 "images like qcow2 contain a special header.  Qemu deals with this by looking "
2766 "for one of the known headers, and if none is found then assuming the disk "
2767 "image must be raw."
2768 msgstr ""
2769
2770 # type: textblock
2771 #. type: textblock
2772 #: ../src/guestfs.pod:1263
2773 msgid ""
2774 "This allows a guest which has been given a raw disk image to write some "
2775 "other header.  At next boot (or when the disk image is accessed by "
2776 "libguestfs) qemu would do autodetection and think the disk image format was, "
2777 "say, qcow2 based on the header written by the guest."
2778 msgstr ""
2779
2780 # type: textblock
2781 #. type: textblock
2782 #: ../src/guestfs.pod:1268
2783 msgid ""
2784 "This in itself would not be a problem, but qcow2 offers many features, one "
2785 "of which is to allow a disk image to refer to another image (called the "
2786 "\"backing disk\").  It does this by placing the path to the backing disk "
2787 "into the qcow2 header.  This path is not validated and could point to any "
2788 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
2789 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2790 "control of the attacker."
2791 msgstr ""
2792
2793 # type: textblock
2794 #. type: textblock
2795 #: ../src/guestfs.pod:1276
2796 msgid ""
2797 "In libguestfs this is rather hard to exploit except under two circumstances:"
2798 msgstr ""
2799
2800 # type: textblock
2801 #. type: textblock
2802 #: ../src/guestfs.pod:1283
2803 msgid "You have enabled the network or have opened the disk in write mode."
2804 msgstr ""
2805
2806 # type: textblock
2807 #. type: textblock
2808 #: ../src/guestfs.pod:1287
2809 msgid ""
2810 "You are also running untrusted code from the guest (see L</RUNNING "
2811 "COMMANDS>)."
2812 msgstr ""
2813
2814 # type: textblock
2815 #. type: textblock
2816 #: ../src/guestfs.pod:1292
2817 msgid ""
2818 "The way to avoid this is to specify the expected disk format when adding "
2819 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
2820 "should always do this if the disk is raw format, and it's a good idea for "
2821 "other cases too."
2822 msgstr ""
2823
2824 # type: textblock
2825 #. type: textblock
2826 #: ../src/guestfs.pod:1297
2827 msgid ""
2828 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2829 "format is fetched from libvirt and passed through."
2830 msgstr ""
2831
2832 # type: textblock
2833 #. type: textblock
2834 #: ../src/guestfs.pod:1300
2835 msgid ""
2836 "For libguestfs tools, use the I<--format> command line parameter as "
2837 "appropriate."
2838 msgstr ""
2839
2840 # type: =head1
2841 #. type: =head1
2842 #: ../src/guestfs.pod:1303
2843 msgid "CONNECTION MANAGEMENT"
2844 msgstr ""
2845
2846 # type: =head2
2847 #. type: =head2
2848 #: ../src/guestfs.pod:1305
2849 msgid "guestfs_h *"
2850 msgstr ""
2851
2852 # type: textblock
2853 #. type: textblock
2854 #: ../src/guestfs.pod:1307
2855 msgid ""
2856 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
2857 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
2858 "handle and release all resources used."
2859 msgstr ""
2860
2861 # type: textblock
2862 #. type: textblock
2863 #: ../src/guestfs.pod:1311
2864 msgid ""
2865 "For information on using multiple handles and threads, see the section L</"
2866 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2867 msgstr ""
2868
2869 # type: =head2
2870 #. type: =head2
2871 #: ../src/guestfs.pod:1314
2872 msgid "guestfs_create"
2873 msgstr ""
2874
2875 # type: verbatim
2876 #. type: verbatim
2877 #: ../src/guestfs.pod:1316
2878 #, no-wrap
2879 msgid ""
2880 " guestfs_h *guestfs_create (void);\n"
2881 "\n"
2882 msgstr ""
2883
2884 # type: textblock
2885 #. type: textblock
2886 #: ../src/guestfs.pod:1318
2887 msgid "Create a connection handle."
2888 msgstr ""
2889
2890 # type: textblock
2891 #. type: textblock
2892 #: ../src/guestfs.pod:1320
2893 msgid ""
2894 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2895 "on the handle at least once."
2896 msgstr ""
2897
2898 # type: textblock
2899 #. type: textblock
2900 #: ../src/guestfs.pod:1323
2901 msgid ""
2902 "This function returns a non-NULL pointer to a handle on success or NULL on "
2903 "error."
2904 msgstr ""
2905
2906 # type: textblock
2907 #. type: textblock
2908 #: ../src/guestfs.pod:1326
2909 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2910 msgstr ""
2911
2912 # type: textblock
2913 #. type: textblock
2914 #: ../src/guestfs.pod:1328
2915 msgid ""
2916 "You may also want to configure error handling for the handle.  See L</ERROR "
2917 "HANDLING> section below."
2918 msgstr ""
2919
2920 # type: =head2
2921 #. type: =head2
2922 #: ../src/guestfs.pod:1331
2923 msgid "guestfs_close"
2924 msgstr ""
2925
2926 # type: verbatim
2927 #. type: verbatim
2928 #: ../src/guestfs.pod:1333
2929 #, no-wrap
2930 msgid ""
2931 " void guestfs_close (guestfs_h *g);\n"
2932 "\n"
2933 msgstr ""
2934
2935 # type: textblock
2936 #. type: textblock
2937 #: ../src/guestfs.pod:1335
2938 msgid "This closes the connection handle and frees up all resources used."
2939 msgstr ""
2940
2941 # type: =head1
2942 #. type: =head1
2943 #: ../src/guestfs.pod:1337
2944 msgid "ERROR HANDLING"
2945 msgstr ""
2946
2947 # type: textblock
2948 #. type: textblock
2949 #: ../src/guestfs.pod:1339
2950 msgid ""
2951 "API functions can return errors.  For example, almost all functions that "
2952 "return C<int> will return C<-1> to indicate an error."
2953 msgstr ""
2954
2955 # type: textblock
2956 #. type: textblock
2957 #: ../src/guestfs.pod:1342
2958 msgid ""
2959 "Additional information is available for errors: an error message string and "
2960 "optionally an error number (errno) if the thing that failed was a system "
2961 "call."
2962 msgstr ""
2963
2964 # type: textblock
2965 #. type: textblock
2966 #: ../src/guestfs.pod:1346
2967 msgid ""
2968 "You can get at the additional information about the last error on the handle "
2969 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2970 "up an error handler with L</guestfs_set_error_handler>."
2971 msgstr ""
2972
2973 # type: textblock
2974 #. type: textblock
2975 #: ../src/guestfs.pod:1351
2976 msgid ""
2977 "When the handle is created, a default error handler is installed which "
2978 "prints the error message string to C<stderr>.  For small short-running "
2979 "command line programs it is sufficient to do:"
2980 msgstr ""
2981
2982 # type: verbatim
2983 #. type: verbatim
2984 #: ../src/guestfs.pod:1355
2985 #, no-wrap
2986 msgid ""
2987 " if (guestfs_launch (g) == -1)\n"
2988 "   exit (EXIT_FAILURE);\n"
2989 "\n"
2990 msgstr ""
2991
2992 # type: textblock
2993 #. type: textblock
2994 #: ../src/guestfs.pod:1358
2995 msgid ""
2996 "since the default error handler will ensure that an error message has been "
2997 "printed to C<stderr> before the program exits."
2998 msgstr ""
2999
3000 # type: textblock
3001 #. type: textblock
3002 #: ../src/guestfs.pod:1361
3003 msgid ""
3004 "For other programs the caller will almost certainly want to install an "
3005 "alternate error handler or do error handling in-line like this:"
3006 msgstr ""
3007
3008 # type: verbatim
3009 #. type: verbatim
3010 #: ../src/guestfs.pod:1364
3011 #, no-wrap
3012 msgid ""
3013 " g = guestfs_create ();\n"
3014 " \n"
3015 msgstr ""
3016
3017 # type: verbatim
3018 #. type: verbatim
3019 #: ../src/guestfs.pod:1366
3020 #, no-wrap
3021 msgid ""
3022 " /* This disables the default behaviour of printing errors\n"
3023 "    on stderr. */\n"
3024 " guestfs_set_error_handler (g, NULL, NULL);\n"
3025 " \n"
3026 msgstr ""
3027
3028 # type: verbatim
3029 #. type: verbatim
3030 #: ../src/guestfs.pod:1370
3031 #, no-wrap
3032 msgid ""
3033 " if (guestfs_launch (g) == -1) {\n"
3034 "   /* Examine the error message and print it etc. */\n"
3035 "   char *msg = guestfs_last_error (g);\n"
3036 "   int errnum = guestfs_last_errno (g);\n"
3037 "   fprintf (stderr, \"%s\\n\", msg);\n"
3038 "   /* ... */\n"
3039 "  }\n"
3040 "\n"
3041 msgstr ""
3042
3043 # type: textblock
3044 #. type: textblock
3045 #: ../src/guestfs.pod:1378
3046 msgid ""
3047 "Out of memory errors are handled differently.  The default action is to call "
3048 "L<abort(3)>.  If this is undesirable, then you can set a handler using L</"
3049 "guestfs_set_out_of_memory_handler>."
3050 msgstr ""
3051
3052 # type: textblock
3053 #. type: textblock
3054 #: ../src/guestfs.pod:1382
3055 msgid ""
3056 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3057 "because there is no handle if this happens there is no way to get additional "
3058 "error information.  However L</guestfs_create> is supposed to be a "
3059 "lightweight operation which can only fail because of insufficient memory (it "
3060 "returns NULL in this case)."
3061 msgstr ""
3062
3063 # type: =head2
3064 #. type: =head2
3065 #: ../src/guestfs.pod:1388
3066 msgid "guestfs_last_error"
3067 msgstr ""
3068
3069 # type: verbatim
3070 #. type: verbatim
3071 #: ../src/guestfs.pod:1390
3072 #, no-wrap
3073 msgid ""
3074 " const char *guestfs_last_error (guestfs_h *g);\n"
3075 "\n"
3076 msgstr ""
3077
3078 # type: textblock
3079 #. type: textblock
3080 #: ../src/guestfs.pod:1392
3081 msgid ""
3082 "This returns the last error message that happened on C<g>.  If there has not "
3083 "been an error since the handle was created, then this returns C<NULL>."
3084 msgstr ""
3085
3086 # type: textblock
3087 #. type: textblock
3088 #: ../src/guestfs.pod:1396
3089 msgid ""
3090 "The lifetime of the returned string is until the next error occurs, or L</"
3091 "guestfs_close> is called."
3092 msgstr ""
3093
3094 # type: =head2
3095 #. type: =head2
3096 #: ../src/guestfs.pod:1399
3097 msgid "guestfs_last_errno"
3098 msgstr ""
3099
3100 # type: verbatim
3101 #. type: verbatim
3102 #: ../src/guestfs.pod:1401
3103 #, no-wrap
3104 msgid ""
3105 " int guestfs_last_errno (guestfs_h *g);\n"
3106 "\n"
3107 msgstr ""
3108
3109 # type: textblock
3110 #. type: textblock
3111 #: ../src/guestfs.pod:1403
3112 msgid "This returns the last error number (errno) that happened on C<g>."
3113 msgstr ""
3114
3115 # type: textblock
3116 #. type: textblock
3117 #: ../src/guestfs.pod:1405
3118 msgid "If successful, an errno integer not equal to zero is returned."
3119 msgstr ""
3120
3121 # type: textblock
3122 #. type: textblock
3123 #: ../src/guestfs.pod:1407
3124 msgid ""
3125 "If no error, this returns 0.  This call can return 0 in three situations:"
3126 msgstr ""
3127
3128 # type: textblock
3129 #. type: textblock
3130 #: ../src/guestfs.pod:1414
3131 msgid "There has not been any error on the handle."
3132 msgstr ""
3133
3134 # type: textblock
3135 #. type: textblock
3136 #: ../src/guestfs.pod:1418
3137 msgid ""
3138 "There has been an error but the errno was meaningless.  This corresponds to "
3139 "the case where the error did not come from a failed system call, but for "
3140 "some other reason."
3141 msgstr ""
3142
3143 # type: textblock
3144 #. type: textblock
3145 #: ../src/guestfs.pod:1424
3146 msgid ""
3147 "There was an error from a failed system call, but for some reason the errno "
3148 "was not captured and returned.  This usually indicates a bug in libguestfs."
3149 msgstr ""
3150
3151 # type: textblock
3152 #. type: textblock
3153 #: ../src/guestfs.pod:1430
3154 msgid ""
3155 "Libguestfs tries to convert the errno from inside the applicance into a "
3156 "corresponding errno for the caller (not entirely trivial: the appliance "
3157 "might be running a completely different operating system from the library "
3158 "and error numbers are not standardized across Un*xen).  If this could not be "
3159 "done, then the error is translated to C<EINVAL>.  In practice this should "
3160 "only happen in very rare circumstances."
3161 msgstr ""
3162
3163 # type: =head2
3164 #. type: =head2
3165 #: ../src/guestfs.pod:1438
3166 msgid "guestfs_set_error_handler"
3167 msgstr ""
3168
3169 # type: verbatim
3170 #. type: verbatim
3171 #: ../src/guestfs.pod:1440
3172 #, no-wrap
3173 msgid ""
3174 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3175 "                                           void *opaque,\n"
3176 "                                           const char *msg);\n"
3177 " void guestfs_set_error_handler (guestfs_h *g,\n"
3178 "                                 guestfs_error_handler_cb cb,\n"
3179 "                                 void *opaque);\n"
3180 "\n"
3181 msgstr ""
3182
3183 # type: textblock
3184 #. type: textblock
3185 #: ../src/guestfs.pod:1447
3186 msgid ""
3187 "The callback C<cb> will be called if there is an error.  The parameters "
3188 "passed to the callback are an opaque data pointer and the error message "
3189 "string."
3190 msgstr ""
3191
3192 # type: textblock
3193 #. type: textblock
3194 #: ../src/guestfs.pod:1451
3195 msgid ""
3196 "C<errno> is not passed to the callback.  To get that the callback must call "
3197 "L</guestfs_last_errno>."
3198 msgstr ""
3199
3200 # type: textblock
3201 #. type: textblock
3202 #: ../src/guestfs.pod:1454
3203 msgid ""
3204 "Note that the message string C<msg> is freed as soon as the callback "
3205 "function returns, so if you want to stash it somewhere you must make your "
3206 "own copy."
3207 msgstr ""
3208
3209 # type: textblock
3210 #. type: textblock
3211 #: ../src/guestfs.pod:1458
3212 msgid "The default handler prints messages on C<stderr>."
3213 msgstr ""
3214
3215 # type: textblock
3216 #. type: textblock
3217 #: ../src/guestfs.pod:1460
3218 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3219 msgstr ""
3220
3221 # type: =head2
3222 #. type: =head2
3223 #: ../src/guestfs.pod:1462
3224 msgid "guestfs_get_error_handler"
3225 msgstr ""
3226
3227 # type: verbatim
3228 #. type: verbatim
3229 #: ../src/guestfs.pod:1464
3230 #, no-wrap
3231 msgid ""
3232 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3233 "                                                     void **opaque_rtn);\n"
3234 "\n"
3235 msgstr ""
3236
3237 # type: textblock
3238 #. type: textblock
3239 #: ../src/guestfs.pod:1467
3240 msgid "Returns the current error handler callback."
3241 msgstr ""
3242
3243 # type: =head2
3244 #. type: =head2
3245 #: ../src/guestfs.pod:1469
3246 msgid "guestfs_set_out_of_memory_handler"
3247 msgstr ""
3248
3249 # type: verbatim
3250 #. type: verbatim
3251 #: ../src/guestfs.pod:1471
3252 #, no-wrap
3253 msgid ""
3254 " typedef void (*guestfs_abort_cb) (void);\n"
3255 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3256 "                                        guestfs_abort_cb);\n"
3257 "\n"
3258 msgstr ""
3259
3260 # type: textblock
3261 #. type: textblock
3262 #: ../src/guestfs.pod:1475
3263 msgid ""
3264 "The callback C<cb> will be called if there is an out of memory situation.  "
3265 "I<Note this callback must not return>."
3266 msgstr ""
3267
3268 # type: textblock
3269 #. type: textblock
3270 #: ../src/guestfs.pod:1478
3271 msgid "The default is to call L<abort(3)>."
3272 msgstr ""
3273
3274 # type: textblock
3275 #. type: textblock
3276 #: ../src/guestfs.pod:1480
3277 msgid ""
3278 "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
3279 msgstr ""
3280
3281 # type: =head2
3282 #. type: =head2
3283 #: ../src/guestfs.pod:1483
3284 msgid "guestfs_get_out_of_memory_handler"
3285 msgstr ""
3286
3287 # type: verbatim
3288 #. type: verbatim
3289 #: ../src/guestfs.pod:1485
3290 #, no-wrap
3291 msgid ""
3292 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3293 "\n"
3294 msgstr ""
3295
3296 # type: textblock
3297 #. type: textblock
3298 #: ../src/guestfs.pod:1487
3299 msgid "This returns the current out of memory handler."
3300 msgstr ""
3301
3302 # type: =head1
3303 #. type: =head1
3304 #: ../src/guestfs.pod:1489
3305 msgid "API CALLS"
3306 msgstr ""
3307
3308 # type: textblock
3309 #. type: textblock
3310 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:989
3311 msgid "@ACTIONS@"
3312 msgstr ""
3313
3314 # type: =head1
3315 #. type: =head1
3316 #: ../src/guestfs.pod:1493
3317 msgid "STRUCTURES"
3318 msgstr ""
3319
3320 # type: textblock
3321 #. type: textblock
3322 #: ../src/guestfs.pod:1495
3323 msgid "@STRUCTS@"
3324 msgstr ""
3325
3326 # type: =head1
3327 #. type: =head1
3328 #: ../src/guestfs.pod:1497
3329 msgid "AVAILABILITY"
3330 msgstr ""
3331
3332 # type: =head2
3333 #. type: =head2
3334 #: ../src/guestfs.pod:1499
3335 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3336 msgstr ""
3337
3338 # type: textblock
3339 #. type: textblock
3340 #: ../src/guestfs.pod:1501
3341 msgid ""
3342 "Using L</guestfs_available> you can test availability of the following "
3343 "groups of functions.  This test queries the appliance to see if the "
3344 "appliance you are currently using supports the functionality."
3345 msgstr ""
3346
3347 # type: textblock
3348 #. type: textblock
3349 #: ../src/guestfs.pod:1506
3350 msgid "@AVAILABILITY@"
3351 msgstr ""
3352
3353 # type: =head2
3354 #. type: =head2
3355 #: ../src/guestfs.pod:1508
3356 msgid "GUESTFISH supported COMMAND"
3357 msgstr ""
3358
3359 # type: textblock
3360 #. type: textblock
3361 #: ../src/guestfs.pod:1510
3362 msgid ""
3363 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3364 "prints out the available groups and whether they are supported by this build "
3365 "of libguestfs.  Note however that you have to do C<run> first."
3366 msgstr ""
3367
3368 # type: =head2
3369 #. type: =head2
3370 #: ../src/guestfs.pod:1515
3371 msgid "SINGLE CALLS AT COMPILE TIME"
3372 msgstr ""
3373
3374 # type: textblock
3375 #. type: textblock
3376 #: ../src/guestfs.pod:1517
3377 msgid ""
3378 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3379 "function, such as:"
3380 msgstr ""
3381
3382 # type: verbatim
3383 #. type: verbatim
3384 #: ../src/guestfs.pod:1520
3385 #, no-wrap
3386 msgid ""
3387 " #define LIBGUESTFS_HAVE_DD 1\n"
3388 "\n"
3389 msgstr ""
3390
3391 # type: textblock
3392 #. type: textblock
3393 #: ../src/guestfs.pod:1522
3394 msgid "if L</guestfs_dd> is available."
3395 msgstr ""
3396
3397 # type: textblock
3398 #. type: textblock
3399 #: ../src/guestfs.pod:1524
3400 msgid ""
3401 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3402 "function is available at compile time, we recommended using build tools such "
3403 "as autoconf or cmake.  For example in autotools you could use:"
3404 msgstr ""
3405
3406 # type: verbatim
3407 #. type: verbatim
3408 #: ../src/guestfs.pod:1529
3409 #, no-wrap
3410 msgid ""
3411 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3412 " AC_CHECK_FUNCS([guestfs_dd])\n"
3413 "\n"
3414 msgstr ""
3415
3416 # type: textblock
3417 #. type: textblock
3418 #: ../src/guestfs.pod:1532
3419 msgid ""
3420 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3421 "in your program."
3422 msgstr ""
3423
3424 # type: =head2
3425 #. type: =head2
3426 #: ../src/guestfs.pod:1535
3427 msgid "SINGLE CALLS AT RUN TIME"
3428 msgstr ""
3429
3430 # type: textblock
3431 #. type: textblock
3432 #: ../src/guestfs.pod:1537
3433 msgid ""
3434 "Testing at compile time doesn't guarantee that a function really exists in "
3435 "the library.  The reason is that you might be dynamically linked against a "
3436 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
3437 "This situation unfortunately results in a segmentation fault, which is a "
3438 "shortcoming of the C dynamic linking system itself."
3439 msgstr ""
3440
3441 # type: textblock
3442 #. type: textblock
3443 #: ../src/guestfs.pod:1544
3444 msgid ""
3445 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3446 "in this example program (note that you still need the compile time check as "
3447 "well):"
3448 msgstr ""
3449
3450 # type: verbatim
3451 #. type: verbatim
3452 #: ../src/guestfs.pod:1548
3453 #, no-wrap
3454 msgid ""
3455 " #include <stdio.h>\n"
3456 " #include <stdlib.h>\n"
3457 " #include <unistd.h>\n"
3458 " #include <dlfcn.h>\n"
3459 " #include <guestfs.h>\n"
3460 " \n"
3461 msgstr ""
3462
3463 # type: verbatim
3464 #. type: verbatim
3465 #: ../src/guestfs.pod:1554
3466 #, no-wrap
3467 msgid ""
3468 " main ()\n"
3469 " {\n"
3470 " #ifdef LIBGUESTFS_HAVE_DD\n"
3471 "   void *dl;\n"
3472 "   int has_function;\n"
3473 " \n"
3474 msgstr ""
3475
3476 # type: verbatim
3477 #. type: verbatim
3478 #: ../src/guestfs.pod:1560
3479 #, no-wrap
3480 msgid ""
3481 "   /* Test if the function guestfs_dd is really available. */\n"
3482 "   dl = dlopen (NULL, RTLD_LAZY);\n"
3483 "   if (!dl) {\n"
3484 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3485 "     exit (EXIT_FAILURE);\n"
3486 "   }\n"
3487 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3488 "   dlclose (dl);\n"
3489 " \n"
3490 msgstr ""
3491
3492 # type: verbatim
3493 #. type: verbatim
3494 #: ../src/guestfs.pod:1569
3495 #, no-wrap
3496 msgid ""
3497 "   if (!has_function)\n"
3498 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3499 "   else {\n"
3500 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3501 "     /* Now it's safe to call\n"
3502 "     guestfs_dd (g, \"foo\", \"bar\");\n"
3503 "     */\n"
3504 "   }\n"
3505 " #else\n"
3506 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3507 " #endif\n"
3508 "  }\n"
3509 "\n"
3510 msgstr ""
3511
3512 # type: textblock
3513 #. type: textblock
3514 #: ../src/guestfs.pod:1582
3515 msgid ""
3516 "You may think the above is an awful lot of hassle, and it is.  There are "
3517 "other ways outside of the C linking system to ensure that this kind of "
3518 "incompatibility never arises, such as using package versioning:"
3519 msgstr ""
3520
3521 # type: verbatim
3522 #. type: verbatim
3523 #: ../src/guestfs.pod:1587
3524 #, no-wrap
3525 msgid ""
3526 " Requires: libguestfs >= 1.0.80\n"
3527 "\n"
3528 msgstr ""
3529
3530 # type: =head1
3531 #. type: =head1
3532 #: ../src/guestfs.pod:1589
3533 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3534 msgstr ""
3535
3536 # type: textblock
3537 #. type: textblock
3538 #: ../src/guestfs.pod:1591
3539 msgid ""
3540 "A recent feature of the API is the introduction of calls which take optional "
3541 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
3542 "takes variable arguments (ie. C<...>), as in this example:"
3543 msgstr ""
3544
3545 # type: verbatim
3546 #. type: verbatim
3547 #: ../src/guestfs.pod:1596
3548 #, no-wrap
3549 msgid ""
3550 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3551 "\n"
3552 msgstr ""
3553
3554 # type: textblock
3555 #. type: textblock
3556 #: ../src/guestfs.pod:1598
3557 msgid ""
3558 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
3559 "call with no optional arguments specified:"
3560 msgstr ""
3561
3562 # type: verbatim
3563 #. type: verbatim
3564 #: ../src/guestfs.pod:1601
3565 #, no-wrap
3566 msgid ""
3567 " guestfs_add_drive_opts (g, filename, -1);\n"
3568 "\n"
3569 msgstr ""
3570
3571 # type: textblock
3572 #. type: textblock
3573 #: ../src/guestfs.pod:1603
3574 msgid "With a single optional argument:"
3575 msgstr ""
3576
3577 # type: verbatim
3578 #. type: verbatim
3579 #: ../src/guestfs.pod:1605
3580 #, no-wrap
3581 msgid ""
3582 " guestfs_add_drive_opts (g, filename,\n"
3583 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3584 "                         -1);\n"
3585 "\n"
3586 msgstr ""
3587
3588 # type: textblock
3589 #. type: textblock
3590 #: ../src/guestfs.pod:1609
3591 msgid "With two:"
3592 msgstr ""
3593
3594 # type: verbatim
3595 #. type: verbatim
3596 #: ../src/guestfs.pod:1611
3597 #, no-wrap
3598 msgid ""
3599 " guestfs_add_drive_opts (g, filename,\n"
3600 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3601 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3602 "                         -1);\n"
3603 "\n"
3604 msgstr ""
3605
3606 # type: textblock
3607 #. type: textblock
3608 #: ../src/guestfs.pod:1616
3609 msgid ""
3610 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
3611 "happen!"
3612 msgstr ""
3613
3614 # type: =head2
3615 #. type: =head2
3616 #: ../src/guestfs.pod:1619
3617 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3618 msgstr ""
3619
3620 # type: textblock
3621 #. type: textblock
3622 #: ../src/guestfs.pod:1621
3623 msgid ""
3624 "The second variant has the same name with the suffix C<_va>, which works the "
3625 "same way but takes a C<va_list>.  See the C manual for details.  For the "
3626 "example function, this is declared:"
3627 msgstr ""
3628
3629 # type: verbatim
3630 #. type: verbatim
3631 #: ../src/guestfs.pod:1625
3632 #, no-wrap
3633 msgid ""
3634 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3635 "                                va_list args);\n"
3636 "\n"
3637 msgstr ""
3638
3639 # type: =head2
3640 #. type: =head2
3641 #: ../src/guestfs.pod:1628
3642 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3643 msgstr ""
3644
3645 # type: textblock
3646 #. type: textblock
3647 #: ../src/guestfs.pod:1630
3648 msgid ""
3649 "The third variant is useful where you need to construct these calls.  You "
3650 "pass in a structure where you fill in the optional fields.  The structure "
3651 "has a bitmask as the first element which you must set to indicate which "
3652 "fields you have filled in.  For our example function the structure and call "
3653 "are declared:"
3654 msgstr ""
3655
3656 # type: verbatim
3657 #. type: verbatim
3658 #: ../src/guestfs.pod:1636
3659 #, no-wrap
3660 msgid ""
3661 " struct guestfs_add_drive_opts_argv {\n"
3662 "   uint64_t bitmask;\n"
3663 "   int readonly;\n"
3664 "   const char *format;\n"
3665 "   /* ... */\n"
3666 " };\n"
3667 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3668 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
3669 "\n"
3670 msgstr ""
3671
3672 # type: textblock
3673 #. type: textblock
3674 #: ../src/guestfs.pod:1645
3675 msgid "You could call it like this:"
3676 msgstr ""
3677
3678 # type: verbatim
3679 #. type: verbatim
3680 #: ../src/guestfs.pod:1647
3681 #, no-wrap
3682 msgid ""
3683 " struct guestfs_add_drive_opts_argv optargs = {\n"
3684 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3685 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3686 "   .readonly = 1,\n"
3687 "   .format = \"qcow2\"\n"
3688 " };\n"
3689 " \n"
3690 msgstr ""
3691
3692 # type: verbatim
3693 #. type: verbatim
3694 #: ../src/guestfs.pod:1654
3695 #, no-wrap
3696 msgid ""
3697 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3698 "\n"
3699 msgstr ""
3700
3701 # type: textblock
3702 #. type: textblock
3703 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3704 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:9
3705 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3706 msgid "Notes:"
3707 msgstr ""
3708
3709 # type: textblock
3710 #. type: textblock
3711 #: ../src/guestfs.pod:1662
3712 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3713 msgstr ""
3714
3715 # type: textblock
3716 #. type: textblock
3717 #: ../src/guestfs.pod:1667
3718 msgid "You do not need to fill in all fields of the structure."
3719 msgstr ""
3720
3721 # type: textblock
3722 #. type: textblock
3723 #: ../src/guestfs.pod:1671
3724 msgid ""
3725 "There must be a one-to-one correspondence between fields of the structure "
3726 "that are filled in, and bits set in the bitmask."
3727 msgstr ""
3728
3729 # type: =head2
3730 #. type: =head2
3731 #: ../src/guestfs.pod:1676
3732 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3733 msgstr ""
3734
3735 # type: textblock
3736 #. type: textblock
3737 #: ../src/guestfs.pod:1678
3738 msgid ""
3739 "In other languages, optional arguments are expressed in the way that is "
3740 "natural for that language.  We refer you to the language-specific "
3741 "documentation for more details on that."
3742 msgstr ""
3743
3744 # type: textblock
3745 #. type: textblock
3746 #: ../src/guestfs.pod:1682
3747 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3748 msgstr ""
3749
3750 # type: =head2
3751 #. type: =head2
3752 #: ../src/guestfs.pod:1684
3753 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3754 msgstr ""
3755
3756 # type: textblock
3757 #. type: textblock
3758 #: ../src/guestfs.pod:1686
3759 msgid ""
3760 "The child process generates events in some situations.  Current events "
3761 "include: receiving a log message, the child process exits."
3762 msgstr ""
3763
3764 # type: textblock
3765 #. type: textblock
3766 #: ../src/guestfs.pod:1689
3767 msgid ""
3768 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3769 "types of events."
3770 msgstr ""
3771
3772 # type: textblock
3773 #. type: textblock
3774 #: ../src/guestfs.pod:1692
3775 msgid ""
3776 "Only I<one callback of each type> can be registered for each handle.  "
3777 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3778 "that type.  Cancel all callbacks of this type by calling this function with "
3779 "C<cb> set to C<NULL>."
3780 msgstr ""
3781
3782 # type: =head2
3783 #. type: =head2
3784 #: ../src/guestfs.pod:1697
3785 msgid "guestfs_set_log_message_callback"
3786 msgstr ""
3787
3788 # type: verbatim
3789 #. type: verbatim
3790 #: ../src/guestfs.pod:1699
3791 #, no-wrap
3792 msgid ""
3793 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3794 "                                         char *buf, int len);\n"
3795 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3796 "                                        guestfs_log_message_cb cb,\n"
3797 "                                        void *opaque);\n"
3798 "\n"
3799 msgstr ""
3800
3801 # type: textblock
3802 #. type: textblock
3803 #: ../src/guestfs.pod:1705
3804 msgid ""
3805 "The callback function C<cb> will be called whenever qemu or the guest writes "
3806 "anything to the console."
3807 msgstr ""
3808
3809 # type: textblock
3810 #. type: textblock
3811 #: ../src/guestfs.pod:1708
3812 msgid "Use this function to capture kernel messages and similar."
3813 msgstr ""
3814
3815 # type: textblock
3816 #. type: textblock
3817 #: ../src/guestfs.pod:1710
3818 msgid ""
3819 "Normally there is no log message handler, and log messages are just "
3820 "discarded."
3821 msgstr ""
3822
3823 # type: =head2
3824 #. type: =head2
3825 #: ../src/guestfs.pod:1713
3826 msgid "guestfs_set_subprocess_quit_callback"
3827 msgstr ""
3828
3829 # type: verbatim
3830 #. type: verbatim
3831 #: ../src/guestfs.pod:1715
3832 #, no-wrap
3833 msgid ""
3834 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3835 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3836 "                                            guestfs_subprocess_quit_cb cb,\n"
3837 "                                            void *opaque);\n"
3838 "\n"
3839 msgstr ""
3840
3841 # type: textblock
3842 #. type: textblock
3843 #: ../src/guestfs.pod:1720
3844 msgid ""
3845 "The callback function C<cb> will be called when the child process quits, "
3846 "either asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
3847 "corresponds to a transition from any state to the CONFIG state)."
3848 msgstr ""
3849
3850 # type: =head2
3851 #. type: =head2
3852 #: ../src/guestfs.pod:1725
3853 msgid "guestfs_set_launch_done_callback"
3854 msgstr ""
3855
3856 # type: verbatim
3857 #. type: verbatim
3858 #: ../src/guestfs.pod:1727
3859 #, no-wrap
3860 msgid ""
3861 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3862 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3863 "                                        guestfs_launch_done_cb cb,\n"
3864 "                                        void *opaque);\n"
3865 "\n"
3866 msgstr ""
3867
3868 # type: textblock
3869 #. type: textblock
3870 #: ../src/guestfs.pod:1732
3871 msgid ""
3872 "The callback function C<cb> will be called when the child process becomes "
3873 "ready first time after it has been launched.  (This corresponds to a "
3874 "transition from LAUNCHING to the READY state)."
3875 msgstr ""
3876
3877 # type: =head2
3878 #. type: =head2
3879 #: ../src/guestfs.pod:1736
3880 msgid "guestfs_set_close_callback"
3881 msgstr ""
3882
3883 # type: verbatim
3884 #. type: verbatim
3885 #: ../src/guestfs.pod:1738
3886 #, no-wrap
3887 msgid ""
3888 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3889 " void guestfs_set_close_callback (guestfs_h *g,\n"
3890 "                                  guestfs_close_cb cb,\n"
3891 "                                  void *opaque);\n"
3892 "\n"
3893 msgstr ""
3894
3895 # type: textblock
3896 #. type: textblock
3897 #: ../src/guestfs.pod:1743
3898 msgid ""
3899 "The callback function C<cb> will be called while the handle is being closed "
3900 "(synchronously from L</guestfs_close>)."
3901 msgstr ""
3902
3903 # type: textblock
3904 #. type: textblock
3905 #: ../src/guestfs.pod:1746
3906 msgid ""
3907 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3908 "handles that are open when the program exits.  This means that this callback "
3909 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3910 "problems in higher-level languages (eg. if your HLL interpreter has already "
3911 "been cleaned up by the time this is called, and if your callback then jumps "
3912 "into some HLL function)."
3913 msgstr ""
3914
3915 # type: =head2
3916 #. type: =head2
3917 #: ../src/guestfs.pod:1754
3918 msgid "guestfs_set_progress_callback"
3919 msgstr ""
3920
3921 # type: verbatim
3922 #. type: verbatim
3923 #: ../src/guestfs.pod:1756
3924 #, no-wrap
3925 msgid ""
3926 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3927 "                                      int proc_nr, int serial,\n"
3928 "                                      uint64_t position, uint64_t total);\n"
3929 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3930 "                                     guestfs_progress_cb cb,\n"
3931 "                                     void *opaque);\n"
3932 "\n"
3933 msgstr ""
3934
3935 # type: textblock
3936 #. type: textblock
3937 #: ../src/guestfs.pod:1763
3938 msgid ""
3939 "Some long-running operations can generate progress messages.  If this "
3940 "callback is registered, then it will be called each time a progress message "
3941 "is generated (usually two seconds after the operation started, and three "
3942 "times per second thereafter until it completes, although the frequency may "
3943 "change in future versions)."
3944 msgstr ""
3945
3946 # type: textblock
3947 #. type: textblock
3948 #: ../src/guestfs.pod:1769
3949 msgid ""
3950 "The callback receives two numbers: C<position> and C<total>.  The units of "
3951 "C<total> are not defined, although for some operations C<total> may relate "
3952 "in some way to the amount of data to be transferred (eg. in bytes or "
3953 "megabytes), and C<position> may be the portion which has been transferred."
3954 msgstr ""
3955
3956 # type: textblock
3957 #. type: textblock
3958 #: ../src/guestfs.pod:1775
3959 msgid "The only defined and stable parts of the API are:"
3960 msgstr ""
3961
3962 # type: textblock
3963 #. type: textblock
3964 #: ../src/guestfs.pod:1781
3965 msgid ""
3966 "The callback can display to the user some type of progress bar or indicator "
3967 "which shows the ratio of C<position>:C<total>."
3968 msgstr ""
3969
3970 # type: textblock
3971 #. type: textblock
3972 #: ../src/guestfs.pod:1786
3973 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3974 msgstr ""
3975
3976 # type: textblock
3977 #. type: textblock
3978 #: ../src/guestfs.pod:1790
3979 msgid ""
3980 "If any progress notification is sent during a call, then a final progress "
3981 "notification is always sent when C<position> = C<total>."
3982 msgstr ""
3983
3984 # type: textblock
3985 #. type: textblock
3986 #: ../src/guestfs.pod:1793
3987 msgid ""
3988 "This is to simplify caller code, so callers can easily set the progress "
3989 "indicator to \"100%\" at the end of the operation, without requiring special "
3990 "code to detect this case."
3991 msgstr ""
3992
3993 # type: textblock
3994 #. type: textblock
3995 #: ../src/guestfs.pod:1799
3996 msgid ""
3997 "The callback also receives the procedure number and serial number of the "
3998 "call.  These are only useful for debugging protocol issues, and the callback "
3999 "can normally ignore them.  The callback may want to print these numbers in "
4000 "error messages or debugging messages."
4001 msgstr ""
4002
4003 # type: =head1
4004 #. type: =head1
4005 #: ../src/guestfs.pod:1804
4006 msgid "PRIVATE DATA AREA"
4007 msgstr ""
4008
4009 # type: textblock
4010 #. type: textblock
4011 #: ../src/guestfs.pod:1806
4012 msgid ""
4013 "You can attach named pieces of private data to the libguestfs handle, and "
4014 "fetch them by name for the lifetime of the handle.  This is called the "
4015 "private data area and is only available from the C API."
4016 msgstr ""
4017
4018 # type: textblock
4019 #. type: textblock
4020 #: ../src/guestfs.pod:1810
4021 msgid "To attach a named piece of data, use the following call:"
4022 msgstr ""
4023
4024 # type: verbatim
4025 #. type: verbatim
4026 #: ../src/guestfs.pod:1812
4027 #, no-wrap
4028 msgid ""
4029 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4030 "\n"
4031 msgstr ""
4032
4033 # type: textblock
4034 #. type: textblock
4035 #: ../src/guestfs.pod:1814
4036 msgid ""
4037 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4038 "pointer (which can be C<NULL>).  Any previous item with the same name is "
4039 "overwritten."
4040 msgstr ""
4041
4042 # type: textblock
4043 #. type: textblock
4044 #: ../src/guestfs.pod:1818
4045 msgid ""
4046 "You can use any C<key> you want, but names beginning with an underscore "
4047 "character are reserved for internal libguestfs purposes (for implementing "
4048 "language bindings).  It is recommended to prefix the name with some unique "
4049 "string to avoid collisions with other users."
4050 msgstr ""
4051
4052 # type: textblock
4053 #. type: textblock
4054 #: ../src/guestfs.pod:1823
4055 msgid "To retrieve the pointer, use:"
4056 msgstr ""
4057
4058 # type: verbatim
4059 #. type: verbatim
4060 #: ../src/guestfs.pod:1825
4061 #, no-wrap
4062 msgid ""
4063 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4064 "\n"
4065 msgstr ""
4066
4067 # type: textblock
4068 #. type: textblock
4069 #: ../src/guestfs.pod:1827
4070 msgid ""
4071 "This function returns C<NULL> if either no data is found associated with "
4072 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4073 "C<NULL>."
4074 msgstr ""
4075
4076 # type: textblock
4077 #. type: textblock
4078 #: ../src/guestfs.pod:1831
4079 msgid ""
4080 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4081 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
4082 "all.  In particular, libguestfs does I<not> try to free the data when the "
4083 "handle is closed.  If the data must be freed, then the caller must either "
4084 "free it before calling L</guestfs_close> or must set up a close callback to "
4085 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
4086 "can be registered for a handle)."
4087 msgstr ""
4088
4089 # type: textblock
4090 #. type: textblock
4091 #: ../src/guestfs.pod:1839
4092 msgid ""
4093 "The private data area is implemented using a hash table, and should be "
4094 "reasonably efficient for moderate numbers of keys."
4095 msgstr ""
4096
4097 # type: =end
4098 #. type: =end
4099 #: ../src/guestfs.pod:1842 ../src/guestfs.pod:1847
4100 msgid "html"
4101 msgstr ""
4102
4103 # type: textblock
4104 #. type: textblock
4105 #: ../src/guestfs.pod:1844
4106 msgid ""
4107 "<!-- old anchor for the next section --> <a name="
4108 "\"state_machine_and_low_level_event_api\"/>"
4109 msgstr ""
4110
4111 # type: =head1
4112 #. type: =head1
4113 #: ../src/guestfs.pod:1849
4114 msgid "ARCHITECTURE"
4115 msgstr ""
4116
4117 # type: textblock
4118 #. type: textblock
4119 #: ../src/guestfs.pod:1851
4120 msgid ""
4121 "Internally, libguestfs is implemented by running an appliance (a special "
4122 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
4123 "process of the main program."
4124 msgstr ""
4125
4126 # type: verbatim
4127 #. type: verbatim
4128 #: ../src/guestfs.pod:1855
4129 #, no-wrap
4130 msgid ""
4131 "  ___________________\n"
4132 " /                   \\\n"
4133 " | main program      |\n"
4134 " |                   |\n"
4135 " |                   |           child process / appliance\n"
4136 " |                   |           __________________________\n"
4137 " |                   |          / qemu                     \\\n"
4138 " +-------------------+   RPC    |      +-----------------+ |\n"
4139 " | libguestfs     <--------------------> guestfsd        | |\n"
4140 " |                   |          |      +-----------------+ |\n"
4141 " \\___________________/          |      | Linux kernel    | |\n"
4142 "                                |      +--^--------------+ |\n"
4143 "                                \\_________|________________/\n"
4144 "                                          |\n"
4145 "                                   _______v______\n"
4146 "                                  /              \\\n"
4147 "                                  | Device or    |\n"
4148 "                                  | disk image   |\n"
4149 "                                  \\______________/\n"
4150 "\n"
4151 msgstr ""
4152
4153 # type: textblock
4154 #. type: textblock
4155 #: ../src/guestfs.pod:1875
4156 msgid ""
4157 "The library, linked to the main program, creates the child process and hence "
4158 "the appliance in the L</guestfs_launch> function."
4159 msgstr ""
4160
4161 # type: textblock
4162 #. type: textblock
4163 #: ../src/guestfs.pod:1878
4164 msgid ""
4165 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4166 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4167 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
4168 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
4169 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
4170 "attached to the qemu process which translates device access by the "
4171 "appliance's Linux kernel into accesses to the image."
4172 msgstr ""
4173
4174 # type: textblock
4175 #. type: textblock
4176 #: ../src/guestfs.pod:1887
4177 msgid ""
4178 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
4179 "Although the disk image you are attached to might also be used by some "
4180 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
4181 "care if both libguestfs's qemu process and your virtual machine are trying "
4182 "to update the disk image at the same time, since these usually results in "
4183 "massive disk corruption)."
4184 msgstr ""
4185
4186 # type: =head1
4187 #. type: =head1
4188 #: ../src/guestfs.pod:1894
4189 msgid "STATE MACHINE"
4190 msgstr ""
4191
4192 # type: textblock
4193 #. type: textblock
4194 #: ../src/guestfs.pod:1896
4195 msgid "libguestfs uses a state machine to model the child process:"
4196 msgstr ""
4197
4198 # type: verbatim
4199 #. type: verbatim
4200 #: ../src/guestfs.pod:1898
4201 #, no-wrap
4202 msgid ""
4203 "                         |\n"
4204 "                    guestfs_create\n"
4205 "                         |\n"
4206 "                         |\n"
4207 "                     ____V_____\n"
4208 "                    /          \\\n"
4209 "                    |  CONFIG  |\n"
4210 "                    \\__________/\n"
4211 "                     ^ ^   ^  \\\n"
4212 "                    /  |    \\  \\ guestfs_launch\n"
4213 "                   /   |    _\\__V______\n"
4214 "                  /    |   /           \\\n"
4215 "                 /     |   | LAUNCHING |\n"
4216 "                /      |   \\___________/\n"
4217 "               /       |       /\n"
4218 "              /        |  guestfs_launch\n"
4219 "             /         |     /\n"
4220 "    ______  /        __|____V\n"
4221 "   /      \\ ------> /        \\\n"
4222 "   | BUSY |         | READY  |\n"
4223 "   \\______/ <------ \\________/\n"
4224 "\n"
4225 msgstr ""
4226
4227 # type: textblock
4228 #. type: textblock
4229 #: ../src/guestfs.pod:1920
4230 msgid ""
4231 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4232 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4233 "(3) alternating between READY and BUSY as commands are issued to, and "
4234 "carried out by, the child process."
4235 msgstr ""
4236
4237 # type: textblock
4238 #. type: textblock
4239 #: ../src/guestfs.pod:1925
4240 msgid ""
4241 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4242 "asynchronously at any time (eg. due to some internal error), and that causes "
4243 "the state to transition back to CONFIG."
4244 msgstr ""
4245
4246 # type: textblock
4247 #. type: textblock
4248 #: ../src/guestfs.pod:1929
4249 msgid ""
4250 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4251 "issued when in the CONFIG state."
4252 msgstr ""
4253
4254 # type: textblock
4255 #. type: textblock
4256 #: ../src/guestfs.pod:1932
4257 msgid ""
4258 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
4259 "L</guestfs_launch> blocks until the child process is READY to accept "
4260 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
4261 "moves the state from CONFIG to LAUNCHING while it is running."
4262 msgstr ""
4263
4264 # type: textblock
4265 #. type: textblock
4266 #: ../src/guestfs.pod:1938
4267 msgid ""
4268 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4269 "state.  These API calls block waiting for the command to be carried out (ie. "
4270 "the state to transition to BUSY and then back to READY).  There are no non-"
4271 "blocking versions, and no way to issue more than one command per handle at "
4272 "the same time."
4273 msgstr ""
4274
4275 # type: textblock
4276 #. type: textblock
4277 #: ../src/guestfs.pod:1944
4278 msgid ""
4279 "Finally, the child process sends asynchronous messages back to the main "
4280 "program, such as kernel log messages.  You can register a callback to "
4281 "receive these messages."
4282 msgstr ""
4283
4284 # type: =head1
4285 #. type: =head1
4286 #: ../src/guestfs.pod:1948
4287 msgid "INTERNALS"
4288 msgstr ""
4289
4290 # type: =head2
4291 #. type: =head2
4292 #: ../src/guestfs.pod:1950
4293 msgid "COMMUNICATION PROTOCOL"
4294 msgstr ""
4295
4296 # type: textblock
4297 #. type: textblock
4298 #: ../src/guestfs.pod:1952
4299 msgid ""
4300 "Don't rely on using this protocol directly.  This section documents how it "
4301 "currently works, but it may change at any time."
4302 msgstr ""
4303
4304 # type: textblock
4305 #. type: textblock
4306 #: ../src/guestfs.pod:1955
4307 msgid ""
4308 "The protocol used to talk between the library and the daemon running inside "
4309 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4310 "1014, RFC 1832, RFC 4506)."
4311 msgstr ""
4312
4313 # type: textblock
4314 #. type: textblock
4315 #: ../src/guestfs.pod:1959
4316 msgid ""
4317 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4318 "this file is automatically generated)."
4319 msgstr ""
4320
4321 # type: textblock
4322 #. type: textblock
4323 #: ../src/guestfs.pod:1962
4324 msgid ""
4325 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4326 "and C<FileOut> parameters, which are handled with very simple request/reply "
4327 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
4328 "parameters, which use the same request and reply messages, but they may also "
4329 "be followed by files sent using a chunked encoding."
4330 msgstr ""
4331
4332 # type: =head3
4333 #. type: =head3
4334 #: ../src/guestfs.pod:1969
4335 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4336 msgstr ""
4337
4338 # type: textblock
4339 #. type: textblock
4340 #: ../src/guestfs.pod:1971
4341 msgid "For ordinary functions, the request message is:"
4342 msgstr ""
4343
4344 # type: verbatim
4345 #. type: verbatim
4346 #: ../src/guestfs.pod:1973
4347 #, no-wrap
4348 msgid ""
4349 " total length (header + arguments,\n"
4350 "      but not including the length word itself)\n"
4351 " struct guestfs_message_header (encoded as XDR)\n"
4352 " struct guestfs_<foo>_args (encoded as XDR)\n"
4353 "\n"
4354 msgstr ""
4355
4356 # type: textblock
4357 #. type: textblock
4358 #: ../src/guestfs.pod:1978
4359 msgid ""
4360 "The total length field allows the daemon to allocate a fixed size buffer "
4361 "into which it slurps the rest of the message.  As a result, the total length "
4362 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4363 "effective size of any request is limited to somewhere under this size."
4364 msgstr ""
4365
4366 # type: textblock
4367 #. type: textblock
4368 #: ../src/guestfs.pod:1984
4369 msgid ""
4370 "Note also that many functions don't take any arguments, in which case the "
4371 "C<guestfs_I<foo>_args> is completely omitted."
4372 msgstr ""
4373
4374 # type: textblock
4375 #. type: textblock
4376 #: ../src/guestfs.pod:1987
4377 msgid ""
4378 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4379 "receiver knows what type of args structure to expect, or none at all."
4380 msgstr ""
4381
4382 # type: textblock
4383 #. type: textblock
4384 #: ../src/guestfs.pod:1991
4385 msgid ""
4386 "For functions that take optional arguments, the optional arguments are "
4387 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4388 "arguments.  A bitmask in the header indicates which optional arguments are "
4389 "meaningful.  The bitmask is also checked to see if it contains bits set "
4390 "which the daemon does not know about (eg. if more optional arguments were "
4391 "added in a later version of the library), and this causes the call to be "
4392 "rejected."
4393 msgstr ""
4394
4395 # type: textblock
4396 #. type: textblock
4397 #: ../src/guestfs.pod:1999
4398 msgid "The reply message for ordinary functions is:"
4399 msgstr ""
4400
4401 # type: verbatim
4402 #. type: verbatim
4403 #: ../src/guestfs.pod:2001
4404 #, no-wrap
4405 msgid ""
4406 " total length (header + ret,\n"
4407 "      but not including the length word itself)\n"
4408 " struct guestfs_message_header (encoded as XDR)\n"
4409 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4410 "\n"
4411 msgstr ""
4412
4413 # type: textblock
4414 #. type: textblock
4415 #: ../src/guestfs.pod:2006
4416 msgid ""
4417 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4418 "functions that return no formal return values."
4419 msgstr ""
4420
4421 # type: textblock
4422 #. type: textblock
4423 #: ../src/guestfs.pod:2009
4424 msgid ""
4425 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4426 msgstr ""
4427
4428 # type: textblock
4429 #. type: textblock
4430 #: ../src/guestfs.pod:2012
4431 msgid ""
4432 "In the case of an error, a flag is set in the header, and the reply message "
4433 "is slightly changed:"
4434 msgstr ""
4435
4436 # type: verbatim
4437 #. type: verbatim
4438 #: ../src/guestfs.pod:2015
4439 #, no-wrap
4440 msgid ""
4441 " total length (header + error,\n"
4442 "      but not including the length word itself)\n"
4443 " struct guestfs_message_header (encoded as XDR)\n"
4444 " struct guestfs_message_error (encoded as XDR)\n"
4445 "\n"
4446 msgstr ""
4447
4448 # type: textblock
4449 #. type: textblock
4450 #: ../src/guestfs.pod:2020
4451 msgid ""
4452 "The C<guestfs_message_error> structure contains the error message as a "
4453 "string."
4454 msgstr ""
4455
4456 # type: =head3
4457 #. type: =head3
4458 #: ../src/guestfs.pod:2023
4459 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4460 msgstr ""
4461
4462 # type: textblock
4463 #. type: textblock
4464 #: ../src/guestfs.pod:2025
4465 msgid ""
4466 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
4467 "The normal request message is sent (see above).  However this is followed by "
4468 "a sequence of file chunks."
4469 msgstr ""
4470
4471 # type: verbatim
4472 #. type: verbatim
4473 #: ../src/guestfs.pod:2029
4474 #, no-wrap
4475 msgid ""
4476 " total length (header + arguments,\n"
4477 "      but not including the length word itself,\n"
4478 "      and not including the chunks)\n"
4479 " struct guestfs_message_header (encoded as XDR)\n"
4480 " struct guestfs_<foo>_args (encoded as XDR)\n"
4481 " sequence of chunks for FileIn param #0\n"
4482 " sequence of chunks for FileIn param #1 etc.\n"
4483 "\n"
4484 msgstr ""
4485
4486 # type: textblock
4487 #. type: textblock
4488 #: ../src/guestfs.pod:2037
4489 msgid "The \"sequence of chunks\" is:"
4490 msgstr ""
4491
4492 # type: verbatim
4493 #. type: verbatim
4494 #: ../src/guestfs.pod:2039
4495 #, no-wrap
4496 msgid ""
4497 " length of chunk (not including length word itself)\n"
4498 " struct guestfs_chunk (encoded as XDR)\n"
4499 " length of chunk\n"
4500 " struct guestfs_chunk (encoded as XDR)\n"
4501 "   ...\n"
4502 " length of chunk\n"
4503 " struct guestfs_chunk (with data.data_len == 0)\n"
4504 "\n"
4505 msgstr ""
4506
4507 # type: textblock
4508 #. type: textblock
4509 #: ../src/guestfs.pod:2047
4510 msgid ""
4511 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
4512 "is set in the final chunk to indicate either successful completion or early "
4513 "cancellation."
4514 msgstr ""
4515
4516 # type: textblock
4517 #. type: textblock
4518 #: ../src/guestfs.pod:2051
4519 msgid ""
4520 "At time of writing there are no functions that have more than one FileIn "
4521 "parameter.  However this is (theoretically) supported, by sending the "
4522 "sequence of chunks for each FileIn parameter one after another (from left to "
4523 "right)."
4524 msgstr ""
4525
4526 # type: textblock
4527 #. type: textblock
4528 #: ../src/guestfs.pod:2056
4529 msgid ""
4530 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4531 "transfer.  The library does this by sending a chunk with a special flag set "
4532 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
4533 "RPC, does I<not> send any reply, and goes back to reading the next request."
4534 msgstr ""
4535
4536 # type: textblock
4537 #. type: textblock
4538 #: ../src/guestfs.pod:2062
4539 msgid ""
4540 "The daemon may also cancel.  It does this by writing a special word "
4541 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
4542 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4543 "cancel chunk).  The special word is chosen so that even if cancellation "
4544 "happens right at the end of the transfer (after the library has finished "
4545 "writing and has started listening for the reply), the \"spurious\" cancel "
4546 "flag will not be confused with the reply message."
4547 msgstr ""
4548
4549 # type: textblock
4550 #. type: textblock
4551 #: ../src/guestfs.pod:2071
4552 msgid ""
4553 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4554 "limit), and also files where the size is not known in advance (eg. from "
4555 "pipes or sockets).  However the chunks are rather small "
4556 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4557 "to keep much in memory."
4558 msgstr ""
4559
4560 # type: =head3
4561 #. type: =head3
4562 #: ../src/guestfs.pod:2077
4563 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4564 msgstr ""
4565
4566 # type: textblock
4567 #. type: textblock
4568 #: ../src/guestfs.pod:2079
4569 msgid ""
4570 "The protocol for FileOut parameters is exactly the same as for FileIn "
4571 "parameters, but with the roles of daemon and library reversed."
4572 msgstr ""
4573
4574 # type: verbatim
4575 #. type: verbatim
4576 #: ../src/guestfs.pod:2082
4577 #, no-wrap
4578 msgid ""
4579 " total length (header + ret,\n"
4580 "      but not including the length word itself,\n"
4581 "      and not including the chunks)\n"
4582 " struct guestfs_message_header (encoded as XDR)\n"
4583 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4584 " sequence of chunks for FileOut param #0\n"
4585 " sequence of chunks for FileOut param #1 etc.\n"
4586 "\n"
4587 msgstr ""
4588
4589 # type: =head3
4590 #. type: =head3
4591 #: ../src/guestfs.pod:2090
4592 msgid "INITIAL MESSAGE"
4593 msgstr ""
4594
4595 # type: textblock
4596 #. type: textblock
4597 #: ../src/guestfs.pod:2092
4598 msgid ""
4599 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4600 "which indicates that the guest and daemon is alive.  This is what L</"
4601 "guestfs_launch> waits for."
4602 msgstr ""
4603
4604 # type: =head3
4605 #. type: =head3
4606 #: ../src/guestfs.pod:2096
4607 msgid "PROGRESS NOTIFICATION MESSAGES"
4608 msgstr ""
4609
4610 # type: textblock
4611 #. type: textblock
4612 #: ../src/guestfs.pod:2098
4613 msgid ""
4614 "The daemon may send progress notification messages at any time.  These are "
4615 "distinguished by the normal length word being replaced by "
4616 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4617 msgstr ""
4618
4619 # type: textblock
4620 #. type: textblock
4621 #: ../src/guestfs.pod:2102
4622 msgid ""
4623 "The library turns them into progress callbacks (see "
4624 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
4625 "discards them if not."
4626 msgstr ""
4627
4628 # type: textblock
4629 #. type: textblock
4630 #: ../src/guestfs.pod:2106
4631 msgid ""
4632 "The daemon self-limits the frequency of progress messages it sends (see "
4633 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
4634 "messages."
4635 msgstr ""
4636
4637 # type: =head1
4638 #. type: =head1
4639 #: ../src/guestfs.pod:2110
4640 msgid "LIBGUESTFS VERSION NUMBERS"
4641 msgstr ""
4642
4643 # type: textblock
4644 #. type: textblock
4645 #: ../src/guestfs.pod:2112
4646 msgid ""
4647 "Since April 2010, libguestfs has started to make separate development and "
4648 "stable releases, along with corresponding branches in our git repository.  "
4649 "These separate releases can be identified by version number:"
4650 msgstr ""
4651
4652 # type: verbatim
4653 #. type: verbatim
4654 #: ../src/guestfs.pod:2117
4655 #, no-wrap
4656 msgid ""
4657 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
4658 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4659 "       |\n"
4660 "       v\n"
4661 " 1  .  3  .  5\n"
4662 " ^           ^\n"
4663 " |           |\n"
4664 " |           `-------- sub-version\n"
4665 " |\n"
4666 " `------ always '1' because we don't change the ABI\n"
4667 "\n"
4668 msgstr ""
4669
4670 # type: textblock
4671 #. type: textblock
4672 #: ../src/guestfs.pod:2128
4673 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4674 msgstr ""
4675
4676 # type: textblock
4677 #. type: textblock
4678 #: ../src/guestfs.pod:2130
4679 msgid ""
4680 "As time passes we cherry pick fixes from the development branch and backport "
4681 "those into the stable branch, the effect being that the stable branch should "
4682 "get more stable and less buggy over time.  So the stable releases are ideal "
4683 "for people who don't need new features but would just like the software to "
4684 "work."
4685 msgstr ""
4686
4687 # type: textblock
4688 #. type: textblock
4689 #: ../src/guestfs.pod:2136
4690 msgid "Our criteria for backporting changes are:"
4691 msgstr ""
4692
4693 # type: textblock
4694 #. type: textblock
4695 #: ../src/guestfs.pod:2142
4696 msgid ""
4697 "Documentation changes which don't affect any code are backported unless the "
4698 "documentation refers to a future feature which is not in stable."
4699 msgstr ""
4700
4701 # type: textblock
4702 #. type: textblock
4703 #: ../src/guestfs.pod:2148
4704 msgid ""
4705 "Bug fixes which are not controversial, fix obvious problems, and have been "
4706 "well tested are backported."
4707 msgstr ""
4708
4709 # type: textblock
4710 #. type: textblock
4711 #: ../src/guestfs.pod:2153
4712 msgid ""
4713 "Simple rearrangements of code which shouldn't affect how it works get "
4714 "backported.  This is so that the code in the two branches doesn't get too "
4715 "far out of step, allowing us to backport future fixes more easily."
4716 msgstr ""
4717
4718 # type: textblock
4719 #. type: textblock
4720 #: ../src/guestfs.pod:2159
4721 msgid ""
4722 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4723 "exceptional case: the new feature is required in order to implement an "
4724 "important bug fix."
4725 msgstr ""
4726
4727 # type: textblock
4728 #. type: textblock
4729 #: ../src/guestfs.pod:2165
4730 msgid ""
4731 "A new stable branch starts when we think the new features in development are "
4732 "substantial and compelling enough over the current stable branch to warrant "
4733 "it.  When that happens we create new stable and development versions 1.N.0 "
4734 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
4735 "stable at this point, but by backporting fixes from development, that branch "
4736 "will stabilize over time."
4737 msgstr ""
4738
4739 #. type: =head1
4740 #: ../src/guestfs.pod:2173
4741 msgid "EXTENDING LIBGUESTFS"
4742 msgstr ""
4743
4744 #. type: =head2
4745 #: ../src/guestfs.pod:2175
4746 msgid "ADDING A NEW API ACTION"
4747 msgstr ""
4748
4749 #. type: textblock
4750 #: ../src/guestfs.pod:2177
4751 msgid ""
4752 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4753 "documentation) are generated, and this makes it easy to extend the "
4754 "libguestfs API."
4755 msgstr ""
4756
4757 #. type: textblock
4758 #: ../src/guestfs.pod:2181
4759 msgid "To add a new API action there are two changes:"
4760 msgstr ""
4761
4762 #. type: textblock
4763 #: ../src/guestfs.pod:2187
4764 msgid ""
4765 "You need to add a description of the call (name, parameters, return type, "
4766 "tests, documentation) to C<generator/generator_actions.ml>."
4767 msgstr ""
4768
4769 #. type: textblock
4770 #: ../src/guestfs.pod:2190
4771 msgid ""
4772 "There are two sorts of API action, depending on whether the call goes "
4773 "through to the daemon in the appliance, or is serviced entirely by the "
4774 "library (see L</ARCHITECTURE> above).  L</guestfs_sync> is an example of the "
4775 "former, since the sync is done in the appliance.  L</guestfs_set_trace> is "
4776 "an example of the latter, since a trace flag is maintained in the handle and "
4777 "all tracing is done on the library side."
4778 msgstr ""
4779
4780 #. type: textblock
4781 #: ../src/guestfs.pod:2198
4782 msgid ""
4783 "Most new actions are of the first type, and get added to the "
4784 "C<daemon_functions> list.  Each function has a unique procedure number used "
4785 "in the RPC protocol which is assigned to that action when we publish "
4786 "libguestfs and cannot be reused.  Take the latest procedure number and "
4787 "increment it."
4788 msgstr ""
4789
4790 #. type: textblock
4791 #: ../src/guestfs.pod:2204
4792 msgid ""
4793 "For library-only actions of the second type, add to the "
4794 "C<non_daemon_functions> list.  Since these functions are serviced by the "
4795 "library and do not travel over the RPC mechanism to the daemon, these "
4796 "functions do not need a procedure number, and so the procedure number is set "
4797 "to C<-1>."
4798 msgstr ""
4799
4800 #. type: textblock
4801 #: ../src/guestfs.pod:2212
4802 msgid "Implement the action (in C):"
4803 msgstr ""
4804
4805 #. type: textblock
4806 #: ../src/guestfs.pod:2214
4807 msgid ""
4808 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4809 "C<daemon/> directory."
4810 msgstr ""
4811
4812 #. type: textblock
4813 #: ../src/guestfs.pod:2217
4814 msgid ""
4815 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4816 "(note: double underscore) in the C<src/> directory."
4817 msgstr ""
4818
4819 #. type: textblock
4820 #: ../src/guestfs.pod:2220
4821 msgid "In either case, use another function as an example of what to do."
4822 msgstr ""
4823
4824 #. type: textblock
4825 #: ../src/guestfs.pod:2224
4826 msgid "After making these changes, use C<make> to compile."
4827 msgstr ""
4828
4829 #. type: textblock
4830 #: ../src/guestfs.pod:2226
4831 msgid ""
4832 "Note that you don't need to implement the RPC, language bindings, manual "
4833 "pages or anything else.  It's all automatically generated from the OCaml "
4834 "description."
4835 msgstr ""
4836
4837 #. type: =head2
4838 #: ../src/guestfs.pod:2230
4839 msgid "ADDING TESTS FOR AN API ACTION"
4840 msgstr ""
4841
4842 #. type: textblock
4843 #: ../src/guestfs.pod:2232
4844 msgid ""
4845 "You can supply zero or as many tests as you want per API call.  The tests "
4846 "can either be added as part of the API description (C<generator/"
4847 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4848 "into C<regressions/>.  Note that adding a script to C<regressions/> is "
4849 "slower, so if possible use the first method."
4850 msgstr ""
4851
4852 #. type: textblock
4853 #: ../src/guestfs.pod:2238
4854 msgid ""
4855 "The following describes the test environment used when you add an API test "
4856 "in C<generator_actions.ml>."
4857 msgstr ""
4858
4859 #. type: textblock
4860 #: ../src/guestfs.pod:2241
4861 msgid "The test environment has 4 block devices:"
4862 msgstr ""
4863
4864 #. type: =item
4865 #: ../src/guestfs.pod:2245
4866 msgid "C</dev/sda> 500MB"
4867 msgstr ""
4868
4869 #. type: textblock
4870 #: ../src/guestfs.pod:2247
4871 msgid "General block device for testing."
4872 msgstr ""
4873
4874 #. type: =item
4875 #: ../src/guestfs.pod:2249
4876 msgid "C</dev/sdb> 50MB"
4877 msgstr ""
4878
4879 #. type: textblock
4880 #: ../src/guestfs.pod:2251
4881 msgid ""
4882 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4883 "operations."
4884 msgstr ""
4885
4886 #. type: =item
4887 #: ../src/guestfs.pod:2254
4888 msgid "C</dev/sdc> 10MB"
4889 msgstr ""
4890
4891 #. type: textblock
4892 #: ../src/guestfs.pod:2256
4893 msgid "Used in a few tests where two block devices are needed."
4894 msgstr ""
4895
4896 #. type: =item
4897 #: ../src/guestfs.pod:2258
4898 msgid "C</dev/sdd>"
4899 msgstr ""
4900
4901 #. type: textblock
4902 #: ../src/guestfs.pod:2260
4903 msgid "ISO with fixed content (see C<images/test.iso>)."
4904 msgstr ""
4905
4906 #. type: textblock
4907 #: ../src/guestfs.pod:2264
4908 msgid ""
4909 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4910 "appliance and block devices are reused between tests.  So don't try testing "
4911 "L</guestfs_kill_subprocess> :-x"
4912 msgstr ""
4913
4914 #. type: textblock
4915 #: ../src/guestfs.pod:2268
4916 msgid ""
4917 "Each test starts with an initial scenario, selected using one of the "
4918 "C<Init*> expressions, described in C<generator/generator_types.ml>.  These "
4919 "initialize the disks mentioned above in a particular way as documented in "
4920 "C<generator_types.ml>.  You should not assume anything about the previous "
4921 "contents of other disks that are not initialized."
4922 msgstr ""
4923
4924 #. type: textblock
4925 #: ../src/guestfs.pod:2274
4926 msgid ""
4927 "You can add a prerequisite clause to any individual test.  This is a run-"
4928 "time check, which, if it fails, causes the test to be skipped.  Useful if "
4929 "testing a command which might not work on all variations of libguestfs "
4930 "builds.  A test that has prerequisite of C<Always> means to run "
4931 "unconditionally."
4932 msgstr ""
4933
4934 #. type: textblock
4935 #: ../src/guestfs.pod:2280
4936 msgid ""
4937 "In addition, packagers can skip individual tests by setting environment "
4938 "variables before running C<make check>."
4939 msgstr ""
4940
4941 #. type: verbatim
4942 #: ../src/guestfs.pod:2283
4943 #, no-wrap
4944 msgid ""
4945 " SKIP_TEST_<CMD>_<NUM>=1\n"
4946 "\n"
4947 msgstr ""
4948
4949 #. type: textblock
4950 #: ../src/guestfs.pod:2285
4951 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4952 msgstr ""
4953
4954 #. type: textblock
4955 #: ../src/guestfs.pod:2287
4956 msgid "or:"
4957 msgstr ""
4958
4959 #. type: verbatim
4960 #: ../src/guestfs.pod:2289
4961 #, no-wrap
4962 msgid ""
4963 " SKIP_TEST_<CMD>=1\n"
4964 "\n"
4965 msgstr ""
4966
4967 #. type: textblock
4968 #: ../src/guestfs.pod:2291
4969 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4970 msgstr ""
4971
4972 #. type: textblock
4973 #: ../src/guestfs.pod:2293
4974 msgid "Packagers can run only certain tests by setting for example:"
4975 msgstr ""
4976
4977 #. type: verbatim
4978 #: ../src/guestfs.pod:2295