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