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