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