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