Version 1.11.3.
[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-22 22:23+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:1087
858 #: ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100
859 #: ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135
860 #: ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165
861 #: ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177
862 #: ../src/guestfs.pod:1659 ../src/guestfs.pod:1664 ../src/guestfs.pod:1668
863 #: ../src/guestfs.pod:1769 ../src/guestfs.pod:1774 ../src/guestfs.pod:1778
864 #: ../src/guestfs.pod:1788 ../src/guestfs.pod:2022 ../src/guestfs.pod:2027
865 #: ../src/guestfs.pod:2033 ../src/guestfs.pod:2041 ../src/guestfs.pod:2395
866 #: ../src/guestfs.pod:2401 ../src/guestfs.pod:2406 ../src/guestfs.pod:2412
867 #: ../src/guestfs.pod:2877 ../src/guestfs.pod:2881 ../src/guestfs.pod:2885
868 #: ../src/guestfs.pod:2889 ../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:1280 ../src/guestfs.pod:1411
1025 #: ../src/guestfs.pod:2440
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:1284 ../src/guestfs.pod:1415
1044 #: ../src/guestfs.pod:2465
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:1421
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 can be found using inspection (see L</INSPECTION> and "
1367 "L</guestfs_inspect_get_drive_mappings>)"
1368 msgstr ""
1369
1370 #. type: textblock
1371 #: ../src/guestfs.pod:647
1372 msgid ""
1373 "Dealing with separator characters (backslash vs forward slash) is outside "
1374 "the scope of libguestfs, but usually a simple character replacement will "
1375 "work."
1376 msgstr ""
1377
1378 #. type: textblock
1379 #: ../src/guestfs.pod:651
1380 msgid ""
1381 "To resolve the case insensitivity of paths, call L</"
1382 "guestfs_case_sensitive_path>."
1383 msgstr ""
1384
1385 #. type: =head3
1386 #: ../src/guestfs.pod:654
1387 msgid "ACCESSING THE WINDOWS REGISTRY"
1388 msgstr ""
1389
1390 #. type: textblock
1391 #: ../src/guestfs.pod:656
1392 msgid ""
1393 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1394 "files, through the library C<hivex> which is part of the libguestfs project "
1395 "although ships as a separate tarball.  You have to locate and download the "
1396 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
1397 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1398 "reg(1)> for more help on this issue."
1399 msgstr ""
1400
1401 #. type: =head3
1402 #: ../src/guestfs.pod:664
1403 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1404 msgstr ""
1405
1406 #. type: textblock
1407 #: ../src/guestfs.pod:666
1408 msgid ""
1409 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1410 "provide something which looks like a Linux symlink.  The way it tries to do "
1411 "the rewriting is described here:"
1412 msgstr ""
1413
1414 #. type: textblock
1415 #: ../src/guestfs.pod:670
1416 msgid ""
1417 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1418 "symbolic-links/>"
1419 msgstr ""
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1421 "symbolic-links/>"
1422
1423 #. type: textblock
1424 #: ../src/guestfs.pod:672
1425 msgid ""
1426 "The essential problem is that ntfs-3g simply does not have enough "
1427 "information to do a correct job.  NTFS links can contain drive letters and "
1428 "references to external device GUIDs that ntfs-3g has no way of resolving.  "
1429 "It is almost certainly the case that libguestfs callers should ignore what "
1430 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1431 msgstr ""
1432
1433 #. type: textblock
1434 #: ../src/guestfs.pod:679
1435 msgid ""
1436 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1437 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1438 "attribute, and read the raw reparse data from that (you can find the format "
1439 "documented in various places around the web)."
1440 msgstr ""
1441
1442 #. type: =head3
1443 #: ../src/guestfs.pod:684
1444 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1445 msgstr ""
1446
1447 #. type: textblock
1448 #: ../src/guestfs.pod:686
1449 msgid ""
1450 "There are other useful extended attributes that can be read from ntfs-3g "
1451 "filesystems (using L</guestfs_getxattr>).  See:"
1452 msgstr ""
1453
1454 #. type: textblock
1455 #: ../src/guestfs.pod:689
1456 msgid ""
1457 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1458 msgstr ""
1459 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1460
1461 #. type: =head2
1462 #: ../src/guestfs.pod:691
1463 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1464 msgstr ""
1465
1466 #. type: textblock
1467 #: ../src/guestfs.pod:693
1468 msgid ""
1469 "Although we don't want to discourage you from using the C API, we will "
1470 "mention here that the same API is also available in other languages."
1471 msgstr ""
1472
1473 #. type: textblock
1474 #: ../src/guestfs.pod:696
1475 msgid ""
1476 "The API is broadly identical in all supported languages.  This means that "
1477 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1478 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1479 "OCaml.  In other words, a straightforward, predictable isomorphism between "
1480 "each language."
1481 msgstr ""
1482
1483 #. type: textblock
1484 #: ../src/guestfs.pod:702
1485 msgid ""
1486 "Error messages are automatically transformed into exceptions if the language "
1487 "supports it."
1488 msgstr ""
1489
1490 #. type: textblock
1491 #: ../src/guestfs.pod:705
1492 msgid ""
1493 "We don't try to \"object orientify\" parts of the API in OO languages, "
1494 "although contributors are welcome to write higher level APIs above what we "
1495 "provide in their favourite languages if they wish."
1496 msgstr ""
1497
1498 #. type: =item
1499 #: ../src/guestfs.pod:711
1500 msgid "B<C++>"
1501 msgstr "B<C++>"
1502
1503 #. type: textblock
1504 #: ../src/guestfs.pod:713
1505 msgid ""
1506 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
1507 "identical to the C API.  C++ classes and exceptions are not used."
1508 msgstr ""
1509
1510 #. type: =item
1511 #: ../src/guestfs.pod:717
1512 msgid "B<C#>"
1513 msgstr "B<C#>"
1514
1515 #. type: textblock
1516 #: ../src/guestfs.pod:719
1517 msgid ""
1518 "The C# bindings are highly experimental.  Please read the warnings at the "
1519 "top of C<csharp/Libguestfs.cs>."
1520 msgstr ""
1521
1522 #. type: =item
1523 #: ../src/guestfs.pod:722
1524 msgid "B<Haskell>"
1525 msgstr "B<Haskell>"
1526
1527 #. type: textblock
1528 #: ../src/guestfs.pod:724
1529 msgid ""
1530 "This is the only language binding that is working but incomplete.  Only "
1531 "calls which return simple integers have been bound in Haskell, and we are "
1532 "looking for help to complete this binding."
1533 msgstr ""
1534
1535 #. type: =item
1536 #: ../src/guestfs.pod:728
1537 msgid "B<Java>"
1538 msgstr "B<Java>"
1539
1540 #. type: textblock
1541 #: ../src/guestfs.pod:730
1542 msgid ""
1543 "Full documentation is contained in the Javadoc which is distributed with "
1544 "libguestfs."
1545 msgstr ""
1546
1547 #. type: =item
1548 #: ../src/guestfs.pod:733
1549 msgid "B<OCaml>"
1550 msgstr "B<OCaml>"
1551
1552 #. type: textblock
1553 #: ../src/guestfs.pod:735
1554 msgid "See L<guestfs-ocaml(3)>."
1555 msgstr "Див. L<guestfs-ocaml(3)>."
1556
1557 #. type: =item
1558 #: ../src/guestfs.pod:737
1559 msgid "B<Perl>"
1560 msgstr "B<Perl>"
1561
1562 #. type: textblock
1563 #: ../src/guestfs.pod:739
1564 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1565 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1566
1567 #. type: =item
1568 #: ../src/guestfs.pod:741
1569 msgid "B<PHP>"
1570 msgstr "B<PHP>"
1571
1572 #. type: textblock
1573 #: ../src/guestfs.pod:743
1574 msgid ""
1575 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1576 "the php-libguestfs package for your distribution."
1577 msgstr ""
1578
1579 #. type: textblock
1580 #: ../src/guestfs.pod:746
1581 msgid "The PHP binding only works correctly on 64 bit machines."
1582 msgstr ""
1583
1584 #. type: =item
1585 #: ../src/guestfs.pod:748
1586 msgid "B<Python>"
1587 msgstr "B<Python>"
1588
1589 #. type: textblock
1590 #: ../src/guestfs.pod:750
1591 msgid "See L<guestfs-python(3)>."
1592 msgstr "Див. L<guestfs-python(3)>."
1593
1594 #. type: =item
1595 #: ../src/guestfs.pod:752
1596 msgid "B<Ruby>"
1597 msgstr "B<Ruby>"
1598
1599 #. type: textblock
1600 #: ../src/guestfs.pod:754
1601 msgid "See L<guestfs-ruby(3)>."
1602 msgstr "Див. L<guestfs-ruby(3)>."
1603
1604 #. type: =item
1605 #: ../src/guestfs.pod:756
1606 msgid "B<shell scripts>"
1607 msgstr "B<скрипти оболонки>"
1608
1609 #. type: textblock
1610 #: ../src/guestfs.pod:758
1611 msgid "See L<guestfish(1)>."
1612 msgstr "Див. L<guestfish(1)>."
1613
1614 #. type: =head2
1615 #: ../src/guestfs.pod:762
1616 msgid "LIBGUESTFS GOTCHAS"
1617 msgstr ""
1618
1619 #. type: textblock
1620 #: ../src/guestfs.pod:764
1621 msgid ""
1622 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1623 "system [...] that works in the way it is documented but is counterintuitive "
1624 "and almost invites mistakes.\""
1625 msgstr ""
1626
1627 #. type: textblock
1628 #: ../src/guestfs.pod:768
1629 msgid ""
1630 "Since we developed libguestfs and the associated tools, there are several "
1631 "things we would have designed differently, but are now stuck with for "
1632 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
1633 "release, you can expect these to change.  Beware of them."
1634 msgstr ""
1635
1636 #. type: =item
1637 #: ../src/guestfs.pod:776
1638 msgid "Autosync / forgetting to sync."
1639 msgstr ""
1640
1641 #. type: textblock
1642 #: ../src/guestfs.pod:778
1643 msgid ""
1644 "When modifying a filesystem from C or another language, you B<must> unmount "
1645 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1646 "libguestfs handle.  You can also call:"
1647 msgstr ""
1648
1649 #. type: verbatim
1650 #: ../src/guestfs.pod:782
1651 #, no-wrap
1652 msgid ""
1653 " guestfs_set_autosync (g, 1);\n"
1654 "\n"
1655 msgstr ""
1656
1657 #. type: textblock
1658 #: ../src/guestfs.pod:784
1659 msgid ""
1660 "to have the unmount/sync done automatically for you when the handle 'g' is "
1661 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1662 msgstr ""
1663
1664 #. type: textblock
1665 #: ../src/guestfs.pod:788
1666 msgid ""
1667 "If you forget to do this, then it is entirely possible that your changes "
1668 "won't be written out, or will be partially written, or (very rarely) that "
1669 "you'll get disk corruption."
1670 msgstr ""
1671
1672 #. type: textblock
1673 #: ../src/guestfs.pod:792
1674 msgid ""
1675 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
1676 "guestfish scripts that forget to sync will work just fine, which can make "
1677 "this very puzzling if you are trying to debug a problem."
1678 msgstr ""
1679
1680 #. type: textblock
1681 #: ../src/guestfs.pod:796
1682 msgid ""
1683 "Update: Autosync is enabled by default for all API users starting from "
1684 "libguestfs 1.5.24."
1685 msgstr ""
1686
1687 #. type: =item
1688 #: ../src/guestfs.pod:799
1689 msgid "Mount option C<-o sync> should not be the default."
1690 msgstr ""
1691
1692 #. type: textblock
1693 #: ../src/guestfs.pod:801
1694 msgid ""
1695 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
1696 "However C<-o sync> does not add any reliability benefit, but does have a "
1697 "very large performance impact."
1698 msgstr ""
1699
1700 #. type: textblock
1701 #: ../src/guestfs.pod:805
1702 msgid ""
1703 "The work around is to use L</guestfs_mount_options> and set the mount "
1704 "options that you actually want to use."
1705 msgstr ""
1706
1707 #. type: =item
1708 #: ../src/guestfs.pod:808
1709 msgid "Read-only should be the default."
1710 msgstr ""
1711
1712 #. type: textblock
1713 #: ../src/guestfs.pod:810
1714 msgid ""
1715 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1716 "specify I<--rw> if you want to make changes to the image."
1717 msgstr ""
1718
1719 #. type: textblock
1720 #: ../src/guestfs.pod:813
1721 msgid "This would reduce the potential to corrupt live VM images."
1722 msgstr ""
1723
1724 #. type: textblock
1725 #: ../src/guestfs.pod:815
1726 msgid ""
1727 "Note that many filesystems change the disk when you just mount and unmount, "
1728 "even if you didn't perform any writes.  You need to use L</"
1729 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1730 msgstr ""
1731
1732 #. type: =item
1733 #: ../src/guestfs.pod:819
1734 msgid "guestfish command line is hard to use."
1735 msgstr ""
1736
1737 #. type: textblock
1738 #: ../src/guestfs.pod:821
1739 msgid ""
1740 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1741 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
1742 "exist, so it fails.  In earlier versions of guestfish the error message was "
1743 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
1744 "we should have used C<guestfish -c command> to run commands."
1745 msgstr ""
1746
1747 #. type: =item
1748 #: ../src/guestfs.pod:828
1749 msgid "guestfish megabyte modifiers don't work right on all commands"
1750 msgstr ""
1751
1752 #. type: textblock
1753 #: ../src/guestfs.pod:830
1754 msgid ""
1755 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1756 "other modifiers).  What guestfish actually does is to multiply the number "
1757 "part by the modifier part and pass the result to the C API.  However this "
1758 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1759 "expecting some other unit (eg. megabytes)."
1760 msgstr ""
1761
1762 #. type: textblock
1763 #: ../src/guestfs.pod:837
1764 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
1765 msgstr ""
1766
1767 #. type: verbatim
1768 #: ../src/guestfs.pod:839
1769 #, no-wrap
1770 msgid ""
1771 " lvcreate LV VG 100M\n"
1772 "\n"
1773 msgstr ""
1774
1775 #. type: textblock
1776 #: ../src/guestfs.pod:841
1777 msgid ""
1778 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
1779 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1780 "megabytes * megabytes) logical volume.  The error message you get from this "
1781 "is also a little obscure."
1782 msgstr ""
1783
1784 #. type: textblock
1785 #: ../src/guestfs.pod:846
1786 msgid ""
1787 "This could be fixed in the generator by specially marking parameters and "
1788 "return values which take bytes or other units."
1789 msgstr ""
1790
1791 #. type: =item
1792 #: ../src/guestfs.pod:849
1793 msgid "Ambiguity between devices and paths"
1794 msgstr ""
1795
1796 #. type: textblock
1797 #: ../src/guestfs.pod:851
1798 msgid ""
1799 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1800 "sdb2>) and a similar pathname.  A file might just happen to be called "
1801 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1802 msgstr ""
1803
1804 #. type: textblock
1805 #: ../src/guestfs.pod:856
1806 msgid ""
1807 "In the current API we usually resolve this ambiguity by having two separate "
1808 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
1809 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1810 "detecting if the path supplied begins with C</dev/>."
1811 msgstr ""
1812
1813 #. type: textblock
1814 #: ../src/guestfs.pod:862
1815 msgid ""
1816 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1817 "make paths/devices into structured names.  One way to do this would be to "
1818 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1819 "aspect of grub.  Another way would be to use a structured type, equivalent "
1820 "to this OCaml type:"
1821 msgstr ""
1822
1823 #. type: verbatim
1824 #: ../src/guestfs.pod:868
1825 #, no-wrap
1826 msgid ""
1827 " type path = Path of string | Device of int | Partition of int * int\n"
1828 "\n"
1829 msgstr ""
1830
1831 #. type: textblock
1832 #: ../src/guestfs.pod:870
1833 msgid "which would allow you to pass arguments like:"
1834 msgstr ""
1835
1836 #. type: verbatim
1837 #: ../src/guestfs.pod:872
1838 #, no-wrap
1839 msgid ""
1840 " Path \"/foo/bar\"\n"
1841 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
1842 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1843 " Path \"/dev/sdb2\"    (* not a device *)\n"
1844 "\n"
1845 msgstr ""
1846
1847 #. type: textblock
1848 #: ../src/guestfs.pod:877
1849 msgid ""
1850 "As you can see there are still problems to resolve even with this "
1851 "representation.  Also consider how it might work in guestfish."
1852 msgstr ""
1853
1854 #. type: =head2
1855 #: ../src/guestfs.pod:882
1856 msgid "PROTOCOL LIMITS"
1857 msgstr ""
1858
1859 #. type: textblock
1860 #: ../src/guestfs.pod:884
1861 msgid ""
1862 "Internally libguestfs uses a message-based protocol to pass API calls and "
1863 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1864 "plenty more detail about this).  The maximum message size used by the "
1865 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
1866 "aware of this limit.  The API calls which may be affected are individually "
1867 "documented, with a link back to this section of the documentation."
1868 msgstr ""
1869
1870 #. type: textblock
1871 #: ../src/guestfs.pod:892
1872 msgid ""
1873 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1874 "a simple string.  Because this string is at some point internally encoded as "
1875 "a message, the maximum size that it can return is slightly under 4 MB.  If "
1876 "the requested file is larger than this then you will get an error."
1877 msgstr ""
1878
1879 #. type: textblock
1880 #: ../src/guestfs.pod:898
1881 msgid ""
1882 "In order to transfer large files into and out of the guest filesystem, you "
1883 "need to use particular calls that support this.  The sections L</UPLOADING> "
1884 "and L</DOWNLOADING> document how to do this."
1885 msgstr ""
1886
1887 #. type: textblock
1888 #: ../src/guestfs.pod:902
1889 msgid ""
1890 "You might also consider mounting the disk image using our FUSE filesystem "
1891 "support (L<guestmount(1)>)."
1892 msgstr ""
1893
1894 #. type: =head2
1895 #: ../src/guestfs.pod:905
1896 msgid "KEYS AND PASSPHRASES"
1897 msgstr ""
1898
1899 #. type: textblock
1900 #: ../src/guestfs.pod:907
1901 msgid ""
1902 "Certain libguestfs calls take a parameter that contains sensitive key "
1903 "material, passed in as a C string."
1904 msgstr ""
1905
1906 #. type: textblock
1907 #: ../src/guestfs.pod:910
1908 msgid ""
1909 "In the future we would hope to change the libguestfs implementation so that "
1910 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1911 "swap.  However this is I<not> done at the moment, because of the complexity "
1912 "of such an implementation."
1913 msgstr ""
1914
1915 #. type: textblock
1916 #: ../src/guestfs.pod:915
1917 msgid ""
1918 "Therefore you should be aware that any key parameter you pass to libguestfs "
1919 "might end up being written out to the swap partition.  If this is a concern, "
1920 "scrub the swap partition or don't use libguestfs on encrypted devices."
1921 msgstr ""
1922
1923 #. type: =head2
1924 #: ../src/guestfs.pod:920
1925 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1926 msgstr ""
1927
1928 #. type: textblock
1929 #: ../src/guestfs.pod:922
1930 msgid ""
1931 "All high-level libguestfs actions are synchronous.  If you want to use "
1932 "libguestfs asynchronously then you must create a thread."
1933 msgstr ""
1934
1935 #. type: textblock
1936 #: ../src/guestfs.pod:925
1937 msgid ""
1938 "Only use the handle from a single thread.  Either use the handle exclusively "
1939 "from one thread, or provide your own mutex so that two threads cannot issue "
1940 "calls on the same handle at the same time."
1941 msgstr ""
1942
1943 #. type: textblock
1944 #: ../src/guestfs.pod:929
1945 msgid ""
1946 "See the graphical program guestfs-browser for one possible architecture for "
1947 "multithreaded programs using libvirt and libguestfs."
1948 msgstr ""
1949
1950 #. type: =head2
1951 #: ../src/guestfs.pod:932
1952 msgid "PATH"
1953 msgstr "ШЛЯХ"
1954
1955 #. type: textblock
1956 #: ../src/guestfs.pod:934
1957 msgid ""
1958 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1959 "internal path."
1960 msgstr ""
1961
1962 #. type: textblock
1963 #: ../src/guestfs.pod:937
1964 msgid ""
1965 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1966 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1967 msgstr ""
1968
1969 #. type: textblock
1970 #: ../src/guestfs.pod:940
1971 msgid ""
1972 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1973 "to change the directories that libguestfs will search in.  The value is a "
1974 "colon-separated list of paths.  The current directory is I<not> searched "
1975 "unless the path contains an empty element or C<.>.  For example "
1976 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1977 "then C</usr/lib/guestfs>."
1978 msgstr ""
1979
1980 #. type: =head2
1981 #: ../src/guestfs.pod:947
1982 msgid "QEMU WRAPPERS"
1983 msgstr ""
1984
1985 #. type: textblock
1986 #: ../src/guestfs.pod:949
1987 msgid ""
1988 "If you want to compile your own qemu, run qemu from a non-standard location, "
1989 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1990 "around qemu."
1991 msgstr ""
1992
1993 #. type: textblock
1994 #: ../src/guestfs.pod:953
1995 msgid ""
1996 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1997 "last command in the shell script (so that qemu replaces the shell and "
1998 "becomes the direct child of the libguestfs-using program).  If you don't do "
1999 "this, then the qemu process won't be cleaned up correctly."
2000 msgstr ""
2001
2002 #. type: textblock
2003 #: ../src/guestfs.pod:958
2004 msgid ""
2005 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2006 "source:"
2007 msgstr ""
2008
2009 #. type: verbatim
2010 #: ../src/guestfs.pod:961
2011 #, no-wrap
2012 msgid ""
2013 " #!/bin/sh -\n"
2014 " qemudir=/home/rjones/d/qemu\n"
2015 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2016 "\n"
2017 msgstr ""
2018
2019 #. type: textblock
2020 #: ../src/guestfs.pod:965
2021 msgid ""
2022 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2023 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
2024 "example:"
2025 msgstr ""
2026
2027 #. type: verbatim
2028 #: ../src/guestfs.pod:969
2029 #, no-wrap
2030 msgid ""
2031 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2032 "\n"
2033 msgstr ""
2034
2035 #. type: textblock
2036 #: ../src/guestfs.pod:971
2037 msgid ""
2038 "Note that libguestfs also calls qemu with the -help and -version options in "
2039 "order to determine features."
2040 msgstr ""
2041
2042 #. type: =head2
2043 #: ../src/guestfs.pod:974
2044 msgid "ATTACHING TO RUNNING DAEMONS"
2045 msgstr ""
2046
2047 #. type: textblock
2048 #: ../src/guestfs.pod:976
2049 msgid ""
2050 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2051 "babies.  Use with caution."
2052 msgstr ""
2053
2054 #. type: textblock
2055 #: ../src/guestfs.pod:979
2056 msgid ""
2057 "I<Note (2):> This section explains how to attach to a running daemon from a "
2058 "low level perspective.  For most users, simply using virt tools such as "
2059 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2060 msgstr ""
2061
2062 #. type: =head3
2063 #: ../src/guestfs.pod:983
2064 msgid "Using guestfs_set_attach_method"
2065 msgstr ""
2066
2067 #. type: textblock
2068 #: ../src/guestfs.pod:985
2069 msgid ""
2070 "By calling L</guestfs_set_attach_method> you can change how the library "
2071 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2072 "ARCHITECTURE> for some background)."
2073 msgstr ""
2074
2075 #. type: textblock
2076 #: ../src/guestfs.pod:989
2077 msgid ""
2078 "The normal attach method is C<appliance>, where a small appliance is created "
2079 "containing the daemon, and then the library connects to this."
2080 msgstr ""
2081
2082 #. type: textblock
2083 #: ../src/guestfs.pod:992
2084 msgid ""
2085 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2086 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2087 "daemon over the Unix domain socket."
2088 msgstr ""
2089
2090 #. type: textblock
2091 #: ../src/guestfs.pod:996
2092 msgid ""
2093 "The normal use for this is to connect to a running virtual machine that "
2094 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2095 "files inside the live virtual machine."
2096 msgstr ""
2097
2098 #. type: =head3
2099 #: ../src/guestfs.pod:1000
2100 msgid "Using guestfs_add_domain with live flag"
2101 msgstr ""
2102
2103 #. type: textblock
2104 #: ../src/guestfs.pod:1002
2105 msgid ""
2106 "L</guestfs_add_domain> provides some help for getting the correct attach "
2107 "method.  If you pass the C<live> option to this function, then (if the "
2108 "virtual machine is running) it will examine the libvirt XML looking for a "
2109 "virtio-serial channel to connect to:"
2110 msgstr ""
2111
2112 #. type: verbatim
2113 #: ../src/guestfs.pod:1008
2114 #, no-wrap
2115 msgid ""
2116 " <domain>\n"
2117 "   ...\n"
2118 "   <devices>\n"
2119 "     ...\n"
2120 "     <channel type='unix'>\n"
2121 "       <source mode='bind' path='/path/to/socket'/>\n"
2122 "       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2123 "     </channel>\n"
2124 "     ...\n"
2125 "   </devices>\n"
2126 " </domain>\n"
2127 "\n"
2128 msgstr ""
2129
2130 #. type: textblock
2131 #: ../src/guestfs.pod:1020
2132 msgid ""
2133 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2134 "method to C<unix:/path/to/socket>."
2135 msgstr ""
2136
2137 #. type: textblock
2138 #: ../src/guestfs.pod:1023
2139 msgid ""
2140 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2141 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2142 "to attach to and modify live virtual machines."
2143 msgstr ""
2144
2145 #. type: textblock
2146 #: ../src/guestfs.pod:1027
2147 msgid ""
2148 "The virtual machine needs to have been set up beforehand so that it has the "
2149 "virtio-serial channel and so that guestfsd is running inside it."
2150 msgstr ""
2151
2152 #. type: =head2
2153 #: ../src/guestfs.pod:1031
2154 msgid "ABI GUARANTEE"
2155 msgstr ""
2156
2157 #. type: textblock
2158 #: ../src/guestfs.pod:1033
2159 msgid ""
2160 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2161 "actions as outlined in this section.  Although we will deprecate some "
2162 "actions, for example if they get replaced by newer calls, we will keep the "
2163 "old actions forever.  This allows you the developer to program in confidence "
2164 "against the libguestfs API."
2165 msgstr ""
2166
2167 #. type: =head2
2168 #: ../src/guestfs.pod:1039
2169 msgid "BLOCK DEVICE NAMING"
2170 msgstr ""
2171
2172 #. type: textblock
2173 #: ../src/guestfs.pod:1041
2174 msgid ""
2175 "In the kernel there is now quite a profusion of schemata for naming block "
2176 "devices (in this context, by I<block device> I mean a physical or virtual "
2177 "hard drive).  The original Linux IDE driver used names starting with C</dev/"
2178 "hd*>.  SCSI devices have historically used a different naming scheme, C</dev/"
2179 "sd*>.  When the Linux kernel I<libata> driver became a popular replacement "
2180 "for the old IDE driver (particularly for SATA devices) those devices also "
2181 "used the C</dev/sd*> scheme.  Additionally we now have virtual machines with "
2182 "paravirtualized drivers.  This has created several different naming systems, "
2183 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2184 msgstr ""
2185
2186 #. type: textblock
2187 #: ../src/guestfs.pod:1053
2188 msgid ""
2189 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2190 "Linux kernel to access block devices.  We can run a variety of appliances "
2191 "based on a variety of Linux kernels."
2192 msgstr ""
2193
2194 #. type: textblock
2195 #: ../src/guestfs.pod:1057
2196 msgid ""
2197 "This causes a problem for libguestfs because many API calls use device or "
2198 "partition names.  Working scripts and the recipe (example) scripts that we "
2199 "make available over the internet could fail if the naming scheme changes."
2200 msgstr ""
2201
2202 #. type: textblock
2203 #: ../src/guestfs.pod:1062
2204 msgid ""
2205 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
2206 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2207 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2208 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2209 msgstr ""
2210
2211 #. type: textblock
2212 #: ../src/guestfs.pod:1068
2213 msgid ""
2214 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
2215 "L</guestfs_list_partitions> and similar calls return the true names of the "
2216 "devices and partitions as known to the appliance."
2217 msgstr ""
2218
2219 #. type: =head3
2220 #: ../src/guestfs.pod:1073
2221 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2222 msgstr ""
2223
2224 #. type: textblock
2225 #: ../src/guestfs.pod:1075
2226 msgid ""
2227 "Usually this translation is transparent.  However in some (very rare)  cases "
2228 "you may need to know the exact algorithm.  Such cases include where you use "
2229 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2230 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2231 msgstr ""
2232
2233 #. type: textblock
2234 #: ../src/guestfs.pod:1081
2235 msgid ""
2236 "The algorithm is applied only to I<parameters> which are known to be either "
2237 "device or partition names.  Return values from functions such as L</"
2238 "guestfs_list_devices> are never changed."
2239 msgstr ""
2240
2241 #. type: textblock
2242 #: ../src/guestfs.pod:1089
2243 msgid "Is the string a parameter which is a device or partition name?"
2244 msgstr ""
2245
2246 #. type: textblock
2247 #: ../src/guestfs.pod:1093
2248 msgid "Does the string begin with C</dev/sd>?"
2249 msgstr ""
2250
2251 #. type: textblock
2252 #: ../src/guestfs.pod:1097
2253 msgid ""
2254 "Does the named device exist? If so, we use that device.  However if I<not> "
2255 "then we continue with this algorithm."
2256 msgstr ""
2257
2258 #. type: textblock
2259 #: ../src/guestfs.pod:1102
2260 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2261 msgstr ""
2262
2263 #. type: textblock
2264 #: ../src/guestfs.pod:1104
2265 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2266 msgstr ""
2267
2268 #. type: textblock
2269 #: ../src/guestfs.pod:1106
2270 msgid "If that named device exists, use it.  If not, continue."
2271 msgstr ""
2272
2273 #. type: textblock
2274 #: ../src/guestfs.pod:1110
2275 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2276 msgstr ""
2277
2278 #. type: textblock
2279 #: ../src/guestfs.pod:1112
2280 msgid "If that named device exists, use it.  If not, return an error."
2281 msgstr ""
2282
2283 #. type: =head3
2284 #: ../src/guestfs.pod:1116
2285 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2286 msgstr ""
2287
2288 #. type: textblock
2289 #: ../src/guestfs.pod:1118
2290 msgid ""
2291 "Although the standard naming scheme and automatic translation is useful for "
2292 "simple programs and guestfish scripts, for larger programs it is best not to "
2293 "rely on this mechanism."
2294 msgstr ""
2295
2296 #. type: textblock
2297 #: ../src/guestfs.pod:1122
2298 msgid ""
2299 "Where possible for maximum future portability programs using libguestfs "
2300 "should use these future-proof techniques:"
2301 msgstr ""
2302
2303 #. type: textblock
2304 #: ../src/guestfs.pod:1129
2305 msgid ""
2306 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2307 "device names, and then use those names directly."
2308 msgstr ""
2309
2310 #. type: textblock
2311 #: ../src/guestfs.pod:1132
2312 msgid ""
2313 "Since those device names exist by definition, they will never be translated."
2314 msgstr ""
2315
2316 #. type: textblock
2317 #: ../src/guestfs.pod:1137
2318 msgid ""
2319 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2320 "filesystem labels."
2321 msgstr ""
2322
2323 #. type: =head1
2324 #: ../src/guestfs.pod:1142
2325 msgid "SECURITY"
2326 msgstr "БЕЗПЕКА"
2327
2328 #. type: textblock
2329 #: ../src/guestfs.pod:1144
2330 msgid ""
2331 "This section discusses security implications of using libguestfs, "
2332 "particularly with untrusted or malicious guests or disk images."
2333 msgstr ""
2334
2335 #. type: =head2
2336 #: ../src/guestfs.pod:1147
2337 msgid "GENERAL SECURITY CONSIDERATIONS"
2338 msgstr ""
2339
2340 #. type: textblock
2341 #: ../src/guestfs.pod:1149
2342 msgid ""
2343 "Be careful with any files or data that you download from a guest (by "
2344 "\"download\" we mean not just the L</guestfs_download> command but any "
2345 "command that reads files, filenames, directories or anything else from a "
2346 "disk image).  An attacker could manipulate the data to fool your program "
2347 "into doing the wrong thing.  Consider cases such as:"
2348 msgstr ""
2349
2350 #. type: textblock
2351 #: ../src/guestfs.pod:1159
2352 msgid "the data (file etc) not being present"
2353 msgstr ""
2354
2355 #. type: textblock
2356 #: ../src/guestfs.pod:1163
2357 msgid "being present but empty"
2358 msgstr ""
2359
2360 #. type: textblock
2361 #: ../src/guestfs.pod:1167
2362 msgid "being much larger than normal"
2363 msgstr ""
2364
2365 #. type: textblock
2366 #: ../src/guestfs.pod:1171
2367 msgid "containing arbitrary 8 bit data"
2368 msgstr ""
2369
2370 #. type: textblock
2371 #: ../src/guestfs.pod:1175
2372 msgid "being in an unexpected character encoding"
2373 msgstr ""
2374
2375 #. type: textblock
2376 #: ../src/guestfs.pod:1179
2377 msgid "containing homoglyphs."
2378 msgstr ""
2379
2380 #. type: =head2
2381 #: ../src/guestfs.pod:1183
2382 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2383 msgstr ""
2384
2385 #. type: textblock
2386 #: ../src/guestfs.pod:1185
2387 msgid ""
2388 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2389 "(VFS) module can sometimes be escalated into exploits by deliberately "
2390 "creating a malicious, malformed filesystem.  These exploits are very severe "
2391 "for two reasons.  Firstly there are very many filesystem drivers in the "
2392 "kernel, and many of them are infrequently used and not much developer "
2393 "attention has been paid to the code.  Linux userspace helps potential "
2394 "crackers by detecting the filesystem type and automatically choosing the "
2395 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2396 "the administrator.  Secondly, a kernel-level exploit is like a local root "
2397 "exploit (worse in some ways), giving immediate and total access to the "
2398 "system right down to the hardware level."
2399 msgstr ""
2400
2401 #. type: textblock
2402 #: ../src/guestfs.pod:1198
2403 msgid ""
2404 "That explains why you should never mount a filesystem from an untrusted "
2405 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
2406 "inside a qemu virtual machine, usually running as a non-root user.  The "
2407 "attacker would need to write a filesystem which first exploited the kernel, "
2408 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2409 "the libguestfs protocol, and finally to be as serious as the host kernel "
2410 "exploit it would need to escalate its privileges to root.  This multi-step "
2411 "escalation, performed by a static piece of data, is thought to be extremely "
2412 "hard to do, although we never say 'never' about security issues."
2413 msgstr ""
2414
2415 #. type: textblock
2416 #: ../src/guestfs.pod:1209
2417 msgid ""
2418 "In any case callers can reduce the attack surface by forcing the filesystem "
2419 "type when mounting (use L</guestfs_mount_vfs>)."
2420 msgstr ""
2421
2422 #. type: =head2
2423 #: ../src/guestfs.pod:1212
2424 msgid "PROTOCOL SECURITY"
2425 msgstr ""
2426
2427 #. type: textblock
2428 #: ../src/guestfs.pod:1214
2429 msgid ""
2430 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
2431 "defined upper message size.  However a program that uses libguestfs must "
2432 "also take care - for example you can write a program that downloads a binary "
2433 "from a disk image and executes it locally, and no amount of protocol "
2434 "security will save you from the consequences."
2435 msgstr ""
2436
2437 #. type: =head2
2438 #: ../src/guestfs.pod:1220
2439 msgid "INSPECTION SECURITY"
2440 msgstr ""
2441
2442 #. type: textblock
2443 #: ../src/guestfs.pod:1222
2444 msgid ""
2445 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2446 "directly from the guest, and these could contain any 8 bit data.  Callers "
2447 "should be careful to escape these before printing them to a structured file "
2448 "(for example, use HTML escaping if creating a web page)."
2449 msgstr ""
2450
2451 #. type: textblock
2452 #: ../src/guestfs.pod:1228
2453 msgid ""
2454 "Guest configuration may be altered in unusual ways by the administrator of "
2455 "the virtual machine, and may not reflect reality (particularly for untrusted "
2456 "or actively malicious guests).  For example we parse the hostname from "
2457 "configuration files like C</etc/sysconfig/network> that we find in the "
2458 "guest, but the guest administrator can easily manipulate these files to "
2459 "provide the wrong hostname."
2460 msgstr ""
2461
2462 #. type: textblock
2463 #: ../src/guestfs.pod:1236
2464 msgid ""
2465 "The inspection API parses guest configuration using two external libraries: "
2466 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
2467 "designed to be robust in the face of malicious data, although denial of "
2468 "service attacks are still possible, for example with oversized configuration "
2469 "files."
2470 msgstr ""
2471
2472 #. type: =head2
2473 #: ../src/guestfs.pod:1242
2474 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2475 msgstr ""
2476
2477 #. type: textblock
2478 #: ../src/guestfs.pod:1244
2479 msgid ""
2480 "Be very cautious about running commands from the guest.  By running a "
2481 "command in the guest, you are giving CPU time to a binary that you do not "
2482 "control, under the same user account as the library, albeit wrapped in qemu "
2483 "virtualization.  More information and alternatives can be found in the "
2484 "section L</RUNNING COMMANDS>."
2485 msgstr ""
2486
2487 #. type: =head2
2488 #: ../src/guestfs.pod:1250
2489 msgid "CVE-2010-3851"
2490 msgstr "CVE-2010-3851"
2491
2492 #. type: textblock
2493 #: ../src/guestfs.pod:1252
2494 msgid "https://bugzilla.redhat.com/642934"
2495 msgstr "https://bugzilla.redhat.com/642934"
2496
2497 #. type: textblock
2498 #: ../src/guestfs.pod:1254
2499 msgid ""
2500 "This security bug concerns the automatic disk format detection that qemu "
2501 "does on disk images."
2502 msgstr ""
2503
2504 #. type: textblock
2505 #: ../src/guestfs.pod:1257
2506 msgid ""
2507 "A raw disk image is just the raw bytes, there is no header.  Other disk "
2508 "images like qcow2 contain a special header.  Qemu deals with this by looking "
2509 "for one of the known headers, and if none is found then assuming the disk "
2510 "image must be raw."
2511 msgstr ""
2512
2513 #. type: textblock
2514 #: ../src/guestfs.pod:1262
2515 msgid ""
2516 "This allows a guest which has been given a raw disk image to write some "
2517 "other header.  At next boot (or when the disk image is accessed by "
2518 "libguestfs) qemu would do autodetection and think the disk image format was, "
2519 "say, qcow2 based on the header written by the guest."
2520 msgstr ""
2521
2522 #. type: textblock
2523 #: ../src/guestfs.pod:1267
2524 msgid ""
2525 "This in itself would not be a problem, but qcow2 offers many features, one "
2526 "of which is to allow a disk image to refer to another image (called the "
2527 "\"backing disk\").  It does this by placing the path to the backing disk "
2528 "into the qcow2 header.  This path is not validated and could point to any "
2529 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
2530 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2531 "control of the attacker."
2532 msgstr ""
2533
2534 #. type: textblock
2535 #: ../src/guestfs.pod:1275
2536 msgid ""
2537 "In libguestfs this is rather hard to exploit except under two circumstances:"
2538 msgstr ""
2539
2540 #. type: textblock
2541 #: ../src/guestfs.pod:1282
2542 msgid "You have enabled the network or have opened the disk in write mode."
2543 msgstr ""
2544
2545 #. type: textblock
2546 #: ../src/guestfs.pod:1286
2547 msgid ""
2548 "You are also running untrusted code from the guest (see L</RUNNING "
2549 "COMMANDS>)."
2550 msgstr ""
2551
2552 #. type: textblock
2553 #: ../src/guestfs.pod:1291
2554 msgid ""
2555 "The way to avoid this is to specify the expected disk format when adding "
2556 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
2557 "should always do this if the disk is raw format, and it's a good idea for "
2558 "other cases too."
2559 msgstr ""
2560
2561 #. type: textblock
2562 #: ../src/guestfs.pod:1296
2563 msgid ""
2564 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2565 "format is fetched from libvirt and passed through."
2566 msgstr ""
2567
2568 #. type: textblock
2569 #: ../src/guestfs.pod:1299
2570 msgid ""
2571 "For libguestfs tools, use the I<--format> command line parameter as "
2572 "appropriate."
2573 msgstr ""
2574
2575 #. type: =head1
2576 #: ../src/guestfs.pod:1302
2577 msgid "CONNECTION MANAGEMENT"
2578 msgstr ""
2579
2580 #. type: =head2
2581 #: ../src/guestfs.pod:1304
2582 msgid "guestfs_h *"
2583 msgstr ""
2584
2585 #. type: textblock
2586 #: ../src/guestfs.pod:1306
2587 msgid ""
2588 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
2589 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
2590 "handle and release all resources used."
2591 msgstr ""
2592
2593 #. type: textblock
2594 #: ../src/guestfs.pod:1310
2595 msgid ""
2596 "For information on using multiple handles and threads, see the section L</"
2597 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2598 msgstr ""
2599
2600 #. type: =head2
2601 #: ../src/guestfs.pod:1313
2602 msgid "guestfs_create"
2603 msgstr ""
2604
2605 #. type: verbatim
2606 #: ../src/guestfs.pod:1315
2607 #, no-wrap
2608 msgid ""
2609 " guestfs_h *guestfs_create (void);\n"
2610 "\n"
2611 msgstr ""
2612
2613 #. type: textblock
2614 #: ../src/guestfs.pod:1317
2615 msgid "Create a connection handle."
2616 msgstr ""
2617
2618 #. type: textblock
2619 #: ../src/guestfs.pod:1319
2620 msgid ""
2621 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2622 "on the handle at least once."
2623 msgstr ""
2624
2625 #. type: textblock
2626 #: ../src/guestfs.pod:1322
2627 msgid ""
2628 "This function returns a non-NULL pointer to a handle on success or NULL on "
2629 "error."
2630 msgstr ""
2631
2632 #. type: textblock
2633 #: ../src/guestfs.pod:1325
2634 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2635 msgstr ""
2636
2637 #. type: textblock
2638 #: ../src/guestfs.pod:1327
2639 msgid ""
2640 "You may also want to configure error handling for the handle.  See L</ERROR "
2641 "HANDLING> section below."
2642 msgstr ""
2643
2644 #. type: =head2
2645 #: ../src/guestfs.pod:1330
2646 msgid "guestfs_close"
2647 msgstr ""
2648
2649 #. type: verbatim
2650 #: ../src/guestfs.pod:1332
2651 #, no-wrap
2652 msgid ""
2653 " void guestfs_close (guestfs_h *g);\n"
2654 "\n"
2655 msgstr ""
2656
2657 #. type: textblock
2658 #: ../src/guestfs.pod:1334
2659 msgid "This closes the connection handle and frees up all resources used."
2660 msgstr ""
2661
2662 #. type: =head1
2663 #: ../src/guestfs.pod:1336
2664 msgid "ERROR HANDLING"
2665 msgstr "ОБРОБКА ПОМИЛОК"
2666
2667 #. type: textblock
2668 #: ../src/guestfs.pod:1338
2669 msgid ""
2670 "API functions can return errors.  For example, almost all functions that "
2671 "return C<int> will return C<-1> to indicate an error."
2672 msgstr ""
2673
2674 #. type: textblock
2675 #: ../src/guestfs.pod:1341
2676 msgid ""
2677 "Additional information is available for errors: an error message string and "
2678 "optionally an error number (errno) if the thing that failed was a system "
2679 "call."
2680 msgstr ""
2681
2682 #. type: textblock
2683 #: ../src/guestfs.pod:1345
2684 msgid ""
2685 "You can get at the additional information about the last error on the handle "
2686 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2687 "up an error handler with L</guestfs_set_error_handler>."
2688 msgstr ""
2689
2690 #. type: textblock
2691 #: ../src/guestfs.pod:1350
2692 msgid ""
2693 "When the handle is created, a default error handler is installed which "
2694 "prints the error message string to C<stderr>.  For small short-running "
2695 "command line programs it is sufficient to do:"
2696 msgstr ""
2697
2698 #. type: verbatim
2699 #: ../src/guestfs.pod:1354
2700 #, no-wrap
2701 msgid ""
2702 " if (guestfs_launch (g) == -1)\n"
2703 "   exit (EXIT_FAILURE);\n"
2704 "\n"
2705 msgstr ""
2706
2707 #. type: textblock
2708 #: ../src/guestfs.pod:1357
2709 msgid ""
2710 "since the default error handler will ensure that an error message has been "
2711 "printed to C<stderr> before the program exits."
2712 msgstr ""
2713
2714 #. type: textblock
2715 #: ../src/guestfs.pod:1360
2716 msgid ""
2717 "For other programs the caller will almost certainly want to install an "
2718 "alternate error handler or do error handling in-line like this:"
2719 msgstr ""
2720
2721 #. type: verbatim
2722 #: ../src/guestfs.pod:1363
2723 #, no-wrap
2724 msgid ""
2725 " g = guestfs_create ();\n"
2726 " \n"
2727 msgstr ""
2728
2729 #. type: verbatim
2730 #: ../src/guestfs.pod:1365
2731 #, no-wrap
2732 msgid ""
2733 " /* This disables the default behaviour of printing errors\n"
2734 "    on stderr. */\n"
2735 " guestfs_set_error_handler (g, NULL, NULL);\n"
2736 " \n"
2737 msgstr ""
2738
2739 #. type: verbatim
2740 #: ../src/guestfs.pod:1369
2741 #, no-wrap
2742 msgid ""
2743 " if (guestfs_launch (g) == -1) {\n"
2744 "   /* Examine the error message and print it etc. */\n"
2745 "   char *msg = guestfs_last_error (g);\n"
2746 "   int errnum = guestfs_last_errno (g);\n"
2747 "   fprintf (stderr, \"%s\\n\", msg);\n"
2748 "   /* ... */\n"
2749 "  }\n"
2750 "\n"
2751 msgstr ""
2752
2753 #. type: textblock
2754 #: ../src/guestfs.pod:1377
2755 msgid ""
2756 "Out of memory errors are handled differently.  The default action is to call "
2757 "L<abort(3)>.  If this is undesirable, then you can set a handler using L</"
2758 "guestfs_set_out_of_memory_handler>."
2759 msgstr ""
2760
2761 #. type: textblock
2762 #: ../src/guestfs.pod:1381
2763 msgid ""
2764 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2765 "because there is no handle if this happens there is no way to get additional "
2766 "error information.  However L</guestfs_create> is supposed to be a "
2767 "lightweight operation which can only fail because of insufficient memory (it "
2768 "returns NULL in this case)."
2769 msgstr ""
2770
2771 #. type: =head2
2772 #: ../src/guestfs.pod:1387
2773 msgid "guestfs_last_error"
2774 msgstr ""
2775
2776 #. type: verbatim
2777 #: ../src/guestfs.pod:1389
2778 #, no-wrap
2779 msgid ""
2780 " const char *guestfs_last_error (guestfs_h *g);\n"
2781 "\n"
2782 msgstr ""
2783
2784 #. type: textblock
2785 #: ../src/guestfs.pod:1391
2786 msgid ""
2787 "This returns the last error message that happened on C<g>.  If there has not "
2788 "been an error since the handle was created, then this returns C<NULL>."
2789 msgstr ""
2790
2791 #. type: textblock
2792 #: ../src/guestfs.pod:1395
2793 msgid ""
2794 "The lifetime of the returned string is until the next error occurs, or L</"
2795 "guestfs_close> is called."
2796 msgstr ""
2797
2798 #. type: =head2
2799 #: ../src/guestfs.pod:1398
2800 msgid "guestfs_last_errno"
2801 msgstr ""
2802
2803 #. type: verbatim
2804 #: ../src/guestfs.pod:1400
2805 #, no-wrap
2806 msgid ""
2807 " int guestfs_last_errno (guestfs_h *g);\n"
2808 "\n"
2809 msgstr ""
2810
2811 #. type: textblock
2812 #: ../src/guestfs.pod:1402
2813 msgid "This returns the last error number (errno) that happened on C<g>."
2814 msgstr ""
2815
2816 #. type: textblock
2817 #: ../src/guestfs.pod:1404
2818 msgid "If successful, an errno integer not equal to zero is returned."
2819 msgstr ""
2820
2821 #. type: textblock
2822 #: ../src/guestfs.pod:1406
2823 msgid ""
2824 "If no error, this returns 0.  This call can return 0 in three situations:"
2825 msgstr ""
2826
2827 #. type: textblock
2828 #: ../src/guestfs.pod:1413
2829 msgid "There has not been any error on the handle."
2830 msgstr ""
2831
2832 #. type: textblock
2833 #: ../src/guestfs.pod:1417
2834 msgid ""
2835 "There has been an error but the errno was meaningless.  This corresponds to "
2836 "the case where the error did not come from a failed system call, but for "
2837 "some other reason."
2838 msgstr ""
2839
2840 #. type: textblock
2841 #: ../src/guestfs.pod:1423
2842 msgid ""
2843 "There was an error from a failed system call, but for some reason the errno "
2844 "was not captured and returned.  This usually indicates a bug in libguestfs."
2845 msgstr ""
2846
2847 #. type: textblock
2848 #: ../src/guestfs.pod:1429
2849 msgid ""
2850 "Libguestfs tries to convert the errno from inside the applicance into a "
2851 "corresponding errno for the caller (not entirely trivial: the appliance "
2852 "might be running a completely different operating system from the library "
2853 "and error numbers are not standardized across Un*xen).  If this could not be "
2854 "done, then the error is translated to C<EINVAL>.  In practice this should "
2855 "only happen in very rare circumstances."
2856 msgstr ""
2857
2858 #. type: =head2
2859 #: ../src/guestfs.pod:1437
2860 msgid "guestfs_set_error_handler"
2861 msgstr ""
2862
2863 #. type: verbatim
2864 #: ../src/guestfs.pod:1439
2865 #, no-wrap
2866 msgid ""
2867 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2868 "                                           void *opaque,\n"
2869 "                                           const char *msg);\n"
2870 " void guestfs_set_error_handler (guestfs_h *g,\n"
2871 "                                 guestfs_error_handler_cb cb,\n"
2872 "                                 void *opaque);\n"
2873 "\n"
2874 msgstr ""
2875
2876 #. type: textblock
2877 #: ../src/guestfs.pod:1446
2878 msgid ""
2879 "The callback C<cb> will be called if there is an error.  The parameters "
2880 "passed to the callback are an opaque data pointer and the error message "
2881 "string."
2882 msgstr ""
2883
2884 #. type: textblock
2885 #: ../src/guestfs.pod:1450
2886 msgid ""
2887 "C<errno> is not passed to the callback.  To get that the callback must call "
2888 "L</guestfs_last_errno>."
2889 msgstr ""
2890
2891 #. type: textblock
2892 #: ../src/guestfs.pod:1453
2893 msgid ""
2894 "Note that the message string C<msg> is freed as soon as the callback "
2895 "function returns, so if you want to stash it somewhere you must make your "
2896 "own copy."
2897 msgstr ""
2898
2899 #. type: textblock
2900 #: ../src/guestfs.pod:1457
2901 msgid "The default handler prints messages on C<stderr>."
2902 msgstr ""
2903
2904 #. type: textblock
2905 #: ../src/guestfs.pod:1459
2906 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2907 msgstr ""
2908
2909 #. type: =head2
2910 #: ../src/guestfs.pod:1461
2911 msgid "guestfs_get_error_handler"
2912 msgstr ""
2913
2914 #. type: verbatim
2915 #: ../src/guestfs.pod:1463
2916 #, no-wrap
2917 msgid ""
2918 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2919 "                                                     void **opaque_rtn);\n"
2920 "\n"
2921 msgstr ""
2922
2923 #. type: textblock
2924 #: ../src/guestfs.pod:1466
2925 msgid "Returns the current error handler callback."
2926 msgstr ""
2927
2928 #. type: =head2
2929 #: ../src/guestfs.pod:1468
2930 msgid "guestfs_set_out_of_memory_handler"
2931 msgstr ""
2932
2933 #. type: verbatim
2934 #: ../src/guestfs.pod:1470
2935 #, no-wrap
2936 msgid ""
2937 " typedef void (*guestfs_abort_cb) (void);\n"
2938 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2939 "                                        guestfs_abort_cb);\n"
2940 "\n"
2941 msgstr ""
2942
2943 #. type: textblock
2944 #: ../src/guestfs.pod:1474
2945 msgid ""
2946 "The callback C<cb> will be called if there is an out of memory situation.  "
2947 "I<Note this callback must not return>."
2948 msgstr ""
2949
2950 #. type: textblock
2951 #: ../src/guestfs.pod:1477
2952 msgid "The default is to call L<abort(3)>."
2953 msgstr ""
2954
2955 #. type: textblock
2956 #: ../src/guestfs.pod:1479
2957 msgid ""
2958 "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
2959 msgstr ""
2960
2961 #. type: =head2
2962 #: ../src/guestfs.pod:1482
2963 msgid "guestfs_get_out_of_memory_handler"
2964 msgstr ""
2965
2966 #. type: verbatim
2967 #: ../src/guestfs.pod:1484
2968 #, no-wrap
2969 msgid ""
2970 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2971 "\n"
2972 msgstr ""
2973
2974 #. type: textblock
2975 #: ../src/guestfs.pod:1486
2976 msgid "This returns the current out of memory handler."
2977 msgstr ""
2978
2979 #. type: =head1
2980 #: ../src/guestfs.pod:1488
2981 msgid "API CALLS"
2982 msgstr ""
2983
2984 #. type: textblock
2985 #: ../src/guestfs.pod:1490 ../fish/guestfish.pod:1008
2986 msgid "@ACTIONS@"
2987 msgstr "@ACTIONS@"
2988
2989 #. type: =head1
2990 #: ../src/guestfs.pod:1492
2991 msgid "STRUCTURES"
2992 msgstr "СТРУКТУРИ"
2993
2994 #. type: textblock
2995 #: ../src/guestfs.pod:1494
2996 msgid "@STRUCTS@"
2997 msgstr "@STRUCTS@"
2998
2999 #. type: =head1
3000 #: ../src/guestfs.pod:1496
3001 msgid "AVAILABILITY"
3002 msgstr ""
3003
3004 #. type: =head2
3005 #: ../src/guestfs.pod:1498
3006 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3007 msgstr ""
3008
3009 #. type: textblock
3010 #: ../src/guestfs.pod:1500
3011 msgid ""
3012 "Using L</guestfs_available> you can test availability of the following "
3013 "groups of functions.  This test queries the appliance to see if the "
3014 "appliance you are currently using supports the functionality."
3015 msgstr ""
3016
3017 #. type: textblock
3018 #: ../src/guestfs.pod:1505
3019 msgid "@AVAILABILITY@"
3020 msgstr ""
3021
3022 #. type: =head2
3023 #: ../src/guestfs.pod:1507
3024 msgid "GUESTFISH supported COMMAND"
3025 msgstr ""
3026
3027 #. type: textblock
3028 #: ../src/guestfs.pod:1509
3029 msgid ""
3030 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3031 "prints out the available groups and whether they are supported by this build "
3032 "of libguestfs.  Note however that you have to do C<run> first."
3033 msgstr ""
3034
3035 #. type: =head2
3036 #: ../src/guestfs.pod:1514
3037 msgid "SINGLE CALLS AT COMPILE TIME"
3038 msgstr ""
3039
3040 #. type: textblock
3041 #: ../src/guestfs.pod:1516
3042 msgid ""
3043 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3044 "function, such as:"
3045 msgstr ""
3046
3047 #. type: verbatim
3048 #: ../src/guestfs.pod:1519
3049 #, no-wrap
3050 msgid ""
3051 " #define LIBGUESTFS_HAVE_DD 1\n"
3052 "\n"
3053 msgstr ""
3054
3055 #. type: textblock
3056 #: ../src/guestfs.pod:1521
3057 msgid "if L</guestfs_dd> is available."
3058 msgstr ""
3059
3060 #. type: textblock
3061 #: ../src/guestfs.pod:1523
3062 msgid ""
3063 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3064 "function is available at compile time, we recommended using build tools such "
3065 "as autoconf or cmake.  For example in autotools you could use:"
3066 msgstr ""
3067
3068 #. type: verbatim
3069 #: ../src/guestfs.pod:1528
3070 #, no-wrap
3071 msgid ""
3072 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3073 " AC_CHECK_FUNCS([guestfs_dd])\n"
3074 "\n"
3075 msgstr ""
3076
3077 #. type: textblock
3078 #: ../src/guestfs.pod:1531
3079 msgid ""
3080 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3081 "in your program."
3082 msgstr ""
3083
3084 #. type: =head2
3085 #: ../src/guestfs.pod:1534
3086 msgid "SINGLE CALLS AT RUN TIME"
3087 msgstr ""
3088
3089 #. type: textblock
3090 #: ../src/guestfs.pod:1536
3091 msgid ""
3092 "Testing at compile time doesn't guarantee that a function really exists in "
3093 "the library.  The reason is that you might be dynamically linked against a "
3094 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
3095 "This situation unfortunately results in a segmentation fault, which is a "
3096 "shortcoming of the C dynamic linking system itself."
3097 msgstr ""
3098
3099 #. type: textblock
3100 #: ../src/guestfs.pod:1543
3101 msgid ""
3102 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3103 "in this example program (note that you still need the compile time check as "
3104 "well):"
3105 msgstr ""
3106
3107 #. type: verbatim
3108 #: ../src/guestfs.pod:1547
3109 #, no-wrap
3110 msgid ""
3111 " #include <stdio.h>\n"
3112 " #include <stdlib.h>\n"
3113 " #include <unistd.h>\n"
3114 " #include <dlfcn.h>\n"
3115 " #include <guestfs.h>\n"
3116 " \n"
3117 msgstr ""
3118
3119 #. type: verbatim
3120 #: ../src/guestfs.pod:1553
3121 #, no-wrap
3122 msgid ""
3123 " main ()\n"
3124 " {\n"
3125 " #ifdef LIBGUESTFS_HAVE_DD\n"
3126 "   void *dl;\n"
3127 "   int has_function;\n"
3128 " \n"
3129 msgstr ""
3130
3131 #. type: verbatim
3132 #: ../src/guestfs.pod:1559
3133 #, no-wrap
3134 msgid ""
3135 "   /* Test if the function guestfs_dd is really available. */\n"
3136 "   dl = dlopen (NULL, RTLD_LAZY);\n"
3137 "   if (!dl) {\n"
3138 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3139 "     exit (EXIT_FAILURE);\n"
3140 "   }\n"
3141 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3142 "   dlclose (dl);\n"
3143 " \n"
3144 msgstr ""
3145
3146 #. type: verbatim
3147 #: ../src/guestfs.pod:1568
3148 #, no-wrap
3149 msgid ""
3150 "   if (!has_function)\n"
3151 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3152 "   else {\n"
3153 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3154 "     /* Now it's safe to call\n"
3155 "     guestfs_dd (g, \"foo\", \"bar\");\n"
3156 "     */\n"
3157 "   }\n"
3158 " #else\n"
3159 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3160 " #endif\n"
3161 "  }\n"
3162 "\n"
3163 msgstr ""
3164
3165 #. type: textblock
3166 #: ../src/guestfs.pod:1581
3167 msgid ""
3168 "You may think the above is an awful lot of hassle, and it is.  There are "
3169 "other ways outside of the C linking system to ensure that this kind of "
3170 "incompatibility never arises, such as using package versioning:"
3171 msgstr ""
3172
3173 #. type: verbatim
3174 #: ../src/guestfs.pod:1586
3175 #, no-wrap
3176 msgid ""
3177 " Requires: libguestfs >= 1.0.80\n"
3178 "\n"
3179 msgstr ""
3180
3181 #. type: =head1
3182 #: ../src/guestfs.pod:1588
3183 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3184 msgstr ""
3185
3186 #. type: textblock
3187 #: ../src/guestfs.pod:1590
3188 msgid ""
3189 "A recent feature of the API is the introduction of calls which take optional "
3190 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
3191 "takes variable arguments (ie. C<...>), as in this example:"
3192 msgstr ""
3193
3194 #. type: verbatim
3195 #: ../src/guestfs.pod:1595
3196 #, no-wrap
3197 msgid ""
3198 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3199 "\n"
3200 msgstr ""
3201
3202 #. type: textblock
3203 #: ../src/guestfs.pod:1597
3204 msgid ""
3205 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
3206 "call with no optional arguments specified:"
3207 msgstr ""
3208
3209 #. type: verbatim
3210 #: ../src/guestfs.pod:1600
3211 #, no-wrap
3212 msgid ""
3213 " guestfs_add_drive_opts (g, filename, -1);\n"
3214 "\n"
3215 msgstr ""
3216
3217 #. type: textblock
3218 #: ../src/guestfs.pod:1602
3219 msgid "With a single optional argument:"
3220 msgstr ""
3221
3222 #. type: verbatim
3223 #: ../src/guestfs.pod:1604
3224 #, no-wrap
3225 msgid ""
3226 " guestfs_add_drive_opts (g, filename,\n"
3227 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3228 "                         -1);\n"
3229 "\n"
3230 msgstr ""
3231
3232 #. type: textblock
3233 #: ../src/guestfs.pod:1608
3234 msgid "With two:"
3235 msgstr ""
3236
3237 #. type: verbatim
3238 #: ../src/guestfs.pod:1610
3239 #, no-wrap
3240 msgid ""
3241 " guestfs_add_drive_opts (g, filename,\n"
3242 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3243 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3244 "                         -1);\n"
3245 "\n"
3246 msgstr ""
3247
3248 #. type: textblock
3249 #: ../src/guestfs.pod:1615
3250 msgid ""
3251 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
3252 "happen!"
3253 msgstr ""
3254
3255 #. type: =head2
3256 #: ../src/guestfs.pod:1618
3257 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3258 msgstr ""
3259
3260 #. type: textblock
3261 #: ../src/guestfs.pod:1620
3262 msgid ""
3263 "The second variant has the same name with the suffix C<_va>, which works the "
3264 "same way but takes a C<va_list>.  See the C manual for details.  For the "
3265 "example function, this is declared:"
3266 msgstr ""
3267
3268 #. type: verbatim
3269 #: ../src/guestfs.pod:1624
3270 #, no-wrap
3271 msgid ""
3272 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3273 "                                va_list args);\n"
3274 "\n"
3275 msgstr ""
3276
3277 #. type: =head2
3278 #: ../src/guestfs.pod:1627
3279 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3280 msgstr ""
3281
3282 #. type: textblock
3283 #: ../src/guestfs.pod:1629
3284 msgid ""
3285 "The third variant is useful where you need to construct these calls.  You "
3286 "pass in a structure where you fill in the optional fields.  The structure "
3287 "has a bitmask as the first element which you must set to indicate which "
3288 "fields you have filled in.  For our example function the structure and call "
3289 "are declared:"
3290 msgstr ""
3291
3292 #. type: verbatim
3293 #: ../src/guestfs.pod:1635
3294 #, no-wrap
3295 msgid ""
3296 " struct guestfs_add_drive_opts_argv {\n"
3297 "   uint64_t bitmask;\n"
3298 "   int readonly;\n"
3299 "   const char *format;\n"
3300 "   /* ... */\n"
3301 " };\n"
3302 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3303 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
3304 "\n"
3305 msgstr ""
3306
3307 #. type: textblock
3308 #: ../src/guestfs.pod:1644
3309 msgid "You could call it like this:"
3310 msgstr ""
3311
3312 #. type: verbatim
3313 #: ../src/guestfs.pod:1646
3314 #, no-wrap
3315 msgid ""
3316 " struct guestfs_add_drive_opts_argv optargs = {\n"
3317 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3318 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3319 "   .readonly = 1,\n"
3320 "   .format = \"qcow2\"\n"
3321 " };\n"
3322 " \n"
3323 msgstr ""
3324
3325 #. type: verbatim
3326 #: ../src/guestfs.pod:1653
3327 #, no-wrap
3328 msgid ""
3329 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3330 "\n"
3331 msgstr ""
3332
3333 #. type: textblock
3334 #: ../src/guestfs.pod:1655 ../src/guestfs-actions.pod:11
3335 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3336 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3337 msgid "Notes:"
3338 msgstr "Нотатки:"
3339
3340 #. type: textblock
3341 #: ../src/guestfs.pod:1661
3342 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3343 msgstr ""
3344
3345 #. type: textblock
3346 #: ../src/guestfs.pod:1666
3347 msgid "You do not need to fill in all fields of the structure."
3348 msgstr ""
3349
3350 #. type: textblock
3351 #: ../src/guestfs.pod:1670
3352 msgid ""
3353 "There must be a one-to-one correspondence between fields of the structure "
3354 "that are filled in, and bits set in the bitmask."
3355 msgstr ""
3356
3357 #. type: =head2
3358 #: ../src/guestfs.pod:1675
3359 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3360 msgstr ""
3361
3362 #. type: textblock
3363 #: ../src/guestfs.pod:1677
3364 msgid ""
3365 "In other languages, optional arguments are expressed in the way that is "
3366 "natural for that language.  We refer you to the language-specific "
3367 "documentation for more details on that."
3368 msgstr ""
3369
3370 #. type: textblock
3371 #: ../src/guestfs.pod:1681
3372 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3373 msgstr ""
3374
3375 #. type: =head2
3376 #: ../src/guestfs.pod:1683
3377 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3378 msgstr ""
3379
3380 #. type: textblock
3381 #: ../src/guestfs.pod:1685
3382 msgid ""
3383 "B<Note:> This section documents the generic event mechanism introduced in "
3384 "libguestfs 1.10, which you should use in new code if possible.  The old "
3385 "functions C<guestfs_set_log_message_callback>, "
3386 "C<guestfs_set_subprocess_quit_callback>, "
3387 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3388 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3389 "page."
3390 msgstr ""
3391
3392 #. type: textblock
3393 #: ../src/guestfs.pod:1693
3394 msgid ""
3395 "Handles generate events when certain things happen, such as log messages "
3396 "being generated, progress messages during long-running operations, or the "
3397 "handle being closed.  The API calls described below let you register a "
3398 "callback to be called when events happen.  You can register multiple "
3399 "callbacks (for the same, different or overlapping sets of events), and "
3400 "individually remove callbacks.  If callbacks are not removed, then they "
3401 "remain in force until the handle is closed."
3402 msgstr ""
3403
3404 #. type: textblock
3405 #: ../src/guestfs.pod:1701
3406 msgid ""
3407 "In the current implementation, events are only generated synchronously: that "
3408 "means that events (and hence callbacks) can only happen while you are in the "
3409 "middle of making another libguestfs call.  The callback is called in the "
3410 "same thread."
3411 msgstr ""
3412
3413 #. type: textblock
3414 #: ../src/guestfs.pod:1706
3415 msgid ""
3416 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3417 "unsigned integers, or a message buffer.  Payloads are discussed later on."
3418 msgstr ""
3419
3420 #. type: =head3
3421 #: ../src/guestfs.pod:1710
3422 msgid "CLASSES OF EVENTS"
3423 msgstr ""
3424
3425 #. type: =item
3426 #: ../src/guestfs.pod:1714
3427 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3428 msgstr ""
3429
3430 #. type: textblock
3431 #: ../src/guestfs.pod:1717
3432 msgid ""
3433 "The callback function will be called while the handle is being closed "
3434 "(synchronously from L</guestfs_close>)."
3435 msgstr ""
3436
3437 #. type: textblock
3438 #: ../src/guestfs.pod:1720
3439 msgid ""
3440 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3441 "handles that are open when the program exits.  This means that this callback "
3442 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3443 "problems in higher-level languages (eg. if your HLL interpreter has already "
3444 "been cleaned up by the time this is called, and if your callback then jumps "
3445 "into some HLL function)."
3446 msgstr ""
3447
3448 #. type: textblock
3449 #: ../src/guestfs.pod:1727
3450 msgid ""
3451 "If no callback is registered: the handle is closed without any callback "
3452 "being invoked."
3453 msgstr ""
3454
3455 #. type: =item
3456 #: ../src/guestfs.pod:1730
3457 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3458 msgstr ""
3459
3460 #. type: textblock
3461 #: ../src/guestfs.pod:1733
3462 msgid ""
3463 "The callback function will be called when the child process quits, either "
3464 "asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
3465 "corresponds to a transition from any state to the CONFIG state)."
3466 msgstr ""
3467
3468 #. type: textblock
3469 #: ../src/guestfs.pod:1737 ../src/guestfs.pod:1746
3470 msgid "If no callback is registered: the event is ignored."
3471 msgstr ""
3472
3473 #. type: =item
3474 #: ../src/guestfs.pod:1739
3475 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3476 msgstr ""
3477
3478 #. type: textblock
3479 #: ../src/guestfs.pod:1742
3480 msgid ""
3481 "The callback function will be called when the child process becomes ready "
3482 "first time after it has been launched.  (This corresponds to a transition "
3483 "from LAUNCHING to the READY state)."
3484 msgstr ""
3485
3486 #. type: =item
3487 #: ../src/guestfs.pod:1748
3488 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3489 msgstr ""
3490
3491 #. type: textblock
3492 #: ../src/guestfs.pod:1751
3493 msgid ""
3494 "Some long-running operations can generate progress messages.  If this "
3495 "callback is registered, then it will be called each time a progress message "
3496 "is generated (usually two seconds after the operation started, and three "
3497 "times per second thereafter until it completes, although the frequency may "
3498 "change in future versions)."
3499 msgstr ""
3500
3501 #. type: textblock
3502 #: ../src/guestfs.pod:1757
3503 msgid ""
3504 "The callback receives in the payload four unsigned 64 bit numbers which are "
3505 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3506 msgstr ""
3507
3508 #. type: textblock
3509 #: ../src/guestfs.pod:1760
3510 msgid ""
3511 "The units of C<total> are not defined, although for some operations C<total> "
3512 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3513 "or megabytes), and C<position> may be the portion which has been transferred."
3514 msgstr ""
3515
3516 #. type: textblock
3517 #: ../src/guestfs.pod:1765
3518 msgid "The only defined and stable parts of the API are:"
3519 msgstr ""
3520
3521 #. type: textblock
3522 #: ../src/guestfs.pod:1771
3523 msgid ""
3524 "The callback can display to the user some type of progress bar or indicator "
3525 "which shows the ratio of C<position>:C<total>."
3526 msgstr ""
3527
3528 #. type: textblock
3529 #: ../src/guestfs.pod:1776
3530 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3531 msgstr ""
3532
3533 #. type: textblock
3534 #: ../src/guestfs.pod:1780
3535 msgid ""
3536 "If any progress notification is sent during a call, then a final progress "
3537 "notification is always sent when C<position> = C<total> (I<unless> the call "
3538 "fails with an error)."
3539 msgstr ""
3540
3541 #. type: textblock
3542 #: ../src/guestfs.pod:1784
3543 msgid ""
3544 "This is to simplify caller code, so callers can easily set the progress "
3545 "indicator to \"100%\" at the end of the operation, without requiring special "
3546 "code to detect this case."
3547 msgstr ""
3548
3549 #. type: textblock
3550 #: ../src/guestfs.pod:1790
3551 msgid ""
3552 "For some calls we are unable to estimate the progress of the call, but we "
3553 "can still generate progress messages to indicate activity.  This is known as "
3554 "\"pulse mode\", and is directly supported by certain progress bar "
3555 "implementations (eg. GtkProgressBar)."
3556 msgstr ""
3557
3558 #. type: textblock
3559 #: ../src/guestfs.pod:1795
3560 msgid ""
3561 "For these calls, zero or more progress messages are generated with "
3562 "C<position = 0> and C<total = 1>, followed by a final message with "
3563 "C<position = total = 1>."
3564 msgstr ""
3565
3566 #. type: textblock
3567 #: ../src/guestfs.pod:1799
3568 msgid ""
3569 "As noted above, if the call fails with an error then the final message may "
3570 "not be generated."
3571 msgstr ""
3572
3573 #. type: textblock
3574 #: ../src/guestfs.pod:1804
3575 msgid ""
3576 "The callback also receives the procedure number (C<proc_nr>) and serial "
3577 "number (C<serial>) of the call.  These are only useful for debugging "
3578 "protocol issues, and the callback can normally ignore them.  The callback "
3579 "may want to print these numbers in error messages or debugging messages."
3580 msgstr ""
3581
3582 #. type: textblock
3583 #: ../src/guestfs.pod:1810
3584 msgid "If no callback is registered: progress messages are discarded."
3585 msgstr ""
3586
3587 #. type: =item
3588 #: ../src/guestfs.pod:1812
3589 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3590 msgstr ""
3591
3592 #. type: textblock
3593 #: ../src/guestfs.pod:1815
3594 msgid ""
3595 "The callback function is called whenever a log message is generated by qemu, "
3596 "the appliance kernel, guestfsd (daemon), or utility programs."
3597 msgstr ""
3598
3599 #. type: textblock
3600 #: ../src/guestfs.pod:1818
3601 msgid ""
3602 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3603 "guestfs_launch>) then additional debug messages are generated."
3604 msgstr ""
3605
3606 #. type: textblock
3607 #: ../src/guestfs.pod:1821 ../src/guestfs.pod:1835
3608 msgid ""
3609 "If no callback is registered: the messages are discarded unless the verbose "
3610 "flag is set in which case they are sent to stderr.  You can override the "
3611 "printing of verbose messages to stderr by setting up a callback."
3612 msgstr ""
3613
3614 #. type: =item
3615 #: ../src/guestfs.pod:1826
3616 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3617 msgstr ""
3618
3619 #. type: textblock
3620 #: ../src/guestfs.pod:1829
3621 msgid ""
3622 "The callback function is called whenever a log message is generated by the "
3623 "library part of libguestfs."
3624 msgstr ""
3625
3626 #. type: textblock
3627 #: ../src/guestfs.pod:1832
3628 msgid ""
3629 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3630 "messages are generated."
3631 msgstr ""
3632
3633 #. type: =item
3634 #: ../src/guestfs.pod:1840
3635 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3636 msgstr ""
3637
3638 #. type: textblock
3639 #: ../src/guestfs.pod:1843
3640 msgid ""
3641 "The callback function is called whenever a trace message is generated.  This "
3642 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3643 msgstr ""
3644
3645 #. type: textblock
3646 #: ../src/guestfs.pod:1846
3647 msgid ""
3648 "If no callback is registered: the messages are sent to stderr.  You can "
3649 "override the printing of trace messages to stderr by setting up a callback."
3650 msgstr ""
3651
3652 #. type: =head3
3653 #: ../src/guestfs.pod:1852
3654 msgid "guestfs_set_event_callback"
3655 msgstr ""
3656
3657 #. type: verbatim
3658 #: ../src/guestfs.pod:1854
3659 #, no-wrap
3660 msgid ""
3661 " int guestfs_set_event_callback (guestfs_h *g,\n"
3662 "                                 guestfs_event_callback cb,\n"
3663 "                                 uint64_t event_bitmask,\n"
3664 "                                 int flags,\n"
3665 "                                 void *opaque);\n"
3666 "\n"
3667 msgstr ""
3668
3669 #. type: textblock
3670 #: ../src/guestfs.pod:1860
3671 msgid ""
3672 "This function registers a callback (C<cb>) for all event classes in the "
3673 "C<event_bitmask>."
3674 msgstr ""
3675
3676 #. type: textblock
3677 #: ../src/guestfs.pod:1863
3678 msgid ""
3679 "For example, to register for all log message events, you could call this "
3680 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>.  "
3681 "To register a single callback for all possible classes of events, use "
3682 "C<GUESTFS_EVENT_ALL>."
3683 msgstr ""
3684
3685 #. type: textblock
3686 #: ../src/guestfs.pod:1869
3687 msgid "C<flags> should always be passed as 0."
3688 msgstr ""
3689
3690 #. type: textblock
3691 #: ../src/guestfs.pod:1871
3692 msgid ""
3693 "C<opaque> is an opaque pointer which is passed to the callback.  You can use "
3694 "it for any purpose."
3695 msgstr ""
3696
3697 #. type: textblock
3698 #: ../src/guestfs.pod:1874
3699 msgid ""
3700 "The return value is the event handle (an integer) which you can use to "
3701 "delete the callback (see below)."
3702 msgstr ""
3703
3704 #. type: textblock
3705 #: ../src/guestfs.pod:1877
3706 msgid ""
3707 "If there is an error, this function returns C<-1>, and sets the error in the "
3708 "handle in the usual way (see L</guestfs_last_error> etc.)"
3709 msgstr ""
3710
3711 #. type: textblock
3712 #: ../src/guestfs.pod:1880
3713 msgid ""
3714 "Callbacks remain in effect until they are deleted, or until the handle is "
3715 "closed."
3716 msgstr ""
3717
3718 #. type: textblock
3719 #: ../src/guestfs.pod:1883
3720 msgid ""
3721 "In the case where multiple callbacks are registered for a particular event "
3722 "class, all of the callbacks are called.  The order in which multiple "
3723 "callbacks are called is not defined."
3724 msgstr ""
3725
3726 #. type: =head3
3727 #: ../src/guestfs.pod:1887
3728 msgid "guestfs_delete_event_callback"
3729 msgstr ""
3730
3731 #. type: verbatim
3732 #: ../src/guestfs.pod:1889
3733 #, no-wrap
3734 msgid ""
3735 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3736 "\n"
3737 msgstr ""
3738
3739 #. type: textblock
3740 #: ../src/guestfs.pod:1891
3741 msgid ""
3742 "Delete a callback that was previously registered.  C<event_handle> should be "
3743 "the integer that was returned by a previous call to "
3744 "C<guestfs_set_event_callback> on the same handle."
3745 msgstr ""
3746
3747 #. type: =head3
3748 #: ../src/guestfs.pod:1895
3749 msgid "guestfs_event_callback"
3750 msgstr ""
3751
3752 #. type: verbatim
3753 #: ../src/guestfs.pod:1897
3754 #, no-wrap
3755 msgid ""
3756 " typedef void (*guestfs_event_callback) (\n"
3757 "                  guestfs_h *g,\n"
3758 "                  void *opaque,\n"
3759 "                  uint64_t event,\n"
3760 "                  int event_handle,\n"
3761 "                  int flags,\n"
3762 "                  const char *buf, size_t buf_len,\n"
3763 "                  const uint64_t *array, size_t array_len);\n"
3764 "\n"
3765 msgstr ""
3766
3767 #. type: textblock
3768 #: ../src/guestfs.pod:1906
3769 msgid ""
3770 "This is the type of the event callback function that you have to provide."
3771 msgstr ""
3772
3773 #. type: textblock
3774 #: ../src/guestfs.pod:1909
3775 msgid ""
3776 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3777 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3778 "handle, and C<flags> which in the current API you should ignore."
3779 msgstr ""
3780
3781 #. type: textblock
3782 #: ../src/guestfs.pod:1913
3783 msgid ""
3784 "The remaining parameters contain the event payload (if any).  Each event may "
3785 "contain a payload, which usually relates to the event class, but for future "
3786 "proofing your code should be written to handle any payload for any event "
3787 "class."
3788 msgstr ""
3789
3790 #. type: textblock
3791 #: ../src/guestfs.pod:1918
3792 msgid ""
3793 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3794 "there is no message buffer).  Note that this message buffer can contain "
3795 "arbitrary 8 bit data, including NUL bytes."
3796 msgstr ""
3797
3798 #. type: textblock
3799 #: ../src/guestfs.pod:1922
3800 msgid ""
3801 "C<array> and C<array_len> is an array of 64 bit unsigned integers.  At the "
3802 "moment this is only used for progress messages."
3803 msgstr ""
3804
3805 #. type: =head3
3806 #: ../src/guestfs.pod:1925
3807 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3808 msgstr ""
3809
3810 #. type: textblock
3811 #: ../src/guestfs.pod:1927
3812 msgid ""
3813 "One motivation for the generic event API was to allow GUI programs to "
3814 "capture debug and other messages.  In libguestfs E<le> 1.8 these were sent "
3815 "unconditionally to C<stderr>."
3816 msgstr ""
3817
3818 #. type: textblock
3819 #: ../src/guestfs.pod:1931
3820 msgid ""
3821 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3822 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>.  (Note that error "
3823 "messages are not events; you must capture error messages separately)."
3824 msgstr ""
3825
3826 #. type: textblock
3827 #: ../src/guestfs.pod:1936
3828 msgid ""
3829 "Programs have to set up a callback to capture the classes of events of "
3830 "interest:"
3831 msgstr ""
3832
3833 #. type: verbatim
3834 #: ../src/guestfs.pod:1939
3835 #, no-wrap
3836 msgid ""
3837 " int eh =\n"
3838 "   guestfs_set_event_callback\n"
3839 "     (g, message_callback,\n"
3840 "      GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3841 "      GUESTFS_EVENT_TRACE,\n"
3842 "      0, NULL) == -1)\n"
3843 " if (eh == -1) {\n"
3844 "   // handle error in the usual way\n"
3845 " }\n"
3846 "\n"
3847 msgstr ""
3848
3849 #. type: textblock
3850 #: ../src/guestfs.pod:1949
3851 msgid ""
3852 "The callback can then direct messages to the appropriate place.  In this "
3853 "example, messages are directed to syslog:"
3854 msgstr ""
3855
3856 #. type: verbatim
3857 #: ../src/guestfs.pod:1952
3858 #, no-wrap
3859 msgid ""
3860 " static void\n"
3861 " message_callback (\n"
3862 "         guestfs_h *g,\n"
3863 "         void *opaque,\n"
3864 "         uint64_t event,\n"
3865 "         int event_handle,\n"
3866 "         int flags,\n"
3867 "         const char *buf, size_t buf_len,\n"
3868 "         const uint64_t *array, size_t array_len)\n"
3869 " {\n"
3870 "   const int priority = LOG_USER|LOG_INFO;\n"
3871 "   if (buf_len > 0)\n"
3872 "     syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3873 " }\n"
3874 "\n"
3875 msgstr ""
3876
3877 #. type: =head1
3878 #: ../src/guestfs.pod:1967
3879 msgid "PRIVATE DATA AREA"
3880 msgstr ""
3881
3882 #. type: textblock
3883 #: ../src/guestfs.pod:1969
3884 msgid ""
3885 "You can attach named pieces of private data to the libguestfs handle, fetch "
3886 "them by name, and walk over them, for the lifetime of the handle.  This is "
3887 "called the private data area and is only available from the C API."
3888 msgstr ""
3889
3890 #. type: textblock
3891 #: ../src/guestfs.pod:1974
3892 msgid "To attach a named piece of data, use the following call:"
3893 msgstr ""
3894
3895 #. type: verbatim
3896 #: ../src/guestfs.pod:1976
3897 #, no-wrap
3898 msgid ""
3899 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3900 "\n"
3901 msgstr ""
3902
3903 #. type: textblock
3904 #: ../src/guestfs.pod:1978
3905 msgid ""
3906 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3907 "pointer (which can be C<NULL>).  Any previous item with the same name is "
3908 "overwritten."
3909 msgstr ""
3910
3911 #. type: textblock
3912 #: ../src/guestfs.pod:1982
3913 msgid ""
3914 "You can use any C<key> you want, but names beginning with an underscore "
3915 "character are reserved for internal libguestfs purposes (for implementing "
3916 "language bindings).  It is recommended to prefix the name with some unique "
3917 "string to avoid collisions with other users."
3918 msgstr ""
3919
3920 #. type: textblock
3921 #: ../src/guestfs.pod:1987
3922 msgid "To retrieve the pointer, use:"
3923 msgstr ""
3924
3925 #. type: verbatim
3926 #: ../src/guestfs.pod:1989
3927 #, no-wrap
3928 msgid ""
3929 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3930 "\n"
3931 msgstr ""
3932
3933 #. type: textblock
3934 #: ../src/guestfs.pod:1991
3935 msgid ""
3936 "This function returns C<NULL> if either no data is found associated with "
3937 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3938 "C<NULL>."
3939 msgstr ""
3940
3941 #. type: textblock
3942 #: ../src/guestfs.pod:1995
3943 msgid ""
3944 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3945 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
3946 "all.  In particular, libguestfs does I<not> try to free the data when the "
3947 "handle is closed.  If the data must be freed, then the caller must either "
3948 "free it before calling L</guestfs_close> or must set up a close callback to "
3949 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3950 msgstr ""
3951
3952 #. type: textblock
3953 #: ../src/guestfs.pod:2002
3954 msgid "To walk over all entries, use these two functions:"
3955 msgstr ""
3956
3957 #. type: verbatim
3958 #: ../src/guestfs.pod:2004
3959 #, no-wrap
3960 msgid ""
3961 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3962 "\n"
3963 msgstr ""
3964
3965 #. type: verbatim
3966 #: ../src/guestfs.pod:2006
3967 #, no-wrap
3968 msgid ""
3969 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3970 "\n"
3971 msgstr ""
3972
3973 #. type: textblock
3974 #: ../src/guestfs.pod:2008
3975 msgid ""
3976 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3977 "not have any particular meaning -- keys are not returned in any defined "
3978 "order).  A pointer to the key is returned in C<*key_rtn> and the "
3979 "corresponding data pointer is returned from the function.  C<NULL> is "
3980 "returned if there are no keys stored in the handle."
3981 msgstr ""
3982
3983 #. type: textblock
3984 #: ../src/guestfs.pod:2014
3985 msgid ""
3986 "C<guestfs_next_private> returns the next key, pointer pair.  The return "
3987 "value of this function is also C<NULL> is there are no further entries to "
3988 "return."
3989 msgstr ""
3990
3991 #. type: textblock
3992 #: ../src/guestfs.pod:2018
3993 msgid "Notes about walking over entries:"
3994 msgstr ""
3995
3996 #. type: textblock
3997 #: ../src/guestfs.pod:2024
3998 msgid ""
3999 "You must not call C<guestfs_set_private> while walking over the entries."
4000 msgstr ""
4001
4002 #. type: textblock
4003 #: ../src/guestfs.pod:2029
4004 msgid ""
4005 "The handle maintains an internal iterator which is reset when you call "
4006 "C<guestfs_first_private>.  This internal iterator is invalidated when you "
4007 "call C<guestfs_set_private>."
4008 msgstr ""
4009
4010 #. type: textblock
4011 #: ../src/guestfs.pod:2035
4012 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4013 msgstr ""
4014
4015 #. type: verbatim
4016 #: ../src/guestfs.pod:2037
4017 #, no-wrap
4018 msgid ""
4019 " guestfs_set_private (g, key, NULL);\n"
4020 "\n"
4021 msgstr ""
4022
4023 #. type: textblock
4024 #: ../src/guestfs.pod:2039
4025 msgid "then that C<key> is not returned when walking."
4026 msgstr ""
4027
4028 #. type: textblock
4029 #: ../src/guestfs.pod:2043
4030 msgid ""
4031 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4032 "C<guestfs_next_private> or C<guestfs_set_private>."
4033 msgstr ""
4034
4035 #. type: textblock
4036 #: ../src/guestfs.pod:2049
4037 msgid ""
4038 "The following example code shows how to print all keys and data pointers "
4039 "that are associated with the handle C<g>:"
4040 msgstr ""
4041
4042 #. type: verbatim
4043 #: ../src/guestfs.pod:2052
4044 #, no-wrap
4045 msgid ""
4046 " const char *key;\n"
4047 " void *data = guestfs_first_private (g, &key);\n"
4048 " while (data != NULL)\n"
4049 "   {\n"
4050 "     printf (\"key = %s, data = %p\\n\", key, data);\n"
4051 "     data = guestfs_next_private (g, &key);\n"
4052 "   }\n"
4053 "\n"
4054 msgstr ""
4055
4056 #. type: textblock
4057 #: ../src/guestfs.pod:2060
4058 msgid ""
4059 "More commonly you are only interested in keys that begin with an application-"
4060 "specific prefix C<foo_>.  Modify the loop like so:"
4061 msgstr ""
4062
4063 #. type: verbatim
4064 #: ../src/guestfs.pod:2063
4065 #, no-wrap
4066 msgid ""
4067 " const char *key;\n"
4068 " void *data = guestfs_first_private (g, &key);\n"
4069 " while (data != NULL)\n"
4070 "   {\n"
4071 "     if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4072 "       printf (\"key = %s, data = %p\\n\", key, data);\n"
4073 "     data = guestfs_next_private (g, &key);\n"
4074 "   }\n"
4075 "\n"
4076 msgstr ""
4077
4078 #. type: textblock
4079 #: ../src/guestfs.pod:2072
4080 msgid ""
4081 "If you need to modify keys while walking, then you have to jump back to the "
4082 "beginning of the loop.  For example, to delete all keys prefixed with "
4083 "C<foo_>:"
4084 msgstr ""
4085
4086 #. type: verbatim
4087 #: ../src/guestfs.pod:2076
4088 #, no-wrap
4089 msgid ""
4090 "  const char *key;\n"
4091 "  void *data;\n"
4092 " again:\n"
4093 "  data = guestfs_first_private (g, &key);\n"
4094 "  while (data != NULL)\n"
4095 "    {\n"
4096 "      if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4097 "        {\n"
4098 "          guestfs_set_private (g, key, NULL);\n"
4099 "          /* note that 'key' pointer is now invalid, and so is\n"
4100 "             the internal iterator */\n"
4101 "          goto again;\n"
4102 "        }\n"
4103 "      data = guestfs_next_private (g, &key);\n"
4104 "    }\n"
4105 "\n"
4106 msgstr ""
4107
4108 #. type: textblock
4109 #: ../src/guestfs.pod:2092
4110 msgid ""
4111 "Note that the above loop is guaranteed to terminate because the keys are "
4112 "being deleted, but other manipulations of keys within the loop might not "
4113 "terminate unless you also maintain an indication of which keys have been "
4114 "visited."
4115 msgstr ""
4116
4117 #. type: =end
4118 #: ../src/guestfs.pod:2097 ../src/guestfs.pod:2102
4119 msgid "html"
4120 msgstr "html"
4121
4122 #. type: textblock
4123 #: ../src/guestfs.pod:2099
4124 msgid ""
4125 "<!-- old anchor for the next section --> <a name="
4126 "\"state_machine_and_low_level_event_api\"/>"
4127 msgstr ""
4128 "<!-- old anchor for the next section --> <a name="
4129 "\"state_machine_and_low_level_event_api\"/>"
4130
4131 #. type: =head1
4132 #: ../src/guestfs.pod:2104
4133 msgid "ARCHITECTURE"
4134 msgstr "АРХІТЕКТУРА"
4135
4136 #. type: textblock
4137 #: ../src/guestfs.pod:2106
4138 msgid ""
4139 "Internally, libguestfs is implemented by running an appliance (a special "
4140 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
4141 "process of the main program."
4142 msgstr ""
4143
4144 #. type: verbatim
4145 #: ../src/guestfs.pod:2110
4146 #, no-wrap
4147 msgid ""
4148 "  ___________________\n"
4149 " /                   \\\n"
4150 " | main program      |\n"
4151 " |                   |\n"
4152 " |                   |           child process / appliance\n"
4153 " |                   |           __________________________\n"
4154 " |                   |          / qemu                     \\\n"
4155 " +-------------------+   RPC    |      +-----------------+ |\n"
4156 " | libguestfs     <--------------------> guestfsd        | |\n"
4157 " |                   |          |      +-----------------+ |\n"
4158 " \\___________________/          |      | Linux kernel    | |\n"
4159 "                                |      +--^--------------+ |\n"
4160 "                                \\_________|________________/\n"
4161 "                                          |\n"
4162 "                                   _______v______\n"
4163 "                                  /              \\\n"
4164 "                                  | Device or    |\n"
4165 "                                  | disk image   |\n"
4166 "                                  \\______________/\n"
4167 "\n"
4168 msgstr ""
4169
4170 #. type: textblock
4171 #: ../src/guestfs.pod:2130
4172 msgid ""
4173 "The library, linked to the main program, creates the child process and hence "
4174 "the appliance in the L</guestfs_launch> function."
4175 msgstr ""
4176
4177 #. type: textblock
4178 #: ../src/guestfs.pod:2133
4179 msgid ""
4180 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4181 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4182 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
4183 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
4184 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
4185 "attached to the qemu process which translates device access by the "
4186 "appliance's Linux kernel into accesses to the image."
4187 msgstr ""
4188
4189 #. type: textblock
4190 #: ../src/guestfs.pod:2142
4191 msgid ""
4192 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
4193 "Although the disk image you are attached to might also be used by some "
4194 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
4195 "care if both libguestfs's qemu process and your virtual machine are trying "
4196 "to update the disk image at the same time, since these usually results in "
4197 "massive disk corruption)."
4198 msgstr ""
4199
4200 #. type: =head1
4201 #: ../src/guestfs.pod:2149
4202 msgid "STATE MACHINE"
4203 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4204
4205 #. type: textblock
4206 #: ../src/guestfs.pod:2151
4207 msgid "libguestfs uses a state machine to model the child process:"
4208 msgstr ""
4209
4210 #. type: verbatim
4211 #: ../src/guestfs.pod:2153
4212 #, no-wrap
4213 msgid ""
4214 "                         |\n"
4215 "                    guestfs_create\n"
4216 "                         |\n"
4217 "                         |\n"
4218 "                     ____V_____\n"
4219 "                    /          \\\n"
4220 "                    |  CONFIG  |\n"
4221 "                    \\__________/\n"
4222 "                     ^ ^   ^  \\\n"
4223 "                    /  |    \\  \\ guestfs_launch\n"
4224 "                   /   |    _\\__V______\n"
4225 "                  /    |   /           \\\n"
4226 "                 /     |   | LAUNCHING |\n"
4227 "                /      |   \\___________/\n"
4228 "               /       |       /\n"
4229 "              /        |  guestfs_launch\n"
4230 "             /         |     /\n"
4231 "    ______  /        __|____V\n"
4232 "   /      \\ ------> /        \\\n"
4233 "   | BUSY |         | READY  |\n"
4234 "   \\______/ <------ \\________/\n"
4235 "\n"
4236 msgstr ""
4237
4238 #. type: textblock
4239 #: ../src/guestfs.pod:2175
4240 msgid ""
4241 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4242 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4243 "(3) alternating between READY and BUSY as commands are issued to, and "
4244 "carried out by, the child process."
4245 msgstr ""
4246
4247 #. type: textblock
4248 #: ../src/guestfs.pod:2180
4249 msgid ""
4250 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4251 "asynchronously at any time (eg. due to some internal error), and that causes "
4252 "the state to transition back to CONFIG."
4253 msgstr ""
4254
4255 #. type: textblock
4256 #: ../src/guestfs.pod:2184
4257 msgid ""
4258 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4259 "issued when in the CONFIG state."
4260 msgstr ""
4261
4262 #. type: textblock
4263 #: ../src/guestfs.pod:2187
4264 msgid ""
4265 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
4266 "L</guestfs_launch> blocks until the child process is READY to accept "
4267 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
4268 "moves the state from CONFIG to LAUNCHING while it is running."
4269 msgstr ""
4270
4271 #. type: textblock
4272 #: ../src/guestfs.pod:2193
4273 msgid ""
4274 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4275 "state.  These API calls block waiting for the command to be carried out (ie. "
4276 "the state to transition to BUSY and then back to READY).  There are no non-"
4277 "blocking versions, and no way to issue more than one command per handle at "
4278 "the same time."
4279 msgstr ""
4280
4281 #. type: textblock
4282 #: ../src/guestfs.pod:2199
4283 msgid ""
4284 "Finally, the child process sends asynchronous messages back to the main "
4285 "program, such as kernel log messages.  You can register a callback to "
4286 "receive these messages."
4287 msgstr ""
4288
4289 #. type: =head1
4290 #: ../src/guestfs.pod:2203
4291 msgid "INTERNALS"
4292 msgstr ""
4293
4294 #. type: =head2
4295 #: ../src/guestfs.pod:2205
4296 msgid "COMMUNICATION PROTOCOL"
4297 msgstr ""
4298
4299 #. type: textblock
4300 #: ../src/guestfs.pod:2207
4301 msgid ""
4302 "Don't rely on using this protocol directly.  This section documents how it "
4303 "currently works, but it may change at any time."
4304 msgstr ""
4305
4306 #. type: textblock
4307 #: ../src/guestfs.pod:2210
4308 msgid ""
4309 "The protocol used to talk between the library and the daemon running inside "
4310 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4311 "1014, RFC 1832, RFC 4506)."
4312 msgstr ""
4313
4314 #. type: textblock
4315 #: ../src/guestfs.pod:2214
4316 msgid ""
4317 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4318 "this file is automatically generated)."
4319 msgstr ""
4320
4321 #. type: textblock
4322 #: ../src/guestfs.pod:2217
4323 msgid ""
4324 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4325 "and C<FileOut> parameters, which are handled with very simple request/reply "
4326 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
4327 "parameters, which use the same request and reply messages, but they may also "
4328 "be followed by files sent using a chunked encoding."
4329 msgstr ""
4330
4331 #. type: =head3
4332 #: ../src/guestfs.pod:2224
4333 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4334 msgstr ""
4335
4336 #. type: textblock
4337 #: ../src/guestfs.pod:2226
4338 msgid "For ordinary functions, the request message is:"
4339 msgstr ""
4340
4341 #. type: verbatim
4342 #: ../src/guestfs.pod:2228
4343 #, no-wrap
4344 msgid ""
4345 " total length (header + arguments,\n"
4346 "      but not including the length word itself)\n"
4347 " struct guestfs_message_header (encoded as XDR)\n"
4348 " struct guestfs_<foo>_args (encoded as XDR)\n"
4349 "\n"
4350 msgstr ""
4351
4352 #. type: textblock
4353 #: ../src/guestfs.pod:2233
4354 msgid ""
4355 "The total length field allows the daemon to allocate a fixed size buffer "
4356 "into which it slurps the rest of the message.  As a result, the total length "
4357 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4358 "effective size of any request is limited to somewhere under this size."
4359 msgstr ""
4360
4361 #. type: textblock
4362 #: ../src/guestfs.pod:2239
4363 msgid ""
4364 "Note also that many functions don't take any arguments, in which case the "
4365 "C<guestfs_I<foo>_args> is completely omitted."
4366 msgstr ""
4367
4368 #. type: textblock
4369 #: ../src/guestfs.pod:2242
4370 msgid ""
4371 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4372 "receiver knows what type of args structure to expect, or none at all."
4373 msgstr ""
4374
4375 #. type: textblock
4376 #: ../src/guestfs.pod:2246
4377 msgid ""
4378 "For functions that take optional arguments, the optional arguments are "
4379 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4380 "arguments.  A bitmask in the header indicates which optional arguments are "
4381 "meaningful.  The bitmask is also checked to see if it contains bits set "
4382 "which the daemon does not know about (eg. if more optional arguments were "
4383 "added in a later version of the library), and this causes the call to be "
4384 "rejected."
4385 msgstr ""
4386
4387 #. type: textblock
4388 #: ../src/guestfs.pod:2254
4389 msgid "The reply message for ordinary functions is:"
4390 msgstr ""
4391
4392 #. type: verbatim
4393 #: ../src/guestfs.pod:2256
4394 #, no-wrap
4395 msgid ""
4396 " total length (header + ret,\n"
4397 "      but not including the length word itself)\n"
4398 " struct guestfs_message_header (encoded as XDR)\n"
4399 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4400 "\n"
4401 msgstr ""
4402
4403 #. type: textblock
4404 #: ../src/guestfs.pod:2261
4405 msgid ""
4406 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4407 "functions that return no formal return values."
4408 msgstr ""
4409
4410 #. type: textblock
4411 #: ../src/guestfs.pod:2264
4412 msgid ""
4413 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4414 msgstr ""
4415
4416 #. type: textblock
4417 #: ../src/guestfs.pod:2267
4418 msgid ""
4419 "In the case of an error, a flag is set in the header, and the reply message "
4420 "is slightly changed:"
4421 msgstr ""
4422
4423 #. type: verbatim
4424 #: ../src/guestfs.pod:2270
4425 #, no-wrap
4426 msgid ""
4427 " total length (header + error,\n"
4428 "      but not including the length word itself)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_message_error (encoded as XDR)\n"
4431 "\n"
4432 msgstr ""
4433
4434 #. type: textblock
4435 #: ../src/guestfs.pod:2275
4436 msgid ""
4437 "The C<guestfs_message_error> structure contains the error message as a "
4438 "string."
4439 msgstr ""
4440
4441 #. type: =head3
4442 #: ../src/guestfs.pod:2278
4443 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4444 msgstr ""
4445
4446 #. type: textblock
4447 #: ../src/guestfs.pod:2280
4448 msgid ""
4449 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
4450 "The normal request message is sent (see above).  However this is followed by "
4451 "a sequence of file chunks."
4452 msgstr ""
4453
4454 #. type: verbatim
4455 #: ../src/guestfs.pod:2284
4456 #, no-wrap
4457 msgid ""
4458 " total length (header + arguments,\n"
4459 "      but not including the length word itself,\n"
4460 "      and not including the chunks)\n"
4461 " struct guestfs_message_header (encoded as XDR)\n"
4462 " struct guestfs_<foo>_args (encoded as XDR)\n"
4463 " sequence of chunks for FileIn param #0\n"
4464 " sequence of chunks for FileIn param #1 etc.\n"
4465 "\n"
4466 msgstr ""
4467
4468 #. type: textblock
4469 #: ../src/guestfs.pod:2292
4470 msgid "The \"sequence of chunks\" is:"
4471 msgstr ""
4472
4473 #. type: verbatim
4474 #: ../src/guestfs.pod:2294
4475 #, no-wrap
4476 msgid ""
4477 " length of chunk (not including length word itself)\n"
4478 " struct guestfs_chunk (encoded as XDR)\n"
4479 " length of chunk\n"
4480 " struct guestfs_chunk (encoded as XDR)\n"
4481 "   ...\n"
4482 " length of chunk\n"
4483 " struct guestfs_chunk (with data.data_len == 0)\n"
4484 "\n"
4485 msgstr ""
4486
4487 #. type: textblock
4488 #: ../src/guestfs.pod:2302
4489 msgid ""
4490 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
4491 "is set in the final chunk to indicate either successful completion or early "
4492 "cancellation."
4493 msgstr ""
4494
4495 #. type: textblock
4496 #: ../src/guestfs.pod:2306
4497 msgid ""
4498 "At time of writing there are no functions that have more than one FileIn "
4499 "parameter.  However this is (theoretically) supported, by sending the "
4500 "sequence of chunks for each FileIn parameter one after another (from left to "
4501 "right)."
4502 msgstr ""
4503
4504 #. type: textblock
4505 #: ../src/guestfs.pod:2311
4506 msgid ""
4507 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4508 "transfer.  The library does this by sending a chunk with a special flag set "
4509 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
4510 "RPC, does I<not> send any reply, and goes back to reading the next request."
4511 msgstr ""
4512
4513 #. type: textblock
4514 #: ../src/guestfs.pod:2317
4515 msgid ""
4516 "The daemon may also cancel.  It does this by writing a special word "
4517 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
4518 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4519 "cancel chunk).  The special word is chosen so that even if cancellation "
4520 "happens right at the end of the transfer (after the library has finished "
4521 "writing and has started listening for the reply), the \"spurious\" cancel "
4522 "flag will not be confused with the reply message."
4523 msgstr ""
4524
4525 #. type: textblock
4526 #: ../src/guestfs.pod:2326
4527 msgid ""
4528 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4529 "limit), and also files where the size is not known in advance (eg. from "
4530 "pipes or sockets).  However the chunks are rather small "
4531 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4532 "to keep much in memory."
4533 msgstr ""
4534
4535 #. type: =head3
4536 #: ../src/guestfs.pod:2332
4537 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4538 msgstr ""
4539
4540 #. type: textblock
4541 #: ../src/guestfs.pod:2334
4542 msgid ""
4543 "The protocol for FileOut parameters is exactly the same as for FileIn "
4544 "parameters, but with the roles of daemon and library reversed."
4545 msgstr ""
4546
4547 #. type: verbatim
4548 #: ../src/guestfs.pod:2337
4549 #, no-wrap
4550 msgid ""
4551 " total length (header + ret,\n"
4552 "      but not including the length word itself,\n"
4553 "      and not including the chunks)\n"
4554 " struct guestfs_message_header (encoded as XDR)\n"
4555 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4556 " sequence of chunks for FileOut param #0\n"
4557 " sequence of chunks for FileOut param #1 etc.\n"
4558 "\n"
4559 msgstr ""
4560
4561 #. type: =head3
4562 #: ../src/guestfs.pod:2345
4563 msgid "INITIAL MESSAGE"
4564 msgstr ""
4565
4566 #. type: textblock
4567 #: ../src/guestfs.pod:2347
4568 msgid ""
4569 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4570 "which indicates that the guest and daemon is alive.  This is what L</"
4571 "guestfs_launch> waits for."
4572 msgstr ""
4573
4574 #. type: =head3
4575 #: ../src/guestfs.pod:2351
4576 msgid "PROGRESS NOTIFICATION MESSAGES"
4577 msgstr ""
4578
4579 #. type: textblock
4580 #: ../src/guestfs.pod:2353
4581 msgid ""
4582 "The daemon may send progress notification messages at any time.  These are "
4583 "distinguished by the normal length word being replaced by "
4584 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4585 msgstr ""
4586
4587 #. type: textblock
4588 #: ../src/guestfs.pod:2357
4589 msgid ""
4590 "The library turns them into progress callbacks (see L</"
4591 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4592 "if not."
4593 msgstr ""
4594
4595 #. type: textblock
4596 #: ../src/guestfs.pod:2361
4597 msgid ""
4598 "The daemon self-limits the frequency of progress messages it sends (see "
4599 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
4600 "messages."
4601 msgstr ""
4602
4603 #. type: =head1
4604 #: ../src/guestfs.pod:2365
4605 msgid "LIBGUESTFS VERSION NUMBERS"
4606 msgstr ""
4607
4608 #. type: textblock
4609 #: ../src/guestfs.pod:2367
4610 msgid ""
4611 "Since April 2010, libguestfs has started to make separate development and "
4612 "stable releases, along with corresponding branches in our git repository.  "
4613 "These separate releases can be identified by version number:"
4614 msgstr ""
4615
4616 #. type: verbatim
4617 #: ../src/guestfs.pod:2372
4618 #, no-wrap
4619 msgid ""
4620 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
4621 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4622 "       |\n"
4623 "       v\n"
4624 " 1  .  3  .  5\n"
4625 " ^           ^\n"
4626 " |           |\n"
4627 " |           `-------- sub-version\n"
4628 " |\n"
4629 " `------ always '1' because we don't change the ABI\n"
4630 "\n"
4631 msgstr ""
4632
4633 #. type: textblock
4634 #: ../src/guestfs.pod:2383
4635 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4636 msgstr ""
4637
4638 #. type: textblock
4639 #: ../src/guestfs.pod:2385
4640 msgid ""
4641 "As time passes we cherry pick fixes from the development branch and backport "
4642 "those into the stable branch, the effect being that the stable branch should "
4643 "get more stable and less buggy over time.  So the stable releases are ideal "
4644 "for people who don't need new features but would just like the software to "
4645 "work."
4646 msgstr ""
4647
4648 #. type: textblock
4649 #: ../src/guestfs.pod:2391
4650 msgid "Our criteria for backporting changes are:"
4651 msgstr ""
4652
4653 #. type: textblock
4654 #: ../src/guestfs.pod:2397
4655 msgid ""
4656 "Documentation changes which don't affect any code are backported unless the "
4657 "documentation refers to a future feature which is not in stable."
4658 msgstr ""
4659
4660 #. type: textblock
4661 #: ../src/guestfs.pod:2403
4662 msgid ""
4663 "Bug fixes which are not controversial, fix obvious problems, and have been "
4664 "well tested are backported."
4665 msgstr ""
4666
4667 #. type: textblock
4668 #: ../src/guestfs.pod:2408
4669 msgid ""
4670 "Simple rearrangements of code which shouldn't affect how it works get "
4671 "backported.  This is so that the code in the two branches doesn't get too "
4672 "far out of step, allowing us to backport future fixes more easily."
4673 msgstr ""
4674
4675 #. type: textblock
4676 #: ../src/guestfs.pod:2414
4677 msgid ""
4678 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4679 "exceptional case: the new feature is required in order to implement an "
4680 "important bug fix."
4681 msgstr ""
4682
4683 #. type: textblock
4684 #: ../src/guestfs.pod:2420
4685 msgid ""
4686 "A new stable branch starts when we think the new features in development are "
4687 "substantial and compelling enough over the current stable branch to warrant "
4688 "it.  When that happens we create new stable and development versions 1.N.0 "
4689 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
4690 "stable at this point, but by backporting fixes from development, that branch "
4691 "will stabilize over time."
4692 msgstr ""
4693
4694 #. type: =head1
4695 #: ../src/guestfs.pod:2428
4696 msgid "EXTENDING LIBGUESTFS"
4697 msgstr ""
4698
4699 #. type: =head2
4700 #: ../src/guestfs.pod:2430
4701 msgid "ADDING A NEW API ACTION"
4702 msgstr ""
4703
4704 #. type: textblock
4705 #: ../src/guestfs.pod:2432
4706 msgid ""
4707 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4708 "documentation) are generated, and this makes it easy to extend the "
4709 "libguestfs API."
4710 msgstr ""
4711
4712 #. type: textblock
4713 #: ../src/guestfs.pod:2436
4714 msgid "To add a new API action there are two changes:"
4715 msgstr ""
4716
4717 #. type: textblock
4718 #: ../src/guestfs.pod:2442
4719 msgid ""
4720 "You need to add a description of the call (name, parameters, return type, "
4721 "tests, documentation) to C<generator/generator_actions.ml>."
4722 msgstr ""
4723
4724 #. type: textblock
4725 #: ../src/guestfs.pod:2445
4726 msgid ""
4727 "There are two sorts of API action, depending on whether the call goes "
4728 "through to the daemon in the appliance, or is serviced entirely by the "
4729 "library (see L</ARCHITECTURE> above).  L</guestfs_sync> is an example of the "
4730 "former, since the sync is done in the appliance.  L</guestfs_set_trace> is "
4731 "an example of the latter, since a trace flag is maintained in the handle and "
4732 "all tracing is done on the library side."
4733 msgstr ""
4734
4735 #. type: textblock
4736 #: ../src/guestfs.pod:2453
4737 msgid ""
4738 "Most new actions are of the first type, and get added to the "
4739 "C<daemon_functions> list.  Each function has a unique procedure number used "
4740 "in the RPC protocol which is assigned to that action when we publish "
4741 "libguestfs and cannot be reused.  Take the latest procedure number and "
4742 "increment it."
4743 msgstr ""
4744
4745 #. type: textblock
4746 #: ../src/guestfs.pod:2459
4747 msgid ""
4748 "For library-only actions of the second type, add to the "
4749 "C<non_daemon_functions> list.  Since these functions are serviced by the "
4750 "library and do not travel over the RPC mechanism to the daemon, these "
4751 "functions do not need a procedure number, and so the procedure number is set "
4752 "to C<-1>."
4753 msgstr ""
4754
4755 #. type: textblock
4756 #: ../src/guestfs.pod:2467
4757 msgid "Implement the action (in C):"
4758 msgstr ""
4759
4760 #. type: textblock
4761 #: ../src/guestfs.pod:2469
4762 msgid ""
4763 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4764 "C<daemon/> directory."
4765 msgstr ""
4766
4767 #. type: textblock
4768 #: ../src/guestfs.pod:2472
4769 msgid ""
4770 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4771 "(note: double underscore) in the C<src/> directory."
4772 msgstr ""
4773
4774 #. type: textblock
4775 #: ../src/guestfs.pod:2475
4776 msgid "In either case, use another function as an example of what to do."
4777 msgstr ""
4778
4779 #. type: textblock
4780 #: ../src/guestfs.pod:2479
4781 msgid "After making these changes, use C<make> to compile."
4782 msgstr ""
4783
4784 #. type: textblock
4785 #: ../src/guestfs.pod:2481
4786 msgid ""
4787 "Note that you don't need to implement the RPC, language bindings, manual "
4788 "pages or anything else.  It's all automatically generated from the OCaml "
4789 "description."
4790 msgstr ""
4791
4792 #. type: =head2
4793 #: ../src/guestfs.pod:2485
4794 msgid "ADDING TESTS FOR AN API ACTION"
4795 msgstr ""
4796
4797 #. type: textblock
4798 #: ../src/guestfs.pod:2487
4799 msgid ""
4800 "You can supply zero or as many tests as you want per API call.  The tests "
4801 "can either be added as part of the API description (C<generator/"
4802 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4803 "into C<regressions/>.  Note that adding a script to C<regressions/> is "
4804 "slower, so if possible use the first method."
4805 msgstr ""
4806
4807 #. type: textblock
4808 #: ../src/guestfs.pod:2493
4809 msgid ""
4810 "The following describes the test environment used when you add an API test "
4811 "in C<generator_actions.ml>."
4812 msgstr ""
4813
4814 #. type: textblock
4815 #: ../src/guestfs.pod:2496
4816 msgid "The test environment has 4 block devices:"
4817 msgstr ""
4818
4819 #. type: =item
4820 #: ../src/guestfs.pod:2500
4821 msgid "C</dev/sda> 500MB"
4822 msgstr ""
4823
4824 #. type: textblock
4825 #: ../src/guestfs.pod:2502
4826 msgid "General block device for testing."
4827 msgstr ""
4828
4829 #. type: =item
4830 #: ../src/guestfs.pod:2504
4831 msgid "C</dev/sdb> 50MB"
4832 msgstr ""
4833
4834 #. type: textblock
4835 #: ../src/guestfs.pod:2506
4836 msgid ""
4837 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4838 "operations."
4839 msgstr ""
4840
4841 #. type: =item
4842 #: ../src/guestfs.pod:2509
4843 msgid "C</dev/sdc> 10MB"
4844 msgstr ""
4845
4846 #. type: textblock
4847 #: ../src/guestfs.pod:2511
4848 msgid "Used in a few tests where two block devices are needed."
4849 msgstr ""
4850
4851 #. type: =item
4852 #: ../src/guestfs.pod:2513
4853 msgid "C</dev/sdd>"
4854 msgstr "C</dev/sdd>"
4855
4856 #. type: textblock
4857 #: ../src/guestfs.pod:2515
4858 msgid "ISO with fixed content (see C<images/test.iso>)."
4859 msgstr ""
4860
4861 #. type: textblock
4862 #: ../src/guestfs.pod:2519
4863 msgid ""
4864 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4865 "appliance and block devices are reused between tests.  So don't try testing "
4866 "L</guestfs_kill_subprocess> :-x"
4867 msgstr ""
4868
4869 #. type: textblock
4870 #: ../src/guestfs.pod:2523
4871 msgid ""
4872 "Each test starts with an initial scenario, selected using one of the "
4873 "C<Init*> expressions, described in C<generator/generator_types.ml>.  These "
4874 "initialize the disks mentioned above in a particular way as documented in "
4875 "C<generator_types.ml>.  You should not assume anything about the previous "
4876 "contents of other disks that are not initialized."
4877 msgstr ""
4878
4879 #. type: textblock
4880 #: ../src/guestfs.pod:2529
4881 msgid ""
4882 "You can add a prerequisite clause to any individual test.  This is a run-"
4883 "time check, which, if it fails, causes