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