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