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