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