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