po-docs/libguestfs-docs.pot

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