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