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