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