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