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