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