Version 1.7.4.
[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.4\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-11 18:35+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:1224 ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 ../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:584 ../inspector/virt-inspector.pl:588 ../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."
822 msgstr ""
823
824 # type: textblock
825 #: ../src/guestfs.pod:411
826 msgid ""
827 "The two main API calls to run commands are L</guestfs_command> and "
828 "L</guestfs_sh> (there are also variations)."
829 msgstr ""
830
831 # type: textblock
832 #: ../src/guestfs.pod:414
833 msgid ""
834 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
835 "shell globs, redirections, etc will work."
836 msgstr ""
837
838 # type: =head2
839 #: ../src/guestfs.pod:417
840 msgid "CONFIGURATION FILES"
841 msgstr ""
842
843 # type: textblock
844 #: ../src/guestfs.pod:419
845 msgid ""
846 "To read and write configuration files in Linux guest filesystems, we "
847 "strongly recommend using Augeas.  For example, Augeas understands how to "
848 "read and write, say, a Linux shadow password file or X.org configuration "
849 "file, and so avoids you having to write that code."
850 msgstr ""
851
852 # type: textblock
853 #: ../src/guestfs.pod:424
854 msgid ""
855 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
856 "document Augeas itself here because there is excellent documentation on the "
857 "L<http://augeas.net/> website."
858 msgstr ""
859
860 # type: textblock
861 #: ../src/guestfs.pod:428
862 msgid ""
863 "If you don't want to use Augeas (you fool!) then try calling "
864 "L</guestfs_read_lines> to get the file as a list of lines which you can "
865 "iterate over."
866 msgstr ""
867
868 # type: =head2
869 #: ../src/guestfs.pod:432
870 msgid "SELINUX"
871 msgstr ""
872
873 # type: textblock
874 #: ../src/guestfs.pod:434
875 msgid ""
876 "We support SELinux guests.  To ensure that labeling happens correctly in "
877 "SELinux guests, you need to enable SELinux and load the guest's policy:"
878 msgstr ""
879
880 # type: =item
881 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
882 msgid "1."
883 msgstr ""
884
885 # type: textblock
886 #: ../src/guestfs.pod:442
887 msgid "Before launching, do:"
888 msgstr ""
889
890 # type: verbatim
891 #: ../src/guestfs.pod:444
892 #, no-wrap
893 msgid ""
894 " guestfs_set_selinux (g, 1);\n"
895 "\n"
896 msgstr ""
897
898 # type: =item
899 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
900 msgid "2."
901 msgstr ""
902
903 # type: textblock
904 #: ../src/guestfs.pod:448
905 msgid ""
906 "After mounting the guest's filesystem(s), load the policy.  This is best "
907 "done by running the L<load_policy(8)> command in the guest itself:"
908 msgstr ""
909
910 # type: verbatim
911 #: ../src/guestfs.pod:452
912 #, no-wrap
913 msgid ""
914 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
915 "\n"
916 msgstr ""
917
918 # type: textblock
919 #: ../src/guestfs.pod:454
920 msgid ""
921 "(Older versions of C<load_policy> require you to specify the name of the "
922 "policy file)."
923 msgstr ""
924
925 # type: =item
926 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
927 msgid "3."
928 msgstr ""
929
930 # type: textblock
931 #: ../src/guestfs.pod:459
932 msgid ""
933 "Optionally, set the security context for the API.  The correct security "
934 "context to use can only be known by inspecting the guest.  As an example:"
935 msgstr ""
936
937 # type: verbatim
938 #: ../src/guestfs.pod:463
939 #, no-wrap
940 msgid ""
941 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
942 "\n"
943 msgstr ""
944
945 # type: textblock
946 #: ../src/guestfs.pod:467
947 msgid "This will work for running commands and editing existing files."
948 msgstr ""
949
950 # type: textblock
951 #: ../src/guestfs.pod:469
952 msgid ""
953 "When new files are created, you may need to label them explicitly, for "
954 "example by running the external command C<restorecon pathname>."
955 msgstr ""
956
957 # type: =head2
958 #: ../src/guestfs.pod:473
959 msgid "UMASK"
960 msgstr ""
961
962 # type: textblock
963 #: ../src/guestfs.pod:475
964 msgid ""
965 "Certain calls are affected by the current file mode creation mask (the "
966 "\"umask\").  In particular ones which create files or directories, such as "
967 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
968 "either the default mode that the file is created with or modifies the mode "
969 "that you supply."
970 msgstr ""
971
972 # type: textblock
973 #: ../src/guestfs.pod:481
974 msgid ""
975 "The default umask is C<022>, so files are created with modes such as C<0644> "
976 "and directories with C<0755>."
977 msgstr ""
978
979 # type: textblock
980 #: ../src/guestfs.pod:484
981 msgid ""
982 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
983 "(call C<guestfs_umask (g, 0)> early after launching).  Or call "
984 "L</guestfs_chmod> after creating each file or directory."
985 msgstr ""
986
987 # type: textblock
988 #: ../src/guestfs.pod:488
989 msgid "For more information about umask, see L<umask(2)>."
990 msgstr ""
991
992 # type: =head1
993 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:669
994 msgid "ENCRYPTED DISKS"
995 msgstr ""
996
997 # type: textblock
998 #: ../src/guestfs.pod:492
999 msgid ""
1000 "Libguestfs allows you to access Linux guests which have been encrypted using "
1001 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1002 "standard.  This includes nearly all whole disk encryption systems used by "
1003 "modern Linux guests."
1004 msgstr ""
1005
1006 # type: textblock
1007 #: ../src/guestfs.pod:498
1008 msgid ""
1009 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1010 "returns the string C<crypto_LUKS>)."
1011 msgstr ""
1012
1013 # type: textblock
1014 #: ../src/guestfs.pod:501
1015 msgid ""
1016 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
1017 "will require the passphrase!"
1018 msgstr ""
1019
1020 # type: textblock
1021 #: ../src/guestfs.pod:504
1022 msgid ""
1023 "Opening a LUKS device creates a new device mapper device called "
1024 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1025 "L</guestfs_luks_open>).  Reads and writes to this mapper device are "
1026 "decrypted from and encrypted to the underlying block device respectively."
1027 msgstr ""
1028
1029 # type: textblock
1030 #: ../src/guestfs.pod:510
1031 msgid ""
1032 "LVM volume groups on the device can be made visible by calling "
1033 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
1034 "volume(s) can now be mounted in the usual way."
1035 msgstr ""
1036
1037 # type: textblock
1038 #: ../src/guestfs.pod:514
1039 msgid ""
1040 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
1041 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1042 "[\"/dev/VG\"])>.  Then close the mapper device by calling "
1043 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1044 "underlying encrypted block device)."
1045 msgstr ""
1046
1047 # type: =head2
1048 #: ../src/guestfs.pod:521
1049 msgid "INSPECTION"
1050 msgstr ""
1051
1052 # type: textblock
1053 #: ../src/guestfs.pod:523
1054 msgid ""
1055 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1056 "contains operating systems.  (These APIs used to be in a separate Perl-only "
1057 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1058 "frequently used part of this library has been rewritten in C and moved into "
1059 "the core code)."
1060 msgstr ""
1061
1062 # type: textblock
1063 #: ../src/guestfs.pod:529
1064 msgid ""
1065 "Add all disks belonging to the unknown virtual machine and call "
1066 "L</guestfs_launch> in the usual way."
1067 msgstr ""
1068
1069 # type: textblock
1070 #: ../src/guestfs.pod:532
1071 msgid ""
1072 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
1073 "and certain heuristics, and returns a list of operating systems that were "
1074 "found.  An empty list means none were found.  A single element is the root "
1075 "filesystem of the operating system.  For dual- or multi-boot guests, "
1076 "multiple roots can be returned, each one corresponding to a separate "
1077 "operating system.  (Multi-boot virtual machines are extremely rare in the "
1078 "world of virtualization, but since this scenario can happen, we have built "
1079 "libguestfs to deal with it.)"
1080 msgstr ""
1081
1082 # type: textblock
1083 #: ../src/guestfs.pod:541
1084 msgid ""
1085 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1086 "to get additional details about that operating system.  For example, call "
1087 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1088 "Windows and Linux-based operating systems respectively."
1089 msgstr ""
1090
1091 # type: textblock
1092 #: ../src/guestfs.pod:547
1093 msgid ""
1094 "Un*x-like and Linux-based operating systems usually consist of several "
1095 "filesystems which are mounted at boot time (for example, a separate boot "
1096 "partition mounted on C</boot>).  The inspection rules are able to detect how "
1097 "filesystems correspond to mount points.  Call "
1098 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
1099 "hash table like this example:"
1100 msgstr ""
1101
1102 # type: verbatim
1103 #: ../src/guestfs.pod:554
1104 #, no-wrap
1105 msgid ""
1106 " /boot => /dev/sda1\n"
1107 " /     => /dev/vg_guest/lv_root\n"
1108 " /usr  => /dev/vg_guest/lv_usr\n"
1109 "\n"
1110 msgstr ""
1111
1112 # type: textblock
1113 #: ../src/guestfs.pod:558
1114 msgid ""
1115 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1116 "filesystems as suggested."
1117 msgstr ""
1118
1119 # type: textblock
1120 #: ../src/guestfs.pod:561
1121 msgid ""
1122 "Be careful to mount filesystems in the right order (eg. C</> before "
1123 "C</usr>).  Sorting the keys of the hash by length, shortest first, should "
1124 "work."
1125 msgstr ""
1126
1127 # type: textblock
1128 #: ../src/guestfs.pod:565
1129 msgid ""
1130 "Inspection currently only works for some common operating systems.  "
1131 "Contributors are welcome to send patches for other operating systems that we "
1132 "currently cannot detect."
1133 msgstr ""
1134
1135 # type: textblock
1136 #: ../src/guestfs.pod:569
1137 msgid ""
1138 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
1139 "for more details.  The L</guestfs_inspect_os> function just ignores any "
1140 "encrypted devices."
1141 msgstr ""
1142
1143 # type: textblock
1144 #: ../src/guestfs.pod:573
1145 msgid ""
1146 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1147 "inspection and caches the results in the guest handle.  Subsequent calls to "
1148 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1149 "re-read the disks.  If you change the content of the guest disks, you can "
1150 "redo inspection by calling L</guestfs_inspect_os> again."
1151 msgstr ""
1152
1153 # type: =head2
1154 #: ../src/guestfs.pod:580
1155 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1156 msgstr ""
1157
1158 # type: textblock
1159 #: ../src/guestfs.pod:582
1160 msgid ""
1161 "Libguestfs can mount NTFS partitions.  It does this using the "
1162 "L<http://www.ntfs-3g.org/> driver."
1163 msgstr ""
1164
1165 # type: textblock
1166 #: ../src/guestfs.pod:585
1167 msgid ""
1168 "DOS and Windows still use drive letters, and the filesystems are always "
1169 "treated as case insensitive by Windows itself, and therefore you might find "
1170 "a Windows configuration file referring to a path like "
1171 "C<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
1172 "that directory might be referred to as C</WINDOWS/System32>."
1173 msgstr ""
1174
1175 # type: textblock
1176 #: ../src/guestfs.pod:591
1177 msgid ""
1178 "Drive letter mappings are outside the scope of libguestfs.  You have to use "
1179 "libguestfs to read the appropriate Windows Registry and configuration files, "
1180 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1181 "L<virt-inspector(1)>)."
1182 msgstr ""
1183
1184 # type: textblock
1185 #: ../src/guestfs.pod:596
1186 msgid ""
1187 "Replacing backslash characters with forward slash characters is also outside "
1188 "the scope of libguestfs, but something that you can easily do."
1189 msgstr ""
1190
1191 # type: textblock
1192 #: ../src/guestfs.pod:599
1193 msgid ""
1194 "Where we can help is in resolving the case insensitivity of paths.  For "
1195 "this, call L</guestfs_case_sensitive_path>."
1196 msgstr ""
1197
1198 # type: textblock
1199 #: ../src/guestfs.pod:602
1200 msgid ""
1201 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1202 "files, through the library C<hivex> which is part of the libguestfs project "
1203 "although ships as a separate tarball.  You have to locate and download the "
1204 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
1205 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1206 "L<virt-win-reg(1)> for more help on this issue."
1207 msgstr ""
1208
1209 # type: =head2
1210 #: ../src/guestfs.pod:610
1211 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1212 msgstr ""
1213
1214 # type: textblock
1215 #: ../src/guestfs.pod:612
1216 msgid ""
1217 "Although we don't want to discourage you from using the C API, we will "
1218 "mention here that the same API is also available in other languages."
1219 msgstr ""
1220
1221 # type: textblock
1222 #: ../src/guestfs.pod:615
1223 msgid ""
1224 "The API is broadly identical in all supported languages.  This means that "
1225 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1226 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml.  In other "
1227 "words, a straightforward, predictable isomorphism between each language."
1228 msgstr ""
1229
1230 # type: textblock
1231 #: ../src/guestfs.pod:621
1232 msgid ""
1233 "Error messages are automatically transformed into exceptions if the language "
1234 "supports it."
1235 msgstr ""
1236
1237 # type: textblock
1238 #: ../src/guestfs.pod:624
1239 msgid ""
1240 "We don't try to \"object orientify\" parts of the API in OO languages, "
1241 "although contributors are welcome to write higher level APIs above what we "
1242 "provide in their favourite languages if they wish."
1243 msgstr ""
1244
1245 # type: =item
1246 #: ../src/guestfs.pod:630
1247 msgid "B<C++>"
1248 msgstr ""
1249
1250 # type: textblock
1251 #: ../src/guestfs.pod:632
1252 msgid ""
1253 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
1254 "identical to the C API.  C++ classes and exceptions are not used."
1255 msgstr ""
1256
1257 # type: =item
1258 #: ../src/guestfs.pod:636
1259 msgid "B<C#>"
1260 msgstr ""
1261
1262 # type: textblock
1263 #: ../src/guestfs.pod:638
1264 msgid ""
1265 "The C# bindings are highly experimental.  Please read the warnings at the "
1266 "top of C<csharp/Libguestfs.cs>."
1267 msgstr ""
1268
1269 # type: =item
1270 #: ../src/guestfs.pod:641
1271 msgid "B<Haskell>"
1272 msgstr ""
1273
1274 # type: textblock
1275 #: ../src/guestfs.pod:643
1276 msgid ""
1277 "This is the only language binding that is working but incomplete.  Only "
1278 "calls which return simple integers have been bound in Haskell, and we are "
1279 "looking for help to complete this binding."
1280 msgstr ""
1281
1282 # type: =item
1283 #: ../src/guestfs.pod:647
1284 msgid "B<Java>"
1285 msgstr ""
1286
1287 # type: textblock
1288 #: ../src/guestfs.pod:649
1289 msgid ""
1290 "Full documentation is contained in the Javadoc which is distributed with "
1291 "libguestfs."
1292 msgstr ""
1293
1294 # type: =item
1295 #: ../src/guestfs.pod:652
1296 msgid "B<OCaml>"
1297 msgstr ""
1298
1299 # type: textblock
1300 #: ../src/guestfs.pod:654
1301 msgid "For documentation see the file C<guestfs.mli>."
1302 msgstr ""
1303
1304 # type: =item
1305 #: ../src/guestfs.pod:656
1306 msgid "B<Perl>"
1307 msgstr ""
1308
1309 # type: textblock
1310 #: ../src/guestfs.pod:658
1311 msgid "For documentation see L<Sys::Guestfs(3)>."
1312 msgstr ""
1313
1314 # type: =item
1315 #: ../src/guestfs.pod:660
1316 msgid "B<PHP>"
1317 msgstr ""
1318
1319 # type: textblock
1320 #: ../src/guestfs.pod:662
1321 msgid ""
1322 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1323 "the php-libguestfs package for your distribution."
1324 msgstr ""
1325
1326 # type: textblock
1327 #: ../src/guestfs.pod:665
1328 msgid "The PHP binding only works correctly on 64 bit machines."
1329 msgstr ""
1330
1331 # type: =item
1332 #: ../src/guestfs.pod:667
1333 msgid "B<Python>"
1334 msgstr ""
1335
1336 # type: textblock
1337 #: ../src/guestfs.pod:669
1338 msgid "For documentation do:"
1339 msgstr ""
1340
1341 # type: verbatim
1342 #: ../src/guestfs.pod:671
1343 #, no-wrap
1344 msgid ""
1345 " $ python\n"
1346 " >>> import guestfs\n"
1347 " >>> help (guestfs)\n"
1348 "\n"
1349 msgstr ""
1350
1351 # type: =item
1352 #: ../src/guestfs.pod:675
1353 msgid "B<Ruby>"
1354 msgstr ""
1355
1356 # type: textblock
1357 #: ../src/guestfs.pod:677
1358 msgid ""
1359 "Use the Guestfs module.  There is no Ruby-specific documentation, but you "
1360 "can find examples written in Ruby in the libguestfs source."
1361 msgstr ""
1362
1363 # type: =item
1364 #: ../src/guestfs.pod:680
1365 msgid "B<shell scripts>"
1366 msgstr ""
1367
1368 # type: textblock
1369 #: ../src/guestfs.pod:682
1370 msgid "For documentation see L<guestfish(1)>."
1371 msgstr ""
1372
1373 # type: =head2
1374 #: ../src/guestfs.pod:686
1375 msgid "LIBGUESTFS GOTCHAS"
1376 msgstr ""
1377
1378 # type: textblock
1379 #: ../src/guestfs.pod:688
1380 msgid ""
1381 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1382 "system [...] that works in the way it is documented but is counterintuitive "
1383 "and almost invites mistakes.\""
1384 msgstr ""
1385
1386 # type: textblock
1387 #: ../src/guestfs.pod:692
1388 msgid ""
1389 "Since we developed libguestfs and the associated tools, there are several "
1390 "things we would have designed differently, but are now stuck with for "
1391 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
1392 "release, you can expect these to change.  Beware of them."
1393 msgstr ""
1394
1395 # type: =item
1396 #: ../src/guestfs.pod:700
1397 msgid "Autosync / forgetting to sync."
1398 msgstr ""
1399
1400 # type: textblock
1401 #: ../src/guestfs.pod:702
1402 msgid ""
1403 "When modifying a filesystem from C or another language, you B<must> unmount "
1404 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1405 "libguestfs handle.  You can also call:"
1406 msgstr ""
1407
1408 # type: verbatim
1409 #: ../src/guestfs.pod:706
1410 #, no-wrap
1411 msgid ""
1412 " guestfs_set_autosync (g, 1);\n"
1413 "\n"
1414 msgstr ""
1415
1416 # type: textblock
1417 #: ../src/guestfs.pod:708
1418 msgid ""
1419 "to have the unmount/sync done automatically for you when the handle 'g' is "
1420 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
1421 "q.v.)"
1422 msgstr ""
1423
1424 # type: textblock
1425 #: ../src/guestfs.pod:712
1426 msgid ""
1427 "If you forget to do this, then it is entirely possible that your changes "
1428 "won't be written out, or will be partially written, or (very rarely) that "
1429 "you'll get disk corruption."
1430 msgstr ""
1431
1432 # type: textblock
1433 #: ../src/guestfs.pod:716
1434 msgid ""
1435 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
1436 "guestfish scripts that forget to sync will work just fine, which can make "
1437 "this very puzzling if you are trying to debug a problem."
1438 msgstr ""
1439
1440 # type: textblock
1441 #: ../src/guestfs.pod:720
1442 msgid ""
1443 "Update: Autosync is enabled by default for all API users starting from "
1444 "libguestfs 1.5.24."
1445 msgstr ""
1446
1447 # type: =item
1448 #: ../src/guestfs.pod:723
1449 msgid "Mount option C<-o sync> should not be the default."
1450 msgstr ""
1451
1452 # type: textblock
1453 #: ../src/guestfs.pod:725
1454 msgid ""
1455 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
1456 "However C<-o sync> does not add any reliability benefit, but does have a "
1457 "very large performance impact."
1458 msgstr ""
1459
1460 # type: textblock
1461 #: ../src/guestfs.pod:729
1462 msgid ""
1463 "The work around is to use L</guestfs_mount_options> and set the mount "
1464 "options that you actually want to use."
1465 msgstr ""
1466
1467 # type: =item
1468 #: ../src/guestfs.pod:732
1469 msgid "Read-only should be the default."
1470 msgstr ""
1471
1472 # type: textblock
1473 #: ../src/guestfs.pod:734
1474 msgid ""
1475 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1476 "specify I<--rw> if you want to make changes to the image."
1477 msgstr ""
1478
1479 # type: textblock
1480 #: ../src/guestfs.pod:737
1481 msgid "This would reduce the potential to corrupt live VM images."
1482 msgstr ""
1483
1484 # type: textblock
1485 #: ../src/guestfs.pod:739
1486 msgid ""
1487 "Note that many filesystems change the disk when you just mount and unmount, "
1488 "even if you didn't perform any writes.  You need to use "
1489 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1490 msgstr ""
1491
1492 # type: =item
1493 #: ../src/guestfs.pod:743
1494 msgid "guestfish command line is hard to use."
1495 msgstr ""
1496
1497 # type: textblock
1498 #: ../src/guestfs.pod:745
1499 msgid ""
1500 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1501 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
1502 "exist, so it fails.  In earlier versions of guestfish the error message was "
1503 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
1504 "we should have used C<guestfish -c command> to run commands."
1505 msgstr ""
1506
1507 # type: =item
1508 #: ../src/guestfs.pod:752
1509 msgid "guestfish megabyte modifiers don't work right on all commands"
1510 msgstr ""
1511
1512 # type: textblock
1513 #: ../src/guestfs.pod:754
1514 msgid ""
1515 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1516 "other modifiers).  What guestfish actually does is to multiply the number "
1517 "part by the modifier part and pass the result to the C API.  However this "
1518 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1519 "expecting some other unit (eg. megabytes)."
1520 msgstr ""
1521
1522 # type: textblock
1523 #: ../src/guestfs.pod:761
1524 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
1525 msgstr ""
1526
1527 # type: verbatim
1528 #: ../src/guestfs.pod:763
1529 #, no-wrap
1530 msgid ""
1531 " lvcreate LV VG 100M\n"
1532 "\n"
1533 msgstr ""
1534
1535 # type: textblock
1536 #: ../src/guestfs.pod:765
1537 msgid ""
1538 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
1539 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1540 "megabytes * megabytes) logical volume.  The error message you get from this "
1541 "is also a little obscure."
1542 msgstr ""
1543
1544 # type: textblock
1545 #: ../src/guestfs.pod:770
1546 msgid ""
1547 "This could be fixed in the generator by specially marking parameters and "
1548 "return values which take bytes or other units."
1549 msgstr ""
1550
1551 # type: =item
1552 #: ../src/guestfs.pod:773
1553 msgid "Ambiguity between devices and paths"
1554 msgstr ""
1555
1556 # type: textblock
1557 #: ../src/guestfs.pod:775
1558 msgid ""
1559 "There is a subtle ambiguity in the API between a device name "
1560 "(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
1561 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1562 msgstr ""
1563
1564 # type: textblock
1565 #: ../src/guestfs.pod:780
1566 msgid ""
1567 "In the current API we usually resolve this ambiguity by having two separate "
1568 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
1569 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1570 "detecting if the path supplied begins with C</dev/>."
1571 msgstr ""
1572
1573 # type: textblock
1574 #: ../src/guestfs.pod:786
1575 msgid ""
1576 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1577 "make paths/devices into structured names.  One way to do this would be to "
1578 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1579 "aspect of grub.  Another way would be to use a structured type, equivalent "
1580 "to this OCaml type:"
1581 msgstr ""
1582
1583 # type: verbatim
1584 #: ../src/guestfs.pod:792
1585 #, no-wrap
1586 msgid ""
1587 " type path = Path of string | Device of int | Partition of int * int\n"
1588 "\n"
1589 msgstr ""
1590
1591 # type: textblock
1592 #: ../src/guestfs.pod:794
1593 msgid "which would allow you to pass arguments like:"
1594 msgstr ""
1595
1596 # type: verbatim
1597 #: ../src/guestfs.pod:796
1598 #, no-wrap
1599 msgid ""
1600 " Path \"/foo/bar\"\n"
1601 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
1602 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1603 " Path \"/dev/sdb2\"    (* not a device *)\n"
1604 "\n"
1605 msgstr ""
1606
1607 # type: textblock
1608 #: ../src/guestfs.pod:801
1609 msgid ""
1610 "As you can see there are still problems to resolve even with this "
1611 "representation.  Also consider how it might work in guestfish."
1612 msgstr ""
1613
1614 # type: =head2
1615 #: ../src/guestfs.pod:806
1616 msgid "PROTOCOL LIMITS"
1617 msgstr ""
1618
1619 # type: textblock
1620 #: ../src/guestfs.pod:808
1621 msgid ""
1622 "Internally libguestfs uses a message-based protocol to pass API calls and "
1623 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1624 "plenty more detail about this).  The maximum message size used by the "
1625 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
1626 "aware of this limit.  The API calls which may be affected are individually "
1627 "documented, with a link back to this section of the documentation."
1628 msgstr ""
1629
1630 # type: textblock
1631 #: ../src/guestfs.pod:816
1632 msgid ""
1633 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1634 "a simple string.  Because this string is at some point internally encoded as "
1635 "a message, the maximum size that it can return is slightly under 4 MB.  If "
1636 "the requested file is larger than this then you will get an error."
1637 msgstr ""
1638
1639 # type: textblock
1640 #: ../src/guestfs.pod:822
1641 msgid ""
1642 "In order to transfer large files into and out of the guest filesystem, you "
1643 "need to use particular calls that support this.  The sections L</UPLOADING> "
1644 "and L</DOWNLOADING> document how to do this."
1645 msgstr ""
1646
1647 # type: textblock
1648 #: ../src/guestfs.pod:826
1649 msgid ""
1650 "You might also consider mounting the disk image using our FUSE filesystem "
1651 "support (L<guestmount(1)>)."
1652 msgstr ""
1653
1654 # type: =head2
1655 #: ../src/guestfs.pod:829
1656 msgid "KEYS AND PASSPHRASES"
1657 msgstr ""
1658
1659 # type: textblock
1660 #: ../src/guestfs.pod:831
1661 msgid ""
1662 "Certain libguestfs calls take a parameter that contains sensitive key "
1663 "material, passed in as a C string."
1664 msgstr ""
1665
1666 # type: textblock
1667 #: ../src/guestfs.pod:834
1668 msgid ""
1669 "In the future we would hope to change the libguestfs implementation so that "
1670 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1671 "swap.  However this is I<not> done at the moment, because of the complexity "
1672 "of such an implementation."
1673 msgstr ""
1674
1675 # type: textblock
1676 #: ../src/guestfs.pod:839
1677 msgid ""
1678 "Therefore you should be aware that any key parameter you pass to libguestfs "
1679 "might end up being written out to the swap partition.  If this is a concern, "
1680 "scrub the swap partition or don't use libguestfs on encrypted devices."
1681 msgstr ""
1682
1683 # type: =head1
1684 #: ../src/guestfs.pod:844
1685 msgid "CONNECTION MANAGEMENT"
1686 msgstr ""
1687
1688 # type: =head2
1689 #: ../src/guestfs.pod:846
1690 msgid "guestfs_h *"
1691 msgstr ""
1692
1693 # type: textblock
1694 #: ../src/guestfs.pod:848
1695 msgid ""
1696 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
1697 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
1698 "handle and release all resources used."
1699 msgstr ""
1700
1701 # type: textblock
1702 #: ../src/guestfs.pod:852
1703 msgid ""
1704 "For information on using multiple handles and threads, see the section "
1705 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1706 msgstr ""
1707
1708 # type: =head2
1709 #: ../src/guestfs.pod:855
1710 msgid "guestfs_create"
1711 msgstr ""
1712
1713 # type: verbatim
1714 #: ../src/guestfs.pod:857
1715 #, no-wrap
1716 msgid ""
1717 " guestfs_h *guestfs_create (void);\n"
1718 "\n"
1719 msgstr ""
1720
1721 # type: textblock
1722 #: ../src/guestfs.pod:859
1723 msgid "Create a connection handle."
1724 msgstr ""
1725
1726 # type: textblock
1727 #: ../src/guestfs.pod:861
1728 msgid ""
1729 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1730 "on the handle at least once."
1731 msgstr ""
1732
1733 # type: textblock
1734 #: ../src/guestfs.pod:864
1735 msgid ""
1736 "This function returns a non-NULL pointer to a handle on success or NULL on "
1737 "error."
1738 msgstr ""
1739
1740 # type: textblock
1741 #: ../src/guestfs.pod:867
1742 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1743 msgstr ""
1744
1745 # type: textblock
1746 #: ../src/guestfs.pod:869
1747 msgid ""
1748 "You may also want to configure error handling for the handle.  See L</ERROR "
1749 "HANDLING> section below."
1750 msgstr ""
1751
1752 # type: =head2
1753 #: ../src/guestfs.pod:872
1754 msgid "guestfs_close"
1755 msgstr ""
1756
1757 # type: verbatim
1758 #: ../src/guestfs.pod:874
1759 #, no-wrap
1760 msgid ""
1761 " void guestfs_close (guestfs_h *g);\n"
1762 "\n"
1763 msgstr ""
1764
1765 # type: textblock
1766 #: ../src/guestfs.pod:876
1767 msgid "This closes the connection handle and frees up all resources used."
1768 msgstr ""
1769
1770 # type: =head1
1771 #: ../src/guestfs.pod:878
1772 msgid "ERROR HANDLING"
1773 msgstr ""
1774
1775 # type: textblock
1776 #: ../src/guestfs.pod:880
1777 msgid ""
1778 "API functions can return errors.  For example, almost all functions that "
1779 "return C<int> will return C<-1> to indicate an error."
1780 msgstr ""
1781
1782 # type: textblock
1783 #: ../src/guestfs.pod:883
1784 msgid ""
1785 "Additional information is available for errors: an error message string and "
1786 "optionally an error number (errno) if the thing that failed was a system "
1787 "call."
1788 msgstr ""
1789
1790 # type: textblock
1791 #: ../src/guestfs.pod:887
1792 msgid ""
1793 "You can get at the additional information about the last error on the handle "
1794 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1795 "up an error handler with L</guestfs_set_error_handler>."
1796 msgstr ""
1797
1798 # type: textblock
1799 #: ../src/guestfs.pod:892
1800 msgid ""
1801 "When the handle is created, a default error handler is installed which "
1802 "prints the error message string to C<stderr>.  For small short-running "
1803 "command line programs it is sufficient to do:"
1804 msgstr ""
1805
1806 # type: verbatim
1807 #: ../src/guestfs.pod:896
1808 #, no-wrap
1809 msgid ""
1810 " if (guestfs_launch (g) == -1)\n"
1811 "   exit (EXIT_FAILURE);\n"
1812 "\n"
1813 msgstr ""
1814
1815 # type: textblock
1816 #: ../src/guestfs.pod:899
1817 msgid ""
1818 "since the default error handler will ensure that an error message has been "
1819 "printed to C<stderr> before the program exits."
1820 msgstr ""
1821
1822 # type: textblock
1823 #: ../src/guestfs.pod:902
1824 msgid ""
1825 "For other programs the caller will almost certainly want to install an "
1826 "alternate error handler or do error handling in-line like this:"
1827 msgstr ""
1828
1829 # type: verbatim
1830 #: ../src/guestfs.pod:905
1831 #, no-wrap
1832 msgid ""
1833 " g = guestfs_create ();\n"
1834 " \n"
1835 msgstr ""
1836
1837 # type: verbatim
1838 #: ../src/guestfs.pod:907
1839 #, no-wrap
1840 msgid ""
1841 " /* This disables the default behaviour of printing errors\n"
1842 "    on stderr. */\n"
1843 " guestfs_set_error_handler (g, NULL, NULL);\n"
1844 " \n"
1845 msgstr ""
1846
1847 # type: verbatim
1848 #: ../src/guestfs.pod:911
1849 #, no-wrap
1850 msgid ""
1851 " if (guestfs_launch (g) == -1) {\n"
1852 "   /* Examine the error message and print it etc. */\n"
1853 "   char *msg = guestfs_last_error (g);\n"
1854 "   int errnum = guestfs_last_errno (g);\n"
1855 "   fprintf (stderr, \"%s\\n\", msg);\n"
1856 "   /* ... */\n"
1857 "  }\n"
1858 "\n"
1859 msgstr ""
1860
1861 # type: textblock
1862 #: ../src/guestfs.pod:919
1863 msgid ""
1864 "Out of memory errors are handled differently.  The default action is to call "
1865 "L<abort(3)>.  If this is undesirable, then you can set a handler using "
1866 "L</guestfs_set_out_of_memory_handler>."
1867 msgstr ""
1868
1869 # type: textblock
1870 #: ../src/guestfs.pod:923
1871 msgid ""
1872 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1873 "because there is no handle if this happens there is no way to get additional "
1874 "error information.  However L</guestfs_create> is supposed to be a "
1875 "lightweight operation which can only fail because of insufficient memory (it "
1876 "returns NULL in this case)."
1877 msgstr ""
1878
1879 # type: =head2
1880 #: ../src/guestfs.pod:929
1881 msgid "guestfs_last_error"
1882 msgstr ""
1883
1884 # type: verbatim
1885 #: ../src/guestfs.pod:931
1886 #, no-wrap
1887 msgid ""
1888 " const char *guestfs_last_error (guestfs_h *g);\n"
1889 "\n"
1890 msgstr ""
1891
1892 # type: textblock
1893 #: ../src/guestfs.pod:933
1894 msgid ""
1895 "This returns the last error message that happened on C<g>.  If there has not "
1896 "been an error since the handle was created, then this returns C<NULL>."
1897 msgstr ""
1898
1899 # type: textblock
1900 #: ../src/guestfs.pod:937
1901 msgid ""
1902 "The lifetime of the returned string is until the next error occurs, or "
1903 "L</guestfs_close> is called."
1904 msgstr ""
1905
1906 # type: =head2
1907 #: ../src/guestfs.pod:940
1908 msgid "guestfs_last_errno"
1909 msgstr ""
1910
1911 # type: verbatim
1912 #: ../src/guestfs.pod:942
1913 #, no-wrap
1914 msgid ""
1915 " int guestfs_last_errno (guestfs_h *g);\n"
1916 "\n"
1917 msgstr ""
1918
1919 # type: textblock
1920 #: ../src/guestfs.pod:944
1921 msgid "This returns the last error number (errno) that happened on C<g>."
1922 msgstr ""
1923
1924 # type: textblock
1925 #: ../src/guestfs.pod:946
1926 msgid "If successful, an errno integer not equal to zero is returned."
1927 msgstr ""
1928
1929 # type: textblock
1930 #: ../src/guestfs.pod:948
1931 msgid "If no error, this returns 0.  This call can return 0 in three situations:"
1932 msgstr ""
1933
1934 # type: textblock
1935 #: ../src/guestfs.pod:955
1936 msgid "There has not been any error on the handle."
1937 msgstr ""
1938
1939 # type: textblock
1940 #: ../src/guestfs.pod:959
1941 msgid ""
1942 "There has been an error but the errno was meaningless.  This corresponds to "
1943 "the case where the error did not come from a failed system call, but for "
1944 "some other reason."
1945 msgstr ""
1946
1947 # type: textblock
1948 #: ../src/guestfs.pod:965
1949 msgid ""
1950 "There was an error from a failed system call, but for some reason the errno "
1951 "was not captured and returned.  This usually indicates a bug in libguestfs."
1952 msgstr ""
1953
1954 # type: textblock
1955 #: ../src/guestfs.pod:971
1956 msgid ""
1957 "Libguestfs tries to convert the errno from inside the applicance into a "
1958 "corresponding errno for the caller (not entirely trivial: the appliance "
1959 "might be running a completely different operating system from the library "
1960 "and error numbers are not standardized across Un*xen).  If this could not be "
1961 "done, then the error is translated to C<EINVAL>.  In practice this should "
1962 "only happen in very rare circumstances."
1963 msgstr ""
1964
1965 # type: =head2
1966 #: ../src/guestfs.pod:979
1967 msgid "guestfs_set_error_handler"
1968 msgstr ""
1969
1970 # type: verbatim
1971 #: ../src/guestfs.pod:981
1972 #, no-wrap
1973 msgid ""
1974 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1975 "                                           void *opaque,\n"
1976 "                                           const char *msg);\n"
1977 " void guestfs_set_error_handler (guestfs_h *g,\n"
1978 "                                 guestfs_error_handler_cb cb,\n"
1979 "                                 void *opaque);\n"
1980 "\n"
1981 msgstr ""
1982
1983 # type: textblock
1984 #: ../src/guestfs.pod:988
1985 msgid ""
1986 "The callback C<cb> will be called if there is an error.  The parameters "
1987 "passed to the callback are an opaque data pointer and the error message "
1988 "string."
1989 msgstr ""
1990
1991 # type: textblock
1992 #: ../src/guestfs.pod:992
1993 msgid ""
1994 "C<errno> is not passed to the callback.  To get that the callback must call "
1995 "L</guestfs_last_errno>."
1996 msgstr ""
1997
1998 # type: textblock
1999 #: ../src/guestfs.pod:995
2000 msgid ""
2001 "Note that the message string C<msg> is freed as soon as the callback "
2002 "function returns, so if you want to stash it somewhere you must make your "
2003 "own copy."
2004 msgstr ""
2005
2006 # type: textblock
2007 #: ../src/guestfs.pod:999
2008 msgid "The default handler prints messages on C<stderr>."
2009 msgstr ""
2010
2011 # type: textblock
2012 #: ../src/guestfs.pod:1001
2013 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2014 msgstr ""
2015
2016 # type: =head2
2017 #: ../src/guestfs.pod:1003
2018 msgid "guestfs_get_error_handler"
2019 msgstr ""
2020
2021 # type: verbatim
2022 #: ../src/guestfs.pod:1005
2023 #, no-wrap
2024 msgid ""
2025 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2026 "                                                     void **opaque_rtn);\n"
2027 "\n"
2028 msgstr ""
2029
2030 # type: textblock
2031 #: ../src/guestfs.pod:1008
2032 msgid "Returns the current error handler callback."
2033 msgstr ""
2034
2035 # type: =head2
2036 #: ../src/guestfs.pod:1010
2037 msgid "guestfs_set_out_of_memory_handler"
2038 msgstr ""
2039
2040 # type: verbatim
2041 #: ../src/guestfs.pod:1012
2042 #, no-wrap
2043 msgid ""
2044 " typedef void (*guestfs_abort_cb) (void);\n"
2045 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2046 "                                        guestfs_abort_cb);\n"
2047 "\n"
2048 msgstr ""
2049
2050 # type: textblock
2051 #: ../src/guestfs.pod:1016
2052 msgid ""
2053 "The callback C<cb> will be called if there is an out of memory situation.  "
2054 "I<Note this callback must not return>."
2055 msgstr ""
2056
2057 # type: textblock
2058 #: ../src/guestfs.pod:1019
2059 msgid "The default is to call L<abort(3)>."
2060 msgstr ""
2061
2062 # type: textblock
2063 #: ../src/guestfs.pod:1021
2064 msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
2065 msgstr ""
2066
2067 # type: =head2
2068 #: ../src/guestfs.pod:1024
2069 msgid "guestfs_get_out_of_memory_handler"
2070 msgstr ""
2071
2072 # type: verbatim
2073 #: ../src/guestfs.pod:1026
2074 #, no-wrap
2075 msgid ""
2076 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2077 "\n"
2078 msgstr ""
2079
2080 # type: textblock
2081 #: ../src/guestfs.pod:1028
2082 msgid "This returns the current out of memory handler."
2083 msgstr ""
2084
2085 # type: =head1
2086 #: ../src/guestfs.pod:1030
2087 msgid "PATH"
2088 msgstr ""
2089
2090 # type: textblock
2091 #: ../src/guestfs.pod:1032
2092 msgid ""
2093 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2094 "internal path."
2095 msgstr ""
2096
2097 # type: textblock
2098 #: ../src/guestfs.pod:1035
2099 msgid ""
2100 "By default it looks for these in the directory C<$libdir/guestfs> "
2101 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2102 msgstr ""
2103
2104 # type: textblock
2105 #: ../src/guestfs.pod:1038
2106 msgid ""
2107 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2108 "to change the directories that libguestfs will search in.  The value is a "
2109 "colon-separated list of paths.  The current directory is I<not> searched "
2110 "unless the path contains an empty element or C<.>.  For example "
2111 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2112 "then C</usr/lib/guestfs>."
2113 msgstr ""
2114
2115 # type: =head1
2116 #: ../src/guestfs.pod:1045
2117 msgid "HIGH-LEVEL API ACTIONS"
2118 msgstr ""
2119
2120 # type: =head2
2121 #: ../src/guestfs.pod:1047
2122 msgid "ABI GUARANTEE"
2123 msgstr ""
2124
2125 # type: textblock
2126 #: ../src/guestfs.pod:1049
2127 msgid ""
2128 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2129 "actions as outlined in this section.  Although we will deprecate some "
2130 "actions, for example if they get replaced by newer calls, we will keep the "
2131 "old actions forever.  This allows you the developer to program in confidence "
2132 "against the libguestfs API."
2133 msgstr ""
2134
2135 # type: textblock
2136 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:907
2137 msgid "@ACTIONS@"
2138 msgstr ""
2139
2140 # type: =head1
2141 #: ../src/guestfs.pod:1057
2142 msgid "STRUCTURES"
2143 msgstr ""
2144
2145 # type: textblock
2146 #: ../src/guestfs.pod:1059
2147 msgid "@STRUCTS@"
2148 msgstr ""
2149
2150 # type: =head1
2151 #: ../src/guestfs.pod:1061
2152 msgid "AVAILABILITY"
2153 msgstr ""
2154
2155 # type: =head2
2156 #: ../src/guestfs.pod:1063
2157 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2158 msgstr ""
2159
2160 # type: textblock
2161 #: ../src/guestfs.pod:1065
2162 msgid ""
2163 "Using L</guestfs_available> you can test availability of the following "
2164 "groups of functions.  This test queries the appliance to see if the "
2165 "appliance you are currently using supports the functionality."
2166 msgstr ""
2167
2168 # type: textblock
2169 #: ../src/guestfs.pod:1070
2170 msgid "@AVAILABILITY@"
2171 msgstr ""
2172
2173 # type: =head2
2174 #: ../src/guestfs.pod:1072
2175 msgid "GUESTFISH supported COMMAND"
2176 msgstr ""
2177
2178 # type: textblock
2179 #: ../src/guestfs.pod:1074
2180 msgid ""
2181 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2182 "prints out the available groups and whether they are supported by this build "
2183 "of libguestfs.  Note however that you have to do C<run> first."
2184 msgstr ""
2185
2186 # type: =head2
2187 #: ../src/guestfs.pod:1079
2188 msgid "SINGLE CALLS AT COMPILE TIME"
2189 msgstr ""
2190
2191 # type: textblock
2192 #: ../src/guestfs.pod:1081
2193 msgid ""
2194 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2195 "function, such as:"
2196 msgstr ""
2197
2198 # type: verbatim
2199 #: ../src/guestfs.pod:1084
2200 #, no-wrap
2201 msgid ""
2202 " #define LIBGUESTFS_HAVE_DD 1\n"
2203 "\n"
2204 msgstr ""
2205
2206 # type: textblock
2207 #: ../src/guestfs.pod:1086
2208 msgid "if L</guestfs_dd> is available."
2209 msgstr ""
2210
2211 # type: textblock
2212 #: ../src/guestfs.pod:1088
2213 msgid ""
2214 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2215 "function is available at compile time, we recommended using build tools such "
2216 "as autoconf or cmake.  For example in autotools you could use:"
2217 msgstr ""
2218
2219 # type: verbatim
2220 #: ../src/guestfs.pod:1093
2221 #, no-wrap
2222 msgid ""
2223 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2224 " AC_CHECK_FUNCS([guestfs_dd])\n"
2225 "\n"
2226 msgstr ""
2227
2228 # type: textblock
2229 #: ../src/guestfs.pod:1096
2230 msgid ""
2231 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2232 "in your program."
2233 msgstr ""
2234
2235 # type: =head2
2236 #: ../src/guestfs.pod:1099
2237 msgid "SINGLE CALLS AT RUN TIME"
2238 msgstr ""
2239
2240 # type: textblock
2241 #: ../src/guestfs.pod:1101
2242 msgid ""
2243 "Testing at compile time doesn't guarantee that a function really exists in "
2244 "the library.  The reason is that you might be dynamically linked against a "
2245 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
2246 "This situation unfortunately results in a segmentation fault, which is a "
2247 "shortcoming of the C dynamic linking system itself."
2248 msgstr ""
2249
2250 # type: textblock
2251 #: ../src/guestfs.pod:1108
2252 msgid ""
2253 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2254 "in this example program (note that you still need the compile time check as "
2255 "well):"
2256 msgstr ""
2257
2258 # type: verbatim
2259 #: ../src/guestfs.pod:1112
2260 #, no-wrap
2261 msgid ""
2262 " #include <stdio.h>\n"
2263 " #include <stdlib.h>\n"
2264 " #include <unistd.h>\n"
2265 " #include <dlfcn.h>\n"
2266 " #include <guestfs.h>\n"
2267 " \n"
2268 msgstr ""
2269
2270 # type: verbatim
2271 #: ../src/guestfs.pod:1118
2272 #, no-wrap
2273 msgid ""
2274 " main ()\n"
2275 " {\n"
2276 " #ifdef LIBGUESTFS_HAVE_DD\n"
2277 "   void *dl;\n"
2278 "   int has_function;\n"
2279 " \n"
2280 msgstr ""
2281
2282 # type: verbatim
2283 #: ../src/guestfs.pod:1124
2284 #, no-wrap
2285 msgid ""
2286 "   /* Test if the function guestfs_dd is really available. */\n"
2287 "   dl = dlopen (NULL, RTLD_LAZY);\n"
2288 "   if (!dl) {\n"
2289 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2290 "     exit (EXIT_FAILURE);\n"
2291 "   }\n"
2292 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2293 "   dlclose (dl);\n"
2294 " \n"
2295 msgstr ""
2296
2297 # type: verbatim
2298 #: ../src/guestfs.pod:1133
2299 #, no-wrap
2300 msgid ""
2301 "   if (!has_function)\n"
2302 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2303 "   else {\n"
2304 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2305 "     /* Now it's safe to call\n"
2306 "     guestfs_dd (g, \"foo\", \"bar\");\n"
2307 "     */\n"
2308 "   }\n"
2309 " #else\n"
2310 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2311 " #endif\n"
2312 "  }\n"
2313 "\n"
2314 msgstr ""
2315
2316 # type: textblock
2317 #: ../src/guestfs.pod:1146
2318 msgid ""
2319 "You may think the above is an awful lot of hassle, and it is.  There are "
2320 "other ways outside of the C linking system to ensure that this kind of "
2321 "incompatibility never arises, such as using package versioning:"
2322 msgstr ""
2323
2324 # type: verbatim
2325 #: ../src/guestfs.pod:1151
2326 #, no-wrap
2327 msgid ""
2328 " Requires: libguestfs >= 1.0.80\n"
2329 "\n"
2330 msgstr ""
2331
2332 # type: =head1
2333 #: ../src/guestfs.pod:1153
2334 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2335 msgstr ""
2336
2337 # type: textblock
2338 #: ../src/guestfs.pod:1155
2339 msgid ""
2340 "A recent feature of the API is the introduction of calls which take optional "
2341 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
2342 "takes variable arguments (ie. C<...>), as in this example:"
2343 msgstr ""
2344
2345 # type: verbatim
2346 #: ../src/guestfs.pod:1160
2347 #, no-wrap
2348 msgid ""
2349 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2350 "\n"
2351 msgstr ""
2352
2353 # type: textblock
2354 #: ../src/guestfs.pod:1162
2355 msgid ""
2356 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
2357 "call with no optional arguments specified:"
2358 msgstr ""
2359
2360 # type: verbatim
2361 #: ../src/guestfs.pod:1165
2362 #, no-wrap
2363 msgid ""
2364 " guestfs_add_drive_opts (g, filename, -1);\n"
2365 "\n"
2366 msgstr ""
2367
2368 # type: textblock
2369 #: ../src/guestfs.pod:1167
2370 msgid "With a single optional argument:"
2371 msgstr ""
2372
2373 # type: verbatim
2374 #: ../src/guestfs.pod:1169
2375 #, no-wrap
2376 msgid ""
2377 " guestfs_add_drive_opts (g, filename,\n"
2378 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2379 "                         -1);\n"
2380 "\n"
2381 msgstr ""
2382
2383 # type: textblock
2384 #: ../src/guestfs.pod:1173
2385 msgid "With two:"
2386 msgstr ""
2387
2388 # type: verbatim
2389 #: ../src/guestfs.pod:1175
2390 #, no-wrap
2391 msgid ""
2392 " guestfs_add_drive_opts (g, filename,\n"
2393 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2394 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2395 "                         -1);\n"
2396 "\n"
2397 msgstr ""
2398
2399 # type: textblock
2400 #: ../src/guestfs.pod:1180
2401 msgid ""
2402 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
2403 "happen!"
2404 msgstr ""
2405
2406 # type: =head2
2407 #: ../src/guestfs.pod:1183
2408 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2409 msgstr ""
2410
2411 # type: textblock
2412 #: ../src/guestfs.pod:1185
2413 msgid ""
2414 "The second variant has the same name with the suffix C<_va>, which works the "
2415 "same way but takes a C<va_list>.  See the C manual for details.  For the "
2416 "example function, this is declared:"
2417 msgstr ""
2418
2419 # type: verbatim
2420 #: ../src/guestfs.pod:1189
2421 #, no-wrap
2422 msgid ""
2423 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2424 "                                va_list args);\n"
2425 "\n"
2426 msgstr ""
2427
2428 # type: =head2
2429 #: ../src/guestfs.pod:1192
2430 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2431 msgstr ""
2432
2433 # type: textblock
2434 #: ../src/guestfs.pod:1194
2435 msgid ""
2436 "The third variant is useful where you need to construct these calls.  You "
2437 "pass in a structure where you fill in the optional fields.  The structure "
2438 "has a bitmask as the first element which you must set to indicate which "
2439 "fields you have filled in.  For our example function the structure and call "
2440 "are declared:"
2441 msgstr ""
2442
2443 # type: verbatim
2444 #: ../src/guestfs.pod:1200
2445 #, no-wrap
2446 msgid ""
2447 " struct guestfs_add_drive_opts_argv {\n"
2448 "   uint64_t bitmask;\n"
2449 "   int readonly;\n"
2450 "   const char *format;\n"
2451 "   /* ... */\n"
2452 " };\n"
2453 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2454 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
2455 "\n"
2456 msgstr ""
2457
2458 # type: textblock
2459 #: ../src/guestfs.pod:1209
2460 msgid "You could call it like this:"
2461 msgstr ""
2462
2463 # type: verbatim
2464 #: ../src/guestfs.pod:1211
2465 #, no-wrap
2466 msgid ""
2467 " struct guestfs_add_drive_opts_argv optargs = {\n"
2468 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2469 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2470 "   .readonly = 1,\n"
2471 "   .format = \"qcow2\"\n"
2472 " };\n"
2473 " \n"
2474 msgstr ""
2475
2476 # type: verbatim
2477 #: ../src/guestfs.pod:1218
2478 #, no-wrap
2479 msgid ""
2480 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2481 "\n"
2482 msgstr ""
2483
2484 # type: textblock
2485 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
2486 msgid "Notes:"
2487 msgstr ""
2488
2489 # type: textblock
2490 #: ../src/guestfs.pod:1226
2491 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2492 msgstr ""
2493
2494 # type: textblock
2495 #: ../src/guestfs.pod:1231
2496 msgid "You do not need to fill in all fields of the structure."
2497 msgstr ""
2498
2499 # type: textblock
2500 #: ../src/guestfs.pod:1235
2501 msgid ""
2502 "There must be a one-to-one correspondence between fields of the structure "
2503 "that are filled in, and bits set in the bitmask."
2504 msgstr ""
2505
2506 # type: =head2
2507 #: ../src/guestfs.pod:1240
2508 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2509 msgstr ""
2510
2511 # type: textblock
2512 #: ../src/guestfs.pod:1242
2513 msgid ""
2514 "In other languages, optional arguments are expressed in the way that is "
2515 "natural for that language.  We refer you to the language-specific "
2516 "documentation for more details on that."
2517 msgstr ""
2518
2519 # type: textblock
2520 #: ../src/guestfs.pod:1246
2521 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2522 msgstr ""
2523
2524 # type: =end
2525 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2526 msgid "html"
2527 msgstr ""
2528
2529 # type: textblock
2530 #: ../src/guestfs.pod:1250
2531 msgid ""
2532 "<!-- old anchor for the next section --> <a "
2533 "name=\"state_machine_and_low_level_event_api\"/>"
2534 msgstr ""
2535
2536 # type: =head1
2537 #: ../src/guestfs.pod:1255
2538 msgid "ARCHITECTURE"
2539 msgstr ""
2540
2541 # type: textblock
2542 #: ../src/guestfs.pod:1257
2543 msgid ""
2544 "Internally, libguestfs is implemented by running an appliance (a special "
2545 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
2546 "process of the main program."
2547 msgstr ""
2548
2549 # type: verbatim
2550 #: ../src/guestfs.pod:1261
2551 #, no-wrap
2552 msgid ""
2553 "  ___________________\n"
2554 " /                   \\\n"
2555 " | main program      |\n"
2556 " |                   |\n"
2557 " |                   |           child process / appliance\n"
2558 " |                   |           __________________________\n"
2559 " |                   |          / qemu                     \\\n"
2560 " +-------------------+   RPC    |      +-----------------+ |\n"
2561 " | libguestfs     <--------------------> guestfsd        | |\n"
2562 " |                   |          |      +-----------------+ |\n"
2563 " \\___________________/          |      | Linux kernel    | |\n"
2564 "                                |      +--^--------------+ |\n"
2565 "                                \\_________|________________/\n"
2566 "                                          |\n"
2567 "                                   _______v______\n"
2568 "                                  /              \\\n"
2569 "                                  | Device or    |\n"
2570 "                                  | disk image   |\n"
2571 "                                  \\______________/\n"
2572 "\n"
2573 msgstr ""
2574
2575 # type: textblock
2576 #: ../src/guestfs.pod:1281
2577 msgid ""
2578 "The library, linked to the main program, creates the child process and hence "
2579 "the appliance in the L</guestfs_launch> function."
2580 msgstr ""
2581
2582 # type: textblock
2583 #: ../src/guestfs.pod:1284
2584 msgid ""
2585 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2586 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2587 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
2588 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
2589 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
2590 "attached to the qemu process which translates device access by the "
2591 "appliance's Linux kernel into accesses to the image."
2592 msgstr ""
2593
2594 # type: textblock
2595 #: ../src/guestfs.pod:1293
2596 msgid ""
2597 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
2598 "Although the disk image you are attached to might also be used by some "
2599 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
2600 "care if both libguestfs's qemu process and your virtual machine are trying "
2601 "to update the disk image at the same time, since these usually results in "
2602 "massive disk corruption)."
2603 msgstr ""
2604
2605 # type: =head1
2606 #: ../src/guestfs.pod:1300
2607 msgid "STATE MACHINE"
2608 msgstr ""
2609
2610 # type: textblock
2611 #: ../src/guestfs.pod:1302
2612 msgid "libguestfs uses a state machine to model the child process:"
2613 msgstr ""
2614
2615 # type: verbatim
2616 #: ../src/guestfs.pod:1304
2617 #, no-wrap
2618 msgid ""
2619 "                         |\n"
2620 "                    guestfs_create\n"
2621 "                         |\n"
2622 "                         |\n"
2623 "                     ____V_____\n"
2624 "                    /          \\\n"
2625 "                    |  CONFIG  |\n"
2626 "                    \\__________/\n"
2627 "                     ^ ^   ^  \\\n"
2628 "                    /  |    \\  \\ guestfs_launch\n"
2629 "                   /   |    _\\__V______\n"
2630 "                  /    |   /           \\\n"
2631 "                 /     |   | LAUNCHING |\n"
2632 "                /      |   \\___________/\n"
2633 "               /       |       /\n"
2634 "              /        |  guestfs_launch\n"
2635 "             /         |     /\n"
2636 "    ______  /        __|____V\n"
2637 "   /      \\ ------> /        \\\n"
2638 "   | BUSY |         | READY  |\n"
2639 "   \\______/ <------ \\________/\n"
2640 "\n"
2641 msgstr ""
2642
2643 # type: textblock
2644 #: ../src/guestfs.pod:1326
2645 msgid ""
2646 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2647 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2648 "(3) alternating between READY and BUSY as commands are issued to, and "
2649 "carried out by, the child process."
2650 msgstr ""
2651
2652 # type: textblock
2653 #: ../src/guestfs.pod:1331
2654 msgid ""
2655 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2656 "asynchronously at any time (eg. due to some internal error), and that causes "
2657 "the state to transition back to CONFIG."
2658 msgstr ""
2659
2660 # type: textblock
2661 #: ../src/guestfs.pod:1335
2662 msgid ""
2663 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2664 "issued when in the CONFIG state."
2665 msgstr ""
2666
2667 # type: textblock
2668 #: ../src/guestfs.pod:1338
2669 msgid ""
2670 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
2671 "L</guestfs_launch> blocks until the child process is READY to accept "
2672 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
2673 "moves the state from CONFIG to LAUNCHING while it is running."
2674 msgstr ""
2675
2676 # type: textblock
2677 #: ../src/guestfs.pod:1344
2678 msgid ""
2679 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2680 "state.  These API calls block waiting for the command to be carried out "
2681 "(ie. the state to transition to BUSY and then back to READY).  There are no "
2682 "non-blocking versions, and no way to issue more than one command per handle "
2683 "at the same time."
2684 msgstr ""
2685
2686 # type: textblock
2687 #: ../src/guestfs.pod:1350
2688 msgid ""
2689 "Finally, the child process sends asynchronous messages back to the main "
2690 "program, such as kernel log messages.  You can register a callback to "
2691 "receive these messages."
2692 msgstr ""
2693
2694 # type: =head2
2695 #: ../src/guestfs.pod:1354
2696 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2697 msgstr ""
2698
2699 # type: textblock
2700 #: ../src/guestfs.pod:1356
2701 msgid ""
2702 "The child process generates events in some situations.  Current events "
2703 "include: receiving a log message, the child process exits."
2704 msgstr ""
2705
2706 # type: textblock
2707 #: ../src/guestfs.pod:1359
2708 msgid ""
2709 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2710 "types of events."
2711 msgstr ""
2712
2713 # type: textblock
2714 #: ../src/guestfs.pod:1362
2715 msgid ""
2716 "Only I<one callback of each type> can be registered for each handle.  "
2717 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2718 "that type.  Cancel all callbacks of this type by calling this function with "
2719 "C<cb> set to C<NULL>."
2720 msgstr ""
2721
2722 # type: =head2
2723 #: ../src/guestfs.pod:1367
2724 msgid "guestfs_set_log_message_callback"
2725 msgstr ""
2726
2727 # type: verbatim
2728 #: ../src/guestfs.pod:1369
2729 #, no-wrap
2730 msgid ""
2731 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2732 "                                         char *buf, int len);\n"
2733 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2734 "                                        guestfs_log_message_cb cb,\n"
2735 "                                        void *opaque);\n"
2736 "\n"
2737 msgstr ""
2738
2739 # type: textblock
2740 #: ../src/guestfs.pod:1375
2741 msgid ""
2742 "The callback function C<cb> will be called whenever qemu or the guest writes "
2743 "anything to the console."
2744 msgstr ""
2745
2746 # type: textblock
2747 #: ../src/guestfs.pod:1378
2748 msgid "Use this function to capture kernel messages and similar."
2749 msgstr ""
2750
2751 # type: textblock
2752 #: ../src/guestfs.pod:1380
2753 msgid ""
2754 "Normally there is no log message handler, and log messages are just "
2755 "discarded."
2756 msgstr ""
2757
2758 # type: =head2
2759 #: ../src/guestfs.pod:1383
2760 msgid "guestfs_set_subprocess_quit_callback"
2761 msgstr ""
2762
2763 # type: verbatim
2764 #: ../src/guestfs.pod:1385
2765 #, no-wrap
2766 msgid ""
2767 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2768 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2769 "                                            guestfs_subprocess_quit_cb cb,\n"
2770 "                                            void *opaque);\n"
2771 "\n"
2772 msgstr ""
2773
2774 # type: textblock
2775 #: ../src/guestfs.pod:1390
2776 msgid ""
2777 "The callback function C<cb> will be called when the child process quits, "
2778 "either asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
2779 "corresponds to a transition from any state to the CONFIG state)."
2780 msgstr ""
2781
2782 # type: =head2
2783 #: ../src/guestfs.pod:1395
2784 msgid "guestfs_set_launch_done_callback"
2785 msgstr ""
2786
2787 # type: verbatim
2788 #: ../src/guestfs.pod:1397
2789 #, no-wrap
2790 msgid ""
2791 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2792 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2793 "                                        guestfs_launch_done_cb cb,\n"
2794 "                                        void *opaque);\n"
2795 "\n"
2796 msgstr ""
2797
2798 # type: textblock
2799 #: ../src/guestfs.pod:1402
2800 msgid ""
2801 "The callback function C<cb> will be called when the child process becomes "
2802 "ready first time after it has been launched.  (This corresponds to a "
2803 "transition from LAUNCHING to the READY state)."
2804 msgstr ""
2805
2806 # type: =head2
2807 #: ../src/guestfs.pod:1406
2808 msgid "guestfs_set_close_callback"
2809 msgstr ""
2810
2811 # type: verbatim
2812 #: ../src/guestfs.pod:1408
2813 #, no-wrap
2814 msgid ""
2815 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2816 " void guestfs_set_close_callback (guestfs_h *g,\n"
2817 "                                  guestfs_close_cb cb,\n"
2818 "                                  void *opaque);\n"
2819 "\n"
2820 msgstr ""
2821
2822 # type: textblock
2823 #: ../src/guestfs.pod:1413
2824 msgid ""
2825 "The callback function C<cb> will be called while the handle is being closed "
2826 "(synchronously from L</guestfs_close>)."
2827 msgstr ""
2828
2829 # type: textblock
2830 #: ../src/guestfs.pod:1416
2831 msgid ""
2832 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2833 "handles that are open when the program exits.  This means that this callback "
2834 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2835 "problems in higher-level languages (eg. if your HLL interpreter has already "
2836 "been cleaned up by the time this is called, and if your callback then jumps "
2837 "into some HLL function)."
2838 msgstr ""
2839
2840 # type: =head2
2841 #: ../src/guestfs.pod:1424
2842 msgid "guestfs_set_progress_callback"
2843 msgstr ""
2844
2845 # type: verbatim
2846 #: ../src/guestfs.pod:1426
2847 #, no-wrap
2848 msgid ""
2849 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2850 "                                      int proc_nr, int serial,\n"
2851 "                                      uint64_t position, uint64_t total);\n"
2852 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2853 "                                     guestfs_progress_cb cb,\n"
2854 "                                     void *opaque);\n"
2855 "\n"
2856 msgstr ""
2857
2858 # type: textblock
2859 #: ../src/guestfs.pod:1433
2860 msgid ""
2861 "Some long-running operations can generate progress messages.  If this "
2862 "callback is registered, then it will be called each time a progress message "
2863 "is generated (usually two seconds after the operation started, and three "
2864 "times per second thereafter until it completes, although the frequency may "
2865 "change in future versions)."
2866 msgstr ""
2867
2868 # type: textblock
2869 #: ../src/guestfs.pod:1439
2870 msgid ""
2871 "The callback receives two numbers: C<position> and C<total>.  The units of "
2872 "C<total> are not defined, although for some operations C<total> may relate "
2873 "in some way to the amount of data to be transferred (eg. in bytes or "
2874 "megabytes), and C<position> may be the portion which has been transferred."
2875 msgstr ""
2876
2877 # type: textblock
2878 #: ../src/guestfs.pod:1445
2879 msgid "The only defined and stable parts of the API are:"
2880 msgstr ""
2881
2882 # type: textblock
2883 #: ../src/guestfs.pod:1451
2884 msgid ""
2885 "The callback can display to the user some type of progress bar or indicator "
2886 "which shows the ratio of C<position>:C<total>."
2887 msgstr ""
2888
2889 # type: textblock
2890 #: ../src/guestfs.pod:1456
2891 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2892 msgstr ""
2893
2894 # type: textblock
2895 #: ../src/guestfs.pod:1460
2896 msgid ""
2897 "If any progress notification is sent during a call, then a final progress "
2898 "notification is always sent when C<position> = C<total>."
2899 msgstr ""
2900
2901 # type: textblock
2902 #: ../src/guestfs.pod:1463
2903 msgid ""
2904 "This is to simplify caller code, so callers can easily set the progress "
2905 "indicator to \"100%\" at the end of the operation, without requiring special "
2906 "code to detect this case."
2907 msgstr ""
2908
2909 # type: textblock
2910 #: ../src/guestfs.pod:1469
2911 msgid ""
2912 "The callback also receives the procedure number and serial number of the "
2913 "call.  These are only useful for debugging protocol issues, and the callback "
2914 "can normally ignore them.  The callback may want to print these numbers in "
2915 "error messages or debugging messages."
2916 msgstr ""
2917
2918 # type: =head1
2919 #: ../src/guestfs.pod:1474
2920 msgid "PRIVATE DATA AREA"
2921 msgstr ""
2922
2923 # type: textblock
2924 #: ../src/guestfs.pod:1476
2925 msgid ""
2926 "You can attach named pieces of private data to the libguestfs handle, and "
2927 "fetch them by name for the lifetime of the handle.  This is called the "
2928 "private data area and is only available from the C API."
2929 msgstr ""
2930
2931 # type: textblock
2932 #: ../src/guestfs.pod:1480
2933 msgid "To attach a named piece of data, use the following call:"
2934 msgstr ""
2935
2936 # type: verbatim
2937 #: ../src/guestfs.pod:1482
2938 #, no-wrap
2939 msgid ""
2940 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2941 "\n"
2942 msgstr ""
2943
2944 # type: textblock
2945 #: ../src/guestfs.pod:1484
2946 msgid ""
2947 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2948 "pointer (which can be C<NULL>).  Any previous item with the same name is "
2949 "overwritten."
2950 msgstr ""
2951
2952 # type: textblock
2953 #: ../src/guestfs.pod:1488
2954 msgid ""
2955 "You can use any C<key> you want, but names beginning with an underscore "
2956 "character are reserved for internal libguestfs purposes (for implementing "
2957 "language bindings).  It is recommended to prefix the name with some unique "
2958 "string to avoid collisions with other users."
2959 msgstr ""
2960
2961 # type: textblock
2962 #: ../src/guestfs.pod:1493
2963 msgid "To retrieve the pointer, use:"
2964 msgstr ""
2965
2966 # type: verbatim
2967 #: ../src/guestfs.pod:1495
2968 #, no-wrap
2969 msgid ""
2970 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2971 "\n"
2972 msgstr ""
2973
2974 # type: textblock
2975 #: ../src/guestfs.pod:1497
2976 msgid ""
2977 "This function returns C<NULL> if either no data is found associated with "
2978 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2979 "C<NULL>."
2980 msgstr ""
2981
2982 # type: textblock
2983 #: ../src/guestfs.pod:1501
2984 msgid ""
2985 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2986 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
2987 "all.  In particular, libguestfs does I<not> try to free the data when the "
2988 "handle is closed.  If the data must be freed, then the caller must either "
2989 "free it before calling L</guestfs_close> or must set up a close callback to "
2990 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2991 "can be registered for a handle)."
2992 msgstr ""
2993
2994 # type: textblock
2995 #: ../src/guestfs.pod:1509
2996 msgid ""
2997 "The private data area is implemented using a hash table, and should be "
2998 "reasonably efficient for moderate numbers of keys."
2999 msgstr ""
3000
3001 # type: =head1
3002 #: ../src/guestfs.pod:1512
3003 msgid "BLOCK DEVICE NAMING"
3004 msgstr ""
3005
3006 # type: textblock
3007 #: ../src/guestfs.pod:1514
3008 msgid ""
3009 "In the kernel there is now quite a profusion of schemata for naming block "
3010 "devices (in this context, by I<block device> I mean a physical or virtual "
3011 "hard drive).  The original Linux IDE driver used names starting with "
3012 "C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
3013 "C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
3014 "replacement for the old IDE driver (particularly for SATA devices) those "
3015 "devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
3016 "machines with paravirtualized drivers.  This has created several different "
3017 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
3018 "Xen PV disks."
3019 msgstr ""
3020
3021 # type: textblock
3022 #: ../src/guestfs.pod:1526
3023 msgid ""
3024 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3025 "Linux kernel to access block devices.  We can run a variety of appliances "
3026 "based on a variety of Linux kernels."
3027 msgstr ""
3028
3029 # type: textblock
3030 #: ../src/guestfs.pod:1530
3031 msgid ""
3032 "This causes a problem for libguestfs because many API calls use device or "
3033 "partition names.  Working scripts and the recipe (example) scripts that we "
3034 "make available over the internet could fail if the naming scheme changes."
3035 msgstr ""
3036
3037 # type: textblock
3038 #: ../src/guestfs.pod:1535
3039 msgid ""
3040 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
3041 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3042 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3043 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3044 msgstr ""
3045
3046 # type: textblock
3047 #: ../src/guestfs.pod:1541
3048 msgid ""
3049 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
3050 "L</guestfs_list_partitions> and similar calls return the true names of the "
3051 "devices and partitions as known to the appliance."
3052 msgstr ""
3053
3054 # type: =head2
3055 #: ../src/guestfs.pod:1546
3056 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3057 msgstr ""
3058
3059 # type: textblock
3060 #: ../src/guestfs.pod:1548
3061 msgid ""
3062 "Usually this translation is transparent.  However in some (very rare)  cases "
3063 "you may need to know the exact algorithm.  Such cases include where you use "
3064 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
3065 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
3066 "devices."
3067 msgstr ""
3068
3069 # type: textblock
3070 #: ../src/guestfs.pod:1554
3071 msgid ""
3072 "The algorithm is applied only to I<parameters> which are known to be either "
3073 "device or partition names.  Return values from functions such as "
3074 "L</guestfs_list_devices> are never changed."
3075 msgstr ""
3076
3077 # type: textblock
3078 #: ../src/guestfs.pod:1562
3079 msgid "Is the string a parameter which is a device or partition name?"
3080 msgstr ""
3081
3082 # type: textblock
3083 #: ../src/guestfs.pod:1566
3084 msgid "Does the string begin with C</dev/sd>?"
3085 msgstr ""
3086
3087 # type: textblock
3088 #: ../src/guestfs.pod:1570
3089 msgid ""
3090 "Does the named device exist? If so, we use that device.  However if I<not> "
3091 "then we continue with this algorithm."
3092 msgstr ""
3093
3094 # type: textblock
3095 #: ../src/guestfs.pod:1575
3096 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3097 msgstr ""
3098
3099 # type: textblock
3100 #: ../src/guestfs.pod:1577
3101 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3102 msgstr ""
3103
3104 # type: textblock
3105 #: ../src/guestfs.pod:1579
3106 msgid "If that named device exists, use it.  If not, continue."
3107 msgstr ""
3108
3109 # type: textblock
3110 #: ../src/guestfs.pod:1583
3111 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3112 msgstr ""
3113
3114 # type: textblock
3115 #: ../src/guestfs.pod:1585
3116 msgid "If that named device exists, use it.  If not, return an error."
3117 msgstr ""
3118
3119 # type: =head2
3120 #: ../src/guestfs.pod:1589
3121 msgid "PORTABILITY CONCERNS"
3122 msgstr ""
3123
3124 # type: textblock
3125 #: ../src/guestfs.pod:1591
3126 msgid ""
3127 "Although the standard naming scheme and automatic translation is useful for "
3128 "simple programs and guestfish scripts, for larger programs it is best not to "
3129 "rely on this mechanism."
3130 msgstr ""
3131
3132 # type: textblock
3133 #: ../src/guestfs.pod:1595
3134 msgid ""
3135 "Where possible for maximum future portability programs using libguestfs "
3136 "should use these future-proof techniques:"
3137 msgstr ""
3138
3139 # type: textblock
3140 #: ../src/guestfs.pod:1602
3141 msgid ""
3142 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3143 "device names, and then use those names directly."
3144 msgstr ""
3145
3146 # type: textblock
3147 #: ../src/guestfs.pod:1605
3148 msgid "Since those device names exist by definition, they will never be translated."
3149 msgstr ""
3150
3151 # type: textblock
3152 #: ../src/guestfs.pod:1610
3153 msgid ""
3154 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3155 "filesystem labels."
3156 msgstr ""
3157
3158 # type: =head1
3159 #: ../src/guestfs.pod:1615
3160 msgid "INTERNALS"
3161 msgstr ""
3162
3163 # type: =head2
3164 #: ../src/guestfs.pod:1617
3165 msgid "COMMUNICATION PROTOCOL"
3166 msgstr ""
3167
3168 # type: textblock
3169 #: ../src/guestfs.pod:1619
3170 msgid ""
3171 "Don't rely on using this protocol directly.  This section documents how it "
3172 "currently works, but it may change at any time."
3173 msgstr ""
3174
3175 # type: textblock
3176 #: ../src/guestfs.pod:1622
3177 msgid ""
3178 "The protocol used to talk between the library and the daemon running inside "
3179 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3180 "1014, RFC 1832, RFC 4506)."
3181 msgstr ""
3182
3183 # type: textblock
3184 #: ../src/guestfs.pod:1626
3185 msgid ""
3186 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3187 "this file is automatically generated)."
3188 msgstr ""
3189
3190 # type: textblock
3191 #: ../src/guestfs.pod:1629
3192 msgid ""
3193 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3194 "and C<FileOut> parameters, which are handled with very simple request/reply "
3195 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
3196 "parameters, which use the same request and reply messages, but they may also "
3197 "be followed by files sent using a chunked encoding."
3198 msgstr ""
3199
3200 # type: =head3
3201 #: ../src/guestfs.pod:1636
3202 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3203 msgstr ""
3204
3205 # type: textblock
3206 #: ../src/guestfs.pod:1638
3207 msgid "For ordinary functions, the request message is:"
3208 msgstr ""
3209
3210 # type: verbatim
3211 #: ../src/guestfs.pod:1640
3212 #, no-wrap
3213 msgid ""
3214 " total length (header + arguments,\n"
3215 "      but not including the length word itself)\n"
3216 " struct guestfs_message_header (encoded as XDR)\n"
3217 " struct guestfs_<foo>_args (encoded as XDR)\n"
3218 "\n"
3219 msgstr ""
3220
3221 # type: textblock
3222 #: ../src/guestfs.pod:1645
3223 msgid ""
3224 "The total length field allows the daemon to allocate a fixed size buffer "
3225 "into which it slurps the rest of the message.  As a result, the total length "
3226 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3227 "effective size of any request is limited to somewhere under this size."
3228 msgstr ""
3229
3230 # type: textblock
3231 #: ../src/guestfs.pod:1651
3232 msgid ""
3233 "Note also that many functions don't take any arguments, in which case the "
3234 "C<guestfs_I<foo>_args> is completely omitted."
3235 msgstr ""
3236
3237 # type: textblock
3238 #: ../src/guestfs.pod:1654
3239 msgid ""
3240 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3241 "receiver knows what type of args structure to expect, or none at all."
3242 msgstr ""
3243
3244 # type: textblock
3245 #: ../src/guestfs.pod:1658
3246 msgid "The reply message for ordinary functions is:"
3247 msgstr ""
3248
3249 # type: verbatim
3250 #: ../src/guestfs.pod:1660
3251 #, no-wrap
3252 msgid ""
3253 " total length (header + ret,\n"
3254 "      but not including the length word itself)\n"
3255 " struct guestfs_message_header (encoded as XDR)\n"
3256 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3257 "\n"
3258 msgstr ""
3259
3260 # type: textblock
3261 #: ../src/guestfs.pod:1665
3262 msgid ""
3263 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3264 "functions that return no formal return values."
3265 msgstr ""
3266
3267 # type: textblock
3268 #: ../src/guestfs.pod:1668
3269 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3270 msgstr ""
3271
3272 # type: textblock
3273 #: ../src/guestfs.pod:1671
3274 msgid ""
3275 "In the case of an error, a flag is set in the header, and the reply message "
3276 "is slightly changed:"
3277 msgstr ""
3278
3279 # type: verbatim
3280 #: ../src/guestfs.pod:1674
3281 #, no-wrap
3282 msgid ""
3283 " total length (header + error,\n"
3284 "      but not including the length word itself)\n"
3285 " struct guestfs_message_header (encoded as XDR)\n"
3286 " struct guestfs_message_error (encoded as XDR)\n"
3287 "\n"
3288 msgstr ""
3289
3290 # type: textblock
3291 #: ../src/guestfs.pod:1679
3292 msgid ""
3293 "The C<guestfs_message_error> structure contains the error message as a "
3294 "string."
3295 msgstr ""
3296
3297 # type: =head3
3298 #: ../src/guestfs.pod:1682
3299 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3300 msgstr ""
3301
3302 # type: textblock
3303 #: ../src/guestfs.pod:1684
3304 msgid ""
3305 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
3306 "The normal request message is sent (see above).  However this is followed by "
3307 "a sequence of file chunks."
3308 msgstr ""
3309
3310 # type: verbatim
3311 #: ../src/guestfs.pod:1688
3312 #, no-wrap
3313 msgid ""
3314 " total length (header + arguments,\n"
3315 "      but not including the length word itself,\n"
3316 "      and not including the chunks)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_args (encoded as XDR)\n"
3319 " sequence of chunks for FileIn param #0\n"
3320 " sequence of chunks for FileIn param #1 etc.\n"
3321 "\n"
3322 msgstr ""
3323
3324 # type: textblock
3325 #: ../src/guestfs.pod:1696
3326 msgid "The \"sequence of chunks\" is:"
3327 msgstr ""
3328
3329 # type: verbatim
3330 #: ../src/guestfs.pod:1698
3331 #, no-wrap
3332 msgid ""
3333 " length of chunk (not including length word itself)\n"
3334 " struct guestfs_chunk (encoded as XDR)\n"
3335 " length of chunk\n"
3336 " struct guestfs_chunk (encoded as XDR)\n"
3337 "   ...\n"
3338 " length of chunk\n"
3339 " struct guestfs_chunk (with data.data_len == 0)\n"
3340 "\n"
3341 msgstr ""
3342
3343 # type: textblock
3344 #: ../src/guestfs.pod:1706
3345 msgid ""
3346 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
3347 "is set in the final chunk to indicate either successful completion or early "
3348 "cancellation."
3349 msgstr ""
3350
3351 # type: textblock
3352 #: ../src/guestfs.pod:1710
3353 msgid ""
3354 "At time of writing there are no functions that have more than one FileIn "
3355 "parameter.  However this is (theoretically) supported, by sending the "
3356 "sequence of chunks for each FileIn parameter one after another (from left to "
3357 "right)."
3358 msgstr ""
3359
3360 # type: textblock
3361 #: ../src/guestfs.pod:1715
3362 msgid ""
3363 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3364 "transfer.  The library does this by sending a chunk with a special flag set "
3365 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
3366 "RPC, does I<not> send any reply, and goes back to reading the next request."
3367 msgstr ""
3368
3369 # type: textblock
3370 #: ../src/guestfs.pod:1721
3371 msgid ""
3372 "The daemon may also cancel.  It does this by writing a special word "
3373 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
3374 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3375 "cancel chunk).  The special word is chosen so that even if cancellation "
3376 "happens right at the end of the transfer (after the library has finished "
3377 "writing and has started listening for the reply), the \"spurious\" cancel "
3378 "flag will not be confused with the reply message."
3379 msgstr ""
3380
3381 # type: textblock
3382 #: ../src/guestfs.pod:1730
3383 msgid ""
3384 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3385 "limit), and also files where the size is not known in advance (eg. from "
3386 "pipes or sockets).  However the chunks are rather small "
3387 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3388 "to keep much in memory."
3389 msgstr ""
3390
3391 # type: =head3
3392 #: ../src/guestfs.pod:1736
3393 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3394 msgstr ""
3395
3396 # type: textblock
3397 #: ../src/guestfs.pod:1738
3398 msgid ""
3399 "The protocol for FileOut parameters is exactly the same as for FileIn "
3400 "parameters, but with the roles of daemon and library reversed."
3401 msgstr ""
3402
3403 # type: verbatim
3404 #: ../src/guestfs.pod:1741
3405 #, no-wrap
3406 msgid ""
3407 " total length (header + ret,\n"
3408 "      but not including the length word itself,\n"
3409 "      and not including the chunks)\n"
3410 " struct guestfs_message_header (encoded as XDR)\n"
3411 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3412 " sequence of chunks for FileOut param #0\n"
3413 " sequence of chunks for FileOut param #1 etc.\n"
3414 "\n"
3415 msgstr ""
3416
3417 # type: =head3
3418 #: ../src/guestfs.pod:1749
3419 msgid "INITIAL MESSAGE"
3420 msgstr ""
3421
3422 # type: textblock
3423 #: ../src/guestfs.pod:1751
3424 msgid ""
3425 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3426 "which indicates that the guest and daemon is alive.  This is what "
3427 "L</guestfs_launch> waits for."
3428 msgstr ""
3429
3430 # type: =head3
3431 #: ../src/guestfs.pod:1755
3432 msgid "PROGRESS NOTIFICATION MESSAGES"
3433 msgstr ""
3434
3435 # type: textblock
3436 #: ../src/guestfs.pod:1757
3437 msgid ""
3438 "The daemon may send progress notification messages at any time.  These are "
3439 "distinguished by the normal length word being replaced by "
3440 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3441 msgstr ""
3442
3443 # type: textblock
3444 #: ../src/guestfs.pod:1761
3445 msgid ""
3446 "The library turns them into progress callbacks (see "
3447 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3448 "discards them if not."
3449 msgstr ""
3450
3451 # type: textblock
3452 #: ../src/guestfs.pod:1765
3453 msgid ""
3454 "The daemon self-limits the frequency of progress messages it sends (see "
3455 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
3456 "messages."
3457 msgstr ""
3458
3459 # type: =head1
3460 #: ../src/guestfs.pod:1769
3461 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3462 msgstr ""
3463
3464 # type: textblock
3465 #: ../src/guestfs.pod:1771
3466 msgid ""
3467 "All high-level libguestfs actions are synchronous.  If you want to use "
3468 "libguestfs asynchronously then you must create a thread."
3469 msgstr ""
3470
3471 # type: textblock
3472 #: ../src/guestfs.pod:1774
3473 msgid ""
3474 "Only use the handle from a single thread.  Either use the handle exclusively "
3475 "from one thread, or provide your own mutex so that two threads cannot issue "
3476 "calls on the same handle at the same time."
3477 msgstr ""
3478
3479 # type: textblock
3480 #: ../src/guestfs.pod:1778
3481 msgid ""
3482 "See the graphical program guestfs-browser for one possible architecture for "
3483 "multithreaded programs using libvirt and libguestfs."
3484 msgstr ""
3485
3486 # type: =head1
3487 #: ../src/guestfs.pod:1781
3488 msgid "QEMU WRAPPERS"
3489 msgstr ""
3490
3491 # type: textblock
3492 #: ../src/guestfs.pod:1783
3493 msgid ""
3494 "If you want to compile your own qemu, run qemu from a non-standard location, "
3495 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3496 "around qemu."
3497 msgstr ""
3498
3499 # type: textblock
3500 #: ../src/guestfs.pod:1787
3501 msgid ""
3502 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3503 "last command in the shell script (so that qemu replaces the shell and "
3504 "becomes the direct child of the libguestfs-using program).  If you don't do "
3505 "this, then the qemu process won't be cleaned up correctly."
3506 msgstr ""
3507
3508 # type: textblock
3509 #: ../src/guestfs.pod:1792
3510 msgid ""
3511 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3512 "source:"
3513 msgstr ""
3514
3515 # type: verbatim
3516 #: ../src/guestfs.pod:1795
3517 #, no-wrap
3518 msgid ""
3519 " #!/bin/sh -\n"
3520 " qemudir=/home/rjones/d/qemu\n"
3521 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
3522 "\"$@\"\n"
3523 "\n"
3524 msgstr ""
3525
3526 # type: textblock
3527 #: ../src/guestfs.pod:1799
3528 msgid ""
3529 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3530 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
3531 "example:"
3532 msgstr ""
3533
3534 # type: verbatim
3535 #: ../src/guestfs.pod:1803
3536 #, no-wrap
3537 msgid ""
3538 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3539 "\n"
3540 msgstr ""
3541
3542 # type: textblock
3543 #: ../src/guestfs.pod:1805
3544 msgid ""
3545 "Note that libguestfs also calls qemu with the -help and -version options in "
3546 "order to determine features."
3547 msgstr ""
3548
3549 # type: =head1
3550 #: ../src/guestfs.pod:1808
3551 msgid "LIBGUESTFS VERSION NUMBERS"
3552 msgstr ""
3553
3554 # type: textblock
3555 #: ../src/guestfs.pod:1810
3556 msgid ""
3557 "Since April 2010, libguestfs has started to make separate development and "
3558 "stable releases, along with corresponding branches in our git repository.  "
3559 "These separate releases can be identified by version number:"
3560 msgstr ""
3561
3562 # type: verbatim
3563 #: ../src/guestfs.pod:1815
3564 #, no-wrap
3565 msgid ""
3566 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
3567 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3568 "       |\n"
3569 "       v\n"
3570 " 1  .  3  .  5\n"
3571 " ^           ^\n"
3572 " |           |\n"
3573 " |           `-------- sub-version\n"
3574 " |\n"
3575 " `------ always '1' because we don't change the ABI\n"
3576 "\n"
3577 msgstr ""
3578
3579 # type: textblock
3580 #: ../src/guestfs.pod:1826
3581 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3582 msgstr ""
3583
3584 # type: textblock
3585 #: ../src/guestfs.pod:1828
3586 msgid ""
3587 "As time passes we cherry pick fixes from the development branch and backport "
3588 "those into the stable branch, the effect being that the stable branch should "
3589 "get more stable and less buggy over time.  So the stable releases are ideal "
3590 "for people who don't need new features but would just like the software to "
3591 "work."
3592 msgstr ""
3593
3594 # type: textblock
3595 #: ../src/guestfs.pod:1834
3596 msgid "Our criteria for backporting changes are:"
3597 msgstr ""
3598
3599 # type: textblock
3600 #: ../src/guestfs.pod:1840
3601 msgid ""
3602 "Documentation changes which don't affect any code are backported unless the "
3603 "documentation refers to a future feature which is not in stable."
3604 msgstr ""
3605
3606 # type: textblock
3607 #: ../src/guestfs.pod:1846
3608 msgid ""
3609 "Bug fixes which are not controversial, fix obvious problems, and have been "
3610 "well tested are backported."
3611 msgstr ""
3612
3613 # type: textblock
3614 #: ../src/guestfs.pod:1851
3615 msgid ""
3616 "Simple rearrangements of code which shouldn't affect how it works get "
3617 "backported.  This is so that the code in the two branches doesn't get too "
3618 "far out of step, allowing us to backport future fixes more easily."
3619 msgstr ""
3620
3621 # type: textblock
3622 #: ../src/guestfs.pod:1857
3623 msgid ""
3624 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3625 "exceptional case: the new feature is required in order to implement an "
3626 "important bug fix."
3627 msgstr ""
3628
3629 # type: textblock
3630 #: ../src/guestfs.pod:1863
3631 msgid ""
3632 "A new stable branch starts when we think the new features in development are "
3633 "substantial and compelling enough over the current stable branch to warrant "
3634 "it.  When that happens we create new stable and development versions 1.N.0 "
3635 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
3636 "stable at this point, but by backporting fixes from development, that branch "
3637 "will stabilize over time."
3638 msgstr ""
3639
3640 # type: =head1
3641 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:914 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3642 msgid "ENVIRONMENT VARIABLES"
3643 msgstr ""
3644
3645 # type: =item
3646 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:940
3647 msgid "LIBGUESTFS_APPEND"
3648 msgstr ""
3649
3650 # type: textblock
3651 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:942
3652 msgid "Pass additional options to the guest kernel."
3653 msgstr ""
3654
3655 # type: =item
3656 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:944
3657 msgid "LIBGUESTFS_DEBUG"
3658 msgstr ""
3659
3660 # type: textblock
3661 #: ../src/guestfs.pod:1881
3662 msgid ""
3663 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
3664 "effect as calling C<guestfs_set_verbose (g, 1)>."
3665 msgstr ""
3666
3667 # type: =item
3668 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:949
3669 msgid "LIBGUESTFS_MEMSIZE"
3670 msgstr ""
3671
3672 # type: textblock
3673 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:951
3674 msgid "Set the memory allocated to the qemu process, in megabytes.  For example:"
3675 msgstr ""
3676
3677 # type: verbatim
3678 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:954
3679 #, no-wrap
3680 msgid ""
3681 " LIBGUESTFS_MEMSIZE=700\n"
3682 "\n"
3683 msgstr ""
3684
3685 # type: =item
3686 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:956
3687 msgid "LIBGUESTFS_PATH"
3688 msgstr ""
3689
3690 # type: textblock
3691 #: ../src/guestfs.pod:1893
3692 msgid ""
3693 "Set the path that libguestfs uses to search for kernel and initrd.img.  See "
3694 "the discussion of paths in section PATH above."
3695 msgstr ""
3696
3697 # type: =item
3698 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:961
3699 msgid "LIBGUESTFS_QEMU"
3700 msgstr ""
3701
3702 # type: textblock
3703 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:963
3704 msgid ""
3705 "Set the default qemu binary that libguestfs uses.  If not set, then the qemu "
3706 "which was found at compile time by the configure script is used."
3707 msgstr ""
3708
3709 # type: textblock
3710 #: ../src/guestfs.pod:1902
3711 msgid "See also L</QEMU WRAPPERS> above."
3712 msgstr ""
3713
3714 # type: =item
3715 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:967
3716 msgid "LIBGUESTFS_TRACE"
3717 msgstr ""
3718
3719 # type: textblock
3720 #: ../src/guestfs.pod:1906
3721 msgid ""
3722 "Set C<LIBGUESTFS_TRACE=1> to enable command traces.  This has the same "
3723 "effect as calling C<guestfs_set_trace (g, 1)>."
3724 msgstr ""
3725
3726 # type: =item
3727 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:976
3728 msgid "TMPDIR"
3729 msgstr ""
3730
3731 # type: textblock
3732 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:978
3733 msgid "Location of temporary directory, defaults to C</tmp>."
3734 msgstr ""
3735
3736 # type: textblock
3737 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:980
3738 msgid ""
3739 "If libguestfs was compiled to use the supermin appliance then the real "
3740 "appliance is cached in this directory, shared between all handles belonging "
3741 "to the same EUID.  You can use C<$TMPDIR> to configure another directory to "
3742 "use in case C</tmp> is not large enough."
3743 msgstr ""
3744
3745 # type: =head1
3746 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod:1038 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../inspector/virt-inspector.pl:570 ../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
3747 msgid "SEE ALSO"
3748 msgstr ""
3749
3750 # type: textblock
3751 #: ../src/guestfs.pod:1923
3752 msgid ""
3753 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
3754 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
3755 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
3756 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
3757 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
3758 msgstr ""
3759
3760 # type: textblock
3761 #: ../src/guestfs.pod:1941
3762 msgid ""
3763 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
3764 "L<lvm(8)>, L<disktype(1)>."
3765 msgstr ""
3766
3767 # type: =head1
3768 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
3769 msgid "BUGS"
3770 msgstr ""
3771
3772 # type: textblock
3773 #: ../src/guestfs.pod:1950
3774 msgid "To get a list of bugs against libguestfs use this link:"
3775 msgstr ""
3776
3777 # type: textblock
3778 #: ../src/guestfs.pod:1952
3779 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
3780 msgstr ""
3781
3782 # type: textblock
3783 #: ../src/guestfs.pod:1954
3784 msgid "To report a new bug against libguestfs use this link:"
3785 msgstr ""
3786
3787 # type: textblock
3788 #: ../src/guestfs.pod:1956
3789 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
3790 msgstr ""
3791
3792 # type: textblock
3793 #: ../src/guestfs.pod:1958
3794 msgid "When reporting a bug, please check:"
3795 msgstr ""
3796
3797 # type: textblock
3798 #: ../src/guestfs.pod:1964
3799 msgid "That the bug hasn't been reported already."
3800 msgstr ""
3801
3802 # type: textblock
3803 #: ../src/guestfs.pod:1968
3804 msgid "That you are testing a recent version."
3805 msgstr ""
3806
3807 # type: textblock
3808 #: ../src/guestfs.pod:1972
3809 msgid "Describe the bug accurately, and give a way to reproduce it."
3810 msgstr ""
3811
3812 # type: textblock
3813 #: ../src/guestfs.pod:1976
3814 msgid ""
3815 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3816 "bug report."
3817 msgstr ""
3818
3819 # type: =head1
3820 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1055 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:580
3821 msgid "AUTHORS"
3822 msgstr ""
3823
3824 # type: textblock
3825 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1057 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
3826 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3827 msgstr ""
3828
3829 # type: =head1
3830 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1059 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../inspector/virt-inspector.pl:594 ../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
3831 msgid "COPYRIGHT"
3832 msgstr ""
3833
3834 # type: textblock
3835 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1061 ../fuse/guestmount.pod:250
3836 msgid "Copyright (C) 2009-2010 Red Hat Inc.  L<http://libguestfs.org/>"
3837 msgstr ""
3838
3839 # type: textblock
3840 #: ../src/guestfs.pod:1990
3841 msgid ""
3842 "This library is free software; you can redistribute it and/or modify it "
3843 "under the terms of the GNU Lesser General Public License as published by the "
3844 "Free Software Foundation; either version 2 of the License, or (at your "
3845 "option) any later version."
3846 msgstr ""
3847
3848 # type: textblock
3849 #: ../src/guestfs.pod:1995
3850 msgid ""
3851 "This library is distributed in the hope that it will be useful, but WITHOUT &