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