po-docs/ja.po

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