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