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