Version 1.11.17.
[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-07-14 14:07+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-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../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-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
41 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
42 #: ../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-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
97 #: ../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 file descriptor 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:1064
858 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
859 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
860 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
861 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
862 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
863 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
864 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
865 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
866 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
867 #: ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980
868 #: ../src/guestfs.pod:2984 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
870 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
871 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1660
872 #: ../src/guestfs-actions.pod:1664 ../src/guestfs-actions.pod:1668
873 #: ../src/guestfs-actions.pod:1672 ../src/guestfs-actions.pod:1680
874 #: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1688
875 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1702
876 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1844
877 #: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1853
878 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1919
879 #: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1928
880 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2852
881 #: ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2867
882 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish.pod:445
883 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
884 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
885 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
886 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
887 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099
888 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
889 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119
890 #: ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127
891 #: ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141
892 #: ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235
893 #: ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244
894 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291
895 #: ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300
896 #: ../fish/guestfish-actions.pod:1927 ../fish/guestfish-actions.pod:1933
897 #: ../fish/guestfish-actions.pod:1941 ../fish/guestfish-actions.pod:1948
898 #: ../fish/guestfish-actions.pod:1955 ../tools/virt-win-reg.pl:195
899 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
900 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
901 #: ../tools/virt-win-reg.pl:720
902 msgid "*"
903 msgstr ""
904
905 #. type: textblock
906 #: ../src/guestfs.pod:390
907 msgid ""
908 "The kernel version that the command runs under will be different from what "
909 "it expects."
910 msgstr ""
911
912 #. type: textblock
913 #: ../src/guestfs.pod:395
914 msgid ""
915 "If the command needs to communicate with daemons, then most likely they "
916 "won't be running."
917 msgstr ""
918
919 #. type: textblock
920 #: ../src/guestfs.pod:400
921 msgid "The command will be running in limited memory."
922 msgstr ""
923
924 #. type: textblock
925 #: ../src/guestfs.pod:404
926 msgid ""
927 "The network may not be available unless you enable it (see L</"
928 "guestfs_set_network>)."
929 msgstr ""
930
931 #. type: textblock
932 #: ../src/guestfs.pod:409
933 msgid "Only supports Linux guests (not Windows, BSD, etc)."
934 msgstr ""
935
936 #. type: textblock
937 #: ../src/guestfs.pod:413
938 msgid ""
939 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
940 msgstr ""
941
942 #. type: textblock
943 #: ../src/guestfs.pod:418
944 msgid ""
945 "For SELinux guests, you may need to enable SELinux and load policy first.  "
946 "See L</SELINUX> in this manpage."
947 msgstr ""
948
949 #. type: textblock
950 #: ../src/guestfs.pod:423
951 msgid ""
952 "I<Security:> It is not safe to run commands from untrusted, possibly "
953 "malicious guests.  These commands may attempt to exploit your program by "
954 "sending unexpected output.  They could also try to exploit the Linux kernel "
955 "or qemu provided by the libguestfs appliance.  They could use the network "
956 "provided by the libguestfs appliance to bypass ordinary network partitions "
957 "and firewalls.  They could use the elevated privileges or different SELinux "
958 "context of your program to their advantage."
959 msgstr ""
960
961 #. type: textblock
962 #: ../src/guestfs.pod:432
963 msgid ""
964 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
965 "(a script which runs when the guest next boots normally), and to have this "
966 "script run the commands you want in the normal context of the running guest, "
967 "network security and so on.  For information about other security issues, "
968 "see L</SECURITY>."
969 msgstr ""
970
971 #. type: textblock
972 #: ../src/guestfs.pod:440
973 msgid ""
974 "The two main API calls to run commands are L</guestfs_command> and L</"
975 "guestfs_sh> (there are also variations)."
976 msgstr ""
977
978 #. type: textblock
979 #: ../src/guestfs.pod:443
980 msgid ""
981 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
982 "shell globs, redirections, etc will work."
983 msgstr ""
984
985 #. type: =head2
986 #: ../src/guestfs.pod:446
987 msgid "CONFIGURATION FILES"
988 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
989
990 #. type: textblock
991 #: ../src/guestfs.pod:448
992 msgid ""
993 "To read and write configuration files in Linux guest filesystems, we "
994 "strongly recommend using Augeas.  For example, Augeas understands how to "
995 "read and write, say, a Linux shadow password file or X.org configuration "
996 "file, and so avoids you having to write that code."
997 msgstr ""
998
999 #. type: textblock
1000 #: ../src/guestfs.pod:453
1001 msgid ""
1002 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
1003 "document Augeas itself here because there is excellent documentation on the "
1004 "L<http://augeas.net/> website."
1005 msgstr ""
1006
1007 #. type: textblock
1008 #: ../src/guestfs.pod:457
1009 msgid ""
1010 "If you don't want to use Augeas (you fool!) then try calling L</"
1011 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1012 "over."
1013 msgstr ""
1014
1015 #. type: =head2
1016 #: ../src/guestfs.pod:461
1017 msgid "SELINUX"
1018 msgstr "SELINUX"
1019
1020 #. type: textblock
1021 #: ../src/guestfs.pod:463
1022 msgid ""
1023 "We support SELinux guests.  To ensure that labeling happens correctly in "
1024 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1025 msgstr ""
1026
1027 #. type: =item
1028 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1029 #: ../src/guestfs.pod:2426
1030 msgid "1."
1031 msgstr ""
1032
1033 #. type: textblock
1034 #: ../src/guestfs.pod:471
1035 msgid "Before launching, do:"
1036 msgstr ""
1037
1038 #. type: verbatim
1039 #: ../src/guestfs.pod:473
1040 #, no-wrap
1041 msgid ""
1042 " guestfs_set_selinux (g, 1);\n"
1043 "\n"
1044 msgstr ""
1045
1046 #. type: =item
1047 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1048 #: ../src/guestfs.pod:2451
1049 msgid "2."
1050 msgstr ""
1051
1052 #. type: textblock
1053 #: ../src/guestfs.pod:477
1054 msgid ""
1055 "After mounting the guest's filesystem(s), load the policy.  This is best "
1056 "done by running the L<load_policy(8)> command in the guest itself:"
1057 msgstr ""
1058
1059 #. type: verbatim
1060 #: ../src/guestfs.pod:481
1061 #, no-wrap
1062 msgid ""
1063 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1064 "\n"
1065 msgstr ""
1066
1067 #. type: textblock
1068 #: ../src/guestfs.pod:483
1069 msgid ""
1070 "(Older versions of C<load_policy> require you to specify the name of the "
1071 "policy file)."
1072 msgstr ""
1073
1074 #. type: =item
1075 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1076 msgid "3."
1077 msgstr ""
1078
1079 #. type: textblock
1080 #: ../src/guestfs.pod:488
1081 msgid ""
1082 "Optionally, set the security context for the API.  The correct security "
1083 "context to use can only be known by inspecting the guest.  As an example:"
1084 msgstr ""
1085
1086 #. type: verbatim
1087 #: ../src/guestfs.pod:492
1088 #, no-wrap
1089 msgid ""
1090 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1091 "\n"
1092 msgstr ""
1093
1094 #. type: textblock
1095 #: ../src/guestfs.pod:496
1096 msgid "This will work for running commands and editing existing files."
1097 msgstr ""
1098
1099 #. type: textblock
1100 #: ../src/guestfs.pod:498
1101 msgid ""
1102 "When new files are created, you may need to label them explicitly, for "
1103 "example by running the external command C<restorecon pathname>."
1104 msgstr ""
1105
1106 #. type: =head2
1107 #: ../src/guestfs.pod:502
1108 msgid "UMASK"
1109 msgstr ""
1110
1111 #. type: textblock
1112 #: ../src/guestfs.pod:504
1113 msgid ""
1114 "Certain calls are affected by the current file mode creation mask (the "
1115 "\"umask\").  In particular ones which create files or directories, such as "
1116 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
1117 "either the default mode that the file is created with or modifies the mode "
1118 "that you supply."
1119 msgstr ""
1120
1121 #. type: textblock
1122 #: ../src/guestfs.pod:510
1123 msgid ""
1124 "The default umask is C<022>, so files are created with modes such as C<0644> "
1125 "and directories with C<0755>."
1126 msgstr ""
1127
1128 #. type: textblock
1129 #: ../src/guestfs.pod:513
1130 msgid ""
1131 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
1132 "(call C<guestfs_umask (g, 0)> early after launching).  Or call L</"
1133 "guestfs_chmod> after creating each file or directory."
1134 msgstr ""
1135
1136 #. type: textblock
1137 #: ../src/guestfs.pod:517
1138 msgid "For more information about umask, see L<umask(2)>."
1139 msgstr ""
1140
1141 #. type: =head1
1142 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1143 msgid "ENCRYPTED DISKS"
1144 msgstr ""
1145
1146 #. type: textblock
1147 #: ../src/guestfs.pod:521
1148 msgid ""
1149 "Libguestfs allows you to access Linux guests which have been encrypted using "
1150 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1151 "standard.  This includes nearly all whole disk encryption systems used by "
1152 "modern Linux guests."
1153 msgstr ""
1154
1155 #. type: textblock
1156 #: ../src/guestfs.pod:527
1157 msgid ""
1158 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1159 "returns the string C<crypto_LUKS>)."
1160 msgstr ""
1161
1162 #. type: textblock
1163 #: ../src/guestfs.pod:530
1164 msgid ""
1165 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
1166 "will require the passphrase!"
1167 msgstr ""
1168
1169 #. type: textblock
1170 #: ../src/guestfs.pod:533
1171 msgid ""
1172 "Opening a LUKS device creates a new device mapper device called C</dev/"
1173 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1174 "guestfs_luks_open>).  Reads and writes to this mapper device are decrypted "
1175 "from and encrypted to the underlying block device respectively."
1176 msgstr ""
1177
1178 #. type: textblock
1179 #: ../src/guestfs.pod:539
1180 msgid ""
1181 "LVM volume groups on the device can be made visible by calling L</"
1182 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical volume"
1183 "(s) can now be mounted in the usual way."
1184 msgstr ""
1185
1186 #. type: textblock
1187 #: ../src/guestfs.pod:543
1188 msgid ""
1189 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
1190 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1191 "[\"/dev/VG\"])>.  Then close the mapper device by calling L</"
1192 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1193 "underlying encrypted block device)."
1194 msgstr ""
1195
1196 #. type: =head2
1197 #: ../src/guestfs.pod:550
1198 msgid "INSPECTION"
1199 msgstr "ПЕРЕВІРКА"
1200
1201 #. type: textblock
1202 #: ../src/guestfs.pod:552
1203 msgid ""
1204 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1205 "contains operating systems, an install CD or a live CD.  (These APIs used to "
1206 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1207 "version 1.5.3 the most frequently used part of this library has been "
1208 "rewritten in C and moved into the core code)."
1209 msgstr ""
1210
1211 #. type: textblock
1212 #: ../src/guestfs.pod:559
1213 msgid ""
1214 "Add all disks belonging to the unknown virtual machine and call L</"
1215 "guestfs_launch> in the usual way."
1216 msgstr ""
1217
1218 #. type: textblock
1219 #: ../src/guestfs.pod:562
1220 msgid ""
1221 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
1222 "and certain heuristics, and returns a list of operating systems that were "
1223 "found.  An empty list means none were found.  A single element is the root "
1224 "filesystem of the operating system.  For dual- or multi-boot guests, "
1225 "multiple roots can be returned, each one corresponding to a separate "
1226 "operating system.  (Multi-boot virtual machines are extremely rare in the "
1227 "world of virtualization, but since this scenario can happen, we have built "
1228 "libguestfs to deal with it.)"
1229 msgstr ""
1230
1231 #. type: textblock
1232 #: ../src/guestfs.pod:571
1233 msgid ""
1234 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1235 "to get additional details about that operating system.  For example, call L</"
1236 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1237 "Windows and Linux-based operating systems respectively."
1238 msgstr ""
1239
1240 #. type: textblock
1241 #: ../src/guestfs.pod:577
1242 msgid ""
1243 "Un*x-like and Linux-based operating systems usually consist of several "
1244 "filesystems which are mounted at boot time (for example, a separate boot "
1245 "partition mounted on C</boot>).  The inspection rules are able to detect how "
1246 "filesystems correspond to mount points.  Call "
1247 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
1248 "hash table like this example:"
1249 msgstr ""
1250
1251 #. type: verbatim
1252 #: ../src/guestfs.pod:584
1253 #, no-wrap
1254 msgid ""
1255 " /boot => /dev/sda1\n"
1256 " /     => /dev/vg_guest/lv_root\n"
1257 " /usr  => /dev/vg_guest/lv_usr\n"
1258 "\n"
1259 msgstr ""
1260
1261 #. type: textblock
1262 #: ../src/guestfs.pod:588
1263 msgid ""
1264 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1265 "filesystems as suggested."
1266 msgstr ""
1267
1268 #. type: textblock
1269 #: ../src/guestfs.pod:591
1270 msgid ""
1271 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1272 "usr>).  Sorting the keys of the hash by length, shortest first, should work."
1273 msgstr ""
1274
1275 #. type: textblock
1276 #: ../src/guestfs.pod:595
1277 msgid ""
1278 "Inspection currently only works for some common operating systems.  "
1279 "Contributors are welcome to send patches for other operating systems that we "
1280 "currently cannot detect."
1281 msgstr ""
1282
1283 #. type: textblock
1284 #: ../src/guestfs.pod:599
1285 msgid ""
1286 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
1287 "for more details.  The L</guestfs_inspect_os> function just ignores any "
1288 "encrypted devices."
1289 msgstr ""
1290
1291 #. type: textblock
1292 #: ../src/guestfs.pod:603
1293 msgid ""
1294 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1295 "inspection and caches the results in the guest handle.  Subsequent calls to "
1296 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1297 "read the disks.  If you change the content of the guest disks, you can redo "
1298 "inspection by calling L</guestfs_inspect_os> again.  (L</"
1299 "guestfs_inspect_list_applications> works a little differently from the other "
1300 "calls and does read the disks.  See documentation for that function for "
1301 "details)."
1302 msgstr ""
1303
1304 #. type: =head3
1305 #: ../src/guestfs.pod:612
1306 msgid "INSPECTING INSTALL DISKS"
1307 msgstr ""
1308
1309 #. type: textblock
1310 #: ../src/guestfs.pod:614
1311 msgid ""
1312 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1313 "CDs and more."
1314 msgstr ""
1315
1316 #. type: textblock
1317 #: ../src/guestfs.pod:617
1318 msgid ""
1319 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1320 "system, which currently can be C<installed> (a regular operating system) or "
1321 "C<installer> (some sort of install disk)."
1322 msgstr ""
1323
1324 #. type: textblock
1325 #: ../src/guestfs.pod:621
1326 msgid ""
1327 "Further information is available about the operating system that can be "
1328 "installed using the regular inspection APIs like L</"
1329 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1330 msgstr ""
1331
1332 #. type: textblock
1333 #: ../src/guestfs.pod:626
1334 msgid ""
1335 "Some additional information specific to installer disks is also available "
1336 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1337 "guestfs_inspect_is_multipart> calls."
1338 msgstr ""
1339
1340 #. type: =head2
1341 #: ../src/guestfs.pod:631
1342 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1343 msgstr ""
1344
1345 #. type: textblock
1346 #: ../src/guestfs.pod:633
1347 msgid ""
1348 "Libguestfs can mount NTFS partitions.  It does this using the L<http://www."
1349 "ntfs-3g.org/> driver."
1350 msgstr ""
1351
1352 #. type: =head3
1353 #: ../src/guestfs.pod:636
1354 msgid "DRIVE LETTERS AND PATHS"
1355 msgstr ""
1356
1357 #. type: textblock
1358 #: ../src/guestfs.pod:638
1359 msgid ""
1360 "DOS and Windows still use drive letters, and the filesystems are always "
1361 "treated as case insensitive by Windows itself, and therefore you might find "
1362 "a Windows configuration file referring to a path like C<c:\\windows"
1363 "\\system32>.  When the filesystem is mounted in libguestfs, that directory "
1364 "might be referred to as C</WINDOWS/System32>."
1365 msgstr ""
1366
1367 #. type: textblock
1368 #: ../src/guestfs.pod:644
1369 msgid ""
1370 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1371 "L</guestfs_inspect_get_drive_mappings>)"
1372 msgstr ""
1373
1374 #. type: textblock
1375 #: ../src/guestfs.pod:647
1376 msgid ""
1377 "Dealing with separator characters (backslash vs forward slash) is outside "
1378 "the scope of libguestfs, but usually a simple character replacement will "
1379 "work."
1380 msgstr ""
1381
1382 #. type: textblock
1383 #: ../src/guestfs.pod:651
1384 msgid ""
1385 "To resolve the case insensitivity of paths, call L</"
1386 "guestfs_case_sensitive_path>."
1387 msgstr ""
1388
1389 #. type: =head3
1390 #: ../src/guestfs.pod:654
1391 msgid "ACCESSING THE WINDOWS REGISTRY"
1392 msgstr ""
1393
1394 #. type: textblock
1395 #: ../src/guestfs.pod:656
1396 msgid ""
1397 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1398 "files, through the library C<hivex> which is part of the libguestfs project "
1399 "although ships as a separate tarball.  You have to locate and download the "
1400 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
1401 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1402 "reg(1)> for more help on this issue."
1403 msgstr ""
1404
1405 #. type: =head3
1406 #: ../src/guestfs.pod:664
1407 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1408 msgstr ""
1409
1410 #. type: textblock
1411 #: ../src/guestfs.pod:666
1412 msgid ""
1413 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1414 "provide something which looks like a Linux symlink.  The way it tries to do "
1415 "the rewriting is described here:"
1416 msgstr ""
1417
1418 #. type: textblock
1419 #: ../src/guestfs.pod:670
1420 msgid ""
1421 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1422 "symbolic-links/>"
1423 msgstr ""
1424 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1425 "symbolic-links/>"
1426
1427 #. type: textblock
1428 #: ../src/guestfs.pod:672
1429 msgid ""
1430 "The essential problem is that ntfs-3g simply does not have enough "
1431 "information to do a correct job.  NTFS links can contain drive letters and "
1432 "references to external device GUIDs that ntfs-3g has no way of resolving.  "
1433 "It is almost certainly the case that libguestfs callers should ignore what "
1434 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1435 msgstr ""
1436
1437 #. type: textblock
1438 #: ../src/guestfs.pod:679
1439 msgid ""
1440 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1441 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1442 "attribute, and read the raw reparse data from that (you can find the format "
1443 "documented in various places around the web)."
1444 msgstr ""
1445
1446 #. type: =head3
1447 #: ../src/guestfs.pod:684
1448 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1449 msgstr ""
1450
1451 #. type: textblock
1452 #: ../src/guestfs.pod:686
1453 msgid ""
1454 "There are other useful extended attributes that can be read from ntfs-3g "
1455 "filesystems (using L</guestfs_getxattr>).  See:"
1456 msgstr ""
1457
1458 #. type: textblock
1459 #: ../src/guestfs.pod:689
1460 msgid ""
1461 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 msgstr ""
1463 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1464
1465 #. type: =head2
1466 #: ../src/guestfs.pod:691
1467 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1468 msgstr ""
1469
1470 #. type: textblock
1471 #: ../src/guestfs.pod:693
1472 msgid ""
1473 "Although we don't want to discourage you from using the C API, we will "
1474 "mention here that the same API is also available in other languages."
1475 msgstr ""
1476
1477 #. type: textblock
1478 #: ../src/guestfs.pod:696
1479 msgid ""
1480 "The API is broadly identical in all supported languages.  This means that "
1481 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1482 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1483 "OCaml.  In other words, a straightforward, predictable isomorphism between "
1484 "each language."
1485 msgstr ""
1486
1487 #. type: textblock
1488 #: ../src/guestfs.pod:702
1489 msgid ""
1490 "Error messages are automatically transformed into exceptions if the language "
1491 "supports it."
1492 msgstr ""
1493
1494 #. type: textblock
1495 #: ../src/guestfs.pod:705
1496 msgid ""
1497 "We don't try to \"object orientify\" parts of the API in OO languages, "
1498 "although contributors are welcome to write higher level APIs above what we "
1499 "provide in their favourite languages if they wish."
1500 msgstr ""
1501
1502 #. type: =item
1503 #: ../src/guestfs.pod:711
1504 msgid "B<C++>"
1505 msgstr "B<C++>"
1506
1507 #. type: textblock
1508 #: ../src/guestfs.pod:713
1509 msgid ""
1510 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
1511 "identical to the C API.  C++ classes and exceptions are not used."
1512 msgstr ""
1513
1514 #. type: =item
1515 #: ../src/guestfs.pod:717
1516 msgid "B<C#>"
1517 msgstr "B<C#>"
1518
1519 #. type: textblock
1520 #: ../src/guestfs.pod:719
1521 msgid ""
1522 "The C# bindings are highly experimental.  Please read the warnings at the "
1523 "top of C<csharp/Libguestfs.cs>."
1524 msgstr ""
1525
1526 #. type: =item
1527 #: ../src/guestfs.pod:722
1528 msgid "B<Haskell>"
1529 msgstr "B<Haskell>"
1530
1531 #. type: textblock
1532 #: ../src/guestfs.pod:724
1533 msgid ""
1534 "This is the only language binding that is working but incomplete.  Only "
1535 "calls which return simple integers have been bound in Haskell, and we are "
1536 "looking for help to complete this binding."
1537 msgstr ""
1538
1539 #. type: =item
1540 #: ../src/guestfs.pod:728
1541 msgid "B<Java>"
1542 msgstr "B<Java>"
1543
1544 #. type: textblock
1545 #: ../src/guestfs.pod:730
1546 msgid ""
1547 "Full documentation is contained in the Javadoc which is distributed with "
1548 "libguestfs."
1549 msgstr ""
1550
1551 #. type: =item
1552 #: ../src/guestfs.pod:733
1553 msgid "B<OCaml>"
1554 msgstr "B<OCaml>"
1555
1556 #. type: textblock
1557 #: ../src/guestfs.pod:735
1558 msgid "See L<guestfs-ocaml(3)>."
1559 msgstr "Див. L<guestfs-ocaml(3)>."
1560
1561 #. type: =item
1562 #: ../src/guestfs.pod:737
1563 msgid "B<Perl>"
1564 msgstr "B<Perl>"
1565
1566 #. type: textblock
1567 #: ../src/guestfs.pod:739
1568 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1569 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1570
1571 #. type: =item
1572 #: ../src/guestfs.pod:741
1573 msgid "B<PHP>"
1574 msgstr "B<PHP>"
1575
1576 #. type: textblock
1577 #: ../src/guestfs.pod:743
1578 msgid ""
1579 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1580 "the php-libguestfs package for your distribution."
1581 msgstr ""
1582
1583 #. type: textblock
1584 #: ../src/guestfs.pod:746
1585 msgid "The PHP binding only works correctly on 64 bit machines."
1586 msgstr ""
1587
1588 #. type: =item
1589 #: ../src/guestfs.pod:748
1590 msgid "B<Python>"
1591 msgstr "B<Python>"
1592
1593 #. type: textblock
1594 #: ../src/guestfs.pod:750
1595 msgid "See L<guestfs-python(3)>."
1596 msgstr "Див. L<guestfs-python(3)>."
1597
1598 #. type: =item
1599 #: ../src/guestfs.pod:752
1600 msgid "B<Ruby>"
1601 msgstr "B<Ruby>"
1602
1603 #. type: textblock
1604 #: ../src/guestfs.pod:754
1605 msgid "See L<guestfs-ruby(3)>."
1606 msgstr "Див. L<guestfs-ruby(3)>."
1607
1608 #. type: =item
1609 #: ../src/guestfs.pod:756
1610 msgid "B<shell scripts>"
1611 msgstr "B<скрипти оболонки>"
1612
1613 #. type: textblock
1614 #: ../src/guestfs.pod:758
1615 msgid "See L<guestfish(1)>."
1616 msgstr "Див. L<guestfish(1)>."
1617
1618 #. type: =head2
1619 #: ../src/guestfs.pod:762
1620 msgid "LIBGUESTFS GOTCHAS"
1621 msgstr ""
1622
1623 #. type: textblock
1624 #: ../src/guestfs.pod:764
1625 msgid ""
1626 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1627 "system [...] that works in the way it is documented but is counterintuitive "
1628 "and almost invites mistakes.\""
1629 msgstr ""
1630
1631 #. type: textblock
1632 #: ../src/guestfs.pod:768
1633 msgid ""
1634 "Since we developed libguestfs and the associated tools, there are several "
1635 "things we would have designed differently, but are now stuck with for "
1636 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
1637 "release, you can expect these to change.  Beware of them."
1638 msgstr ""
1639
1640 #. type: =item
1641 #: ../src/guestfs.pod:776
1642 msgid "Autosync / forgetting to sync."
1643 msgstr ""
1644
1645 #. type: textblock
1646 #: ../src/guestfs.pod:778
1647 msgid ""
1648 "I<Update:> Autosync is enabled by default for all API users starting from "
1649 "libguestfs 1.5.24.  This section only applies to older versions."
1650 msgstr ""
1651
1652 #. type: textblock
1653 #: ../src/guestfs.pod:781
1654 msgid ""
1655 "When modifying a filesystem from C or another language, you B<must> unmount "
1656 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1657 "libguestfs handle.  You can also call:"
1658 msgstr ""
1659
1660 #. type: verbatim
1661 #: ../src/guestfs.pod:785
1662 #, no-wrap
1663 msgid ""
1664 " guestfs_set_autosync (g, 1);\n"
1665 "\n"
1666 msgstr ""
1667
1668 #. type: textblock
1669 #: ../src/guestfs.pod:787
1670 msgid ""
1671 "to have the unmount/sync done automatically for you when the handle 'g' is "
1672 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1673 msgstr ""
1674
1675 #. type: textblock
1676 #: ../src/guestfs.pod:791
1677 msgid ""
1678 "If you forget to do this, then it is entirely possible that your changes "
1679 "won't be written out, or will be partially written, or (very rarely) that "
1680 "you'll get disk corruption."
1681 msgstr ""
1682
1683 #. type: textblock
1684 #: ../src/guestfs.pod:795
1685 msgid ""
1686 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
1687 "guestfish scripts that forget to sync will work just fine, which can make "
1688 "this very puzzling if you are trying to debug a problem."
1689 msgstr ""
1690
1691 #. type: =item
1692 #: ../src/guestfs.pod:799
1693 msgid "Mount option C<-o sync> should not be the default."
1694 msgstr ""
1695
1696 #. type: textblock
1697 #: ../src/guestfs.pod:801
1698 msgid ""
1699 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
1700 "However C<-o sync> does not add any reliability benefit, but does have a "
1701 "very large performance impact."
1702 msgstr ""
1703
1704 #. type: textblock
1705 #: ../src/guestfs.pod:805
1706 msgid ""
1707 "The work around is to use L</guestfs_mount_options> and set the mount "
1708 "options that you actually want to use."
1709 msgstr ""
1710
1711 #. type: =item
1712 #: ../src/guestfs.pod:808
1713 msgid "Read-only should be the default."
1714 msgstr ""
1715
1716 #. type: textblock
1717 #: ../src/guestfs.pod:810
1718 msgid ""
1719 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1720 "specify I<--rw> if you want to make changes to the image."
1721 msgstr ""
1722
1723 #. type: textblock
1724 #: ../src/guestfs.pod:813
1725 msgid "This would reduce the potential to corrupt live VM images."
1726 msgstr ""
1727
1728 #. type: textblock
1729 #: ../src/guestfs.pod:815
1730 msgid ""
1731 "Note that many filesystems change the disk when you just mount and unmount, "
1732 "even if you didn't perform any writes.  You need to use L</"
1733 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1734 msgstr ""
1735
1736 #. type: =item
1737 #: ../src/guestfs.pod:819
1738 msgid "guestfish command line is hard to use."
1739 msgstr ""
1740
1741 #. type: textblock
1742 #: ../src/guestfs.pod:821
1743 msgid ""
1744 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1745 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
1746 "exist, so it fails.  In earlier versions of guestfish the error message was "
1747 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
1748 "we should have used C<guestfish -c command> to run commands."
1749 msgstr ""
1750
1751 #. type: =item
1752 #: ../src/guestfs.pod:828
1753 msgid "guestfish megabyte modifiers don't work right on all commands"
1754 msgstr ""
1755
1756 #. type: textblock
1757 #: ../src/guestfs.pod:830
1758 msgid ""
1759 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1760 "other modifiers).  What guestfish actually does is to multiply the number "
1761 "part by the modifier part and pass the result to the C API.  However this "
1762 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1763 "expecting some other unit (eg. megabytes)."
1764 msgstr ""
1765
1766 #. type: textblock
1767 #: ../src/guestfs.pod:837
1768 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
1769 msgstr ""
1770
1771 #. type: verbatim
1772 #: ../src/guestfs.pod:839
1773 #, no-wrap
1774 msgid ""
1775 " lvcreate LV VG 100M\n"
1776 "\n"
1777 msgstr ""
1778
1779 #. type: textblock
1780 #: ../src/guestfs.pod:841
1781 msgid ""
1782 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
1783 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1784 "megabytes * megabytes) logical volume.  The error message you get from this "
1785 "is also a little obscure."
1786 msgstr ""
1787
1788 #. type: textblock
1789 #: ../src/guestfs.pod:846
1790 msgid ""
1791 "This could be fixed in the generator by specially marking parameters and "
1792 "return values which take bytes or other units."
1793 msgstr ""
1794
1795 #. type: =item
1796 #: ../src/guestfs.pod:849
1797 msgid "Ambiguity between devices and paths"
1798 msgstr ""
1799
1800 #. type: textblock
1801 #: ../src/guestfs.pod:851
1802 msgid ""
1803 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1804 "sdb2>) and a similar pathname.  A file might just happen to be called "
1805 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1806 msgstr ""
1807
1808 #. type: textblock
1809 #: ../src/guestfs.pod:856
1810 msgid ""
1811 "In the current API we usually resolve this ambiguity by having two separate "
1812 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
1813 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1814 "detecting if the path supplied begins with C</dev/>."
1815 msgstr ""
1816
1817 #. type: textblock
1818 #: ../src/guestfs.pod:862
1819 msgid ""
1820 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1821 "make paths/devices into structured names.  One way to do this would be to "
1822 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1823 "aspect of grub.  Another way would be to use a structured type, equivalent "
1824 "to this OCaml type:"
1825 msgstr ""
1826
1827 #. type: verbatim
1828 #: ../src/guestfs.pod:868
1829 #, no-wrap
1830 msgid ""
1831 " type path = Path of string | Device of int | Partition of int * int\n"
1832 "\n"
1833 msgstr ""
1834
1835 #. type: textblock
1836 #: ../src/guestfs.pod:870
1837 msgid "which would allow you to pass arguments like:"
1838 msgstr ""
1839
1840 #. type: verbatim
1841 #: ../src/guestfs.pod:872
1842 #, no-wrap
1843 msgid ""
1844 " Path \"/foo/bar\"\n"
1845 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
1846 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1847 " Path \"/dev/sdb2\"    (* not a device *)\n"
1848 "\n"
1849 msgstr ""
1850
1851 #. type: textblock
1852 #: ../src/guestfs.pod:877
1853 msgid ""
1854 "As you can see there are still problems to resolve even with this "
1855 "representation.  Also consider how it might work in guestfish."
1856 msgstr ""
1857
1858 #. type: =head2
1859 #: ../src/guestfs.pod:882
1860 msgid "KEYS AND PASSPHRASES"
1861 msgstr ""
1862
1863 #. type: textblock
1864 #: ../src/guestfs.pod:884
1865 msgid ""
1866 "Certain libguestfs calls take a parameter that contains sensitive key "
1867 "material, passed in as a C string."
1868 msgstr ""
1869
1870 #. type: textblock
1871 #: ../src/guestfs.pod:887
1872 msgid ""
1873 "In the future we would hope to change the libguestfs implementation so that "
1874 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1875 "swap.  However this is I<not> done at the moment, because of the complexity "
1876 "of such an implementation."
1877 msgstr ""
1878
1879 #. type: textblock
1880 #: ../src/guestfs.pod:892
1881 msgid ""
1882 "Therefore you should be aware that any key parameter you pass to libguestfs "
1883 "might end up being written out to the swap partition.  If this is a concern, "
1884 "scrub the swap partition or don't use libguestfs on encrypted devices."
1885 msgstr ""
1886
1887 #. type: =head2
1888 #: ../src/guestfs.pod:897
1889 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1890 msgstr ""
1891
1892 #. type: textblock
1893 #: ../src/guestfs.pod:899
1894 msgid ""
1895 "All high-level libguestfs actions are synchronous.  If you want to use "
1896 "libguestfs asynchronously then you must create a thread."
1897 msgstr ""
1898
1899 #. type: textblock
1900 #: ../src/guestfs.pod:902
1901 msgid ""
1902 "Only use the handle from a single thread.  Either use the handle exclusively "
1903 "from one thread, or provide your own mutex so that two threads cannot issue "
1904 "calls on the same handle at the same time."
1905 msgstr ""
1906
1907 #. type: textblock
1908 #: ../src/guestfs.pod:906
1909 msgid ""
1910 "See the graphical program guestfs-browser for one possible architecture for "
1911 "multithreaded programs using libvirt and libguestfs."
1912 msgstr ""
1913
1914 #. type: =head2
1915 #: ../src/guestfs.pod:909
1916 msgid "PATH"
1917 msgstr "ШЛЯХ"
1918
1919 #. type: textblock
1920 #: ../src/guestfs.pod:911
1921 msgid ""
1922 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1923 "internal path."
1924 msgstr ""
1925
1926 #. type: textblock
1927 #: ../src/guestfs.pod:914
1928 msgid ""
1929 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1930 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1931 msgstr ""
1932
1933 #. type: textblock
1934 #: ../src/guestfs.pod:917
1935 msgid ""
1936 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1937 "to change the directories that libguestfs will search in.  The value is a "
1938 "colon-separated list of paths.  The current directory is I<not> searched "
1939 "unless the path contains an empty element or C<.>.  For example "
1940 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1941 "then C</usr/lib/guestfs>."
1942 msgstr ""
1943
1944 #. type: =head2
1945 #: ../src/guestfs.pod:924
1946 msgid "QEMU WRAPPERS"
1947 msgstr ""
1948
1949 #. type: textblock
1950 #: ../src/guestfs.pod:926
1951 msgid ""
1952 "If you want to compile your own qemu, run qemu from a non-standard location, "
1953 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1954 "around qemu."
1955 msgstr ""
1956
1957 #. type: textblock
1958 #: ../src/guestfs.pod:930
1959 msgid ""
1960 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1961 "last command in the shell script (so that qemu replaces the shell and "
1962 "becomes the direct child of the libguestfs-using program).  If you don't do "
1963 "this, then the qemu process won't be cleaned up correctly."
1964 msgstr ""
1965
1966 #. type: textblock
1967 #: ../src/guestfs.pod:935
1968 msgid ""
1969 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1970 "source:"
1971 msgstr ""
1972
1973 #. type: verbatim
1974 #: ../src/guestfs.pod:938
1975 #, no-wrap
1976 msgid ""
1977 " #!/bin/sh -\n"
1978 " qemudir=/home/rjones/d/qemu\n"
1979 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1980 "\n"
1981 msgstr ""
1982
1983 #. type: textblock
1984 #: ../src/guestfs.pod:942
1985 msgid ""
1986 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1987 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
1988 "example:"
1989 msgstr ""
1990
1991 #. type: verbatim
1992 #: ../src/guestfs.pod:946
1993 #, no-wrap
1994 msgid ""
1995 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1996 "\n"
1997 msgstr ""
1998
1999 #. type: textblock
2000 #: ../src/guestfs.pod:948
2001 msgid ""
2002 "Note that libguestfs also calls qemu with the -help and -version options in "
2003 "order to determine features."
2004 msgstr ""
2005
2006 #. type: =head2
2007 #: ../src/guestfs.pod:951
2008 msgid "ATTACHING TO RUNNING DAEMONS"
2009 msgstr ""
2010
2011 #. type: textblock
2012 #: ../src/guestfs.pod:953
2013 msgid ""
2014 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2015 "babies.  Use with caution."
2016 msgstr ""
2017
2018 #. type: textblock
2019 #: ../src/guestfs.pod:956
2020 msgid ""
2021 "I<Note (2):> This section explains how to attach to a running daemon from a "
2022 "low level perspective.  For most users, simply using virt tools such as "
2023 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2024 msgstr ""
2025
2026 #. type: =head3
2027 #: ../src/guestfs.pod:960
2028 msgid "Using guestfs_set_attach_method"
2029 msgstr ""
2030
2031 #. type: textblock
2032 #: ../src/guestfs.pod:962
2033 msgid ""
2034 "By calling L</guestfs_set_attach_method> you can change how the library "
2035 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2036 "ARCHITECTURE> for some background)."
2037 msgstr ""
2038
2039 #. type: textblock
2040 #: ../src/guestfs.pod:966
2041 msgid ""
2042 "The normal attach method is C<appliance>, where a small appliance is created "
2043 "containing the daemon, and then the library connects to this."
2044 msgstr ""
2045
2046 #. type: textblock
2047 #: ../src/guestfs.pod:969
2048 msgid ""
2049 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2050 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2051 "daemon over the Unix domain socket."
2052 msgstr ""
2053
2054 #. type: textblock
2055 #: ../src/guestfs.pod:973
2056 msgid ""
2057 "The normal use for this is to connect to a running virtual machine that "
2058 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2059 "files inside the live virtual machine."
2060 msgstr ""
2061
2062 #. type: =head3
2063 #: ../src/guestfs.pod:977
2064 msgid "Using guestfs_add_domain with live flag"
2065 msgstr ""
2066
2067 #. type: textblock
2068 #: ../src/guestfs.pod:979
2069 msgid ""
2070 "L</guestfs_add_domain> provides some help for getting the correct attach "
2071 "method.  If you pass the C<live> option to this function, then (if the "
2072 "virtual machine is running) it will examine the libvirt XML looking for a "
2073 "virtio-serial channel to connect to:"
2074 msgstr ""
2075
2076 #. type: verbatim
2077 #: ../src/guestfs.pod:985
2078 #, no-wrap
2079 msgid ""
2080 " <domain>\n"
2081 "   ...\n"
2082 "   <devices>\n"
2083 "     ...\n"
2084 "     <channel type='unix'>\n"
2085 "       <source mode='bind' path='/path/to/socket'/>\n"
2086 "       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2087 "     </channel>\n"
2088 "     ...\n"
2089 "   </devices>\n"
2090 " </domain>\n"
2091 "\n"
2092 msgstr ""
2093
2094 #. type: textblock
2095 #: ../src/guestfs.pod:997
2096 msgid ""
2097 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2098 "method to C<unix:/path/to/socket>."
2099 msgstr ""
2100
2101 #. type: textblock
2102 #: ../src/guestfs.pod:1000
2103 msgid ""
2104 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2105 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2106 "to attach to and modify live virtual machines."
2107 msgstr ""
2108
2109 #. type: textblock
2110 #: ../src/guestfs.pod:1004
2111 msgid ""
2112 "The virtual machine needs to have been set up beforehand so that it has the "
2113 "virtio-serial channel and so that guestfsd is running inside it."
2114 msgstr ""
2115
2116 #. type: =head2
2117 #: ../src/guestfs.pod:1008
2118 msgid "ABI GUARANTEE"
2119 msgstr ""
2120
2121 #. type: textblock
2122 #: ../src/guestfs.pod:1010
2123 msgid ""
2124 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2125 "actions as outlined in this section.  Although we will deprecate some "
2126 "actions, for example if they get replaced by newer calls, we will keep the "
2127 "old actions forever.  This allows you the developer to program in confidence "
2128 "against the libguestfs API."
2129 msgstr ""
2130
2131 #. type: =head2
2132 #: ../src/guestfs.pod:1016
2133 msgid "BLOCK DEVICE NAMING"
2134 msgstr ""
2135
2136 #. type: textblock
2137 #: ../src/guestfs.pod:1018
2138 msgid ""
2139 "In the kernel there is now quite a profusion of schemata for naming block "
2140 "devices (in this context, by I<block device> I mean a physical or virtual "
2141 "hard drive).  The original Linux IDE driver used names starting with C</dev/"
2142 "hd*>.  SCSI devices have historically used a different naming scheme, C</dev/"
2143 "sd*>.  When the Linux kernel I<libata> driver became a popular replacement "
2144 "for the old IDE driver (particularly for SATA devices) those devices also "
2145 "used the C</dev/sd*> scheme.  Additionally we now have virtual machines with "
2146 "paravirtualized drivers.  This has created several different naming systems, "
2147 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2148 msgstr ""
2149
2150 #. type: textblock
2151 #: ../src/guestfs.pod:1030
2152 msgid ""
2153 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2154 "Linux kernel to access block devices.  We can run a variety of appliances "
2155 "based on a variety of Linux kernels."
2156 msgstr ""
2157
2158 #. type: textblock
2159 #: ../src/guestfs.pod:1034
2160 msgid ""
2161 "This causes a problem for libguestfs because many API calls use device or "
2162 "partition names.  Working scripts and the recipe (example) scripts that we "
2163 "make available over the internet could fail if the naming scheme changes."
2164 msgstr ""
2165
2166 #. type: textblock
2167 #: ../src/guestfs.pod:1039
2168 msgid ""
2169 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
2170 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2171 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2172 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2173 msgstr ""
2174
2175 #. type: textblock
2176 #: ../src/guestfs.pod:1045
2177 msgid ""
2178 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
2179 "L</guestfs_list_partitions> and similar calls return the true names of the "
2180 "devices and partitions as known to the appliance."
2181 msgstr ""
2182
2183 #. type: =head3
2184 #: ../src/guestfs.pod:1050
2185 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2186 msgstr ""
2187
2188 #. type: textblock
2189 #: ../src/guestfs.pod:1052
2190 msgid ""
2191 "Usually this translation is transparent.  However in some (very rare)  cases "
2192 "you may need to know the exact algorithm.  Such cases include where you use "
2193 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2194 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2195 msgstr ""
2196
2197 #. type: textblock
2198 #: ../src/guestfs.pod:1058
2199 msgid ""
2200 "The algorithm is applied only to I<parameters> which are known to be either "
2201 "device or partition names.  Return values from functions such as L</"
2202 "guestfs_list_devices> are never changed."
2203 msgstr ""
2204
2205 #. type: textblock
2206 #: ../src/guestfs.pod:1066
2207 msgid "Is the string a parameter which is a device or partition name?"
2208 msgstr ""
2209
2210 #. type: textblock
2211 #: ../src/guestfs.pod:1070
2212 msgid "Does the string begin with C</dev/sd>?"
2213 msgstr ""
2214
2215 #. type: textblock
2216 #: ../src/guestfs.pod:1074
2217 msgid ""
2218 "Does the named device exist? If so, we use that device.  However if I<not> "
2219 "then we continue with this algorithm."
2220 msgstr ""
2221
2222 #. type: textblock
2223 #: ../src/guestfs.pod:1079
2224 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2225 msgstr ""
2226
2227 #. type: textblock
2228 #: ../src/guestfs.pod:1081
2229 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2230 msgstr ""
2231
2232 #. type: textblock
2233 #: ../src/guestfs.pod:1083
2234 msgid "If that named device exists, use it.  If not, continue."
2235 msgstr ""
2236
2237 #. type: textblock
2238 #: ../src/guestfs.pod:1087
2239 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2240 msgstr ""
2241
2242 #. type: textblock
2243 #: ../src/guestfs.pod:1089
2244 msgid "If that named device exists, use it.  If not, return an error."
2245 msgstr ""
2246
2247 #. type: =head3
2248 #: ../src/guestfs.pod:1093
2249 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2250 msgstr ""
2251
2252 #. type: textblock
2253 #: ../src/guestfs.pod:1095
2254 msgid ""
2255 "Although the standard naming scheme and automatic translation is useful for "
2256 "simple programs and guestfish scripts, for larger programs it is best not to "
2257 "rely on this mechanism."
2258 msgstr ""
2259
2260 #. type: textblock
2261 #: ../src/guestfs.pod:1099
2262 msgid ""
2263 "Where possible for maximum future portability programs using libguestfs "
2264 "should use these future-proof techniques:"
2265 msgstr ""
2266
2267 #. type: textblock
2268 #: ../src/guestfs.pod:1106
2269 msgid ""
2270 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2271 "device names, and then use those names directly."
2272 msgstr ""
2273
2274 #. type: textblock
2275 #: ../src/guestfs.pod:1109
2276 msgid ""
2277 "Since those device names exist by definition, they will never be translated."
2278 msgstr ""
2279
2280 #. type: textblock
2281 #: ../src/guestfs.pod:1114
2282 msgid ""
2283 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2284 "filesystem labels."
2285 msgstr ""
2286
2287 #. type: =head1
2288 #: ../src/guestfs.pod:1119
2289 msgid "SECURITY"
2290 msgstr "БЕЗПЕКА"
2291
2292 #. type: textblock
2293 #: ../src/guestfs.pod:1121
2294 msgid ""
2295 "This section discusses security implications of using libguestfs, "
2296 "particularly with untrusted or malicious guests or disk images."
2297 msgstr ""
2298
2299 #. type: =head2
2300 #: ../src/guestfs.pod:1124
2301 msgid "GENERAL SECURITY CONSIDERATIONS"
2302 msgstr ""
2303
2304 #. type: textblock
2305 #: ../src/guestfs.pod:1126
2306 msgid ""
2307 "Be careful with any files or data that you download from a guest (by "
2308 "\"download\" we mean not just the L</guestfs_download> command but any "
2309 "command that reads files, filenames, directories or anything else from a "
2310 "disk image).  An attacker could manipulate the data to fool your program "
2311 "into doing the wrong thing.  Consider cases such as:"
2312 msgstr ""
2313
2314 #. type: textblock
2315 #: ../src/guestfs.pod:1136
2316 msgid "the data (file etc) not being present"
2317 msgstr ""
2318
2319 #. type: textblock
2320 #: ../src/guestfs.pod:1140
2321 msgid "being present but empty"
2322 msgstr ""
2323
2324 #. type: textblock
2325 #: ../src/guestfs.pod:1144
2326 msgid "being much larger than normal"
2327 msgstr ""
2328
2329 #. type: textblock
2330 #: ../src/guestfs.pod:1148
2331 msgid "containing arbitrary 8 bit data"
2332 msgstr ""
2333
2334 #. type: textblock
2335 #: ../src/guestfs.pod:1152
2336 msgid "being in an unexpected character encoding"
2337 msgstr ""
2338
2339 #. type: textblock
2340 #: ../src/guestfs.pod:1156
2341 msgid "containing homoglyphs."
2342 msgstr ""
2343
2344 #. type: =head2
2345 #: ../src/guestfs.pod:1160
2346 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2347 msgstr ""
2348
2349 #. type: textblock
2350 #: ../src/guestfs.pod:1162
2351 msgid ""
2352 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2353 "(VFS) module can sometimes be escalated into exploits by deliberately "
2354 "creating a malicious, malformed filesystem.  These exploits are very severe "
2355 "for two reasons.  Firstly there are very many filesystem drivers in the "
2356 "kernel, and many of them are infrequently used and not much developer "
2357 "attention has been paid to the code.  Linux userspace helps potential "
2358 "crackers by detecting the filesystem type and automatically choosing the "
2359 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2360 "the administrator.  Secondly, a kernel-level exploit is like a local root "
2361 "exploit (worse in some ways), giving immediate and total access to the "
2362 "system right down to the hardware level."
2363 msgstr ""
2364
2365 #. type: textblock
2366 #: ../src/guestfs.pod:1175
2367 msgid ""
2368 "That explains why you should never mount a filesystem from an untrusted "
2369 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
2370 "inside a qemu virtual machine, usually running as a non-root user.  The "
2371 "attacker would need to write a filesystem which first exploited the kernel, "
2372 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2373 "the libguestfs protocol, and finally to be as serious as the host kernel "
2374 "exploit it would need to escalate its privileges to root.  This multi-step "
2375 "escalation, performed by a static piece of data, is thought to be extremely "
2376 "hard to do, although we never say 'never' about security issues."
2377 msgstr ""
2378
2379 #. type: textblock
2380 #: ../src/guestfs.pod:1186
2381 msgid ""
2382 "In any case callers can reduce the attack surface by forcing the filesystem "
2383 "type when mounting (use L</guestfs_mount_vfs>)."
2384 msgstr ""
2385
2386 #. type: =head2
2387 #: ../src/guestfs.pod:1189
2388 msgid "PROTOCOL SECURITY"
2389 msgstr ""
2390
2391 #. type: textblock
2392 #: ../src/guestfs.pod:1191
2393 msgid ""
2394 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
2395 "defined upper message size.  However a program that uses libguestfs must "
2396 "also take care - for example you can write a program that downloads a binary "
2397 "from a disk image and executes it locally, and no amount of protocol "
2398 "security will save you from the consequences."
2399 msgstr ""
2400
2401 #. type: =head2
2402 #: ../src/guestfs.pod:1197
2403 msgid "INSPECTION SECURITY"
2404 msgstr ""
2405
2406 #. type: textblock
2407 #: ../src/guestfs.pod:1199
2408 msgid ""
2409 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2410 "directly from the guest, and these could contain any 8 bit data.  Callers "
2411 "should be careful to escape these before printing them to a structured file "
2412 "(for example, use HTML escaping if creating a web page)."
2413 msgstr ""
2414
2415 #. type: textblock
2416 #: ../src/guestfs.pod:1205
2417 msgid ""
2418 "Guest configuration may be altered in unusual ways by the administrator of "
2419 "the virtual machine, and may not reflect reality (particularly for untrusted "
2420 "or actively malicious guests).  For example we parse the hostname from "
2421 "configuration files like C</etc/sysconfig/network> that we find in the "
2422 "guest, but the guest administrator can easily manipulate these files to "
2423 "provide the wrong hostname."
2424 msgstr ""
2425
2426 #. type: textblock
2427 #: ../src/guestfs.pod:1213
2428 msgid ""
2429 "The inspection API parses guest configuration using two external libraries: "
2430 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
2431 "designed to be robust in the face of malicious data, although denial of "
2432 "service attacks are still possible, for example with oversized configuration "
2433 "files."
2434 msgstr ""
2435
2436 #. type: =head2
2437 #: ../src/guestfs.pod:1219
2438 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2439 msgstr ""
2440
2441 #. type: textblock
2442 #: ../src/guestfs.pod:1221
2443 msgid ""
2444 "Be very cautious about running commands from the guest.  By running a "
2445 "command in the guest, you are giving CPU time to a binary that you do not "
2446 "control, under the same user account as the library, albeit wrapped in qemu "
2447 "virtualization.  More information and alternatives can be found in the "
2448 "section L</RUNNING COMMANDS>."
2449 msgstr ""
2450
2451 #. type: =head2
2452 #: ../src/guestfs.pod:1227
2453 msgid "CVE-2010-3851"
2454 msgstr "CVE-2010-3851"
2455
2456 #. type: textblock
2457 #: ../src/guestfs.pod:1229
2458 msgid "https://bugzilla.redhat.com/642934"
2459 msgstr "https://bugzilla.redhat.com/642934"
2460
2461 #. type: textblock
2462 #: ../src/guestfs.pod:1231
2463 msgid ""
2464 "This security bug concerns the automatic disk format detection that qemu "
2465 "does on disk images."
2466 msgstr ""
2467
2468 #. type: textblock
2469 #: ../src/guestfs.pod:1234
2470 msgid ""
2471 "A raw disk image is just the raw bytes, there is no header.  Other disk "
2472 "images like qcow2 contain a special header.  Qemu deals with this by looking "
2473 "for one of the known headers, and if none is found then assuming the disk "
2474 "image must be raw."
2475 msgstr ""
2476
2477 #. type: textblock
2478 #: ../src/guestfs.pod:1239
2479 msgid ""
2480 "This allows a guest which has been given a raw disk image to write some "
2481 "other header.  At next boot (or when the disk image is accessed by "
2482 "libguestfs) qemu would do autodetection and think the disk image format was, "
2483 "say, qcow2 based on the header written by the guest."
2484 msgstr ""
2485
2486 #. type: textblock
2487 #: ../src/guestfs.pod:1244
2488 msgid ""
2489 "This in itself would not be a problem, but qcow2 offers many features, one "
2490 "of which is to allow a disk image to refer to another image (called the "
2491 "\"backing disk\").  It does this by placing the path to the backing disk "
2492 "into the qcow2 header.  This path is not validated and could point to any "
2493 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
2494 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2495 "control of the attacker."
2496 msgstr ""
2497
2498 #. type: textblock
2499 #: ../src/guestfs.pod:1252
2500 msgid ""
2501 "In libguestfs this is rather hard to exploit except under two circumstances:"
2502 msgstr ""
2503
2504 #. type: textblock
2505 #: ../src/guestfs.pod:1259
2506 msgid "You have enabled the network or have opened the disk in write mode."
2507 msgstr ""
2508
2509 #. type: textblock
2510 #: ../src/guestfs.pod:1263
2511 msgid ""
2512 "You are also running untrusted code from the guest (see L</RUNNING "
2513 "COMMANDS>)."
2514 msgstr ""
2515
2516 #. type: textblock
2517 #: ../src/guestfs.pod:1268
2518 msgid ""
2519 "The way to avoid this is to specify the expected disk format when adding "
2520 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
2521 "should always do this if the disk is raw format, and it's a good idea for "
2522 "other cases too."
2523 msgstr ""
2524
2525 #. type: textblock
2526 #: ../src/guestfs.pod:1273
2527 msgid ""
2528 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2529 "format is fetched from libvirt and passed through."
2530 msgstr ""
2531
2532 #. type: textblock
2533 #: ../src/guestfs.pod:1276
2534 msgid ""
2535 "For libguestfs tools, use the I<--format> command line parameter as "
2536 "appropriate."
2537 msgstr ""
2538
2539 #. type: =head1
2540 #: ../src/guestfs.pod:1279
2541 msgid "CONNECTION MANAGEMENT"
2542 msgstr ""
2543
2544 #. type: =head2
2545 #: ../src/guestfs.pod:1281
2546 msgid "guestfs_h *"
2547 msgstr ""
2548
2549 #. type: textblock
2550 #: ../src/guestfs.pod:1283
2551 msgid ""
2552 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
2553 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
2554 "handle and release all resources used."
2555 msgstr ""
2556
2557 #. type: textblock
2558 #: ../src/guestfs.pod:1287
2559 msgid ""
2560 "For information on using multiple handles and threads, see the section L</"
2561 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2562 msgstr ""
2563
2564 #. type: =head2
2565 #: ../src/guestfs.pod:1290
2566 msgid "guestfs_create"
2567 msgstr ""
2568
2569 #. type: verbatim
2570 #: ../src/guestfs.pod:1292
2571 #, no-wrap
2572 msgid ""
2573 " guestfs_h *guestfs_create (void);\n"
2574 "\n"
2575 msgstr ""
2576
2577 #. type: textblock
2578 #: ../src/guestfs.pod:1294
2579 msgid "Create a connection handle."
2580 msgstr ""
2581
2582 #. type: textblock
2583 #: ../src/guestfs.pod:1296
2584 msgid ""
2585 "On success this returns a non-NULL pointer to a handle.  On error it returns "
2586 "NULL."
2587 msgstr ""
2588
2589 #. type: textblock
2590 #: ../src/guestfs.pod:1299
2591 msgid ""
2592 "You have to \"configure\" the handle after creating it.  This includes "
2593 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2594 "handle at least once."
2595 msgstr ""
2596
2597 #. type: textblock
2598 #: ../src/guestfs.pod:1303
2599 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2600 msgstr ""
2601
2602 #. type: textblock
2603 #: ../src/guestfs.pod:1305
2604 msgid ""
2605 "You may also want to configure error handling for the handle.  See the L</"
2606 "ERROR HANDLING> section below."
2607 msgstr ""
2608
2609 #. type: =head2
2610 #: ../src/guestfs.pod:1308
2611 msgid "guestfs_close"
2612 msgstr ""
2613
2614 #. type: verbatim
2615 #: ../src/guestfs.pod:1310
2616 #, no-wrap
2617 msgid ""
2618 " void guestfs_close (guestfs_h *g);\n"
2619 "\n"
2620 msgstr ""
2621
2622 #. type: textblock
2623 #: ../src/guestfs.pod:1312
2624 msgid "This closes the connection handle and frees up all resources used."
2625 msgstr ""
2626
2627 #. type: textblock
2628 #: ../src/guestfs.pod:1314
2629 msgid ""
2630 "If autosync was set on the handle and the handle was launched, then this "
2631 "implicitly calls various functions to unmount filesystems and sync the "
2632 "disk.  See L</guestfs_set_autosync> for more details."
2633 msgstr ""
2634
2635 #. type: textblock
2636 #: ../src/guestfs.pod:1318
2637 msgid "If a close callback was set on the handle, then it is called."
2638 msgstr ""
2639
2640 #. type: =head1
2641 #: ../src/guestfs.pod:1320
2642 msgid "ERROR HANDLING"
2643 msgstr "ОБРОБКА ПОМИЛОК"
2644
2645 #. type: textblock
2646 #: ../src/guestfs.pod:1322
2647 msgid ""
2648 "API functions can return errors.  For example, almost all functions that "
2649 "return C<int> will return C<-1> to indicate an error."
2650 msgstr ""
2651
2652 #. type: textblock
2653 #: ../src/guestfs.pod:1325
2654 msgid ""
2655 "Additional information is available for errors: an error message string and "
2656 "optionally an error number (errno) if the thing that failed was a system "
2657 "call."
2658 msgstr ""
2659
2660 #. type: textblock
2661 #: ../src/guestfs.pod:1329
2662 msgid ""
2663 "You can get at the additional information about the last error on the handle "
2664 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2665 "up an error handler with L</guestfs_set_error_handler>."
2666 msgstr ""
2667
2668 #. type: textblock
2669 #: ../src/guestfs.pod:1334
2670 msgid ""
2671 "When the handle is created, a default error handler is installed which "
2672 "prints the error message string to C<stderr>.  For small short-running "
2673 "command line programs it is sufficient to do:"
2674 msgstr ""
2675
2676 #. type: verbatim
2677 #: ../src/guestfs.pod:1338
2678 #, no-wrap
2679 msgid ""
2680 " if (guestfs_launch (g) == -1)\n"
2681 "   exit (EXIT_FAILURE);\n"
2682 "\n"
2683 msgstr ""
2684
2685 #. type: textblock
2686 #: ../src/guestfs.pod:1341
2687 msgid ""
2688 "since the default error handler will ensure that an error message has been "
2689 "printed to C<stderr> before the program exits."
2690 msgstr ""
2691
2692 #. type: textblock
2693 #: ../src/guestfs.pod:1344
2694 msgid ""
2695 "For other programs the caller will almost certainly want to install an "
2696 "alternate error handler or do error handling in-line like this:"
2697 msgstr ""
2698
2699 #. type: verbatim
2700 #: ../src/guestfs.pod:1347
2701 #, no-wrap
2702 msgid ""
2703 " g = guestfs_create ();\n"
2704 " \n"
2705 msgstr ""
2706
2707 #. type: verbatim
2708 #: ../src/guestfs.pod:1349
2709 #, no-wrap
2710 msgid ""
2711 " /* This disables the default behaviour of printing errors\n"
2712 "    on stderr. */\n"
2713 " guestfs_set_error_handler (g, NULL, NULL);\n"
2714 " \n"
2715 msgstr ""
2716
2717 #. type: verbatim
2718 #: ../src/guestfs.pod:1353
2719 #, no-wrap
2720 msgid ""
2721 " if (guestfs_launch (g) == -1) {\n"
2722 "   /* Examine the error message and print it etc. */\n"
2723 "   char *msg = guestfs_last_error (g);\n"
2724 "   int errnum = guestfs_last_errno (g);\n"
2725 "   fprintf (stderr, \"%s\\n\", msg);\n"
2726 "   /* ... */\n"
2727 "  }\n"
2728 "\n"
2729 msgstr ""
2730
2731 #. type: textblock
2732 #: ../src/guestfs.pod:1361
2733 msgid ""
2734 "Out of memory errors are handled differently.  The default action is to call "
2735 "L<abort(3)>.  If this is undesirable, then you can set a handler using L</"
2736 "guestfs_set_out_of_memory_handler>."
2737 msgstr ""
2738
2739 #. type: textblock
2740 #: ../src/guestfs.pod:1365
2741 msgid ""
2742 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2743 "because there is no handle if this happens there is no way to get additional "
2744 "error information.  However L</guestfs_create> is supposed to be a "
2745 "lightweight operation which can only fail because of insufficient memory (it "
2746 "returns NULL in this case)."
2747 msgstr ""
2748
2749 #. type: =head2
2750 #: ../src/guestfs.pod:1371
2751 msgid "guestfs_last_error"
2752 msgstr ""
2753
2754 #. type: verbatim
2755 #: ../src/guestfs.pod:1373
2756 #, no-wrap
2757 msgid ""
2758 " const char *guestfs_last_error (guestfs_h *g);\n"
2759 "\n"
2760 msgstr ""
2761
2762 #. type: textblock
2763 #: ../src/guestfs.pod:1375
2764 msgid ""
2765 "This returns the last error message that happened on C<g>.  If there has not "
2766 "been an error since the handle was created, then this returns C<NULL>."
2767 msgstr ""
2768
2769 #. type: textblock
2770 #: ../src/guestfs.pod:1379
2771 msgid ""
2772 "The lifetime of the returned string is until the next error occurs, or L</"
2773 "guestfs_close> is called."
2774 msgstr ""
2775
2776 #. type: =head2
2777 #: ../src/guestfs.pod:1382
2778 msgid "guestfs_last_errno"
2779 msgstr ""
2780
2781 #. type: verbatim
2782 #: ../src/guestfs.pod:1384
2783 #, no-wrap
2784 msgid ""
2785 " int guestfs_last_errno (guestfs_h *g);\n"
2786 "\n"
2787 msgstr ""
2788
2789 #. type: textblock
2790 #: ../src/guestfs.pod:1386
2791 msgid "This returns the last error number (errno) that happened on C<g>."
2792 msgstr ""
2793
2794 #. type: textblock
2795 #: ../src/guestfs.pod:1388
2796 msgid "If successful, an errno integer not equal to zero is returned."
2797 msgstr ""
2798
2799 #. type: textblock
2800 #: ../src/guestfs.pod:1390
2801 msgid ""
2802 "If no error, this returns 0.  This call can return 0 in three situations:"
2803 msgstr ""
2804
2805 #. type: textblock
2806 #: ../src/guestfs.pod:1397
2807 msgid "There has not been any error on the handle."
2808 msgstr ""
2809
2810 #. type: textblock
2811 #: ../src/guestfs.pod:1401
2812 msgid ""
2813 "There has been an error but the errno was meaningless.  This corresponds to "
2814 "the case where the error did not come from a failed system call, but for "
2815 "some other reason."
2816 msgstr ""
2817
2818 #. type: textblock
2819 #: ../src/guestfs.pod:1407
2820 msgid ""
2821 "There was an error from a failed system call, but for some reason the errno "
2822 "was not captured and returned.  This usually indicates a bug in libguestfs."
2823 msgstr ""
2824
2825 #. type: textblock
2826 #: ../src/guestfs.pod:1413
2827 msgid ""
2828 "Libguestfs tries to convert the errno from inside the applicance into a "
2829 "corresponding errno for the caller (not entirely trivial: the appliance "
2830 "might be running a completely different operating system from the library "
2831 "and error numbers are not standardized across Un*xen).  If this could not be "
2832 "done, then the error is translated to C<EINVAL>.  In practice this should "
2833 "only happen in very rare circumstances."
2834 msgstr ""
2835
2836 #. type: =head2
2837 #: ../src/guestfs.pod:1421
2838 msgid "guestfs_set_error_handler"
2839 msgstr ""
2840
2841 #. type: verbatim
2842 #: ../src/guestfs.pod:1423
2843 #, no-wrap
2844 msgid ""
2845 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2846 "                                           void *opaque,\n"
2847 "                                           const char *msg);\n"
2848 " void guestfs_set_error_handler (guestfs_h *g,\n"
2849 "                                 guestfs_error_handler_cb cb,\n"
2850 "                                 void *opaque);\n"
2851 "\n"
2852 msgstr ""
2853
2854 #. type: textblock
2855 #: ../src/guestfs.pod:1430
2856 msgid ""
2857 "The callback C<cb> will be called if there is an error.  The parameters "
2858 "passed to the callback are an opaque data pointer and the error message "
2859 "string."
2860 msgstr ""
2861
2862 #. type: textblock
2863 #: ../src/guestfs.pod:1434
2864 msgid ""
2865 "C<errno> is not passed to the callback.  To get that the callback must call "
2866 "L</guestfs_last_errno>."
2867 msgstr ""
2868
2869 #. type: textblock
2870 #: ../src/guestfs.pod:1437
2871 msgid ""
2872 "Note that the message string C<msg> is freed as soon as the callback "
2873 "function returns, so if you want to stash it somewhere you must make your "
2874 "own copy."
2875 msgstr ""
2876
2877 #. type: textblock
2878 #: ../src/guestfs.pod:1441
2879 msgid "The default handler prints messages on C<stderr>."
2880 msgstr ""
2881
2882 #. type: textblock
2883 #: ../src/guestfs.pod:1443
2884 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2885 msgstr ""
2886
2887 #. type: =head2
2888 #: ../src/guestfs.pod:1445
2889 msgid "guestfs_get_error_handler"
2890 msgstr ""
2891
2892 #. type: verbatim
2893 #: ../src/guestfs.pod:1447
2894 #, no-wrap
2895 msgid ""
2896 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2897 "                                                     void **opaque_rtn);\n"
2898 "\n"
2899 msgstr ""
2900
2901 #. type: textblock
2902 #: ../src/guestfs.pod:1450
2903 msgid "Returns the current error handler callback."
2904 msgstr ""
2905
2906 #. type: =head2
2907 #: ../src/guestfs.pod:1452
2908 msgid "guestfs_set_out_of_memory_handler"
2909 msgstr ""
2910
2911 #. type: verbatim
2912 #: ../src/guestfs.pod:1454
2913 #, no-wrap
2914 msgid ""
2915 " typedef void (*guestfs_abort_cb) (void);\n"
2916 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2917 "                                        guestfs_abort_cb);\n"
2918 "\n"
2919 msgstr ""
2920
2921 #. type: textblock
2922 #: ../src/guestfs.pod:1458
2923 msgid ""
2924 "The callback C<cb> will be called if there is an out of memory situation.  "
2925 "I<Note this callback must not return>."
2926 msgstr ""
2927
2928 #. type: textblock
2929 #: ../src/guestfs.pod:1461
2930 msgid "The default is to call L<abort(3)>."
2931 msgstr ""
2932
2933 #. type: textblock
2934 #: ../src/guestfs.pod:1463
2935 msgid ""
2936 "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
2937 msgstr ""
2938
2939 #. type: =head2
2940 #: ../src/guestfs.pod:1466
2941 msgid "guestfs_get_out_of_memory_handler"
2942 msgstr ""
2943
2944 #. type: verbatim
2945 #: ../src/guestfs.pod:1468
2946 #, no-wrap
2947 msgid ""
2948 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2949 "\n"
2950 msgstr ""
2951
2952 #. type: textblock
2953 #: ../src/guestfs.pod:1470
2954 msgid "This returns the current out of memory handler."
2955 msgstr ""
2956
2957 #. type: =head1
2958 #: ../src/guestfs.pod:1472
2959 msgid "API CALLS"
2960 msgstr ""
2961
2962 #. type: textblock
2963 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
2964 msgid "@ACTIONS@"
2965 msgstr "@ACTIONS@"
2966
2967 #. type: =head1
2968 #: ../src/guestfs.pod:1476
2969 msgid "STRUCTURES"
2970 msgstr "СТРУКТУРИ"
2971
2972 #. type: textblock
2973 #: ../src/guestfs.pod:1478
2974 msgid "@STRUCTS@"
2975 msgstr "@STRUCTS@"
2976
2977 #. type: =head1
2978 #: ../src/guestfs.pod:1480
2979 msgid "AVAILABILITY"
2980 msgstr ""
2981
2982 #. type: =head2
2983 #: ../src/guestfs.pod:1482
2984 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2985 msgstr ""
2986
2987 #. type: textblock
2988 #: ../src/guestfs.pod:1484
2989 msgid ""
2990 "Using L</guestfs_available> you can test availability of the following "
2991 "groups of functions.  This test queries the appliance to see if the "
2992 "appliance you are currently using supports the functionality."
2993 msgstr ""
2994
2995 #. type: textblock
2996 #: ../src/guestfs.pod:1489
2997 msgid "@AVAILABILITY@"
2998 msgstr ""
2999
3000 #. type: =head2
3001 #: ../src/guestfs.pod:1491
3002 msgid "GUESTFISH supported COMMAND"
3003 msgstr ""
3004
3005 #. type: textblock
3006 #: ../src/guestfs.pod:1493
3007 msgid ""
3008 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3009 "prints out the available groups and whether they are supported by this build "
3010 "of libguestfs.  Note however that you have to do C<run> first."
3011 msgstr ""
3012
3013 #. type: =head2
3014 #: ../src/guestfs.pod:1498
3015 msgid "SINGLE CALLS AT COMPILE TIME"
3016 msgstr ""
3017
3018 #. type: textblock
3019 #: ../src/guestfs.pod:1500
3020 msgid ""
3021 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3022 "function, such as:"
3023 msgstr ""
3024
3025 #. type: verbatim
3026 #: ../src/guestfs.pod:1503
3027 #, no-wrap
3028 msgid ""
3029 " #define LIBGUESTFS_HAVE_DD 1\n"
3030 "\n"
3031 msgstr ""
3032
3033 #. type: textblock
3034 #: ../src/guestfs.pod:1505
3035 msgid "if L</guestfs_dd> is available."
3036 msgstr ""
3037
3038 #. type: textblock
3039 #: ../src/guestfs.pod:1507
3040 msgid ""
3041 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3042 "function is available at compile time, we recommended using build tools such "
3043 "as autoconf or cmake.  For example in autotools you could use:"
3044 msgstr ""
3045
3046 #. type: verbatim
3047 #: ../src/guestfs.pod:1512
3048 #, no-wrap
3049 msgid ""
3050 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3051 " AC_CHECK_FUNCS([guestfs_dd])\n"
3052 "\n"
3053 msgstr ""
3054
3055 #. type: textblock
3056 #: ../src/guestfs.pod:1515
3057 msgid ""
3058 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3059 "in your program."
3060 msgstr ""
3061
3062 #. type: =head2
3063 #: ../src/guestfs.pod:1518
3064 msgid "SINGLE CALLS AT RUN TIME"
3065 msgstr ""
3066
3067 #. type: textblock
3068 #: ../src/guestfs.pod:1520
3069 msgid ""
3070 "Testing at compile time doesn't guarantee that a function really exists in "
3071 "the library.  The reason is that you might be dynamically linked against a "
3072 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
3073 "This situation unfortunately results in a segmentation fault, which is a "
3074 "shortcoming of the C dynamic linking system itself."
3075 msgstr ""
3076
3077 #. type: textblock
3078 #: ../src/guestfs.pod:1527
3079 msgid ""
3080 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3081 "in this example program (note that you still need the compile time check as "
3082 "well):"
3083 msgstr ""
3084
3085 #. type: verbatim
3086 #: ../src/guestfs.pod:1531
3087 #, no-wrap
3088 msgid ""
3089 " #include <stdio.h>\n"
3090 " #include <stdlib.h>\n"
3091 " #include <unistd.h>\n"
3092 " #include <dlfcn.h>\n"
3093 " #include <guestfs.h>\n"
3094 " \n"
3095 msgstr ""
3096
3097 #. type: verbatim
3098 #: ../src/guestfs.pod:1537
3099 #, no-wrap
3100 msgid ""
3101 " main ()\n"
3102 " {\n"
3103 " #ifdef LIBGUESTFS_HAVE_DD\n"
3104 "   void *dl;\n"
3105 "   int has_function;\n"
3106 " \n"
3107 msgstr ""
3108
3109 #. type: verbatim
3110 #: ../src/guestfs.pod:1543
3111 #, no-wrap
3112 msgid ""
3113 "   /* Test if the function guestfs_dd is really available. */\n"
3114 "   dl = dlopen (NULL, RTLD_LAZY);\n"
3115 "   if (!dl) {\n"
3116 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3117 "     exit (EXIT_FAILURE);\n"
3118 "   }\n"
3119 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3120 "   dlclose (dl);\n"
3121 " \n"
3122 msgstr ""
3123
3124 #. type: verbatim
3125 #: ../src/guestfs.pod:1552
3126 #, no-wrap
3127 msgid ""
3128 "   if (!has_function)\n"
3129 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3130 "   else {\n"
3131 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3132 "     /* Now it's safe to call\n"
3133 "     guestfs_dd (g, \"foo\", \"bar\");\n"
3134 "     */\n"
3135 "   }\n"
3136 " #else\n"
3137 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3138 " #endif\n"
3139 "  }\n"
3140 "\n"
3141 msgstr ""
3142
3143 #. type: textblock
3144 #: ../src/guestfs.pod:1565
3145 msgid ""
3146 "You may think the above is an awful lot of hassle, and it is.  There are "
3147 "other ways outside of the C linking system to ensure that this kind of "
3148 "incompatibility never arises, such as using package versioning:"
3149 msgstr ""
3150
3151 #. type: verbatim
3152 #: ../src/guestfs.pod:1570
3153 #, no-wrap
3154 msgid ""
3155 " Requires: libguestfs >= 1.0.80\n"
3156 "\n"
3157 msgstr ""
3158
3159 #. type: =head1
3160 #: ../src/guestfs.pod:1572
3161 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3162 msgstr ""
3163
3164 #. type: textblock
3165 #: ../src/guestfs.pod:1574
3166 msgid ""
3167 "A recent feature of the API is the introduction of calls which take optional "
3168 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
3169 "takes variable arguments (ie. C<...>), as in this example:"
3170 msgstr ""
3171
3172 #. type: verbatim
3173 #: ../src/guestfs.pod:1579
3174 #, no-wrap
3175 msgid ""
3176 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3177 "\n"
3178 msgstr ""
3179
3180 #. type: textblock
3181 #: ../src/guestfs.pod:1581
3182 msgid ""
3183 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
3184 "call with no optional arguments specified:"
3185 msgstr ""
3186
3187 #. type: verbatim
3188 #: ../src/guestfs.pod:1584
3189 #, no-wrap
3190 msgid ""
3191 " guestfs_add_drive_opts (g, filename, -1);\n"
3192 "\n"
3193 msgstr ""
3194
3195 #. type: textblock
3196 #: ../src/guestfs.pod:1586
3197 msgid "With a single optional argument:"
3198 msgstr ""
3199
3200 #. type: verbatim
3201 #: ../src/guestfs.pod:1588
3202 #, no-wrap
3203 msgid ""
3204 " guestfs_add_drive_opts (g, filename,\n"
3205 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3206 "                         -1);\n"
3207 "\n"
3208 msgstr ""
3209
3210 #. type: textblock
3211 #: ../src/guestfs.pod:1592
3212 msgid "With two:"
3213 msgstr ""
3214
3215 #. type: verbatim
3216 #: ../src/guestfs.pod:1594
3217 #, no-wrap
3218 msgid ""
3219 " guestfs_add_drive_opts (g, filename,\n"
3220 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3221 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3222 "                         -1);\n"
3223 "\n"
3224 msgstr ""
3225
3226 #. type: textblock
3227 #: ../src/guestfs.pod:1599
3228 msgid ""
3229 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
3230 "happen!"
3231 msgstr ""
3232
3233 #. type: =head2
3234 #: ../src/guestfs.pod:1602
3235 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3236 msgstr ""
3237
3238 #. type: textblock
3239 #: ../src/guestfs.pod:1604
3240 msgid ""
3241 "The second variant has the same name with the suffix C<_va>, which works the "
3242 "same way but takes a C<va_list>.  See the C manual for details.  For the "
3243 "example function, this is declared:"
3244 msgstr ""
3245
3246 #. type: verbatim
3247 #: ../src/guestfs.pod:1608
3248 #, no-wrap
3249 msgid ""
3250 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3251 "                                va_list args);\n"
3252 "\n"
3253 msgstr ""
3254
3255 #. type: =head2
3256 #: ../src/guestfs.pod:1611
3257 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3258 msgstr ""
3259
3260 #. type: textblock
3261 #: ../src/guestfs.pod:1613
3262 msgid ""
3263 "The third variant is useful where you need to construct these calls.  You "
3264 "pass in a structure where you fill in the optional fields.  The structure "
3265 "has a bitmask as the first element which you must set to indicate which "
3266 "fields you have filled in.  For our example function the structure and call "
3267 "are declared:"
3268 msgstr ""
3269
3270 #. type: verbatim
3271 #: ../src/guestfs.pod:1619
3272 #, no-wrap
3273 msgid ""
3274 " struct guestfs_add_drive_opts_argv {\n"
3275 "   uint64_t bitmask;\n"
3276 "   int readonly;\n"
3277 "   const char *format;\n"
3278 "   /* ... */\n"
3279 " };\n"
3280 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3281 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
3282 "\n"
3283 msgstr ""
3284
3285 #. type: textblock
3286 #: ../src/guestfs.pod:1628
3287 msgid "You could call it like this:"
3288 msgstr ""
3289
3290 #. type: verbatim
3291 #: ../src/guestfs.pod:1630
3292 #, no-wrap
3293 msgid ""
3294 " struct guestfs_add_drive_opts_argv optargs = {\n"
3295 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3296 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3297 "   .readonly = 1,\n"
3298 "   .format = \"qcow2\"\n"
3299 " };\n"
3300 " \n"
3301 msgstr ""
3302
3303 #. type: verbatim
3304 #: ../src/guestfs.pod:1637
3305 #, no-wrap
3306 msgid ""
3307 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3308 "\n"
3309 msgstr ""
3310
3311 #. type: textblock
3312 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3313 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:2842
3314 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
3315 #: ../fish/guestfish-actions.pod:1923 ../tools/virt-win-reg.pl:704
3316 msgid "Notes:"
3317 msgstr "Нотатки:"
3318
3319 #. type: textblock
3320 #: ../src/guestfs.pod:1645
3321 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3322 msgstr ""
3323
3324 #. type: textblock
3325 #: ../src/guestfs.pod:1650
3326 msgid "You do not need to fill in all fields of the structure."
3327 msgstr ""
3328
3329 #. type: textblock
3330 #: ../src/guestfs.pod:1654
3331 msgid ""
3332 "There must be a one-to-one correspondence between fields of the structure "
3333 "that are filled in, and bits set in the bitmask."
3334 msgstr ""
3335
3336 #. type: =head2
3337 #: ../src/guestfs.pod:1659
3338 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3339 msgstr ""
3340
3341 #. type: textblock
3342 #: ../src/guestfs.pod:1661
3343 msgid ""
3344 "In other languages, optional arguments are expressed in the way that is "
3345 "natural for that language.  We refer you to the language-specific "
3346 "documentation for more details on that."
3347 msgstr ""
3348
3349 #. type: textblock
3350 #: ../src/guestfs.pod:1665
3351 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3352 msgstr ""
3353
3354 #. type: =head2
3355 #: ../src/guestfs.pod:1667
3356 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3357 msgstr ""
3358
3359 #. type: textblock
3360 #: ../src/guestfs.pod:1669
3361 msgid ""
3362 "B<Note:> This section documents the generic event mechanism introduced in "
3363 "libguestfs 1.10, which you should use in new code if possible.  The old "
3364 "functions C<guestfs_set_log_message_callback>, "
3365 "C<guestfs_set_subprocess_quit_callback>, "
3366 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3367 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3368 "page.  Because of the ABI guarantee, the old functions continue to work."
3369 msgstr ""
3370
3371 #. type: textblock
3372 #: ../src/guestfs.pod:1678
3373 msgid ""
3374 "Handles generate events when certain things happen, such as log messages "
3375 "being generated, progress messages during long-running operations, or the "
3376 "handle being closed.  The API calls described below let you register a "
3377 "callback to be called when events happen.  You can register multiple "
3378 "callbacks (for the same, different or overlapping sets of events), and "
3379 "individually remove callbacks.  If callbacks are not removed, then they "
3380 "remain in force until the handle is closed."
3381 msgstr ""
3382
3383 #. type: textblock
3384 #: ../src/guestfs.pod:1686
3385 msgid ""
3386 "In the current implementation, events are only generated synchronously: that "
3387 "means that events (and hence callbacks) can only happen while you are in the "
3388 "middle of making another libguestfs call.  The callback is called in the "
3389 "same thread."
3390 msgstr ""
3391
3392 #. type: textblock
3393 #: ../src/guestfs.pod:1691
3394 msgid ""
3395 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3396 "unsigned integers, or a message buffer.  Payloads are discussed later on."
3397 msgstr ""
3398
3399 #. type: =head3
3400 #: ../src/guestfs.pod:1695
3401 msgid "CLASSES OF EVENTS"
3402 msgstr ""
3403
3404 #. type: =item
3405 #: ../src/guestfs.pod:1699
3406 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3407 msgstr ""
3408
3409 #. type: textblock
3410 #: ../src/guestfs.pod:1702
3411 msgid ""
3412 "The callback function will be called while the handle is being closed "
3413 "(synchronously from L</guestfs_close>)."
3414 msgstr ""
3415
3416 #. type: textblock
3417 #: ../src/guestfs.pod:1705
3418 msgid ""
3419 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3420 "handles that are open when the program exits.  This means that this callback "
3421 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3422 "problems in higher-level languages (eg. if your HLL interpreter has already "
3423 "been cleaned up by the time this is called, and if your callback then jumps "
3424 "into some HLL function)."
3425 msgstr ""
3426
3427 #. type: textblock
3428 #: ../src/guestfs.pod:1712
3429 msgid ""
3430 "If no callback is registered: the handle is closed without any callback "
3431 "being invoked."
3432 msgstr ""
3433
3434 #. type: =item
3435 #: ../src/guestfs.pod:1715
3436 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3437 msgstr ""
3438
3439 #. type: textblock
3440 #: ../src/guestfs.pod:1718
3441 msgid ""
3442 "The callback function will be called when the child process quits, either "
3443 "asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
3444 "corresponds to a transition from any state to the CONFIG state)."
3445 msgstr ""
3446
3447 #. type: textblock
3448 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3449 msgid "If no callback is registered: the event is ignored."
3450 msgstr ""
3451
3452 #. type: =item
3453 #: ../src/guestfs.pod:1724
3454 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3455 msgstr ""
3456
3457 #. type: textblock
3458 #: ../src/guestfs.pod:1727
3459 msgid ""
3460 "The callback function will be called when the child process becomes ready "
3461 "first time after it has been launched.  (This corresponds to a transition "
3462 "from LAUNCHING to the READY state)."
3463 msgstr ""
3464
3465 #. type: =item
3466 #: ../src/guestfs.pod:1733
3467 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3468 msgstr ""
3469
3470 #. type: textblock
3471 #: ../src/guestfs.pod:1736
3472 msgid ""
3473 "Some long-running operations can generate progress messages.  If this "
3474 "callback is registered, then it will be called each time a progress message "
3475 "is generated (usually two seconds after the operation started, and three "
3476 "times per second thereafter until it completes, although the frequency may "
3477 "change in future versions)."
3478 msgstr ""
3479
3480 #. type: textblock
3481 #: ../src/guestfs.pod:1742
3482 msgid ""
3483 "The callback receives in the payload four unsigned 64 bit numbers which are "
3484 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3485 msgstr ""
3486
3487 #. type: textblock
3488 #: ../src/guestfs.pod:1745
3489 msgid ""
3490 "The units of C<total> are not defined, although for some operations C<total> "
3491 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3492 "or megabytes), and C<position> may be the portion which has been transferred."
3493 msgstr ""
3494
3495 #. type: textblock
3496 #: ../src/guestfs.pod:1750
3497 msgid "The only defined and stable parts of the API are:"
3498 msgstr ""
3499
3500 #. type: textblock
3501 #: ../src/guestfs.pod:1756
3502 msgid ""
3503 "The callback can display to the user some type of progress bar or indicator "
3504 "which shows the ratio of C<position>:C<total>."
3505 msgstr ""
3506
3507 #. type: textblock
3508 #: ../src/guestfs.pod:1761
3509 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3510 msgstr ""
3511
3512 #. type: textblock
3513 #: ../src/guestfs.pod:1765
3514 msgid ""
3515 "If any progress notification is sent during a call, then a final progress "
3516 "notification is always sent when C<position> = C<total> (I<unless> the call "
3517 "fails with an error)."
3518 msgstr ""
3519
3520 #. type: textblock
3521 #: ../src/guestfs.pod:1769
3522 msgid ""
3523 "This is to simplify caller code, so callers can easily set the progress "
3524 "indicator to \"100%\" at the end of the operation, without requiring special "
3525 "code to detect this case."
3526 msgstr ""
3527
3528 #. type: textblock
3529 #: ../src/guestfs.pod:1775
3530 msgid ""
3531 "For some calls we are unable to estimate the progress of the call, but we "
3532 "can still generate progress messages to indicate activity.  This is known as "
3533 "\"pulse mode\", and is directly supported by certain progress bar "
3534 "implementations (eg. GtkProgressBar)."
3535 msgstr ""
3536
3537 #. type: textblock
3538 #: ../src/guestfs.pod:1780
3539 msgid ""
3540 "For these calls, zero or more progress messages are generated with "
3541 "C<position = 0> and C<total = 1>, followed by a final message with "
3542 "C<position = total = 1>."
3543 msgstr ""
3544
3545 #. type: textblock
3546 #: ../src/guestfs.pod:1784
3547 msgid ""
3548 "As noted above, if the call fails with an error then the final message may "
3549 "not be generated."
3550 msgstr ""
3551
3552 #. type: textblock
3553 #: ../src/guestfs.pod:1789
3554 msgid ""
3555 "The callback also receives the procedure number (C<proc_nr>) and serial "
3556 "number (C<serial>) of the call.  These are only useful for debugging "
3557 "protocol issues, and the callback can normally ignore them.  The callback "
3558 "may want to print these numbers in error messages or debugging messages."
3559 msgstr ""
3560
3561 #. type: textblock
3562 #: ../src/guestfs.pod:1795
3563 msgid "If no callback is registered: progress messages are discarded."
3564 msgstr ""
3565
3566 #. type: =item
3567 #: ../src/guestfs.pod:1797
3568 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3569 msgstr ""
3570
3571 #. type: textblock
3572 #: ../src/guestfs.pod:1800
3573 msgid ""
3574 "The callback function is called whenever a log message is generated by qemu, "
3575 "the appliance kernel, guestfsd (daemon), or utility programs."
3576 msgstr ""
3577
3578 #. type: textblock
3579 #: ../src/guestfs.pod:1803
3580 msgid ""
3581 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3582 "guestfs_launch>) then additional debug messages are generated."
3583 msgstr ""
3584
3585 #. type: textblock
3586 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3587 msgid ""
3588 "If no callback is registered: the messages are discarded unless the verbose "
3589 "flag is set in which case they are sent to stderr.  You can override the "
3590 "printing of verbose messages to stderr by setting up a callback."
3591 msgstr ""
3592
3593 #. type: =item
3594 #: ../src/guestfs.pod:1811
3595 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3596 msgstr ""
3597
3598 #. type: textblock
3599 #: ../src/guestfs.pod:1814
3600 msgid ""
3601 "The callback function is called whenever a log message is generated by the "
3602 "library part of libguestfs."
3603 msgstr ""
3604
3605 #. type: textblock
3606 #: ../src/guestfs.pod:1817
3607 msgid ""
3608 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3609 "messages are generated."
3610 msgstr ""
3611
3612 #. type: =item
3613 #: ../src/guestfs.pod:1825
3614 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3615 msgstr ""
3616
3617 #. type: textblock
3618 #: ../src/guestfs.pod:1828
3619 msgid ""
3620 "The callback function is called whenever a trace message is generated.  This "
3621 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3622 msgstr ""
3623
3624 #. type: textblock
3625 #: ../src/guestfs.pod:1831
3626 msgid ""
3627 "If no callback is registered: the messages are sent to stderr.  You can "
3628 "override the printing of trace messages to stderr by setting up a callback."
3629 msgstr ""
3630
3631 #. type: =head3
3632 #: ../src/guestfs.pod:1837
3633 msgid "guestfs_set_event_callback"
3634 msgstr ""
3635
3636 #. type: verbatim
3637 #: ../src/guestfs.pod:1839
3638 #, no-wrap
3639 msgid ""
3640 " int guestfs_set_event_callback (guestfs_h *g,\n"
3641 "                                 guestfs_event_callback cb,\n"
3642 "                                 uint64_t event_bitmask,\n"
3643 "                                 int flags,\n"
3644 "                                 void *opaque);\n"
3645 "\n"
3646 msgstr ""
3647
3648 #. type: textblock
3649 #: ../src/guestfs.pod:1845
3650 msgid ""
3651 "This function registers a callback (C<cb>) for all event classes in the "
3652 "C<event_bitmask>."
3653 msgstr ""
3654
3655 #. type: textblock
3656 #: ../src/guestfs.pod:1848
3657 msgid ""
3658 "For example, to register for all log message events, you could call this "
3659 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>.  "
3660 "To register a single callback for all possible classes of events, use "
3661 "C<GUESTFS_EVENT_ALL>."
3662 msgstr ""
3663
3664 #. type: textblock
3665 #: ../src/guestfs.pod:1854
3666 msgid "C<flags> should always be passed as 0."
3667 msgstr ""
3668
3669 #. type: textblock
3670 #: ../src/guestfs.pod:1856
3671 msgid ""
3672 "C<opaque> is an opaque pointer which is passed to the callback.  You can use "
3673 "it for any purpose."
3674 msgstr ""
3675
3676 #. type: textblock
3677 #: ../src/guestfs.pod:1859
3678 msgid ""
3679 "The return value is the event handle (an integer) which you can use to "
3680 "delete the callback (see below)."
3681 msgstr ""
3682
3683 #. type: textblock
3684 #: ../src/guestfs.pod:1862
3685 msgid ""
3686 "If there is an error, this function returns C<-1>, and sets the error in the "
3687 "handle in the usual way (see L</guestfs_last_error> etc.)"
3688 msgstr ""
3689
3690 #. type: textblock
3691 #: ../src/guestfs.pod:1865
3692 msgid ""
3693 "Callbacks remain in effect until they are deleted, or until the handle is "
3694 "closed."
3695 msgstr ""
3696
3697 #. type: textblock
3698 #: ../src/guestfs.pod:1868
3699 msgid ""
3700 "In the case where multiple callbacks are registered for a particular event "
3701 "class, all of the callbacks are called.  The order in which multiple "
3702 "callbacks are called is not defined."
3703 msgstr ""
3704
3705 #. type: =head3
3706 #: ../src/guestfs.pod:1872
3707 msgid "guestfs_delete_event_callback"
3708 msgstr ""
3709
3710 #. type: verbatim
3711 #: ../src/guestfs.pod:1874
3712 #, no-wrap
3713 msgid ""
3714 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3715 "\n"
3716 msgstr ""
3717
3718 #. type: textblock
3719 #: ../src/guestfs.pod:1876
3720 msgid ""
3721 "Delete a callback that was previously registered.  C<event_handle> should be "
3722 "the integer that was returned by a previous call to "
3723 "C<guestfs_set_event_callback> on the same handle."
3724 msgstr ""
3725
3726 #. type: =head3
3727 #: ../src/guestfs.pod:1880
3728 msgid "guestfs_event_callback"
3729 msgstr ""
3730
3731 #. type: verbatim
3732 #: ../src/guestfs.pod:1882
3733 #, no-wrap
3734 msgid ""
3735 " typedef void (*guestfs_event_callback) (\n"
3736 "                  guestfs_h *g,\n"
3737 "                  void *opaque,\n"
3738 "                  uint64_t event,\n"
3739 "                  int event_handle,\n"
3740 "                  int flags,\n"
3741 "                  const char *buf, size_t buf_len,\n"
3742 "                  const uint64_t *array, size_t array_len);\n"
3743 "\n"
3744 msgstr ""
3745
3746 #. type: textblock
3747 #: ../src/guestfs.pod:1891
3748 msgid ""
3749 "This is the type of the event callback function that you have to provide."
3750 msgstr ""
3751
3752 #. type: textblock
3753 #: ../src/guestfs.pod:1894
3754 msgid ""
3755 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3756 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3757 "handle, and C<flags> which in the current API you should ignore."
3758 msgstr ""
3759
3760 #. type: textblock
3761 #: ../src/guestfs.pod:1898
3762 msgid ""
3763 "The remaining parameters contain the event payload (if any).  Each event may "
3764 "contain a payload, which usually relates to the event class, but for future "
3765 "proofing your code should be written to handle any payload for any event "
3766 "class."
3767 msgstr ""
3768
3769 #. type: textblock
3770 #: ../src/guestfs.pod:1903
3771 msgid ""
3772 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3773 "there is no message buffer).  Note that this message buffer can contain "
3774 "arbitrary 8 bit data, including NUL bytes."
3775 msgstr ""
3776
3777 #. type: textblock
3778 #: ../src/guestfs.pod:1907
3779 msgid ""
3780 "C<array> and C<array_len> is an array of 64 bit unsigned integers.  At the "
3781 "moment this is only used for progress messages."
3782 msgstr ""
3783
3784 #. type: =head3
3785 #: ../src/guestfs.pod:1910
3786 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3787 msgstr ""
3788
3789 #. type: textblock
3790 #: ../src/guestfs.pod:1912
3791 msgid ""
3792 "One motivation for the generic event API was to allow GUI programs to "
3793 "capture debug and other messages.  In libguestfs E<le> 1.8 these were sent "
3794 "unconditionally to C<stderr>."
3795 msgstr ""
3796
3797 #. type: textblock
3798 #: ../src/guestfs.pod:1916
3799 msgid ""
3800 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3801 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>.  (Note that error "
3802 "messages are not events; you must capture error messages separately)."
3803 msgstr ""
3804
3805 #. type: textblock
3806 #: ../src/guestfs.pod:1921
3807 msgid ""
3808 "Programs have to set up a callback to capture the classes of events of "
3809 "interest:"
3810 msgstr ""
3811
3812 #. type: verbatim
3813 #: ../src/guestfs.pod:1924
3814 #, no-wrap
3815 msgid ""
3816 " int eh =\n"
3817 "   guestfs_set_event_callback\n"
3818 "     (g, message_callback,\n"
3819 "      GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3820 "      GUESTFS_EVENT_TRACE,\n"
3821 "      0, NULL) == -1)\n"
3822 " if (eh == -1) {\n"
3823 "   // handle error in the usual way\n"
3824 " }\n"
3825 "\n"
3826 msgstr ""
3827
3828 #. type: textblock
3829 #: ../src/guestfs.pod:1934
3830 msgid ""
3831 "The callback can then direct messages to the appropriate place.  In this "
3832 "example, messages are directed to syslog:"
3833 msgstr ""
3834
3835 #. type: verbatim
3836 #: ../src/guestfs.pod:1937
3837 #, no-wrap
3838 msgid ""
3839 " static void\n"
3840 " message_callback (\n"
3841 "         guestfs_h *g,\n"
3842 "         void *opaque,\n"
3843 "         uint64_t event,\n"
3844 "         int event_handle,\n"
3845 "         int flags,\n"
3846 "         const char *buf, size_t buf_len,\n"
3847 "         const uint64_t *array, size_t array_len)\n"
3848 " {\n"
3849 "   const int priority = LOG_USER|LOG_INFO;\n"
3850 "   if (buf_len > 0)\n"
3851 "     syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3852 " }\n"
3853 "\n"
3854 msgstr ""
3855
3856 #. type: =head1
3857 #: ../src/guestfs.pod:1952
3858 msgid "PRIVATE DATA AREA"
3859 msgstr ""
3860
3861 #. type: textblock
3862 #: ../src/guestfs.pod:1954
3863 msgid ""
3864 "You can attach named pieces of private data to the libguestfs handle, fetch "
3865 "them by name, and walk over them, for the lifetime of the handle.  This is "
3866 "called the private data area and is only available from the C API."
3867 msgstr ""
3868
3869 #. type: textblock
3870 #: ../src/guestfs.pod:1959
3871 msgid "To attach a named piece of data, use the following call:"
3872 msgstr ""
3873
3874 #. type: verbatim
3875 #: ../src/guestfs.pod:1961
3876 #, no-wrap
3877 msgid ""
3878 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3879 "\n"
3880 msgstr ""
3881
3882 #. type: textblock
3883 #: ../src/guestfs.pod:1963
3884 msgid ""
3885 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3886 "pointer (which can be C<NULL>).  Any previous item with the same key is "
3887 "overwritten."
3888 msgstr ""
3889
3890 #. type: textblock
3891 #: ../src/guestfs.pod:1967
3892 msgid ""
3893 "You can use any C<key> you want, but your key should I<not> start with an "
3894 "underscore character.  Keys beginning with an underscore character are "
3895 "reserved for internal libguestfs purposes (eg. for implementing language "
3896 "bindings).  It is recommended that you prefix the key with some unique "
3897 "string to avoid collisions with other users."
3898 msgstr ""
3899
3900 #. type: textblock
3901 #: ../src/guestfs.pod:1973
3902 msgid "To retrieve the pointer, use:"
3903 msgstr ""
3904
3905 #. type: verbatim
3906 #: ../src/guestfs.pod:1975
3907 #, no-wrap
3908 msgid ""
3909 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3910 "\n"
3911 msgstr ""
3912
3913 #. type: textblock
3914 #: ../src/guestfs.pod:1977
3915 msgid ""
3916 "This function returns C<NULL> if either no data is found associated with "
3917 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3918 "C<NULL>."
3919 msgstr ""
3920
3921 #. type: textblock
3922 #: ../src/guestfs.pod:1981
3923 msgid ""
3924 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3925 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
3926 "all.  In particular, libguestfs does I<not> try to free the data when the "
3927 "handle is closed.  If the data must be freed, then the caller must either "
3928 "free it before calling L</guestfs_close> or must set up a close callback to "
3929 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3930 msgstr ""
3931
3932 #. type: textblock
3933 #: ../src/guestfs.pod:1988
3934 msgid "To walk over all entries, use these two functions:"
3935 msgstr ""
3936
3937 #. type: verbatim
3938 #: ../src/guestfs.pod:1990
3939 #, no-wrap
3940 msgid ""
3941 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3942 "\n"
3943 msgstr ""
3944
3945 #. type: verbatim
3946 #: ../src/guestfs.pod:1992
3947 #, no-wrap
3948 msgid ""
3949 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3950 "\n"
3951 msgstr ""
3952
3953 #. type: textblock
3954 #: ../src/guestfs.pod:1994
3955 msgid ""
3956 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3957 "not have any particular meaning -- keys are not returned in any defined "
3958 "order).  A pointer to the key is returned in C<*key_rtn> and the "
3959 "corresponding data pointer is returned from the function.  C<NULL> is "
3960 "returned if there are no keys stored in the handle."
3961 msgstr ""
3962
3963 #. type: textblock
3964 #: ../src/guestfs.pod:2000
3965 msgid ""
3966 "C<guestfs_next_private> returns the next key, pointer pair.  The return "
3967 "value of this function is also C<NULL> is there are no further entries to "
3968 "return."
3969 msgstr ""
3970
3971 #. type: textblock
3972 #: ../src/guestfs.pod:2004
3973 msgid "Notes about walking over entries:"
3974 msgstr ""
3975
3976 #. type: textblock
3977 #: ../src/guestfs.pod:2010
3978 msgid ""
3979 "You must not call C<guestfs_set_private> while walking over the entries."
3980 msgstr ""
3981
3982 #. type: textblock
3983 #: ../src/guestfs.pod:2015
3984 msgid ""
3985 "The handle maintains an internal iterator which is reset when you call "
3986 "C<guestfs_first_private>.  This internal iterator is invalidated when you "
3987 "call C<guestfs_set_private>."
3988 msgstr ""
3989
3990 #. type: textblock
3991 #: ../src/guestfs.pod:2021
3992 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3993 msgstr ""
3994
3995 #. type: verbatim
3996 #: ../src/guestfs.pod:2023
3997 #, no-wrap
3998 msgid ""
3999 " guestfs_set_private (g, key, NULL);\n"
4000 "\n"
4001 msgstr ""
4002
4003 #. type: textblock
4004 #: ../src/guestfs.pod:2025
4005 msgid "then that C<key> is not returned when walking."
4006 msgstr ""
4007
4008 #. type: textblock
4009 #: ../src/guestfs.pod:2029
4010 msgid ""
4011 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4012 "C<guestfs_next_private> or C<guestfs_set_private>."
4013 msgstr ""
4014
4015 #. type: textblock
4016 #: ../src/guestfs.pod:2035
4017 msgid ""
4018 "The following example code shows how to print all keys and data pointers "
4019 "that are associated with the handle C<g>:"
4020 msgstr ""
4021
4022 #. type: verbatim
4023 #: ../src/guestfs.pod:2038
4024 #, no-wrap
4025 msgid ""
4026 " const char *key;\n"
4027 " void *data = guestfs_first_private (g, &key);\n"
4028 " while (data != NULL)\n"
4029 "   {\n"
4030 "     printf (\"key = %s, data = %p\\n\", key, data);\n"
4031 "     data = guestfs_next_private (g, &key);\n"
4032 "   }\n"
4033 "\n"
4034 msgstr ""
4035
4036 #. type: textblock
4037 #: ../src/guestfs.pod:2046
4038 msgid ""
4039 "More commonly you are only interested in keys that begin with an application-"
4040 "specific prefix C<foo_>.  Modify the loop like so:"
4041 msgstr ""
4042
4043 #. type: verbatim
4044 #: ../src/guestfs.pod:2049
4045 #, no-wrap
4046 msgid ""
4047 " const char *key;\n"
4048 " void *data = guestfs_first_private (g, &key);\n"
4049 " while (data != NULL)\n"
4050 "   {\n"
4051 "     if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4052 "       printf (\"key = %s, data = %p\\n\", key, data);\n"
4053 "     data = guestfs_next_private (g, &key);\n"
4054 "   }\n"
4055 "\n"
4056 msgstr ""
4057
4058 #. type: textblock
4059 #: ../src/guestfs.pod:2058
4060 msgid ""
4061 "If you need to modify keys while walking, then you have to jump back to the "
4062 "beginning of the loop.  For example, to delete all keys prefixed with "
4063 "C<foo_>:"
4064 msgstr ""
4065
4066 #. type: verbatim
4067 #: ../src/guestfs.pod:2062
4068 #, no-wrap
4069 msgid ""
4070 "  const char *key;\n"
4071 "  void *data;\n"
4072 " again:\n"
4073 "  data = guestfs_first_private (g, &key);\n"
4074 "  while (data != NULL)\n"
4075 "    {\n"
4076 "      if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4077 "        {\n"
4078 "          guestfs_set_private (g, key, NULL);\n"
4079 "          /* note that 'key' pointer is now invalid, and so is\n"
4080 "             the internal iterator */\n"
4081 "          goto again;\n"
4082 "        }\n"
4083 "      data = guestfs_next_private (g, &key);\n"
4084 "    }\n"
4085 "\n"
4086 msgstr ""
4087
4088 #. type: textblock
4089 #: ../src/guestfs.pod:2078
4090 msgid ""
4091 "Note that the above loop is guaranteed to terminate beca