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