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