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