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