po-docs/uk.po

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