+#. type: =head2
+#: ../src/guestfs.pod:1466
+msgid "guestfs_get_out_of_memory_handler"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1468
+#, no-wrap
+msgid ""
+" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1470
+msgid "This returns the current out of memory handler."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:1472
+msgid "API CALLS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1068
+msgid "@ACTIONS@"
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:1476
+msgid "STRUCTURES"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1478
+msgid "@STRUCTS@"
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:1480
+msgid "AVAILABILITY"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1482
+msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1484
+msgid ""
+"Using L</guestfs_available> you can test availability of the following "
+"groups of functions. This test queries the appliance to see if the "
+"appliance you are currently using supports the functionality."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1489
+msgid "@AVAILABILITY@"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1491
+msgid "GUESTFISH supported COMMAND"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1493
+msgid ""
+"In L<guestfish(3)> there is a handy interactive command C<supported> which "
+"prints out the available groups and whether they are supported by this build"
+" of libguestfs. Note however that you have to do C<run> first."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1498
+msgid "SINGLE CALLS AT COMPILE TIME"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1500
+msgid ""
+"Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
+"function, such as:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1503
+#, no-wrap
+msgid ""
+" #define LIBGUESTFS_HAVE_DD 1\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1505
+msgid "if L</guestfs_dd> is available."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1507
+msgid ""
+"Before version 1.5.8, if you needed to test whether a single libguestfs "
+"function is available at compile time, we recommended using build tools such"
+" as autoconf or cmake. For example in autotools you could use:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1512
+#, no-wrap
+msgid ""
+" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
+" AC_CHECK_FUNCS([guestfs_dd])\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1515
+msgid ""
+"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined"
+" in your program."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1518
+msgid "SINGLE CALLS AT RUN TIME"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1520
+msgid ""
+"Testing at compile time doesn't guarantee that a function really exists in "
+"the library. The reason is that you might be dynamically linked against a "
+"previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
+"This situation unfortunately results in a segmentation fault, which is a "
+"shortcoming of the C dynamic linking system itself."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1527
+msgid ""
+"You can use L<dlopen(3)> to test if a function is available at run time, as "
+"in this example program (note that you still need the compile time check as "
+"well):"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1531
+#, no-wrap
+msgid ""
+" #include <stdio.h>\n"
+" #include <stdlib.h>\n"
+" #include <unistd.h>\n"
+" #include <dlfcn.h>\n"
+" #include <guestfs.h>\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1537
+#, no-wrap
+msgid ""
+" main ()\n"
+" {\n"
+" #ifdef LIBGUESTFS_HAVE_DD\n"
+" void *dl;\n"
+" int has_function;\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1543
+#, no-wrap
+msgid ""
+" /* Test if the function guestfs_dd is really available. */\n"
+" dl = dlopen (NULL, RTLD_LAZY);\n"
+" if (!dl) {\n"
+" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
+" exit (EXIT_FAILURE);\n"
+" }\n"
+" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
+" dlclose (dl);\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1552
+#, no-wrap
+msgid ""
+" if (!has_function)\n"
+" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
+" else {\n"
+" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
+" /* Now it's safe to call\n"
+" guestfs_dd (g, \"foo\", \"bar\");\n"
+" */\n"
+" }\n"
+" #else\n"
+" printf (\"guestfs_dd function was not found at compile time\\n\");\n"
+" #endif\n"
+" }\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1565
+msgid ""
+"You may think the above is an awful lot of hassle, and it is. There are "
+"other ways outside of the C linking system to ensure that this kind of "
+"incompatibility never arises, such as using package versioning:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1570
+#, no-wrap
+msgid ""
+" Requires: libguestfs >= 1.0.80\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:1572
+msgid "CALLS WITH OPTIONAL ARGUMENTS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1574
+msgid ""
+"A recent feature of the API is the introduction of calls which take optional"
+" arguments. In C these are declared 3 ways. The main way is as a call "
+"which takes variable arguments (ie. C<...>), as in this example:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1579
+#, no-wrap
+msgid ""
+" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1581
+msgid ""
+"Call this with a list of optional arguments, terminated by C<-1>. So to "
+"call with no optional arguments specified:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1584
+#, no-wrap
+msgid ""
+" guestfs_add_drive_opts (g, filename, -1);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1586
+msgid "With a single optional argument:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1588
+#, no-wrap
+msgid ""
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
+" -1);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1592
+msgid "With two:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1594
+#, no-wrap
+msgid ""
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
+" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
+" -1);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1599
+msgid ""
+"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
+"happen!"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1602
+msgid "USING va_list FOR OPTIONAL ARGUMENTS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1604
+msgid ""
+"The second variant has the same name with the suffix C<_va>, which works the"
+" same way but takes a C<va_list>. See the C manual for details. For the "
+"example function, this is declared:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1608
+#, no-wrap
+msgid ""
+" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1611
+msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1613
+msgid ""
+"The third variant is useful where you need to construct these calls. You "
+"pass in a structure where you fill in the optional fields. The structure "
+"has a bitmask as the first element which you must set to indicate which "
+"fields you have filled in. For our example function the structure and call "
+"are declared:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1619
+#, no-wrap
+msgid ""
+" struct guestfs_add_drive_opts_argv {\n"
+" uint64_t bitmask;\n"
+" int readonly;\n"
+" const char *format;\n"
+" /* ... */\n"
+" };\n"
+" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
+" const struct guestfs_add_drive_opts_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1628
+msgid "You could call it like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1630
+#, no-wrap
+msgid ""
+" struct guestfs_add_drive_opts_argv optargs = {\n"
+" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
+" .readonly = 1,\n"
+" .format = \"qcow2\"\n"
+" };\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1637
+#, no-wrap
+msgid ""
+" guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
+#: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2853
+#: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
+#: ../fish/guestfish-actions.pod:1929 ../tools/virt-win-reg.pl:704
+msgid "Notes:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1645
+msgid ""
+"The C<_BITMASK> suffix on each option name when specifying the bitmask."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1650
+msgid "You do not need to fill in all fields of the structure."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1654
+msgid ""
+"There must be a one-to-one correspondence between fields of the structure "
+"that are filled in, and bits set in the bitmask."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1659
+msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1661
+msgid ""
+"In other languages, optional arguments are expressed in the way that is "
+"natural for that language. We refer you to the language-specific "
+"documentation for more details on that."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1665
+msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1667
+msgid "SETTING CALLBACKS TO HANDLE EVENTS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1669
+msgid ""
+"B<Note:> This section documents the generic event mechanism introduced in "
+"libguestfs 1.10, which you should use in new code if possible. The old "
+"functions C<guestfs_set_log_message_callback>, "
+"C<guestfs_set_subprocess_quit_callback>, "
+"C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
+"C<guestfs_set_progress_callback> are no longer documented in this manual "
+"page. Because of the ABI guarantee, the old functions continue to work."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1678
+msgid ""
+"Handles generate events when certain things happen, such as log messages "
+"being generated, progress messages during long-running operations, or the "
+"handle being closed. The API calls described below let you register a "
+"callback to be called when events happen. You can register multiple "
+"callbacks (for the same, different or overlapping sets of events), and "
+"individually remove callbacks. If callbacks are not removed, then they "
+"remain in force until the handle is closed."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1686
+msgid ""
+"In the current implementation, events are only generated synchronously: that"
+" means that events (and hence callbacks) can only happen while you are in "
+"the middle of making another libguestfs call. The callback is called in the"
+" same thread."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1691
+msgid ""
+"Events may contain a payload, usually nothing (void), an array of 64 bit "
+"unsigned integers, or a message buffer. Payloads are discussed later on."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:1695
+msgid "CLASSES OF EVENTS"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1699
+msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1702
+msgid ""
+"The callback function will be called while the handle is being closed "
+"(synchronously from L</guestfs_close>)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1705
+msgid ""
+"Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
+"handles that are open when the program exits. This means that this callback"
+" might be called indirectly from L<exit(3)>, which can cause unexpected "
+"problems in higher-level languages (eg. if your HLL interpreter has already "
+"been cleaned up by the time this is called, and if your callback then jumps "
+"into some HLL function)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1712
+msgid ""
+"If no callback is registered: the handle is closed without any callback "
+"being invoked."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1715
+msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1718
+msgid ""
+"The callback function will be called when the child process quits, either "
+"asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
+"corresponds to a transition from any state to the CONFIG state)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
+msgid "If no callback is registered: the event is ignored."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1724
+msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1727
+msgid ""
+"The callback function will be called when the child process becomes ready "
+"first time after it has been launched. (This corresponds to a transition "
+"from LAUNCHING to the READY state)."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1733
+msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1736
+msgid ""
+"Some long-running operations can generate progress messages. If this "
+"callback is registered, then it will be called each time a progress message "
+"is generated (usually two seconds after the operation started, and three "
+"times per second thereafter until it completes, although the frequency may "
+"change in future versions)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1742
+msgid ""
+"The callback receives in the payload four unsigned 64 bit numbers which are "
+"(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1745
+msgid ""
+"The units of C<total> are not defined, although for some operations C<total>"
+" may relate in some way to the amount of data to be transferred (eg. in "
+"bytes or megabytes), and C<position> may be the portion which has been "
+"transferred."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1750
+msgid "The only defined and stable parts of the API are:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1756
+msgid ""
+"The callback can display to the user some type of progress bar or indicator "
+"which shows the ratio of C<position>:C<total>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1761
+msgid "0 E<lt>= C<position> E<lt>= C<total>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1765
+msgid ""
+"If any progress notification is sent during a call, then a final progress "
+"notification is always sent when C<position> = C<total> (I<unless> the call "
+"fails with an error)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1769
+msgid ""
+"This is to simplify caller code, so callers can easily set the progress "
+"indicator to \"100%\" at the end of the operation, without requiring special"
+" code to detect this case."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1775
+msgid ""
+"For some calls we are unable to estimate the progress of the call, but we "
+"can still generate progress messages to indicate activity. This is known as"
+" \"pulse mode\", and is directly supported by certain progress bar "
+"implementations (eg. GtkProgressBar)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1780
+msgid ""
+"For these calls, zero or more progress messages are generated with "
+"C<position = 0> and C<total = 1>, followed by a final message with "
+"C<position = total = 1>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1784
+msgid ""
+"As noted above, if the call fails with an error then the final message may "
+"not be generated."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1789
+msgid ""
+"The callback also receives the procedure number (C<proc_nr>) and serial "
+"number (C<serial>) of the call. These are only useful for debugging "
+"protocol issues, and the callback can normally ignore them. The callback "
+"may want to print these numbers in error messages or debugging messages."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1795
+msgid "If no callback is registered: progress messages are discarded."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1797
+msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1800
+msgid ""
+"The callback function is called whenever a log message is generated by qemu,"
+" the appliance kernel, guestfsd (daemon), or utility programs."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1803
+msgid ""
+"If the verbose flag (L</guestfs_set_verbose>) is set before launch "
+"(L</guestfs_launch>) then additional debug messages are generated."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
+msgid ""
+"If no callback is registered: the messages are discarded unless the verbose "
+"flag is set in which case they are sent to stderr. You can override the "
+"printing of verbose messages to stderr by setting up a callback."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1811
+msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1814
+msgid ""
+"The callback function is called whenever a log message is generated by the "
+"library part of libguestfs."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1817
+msgid ""
+"If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
+"messages are generated."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:1825
+msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1828
+msgid ""
+"The callback function is called whenever a trace message is generated. This"
+" only applies if the trace flag (L</guestfs_set_trace>) is set."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1831
+msgid ""
+"If no callback is registered: the messages are sent to stderr. You can "
+"override the printing of trace messages to stderr by setting up a callback."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:1837
+msgid "guestfs_set_event_callback"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1839
+#, no-wrap
+msgid ""
+" int guestfs_set_event_callback (guestfs_h *g,\n"
+" guestfs_event_callback cb,\n"
+" uint64_t event_bitmask,\n"
+" int flags,\n"
+" void *opaque);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1845
+msgid ""
+"This function registers a callback (C<cb>) for all event classes in the "
+"C<event_bitmask>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1848
+msgid ""
+"For example, to register for all log message events, you could call this "
+"function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>."
+" To register a single callback for all possible classes of events, use "
+"C<GUESTFS_EVENT_ALL>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1854
+msgid "C<flags> should always be passed as 0."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1856
+msgid ""
+"C<opaque> is an opaque pointer which is passed to the callback. You can use"
+" it for any purpose."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1859
+msgid ""
+"The return value is the event handle (an integer) which you can use to "
+"delete the callback (see below)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1862
+msgid ""
+"If there is an error, this function returns C<-1>, and sets the error in the"
+" handle in the usual way (see L</guestfs_last_error> etc.)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1865
+msgid ""
+"Callbacks remain in effect until they are deleted, or until the handle is "
+"closed."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1868
+msgid ""
+"In the case where multiple callbacks are registered for a particular event "
+"class, all of the callbacks are called. The order in which multiple "
+"callbacks are called is not defined."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:1872
+msgid "guestfs_delete_event_callback"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1874
+#, no-wrap
+msgid ""
+" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1876
+msgid ""
+"Delete a callback that was previously registered. C<event_handle> should be"
+" the integer that was returned by a previous call to "
+"C<guestfs_set_event_callback> on the same handle."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:1880
+msgid "guestfs_event_callback"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1882
+#, no-wrap
+msgid ""
+" typedef void (*guestfs_event_callback) (\n"
+" guestfs_h *g,\n"
+" void *opaque,\n"
+" uint64_t event,\n"
+" int event_handle,\n"
+" int flags,\n"
+" const char *buf, size_t buf_len,\n"
+" const uint64_t *array, size_t array_len);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1891
+msgid ""
+"This is the type of the event callback function that you have to provide."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1894
+msgid ""
+"The basic parameters are: the handle (C<g>), the opaque user pointer "
+"(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
+"handle, and C<flags> which in the current API you should ignore."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1898
+msgid ""
+"The remaining parameters contain the event payload (if any). Each event may"
+" contain a payload, which usually relates to the event class, but for future"
+" proofing your code should be written to handle any payload for any event "
+"class."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1903
+msgid ""
+"C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
+"there is no message buffer). Note that this message buffer can contain "
+"arbitrary 8 bit data, including NUL bytes."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1907
+msgid ""
+"C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
+"moment this is only used for progress messages."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:1910
+msgid "EXAMPLE: CAPTURING LOG MESSAGES"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1912
+msgid ""
+"One motivation for the generic event API was to allow GUI programs to "
+"capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
+"unconditionally to C<stderr>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1916
+msgid ""
+"Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
+"C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
+"messages are not events; you must capture error messages separately)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1921
+msgid ""
+"Programs have to set up a callback to capture the classes of events of "
+"interest:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1924
+#, no-wrap
+msgid ""
+" int eh =\n"
+" guestfs_set_event_callback\n"
+" (g, message_callback,\n"
+" GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
+" GUESTFS_EVENT_TRACE,\n"
+" 0, NULL) == -1)\n"
+" if (eh == -1) {\n"
+" // handle error in the usual way\n"
+" }\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1934
+msgid ""
+"The callback can then direct messages to the appropriate place. In this "
+"example, messages are directed to syslog:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1937
+#, no-wrap
+msgid ""
+" static void\n"
+" message_callback (\n"
+" guestfs_h *g,\n"
+" void *opaque,\n"
+" uint64_t event,\n"
+" int event_handle,\n"
+" int flags,\n"
+" const char *buf, size_t buf_len,\n"
+" const uint64_t *array, size_t array_len)\n"
+" {\n"
+" const int priority = LOG_USER|LOG_INFO;\n"
+" if (buf_len > 0)\n"
+" syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
+" }\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:1952
+msgid "CANCELLING LONG TRANSFERS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1954
+msgid ""
+"Some operations can be cancelled by the caller while they are in progress. "
+"Currently only operations that involve uploading or downloading data can be "
+"cancelled (technically: operations that have C<FileIn> or C<FileOut> "
+"parameters in the generator)."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1959
+msgid "guestfs_user_cancel"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1961
+#, no-wrap
+msgid ""
+" void guestfs_user_cancel (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1963
+msgid ""
+"C<guestfs_user_cancel> cancels the current upload or download operation."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1966
+msgid ""
+"Unlike most other libguestfs calls, this function is signal safe and thread "
+"safe. You can call it from a signal handler or from another thread, without"
+" needing to do any locking."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1970
+msgid ""
+"The transfer that was in progress (if there is one) will stop shortly "
+"afterwards, and will return an error. The errno (see "
+"L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find"
+" out if the operation was cancelled or failed because of another error."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1976
+msgid ""
+"No cleanup is performed: for example, if a file was being uploaded then "
+"after cancellation there may be a partially uploaded file. It is the "
+"caller's responsibility to clean up if necessary."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1980
+msgid ""
+"There are two common places that you might call C<guestfs_user_cancel>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1982
+msgid ""
+"In an interactive text-based program, you might call it from a C<SIGINT> "
+"signal handler so that pressing C<^C> cancels the current operation. (You "
+"also need to call L</guestfs_set_pgroup> so that child processes don't "
+"receive the C<^C> signal)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1987
+msgid ""
+"In a graphical program, when the main thread is displaying a progress bar "
+"with a cancel button, wire up the cancel button to call this function."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:1991
+msgid "PRIVATE DATA AREA"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1993
+msgid ""
+"You can attach named pieces of private data to the libguestfs handle, fetch "
+"them by name, and walk over them, for the lifetime of the handle. This is "
+"called the private data area and is only available from the C API."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1998
+msgid "To attach a named piece of data, use the following call:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2000
+#, no-wrap
+msgid ""
+" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2002
+msgid ""
+"C<key> is the name to associate with this data, and C<data> is an arbitrary "
+"pointer (which can be C<NULL>). Any previous item with the same key is "
+"overwritten."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2006
+msgid ""
+"You can use any C<key> you want, but your key should I<not> start with an "
+"underscore character. Keys beginning with an underscore character are "
+"reserved for internal libguestfs purposes (eg. for implementing language "
+"bindings). It is recommended that you prefix the key with some unique "
+"string to avoid collisions with other users."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2012
+msgid "To retrieve the pointer, use:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2014
+#, no-wrap
+msgid ""
+" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2016
+msgid ""
+"This function returns C<NULL> if either no data is found associated with "
+"C<key>, or if the user previously set the C<key>'s C<data> pointer to "
+"C<NULL>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2020
+msgid ""
+"Libguestfs does not try to look at or interpret the C<data> pointer in any "
+"way. As far as libguestfs is concerned, it need not be a valid pointer at "
+"all. In particular, libguestfs does I<not> try to free the data when the "
+"handle is closed. If the data must be freed, then the caller must either "
+"free it before calling L</guestfs_close> or must set up a close callback to "
+"do it (see L</GUESTFS_EVENT_CLOSE>)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2027
+msgid "To walk over all entries, use these two functions:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2029
+#, no-wrap
+msgid ""
+" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2031
+#, no-wrap
+msgid ""
+" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2033
+msgid ""
+"C<guestfs_first_private> returns the first key, pointer pair (\"first\" does"
+" not have any particular meaning -- keys are not returned in any defined "
+"order). A pointer to the key is returned in C<*key_rtn> and the "
+"corresponding data pointer is returned from the function. C<NULL> is "
+"returned if there are no keys stored in the handle."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2039
+msgid ""
+"C<guestfs_next_private> returns the next key, pointer pair. The return "
+"value of this function is also C<NULL> is there are no further entries to "
+"return."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2043
+msgid "Notes about walking over entries:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2049
+msgid ""
+"You must not call C<guestfs_set_private> while walking over the entries."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2054
+msgid ""
+"The handle maintains an internal iterator which is reset when you call "
+"C<guestfs_first_private>. This internal iterator is invalidated when you "
+"call C<guestfs_set_private>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2060
+msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2062
+#, no-wrap
+msgid ""
+" guestfs_set_private (g, key, NULL);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2064
+msgid "then that C<key> is not returned when walking."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2068
+msgid ""
+"C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
+"C<guestfs_next_private> or C<guestfs_set_private>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2074
+msgid ""
+"The following example code shows how to print all keys and data pointers "
+"that are associated with the handle C<g>:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2077
+#, no-wrap
+msgid ""
+" const char *key;\n"
+" void *data = guestfs_first_private (g, &key);\n"
+" while (data != NULL)\n"
+" {\n"
+" printf (\"key = %s, data = %p\\n\", key, data);\n"
+" data = guestfs_next_private (g, &key);\n"
+" }\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2085
+msgid ""
+"More commonly you are only interested in keys that begin with an "
+"application-specific prefix C<foo_>. Modify the loop like so:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2088
+#, no-wrap
+msgid ""
+" const char *key;\n"
+" void *data = guestfs_first_private (g, &key);\n"
+" while (data != NULL)\n"
+" {\n"
+" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
+" printf (\"key = %s, data = %p\\n\", key, data);\n"
+" data = guestfs_next_private (g, &key);\n"
+" }\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2097
+msgid ""
+"If you need to modify keys while walking, then you have to jump back to the "
+"beginning of the loop. For example, to delete all keys prefixed with "
+"C<foo_>:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2101
+#, no-wrap
+msgid ""
+" const char *key;\n"
+" void *data;\n"
+" again:\n"
+" data = guestfs_first_private (g, &key);\n"
+" while (data != NULL)\n"
+" {\n"
+" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
+" {\n"
+" guestfs_set_private (g, key, NULL);\n"
+" /* note that 'key' pointer is now invalid, and so is\n"
+" the internal iterator */\n"
+" goto again;\n"
+" }\n"
+" data = guestfs_next_private (g, &key);\n"
+" }\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2117
+msgid ""
+"Note that the above loop is guaranteed to terminate because the keys are "
+"being deleted, but other manipulations of keys within the loop might not "
+"terminate unless you also maintain an indication of which keys have been "
+"visited."
+msgstr ""
+
+#. type: =end
+#: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
+msgid "html"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2124
+msgid ""
+"<!-- old anchor for the next section --> <a "
+"name=\"state_machine_and_low_level_event_api\"/>"
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2129
+msgid "ARCHITECTURE"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2131
+msgid ""
+"Internally, libguestfs is implemented by running an appliance (a special "
+"type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
+"process of the main program."
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2135
+#, no-wrap
+msgid ""
+" ___________________\n"
+" / \\\n"
+" | main program |\n"
+" | |\n"
+" | | child process / appliance\n"
+" | | __________________________\n"
+" | | / qemu \\\n"
+" +-------------------+ RPC | +-----------------+ |\n"
+" | libguestfs <--------------------> guestfsd | |\n"
+" | | | +-----------------+ |\n"
+" \\___________________/ | | Linux kernel | |\n"
+" | +--^--------------+ |\n"
+" \\_________|________________/\n"
+" |\n"
+" _______v______\n"
+" / \\\n"
+" | Device or |\n"
+" | disk image |\n"
+" \\______________/\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2155
+msgid ""
+"The library, linked to the main program, creates the child process and hence"
+" the appliance in the L</guestfs_launch> function."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2158
+msgid ""
+"Inside the appliance is a Linux kernel and a complete stack of userspace "
+"tools (such as LVM and ext2 programs) and a small controlling daemon called "
+"L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
+"calls (RPC). There is a mostly one-to-one correspondence between libguestfs"
+" API calls and RPC calls to the daemon. Lastly the disk image(s) are "
+"attached to the qemu process which translates device access by the "
+"appliance's Linux kernel into accesses to the image."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2167
+msgid ""
+"A common misunderstanding is that the appliance \"is\" the virtual machine."
+" Although the disk image you are attached to might also be used by some "
+"virtual machine, libguestfs doesn't know or care about this. (But you will "
+"care if both libguestfs's qemu process and your virtual machine are trying "
+"to update the disk image at the same time, since these usually results in "
+"massive disk corruption)."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2174
+msgid "STATE MACHINE"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2176
+msgid "libguestfs uses a state machine to model the child process:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2178
+#, no-wrap
+msgid ""
+" |\n"
+" guestfs_create\n"
+" |\n"
+" |\n"
+" ____V_____\n"
+" / \\\n"
+" | CONFIG |\n"
+" \\__________/\n"
+" ^ ^ ^ \\\n"
+" / | \\ \\ guestfs_launch\n"
+" / | _\\__V______\n"
+" / | / \\\n"
+" / | | LAUNCHING |\n"
+" / | \\___________/\n"
+" / | /\n"
+" / | guestfs_launch\n"
+" / | /\n"
+" ______ / __|____V\n"
+" / \\ ------> / \\\n"
+" | BUSY | | READY |\n"
+" \\______/ <------ \\________/\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2200
+msgid ""
+"The normal transitions are (1) CONFIG (when the handle is created, but there"
+" is no child process), (2) LAUNCHING (when the child process is booting up),"
+" (3) alternating between READY and BUSY as commands are issued to, and "
+"carried out by, the child process."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2205
+msgid ""
+"The guest may be killed by L</guestfs_kill_subprocess>, or may die "
+"asynchronously at any time (eg. due to some internal error), and that causes"
+" the state to transition back to CONFIG."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2209
+msgid ""
+"Configuration commands for qemu such as L</guestfs_add_drive> can only be "
+"issued when in the CONFIG state."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2212
+msgid ""
+"The API offers one call that goes from CONFIG through LAUNCHING to READY. "
+"L</guestfs_launch> blocks until the child process is READY to accept "
+"commands (or until some failure or timeout). L</guestfs_launch> internally "
+"moves the state from CONFIG to LAUNCHING while it is running."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2218
+msgid ""
+"API actions such as L</guestfs_mount> can only be issued when in the READY "
+"state. These API calls block waiting for the command to be carried out (ie."
+" the state to transition to BUSY and then back to READY). There are no non-"
+"blocking versions, and no way to issue more than one command per handle at "
+"the same time."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2224
+msgid ""
+"Finally, the child process sends asynchronous messages back to the main "
+"program, such as kernel log messages. You can register a callback to "
+"receive these messages."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2228
+msgid "INTERNALS"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2230
+msgid "COMMUNICATION PROTOCOL"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2232
+msgid ""
+"Don't rely on using this protocol directly. This section documents how it "
+"currently works, but it may change at any time."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2235
+msgid ""
+"The protocol used to talk between the library and the daemon running inside "
+"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
+"1014, RFC 1832, RFC 4506)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2239
+msgid ""
+"The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
+"this file is automatically generated)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2242
+msgid ""
+"There are two broad cases, ordinary functions that don't have any C<FileIn> "
+"and C<FileOut> parameters, which are handled with very simple request/reply "
+"messages. Then there are functions that have any C<FileIn> or C<FileOut> "
+"parameters, which use the same request and reply messages, but they may also"
+" be followed by files sent using a chunked encoding."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:2249
+msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2251
+msgid "For ordinary functions, the request message is:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2253
+#, no-wrap
+msgid ""
+" total length (header + arguments,\n"
+" but not including the length word itself)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_args (encoded as XDR)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2258
+msgid ""
+"The total length field allows the daemon to allocate a fixed size buffer "
+"into which it slurps the rest of the message. As a result, the total length"
+" is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the"
+" effective size of any request is limited to somewhere under this size."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2264
+msgid ""
+"Note also that many functions don't take any arguments, in which case the "
+"C<guestfs_I<foo>_args> is completely omitted."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2267
+msgid ""
+"The header contains the procedure number (C<guestfs_proc>) which is how the "
+"receiver knows what type of args structure to expect, or none at all."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2271
+msgid ""
+"For functions that take optional arguments, the optional arguments are "
+"encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
+"arguments. A bitmask in the header indicates which optional arguments are "
+"meaningful. The bitmask is also checked to see if it contains bits set "
+"which the daemon does not know about (eg. if more optional arguments were "
+"added in a later version of the library), and this causes the call to be "
+"rejected."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2279
+msgid "The reply message for ordinary functions is:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2281
+#, no-wrap
+msgid ""
+" total length (header + ret,\n"
+" but not including the length word itself)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_ret (encoded as XDR)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2286
+msgid ""
+"As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
+"functions that return no formal return values."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2289
+msgid ""
+"As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2292
+msgid ""
+"In the case of an error, a flag is set in the header, and the reply message "
+"is slightly changed:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2295
+#, no-wrap
+msgid ""
+" total length (header + error,\n"
+" but not including the length word itself)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_message_error (encoded as XDR)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2300
+msgid ""
+"The C<guestfs_message_error> structure contains the error message as a "
+"string."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:2303
+msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2305
+msgid ""
+"A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
+"The normal request message is sent (see above). However this is followed by"
+" a sequence of file chunks."
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2309
+#, no-wrap
+msgid ""
+" total length (header + arguments,\n"
+" but not including the length word itself,\n"
+" and not including the chunks)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_args (encoded as XDR)\n"
+" sequence of chunks for FileIn param #0\n"
+" sequence of chunks for FileIn param #1 etc.\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2317
+msgid "The \"sequence of chunks\" is:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2319
+#, no-wrap
+msgid ""
+" length of chunk (not including length word itself)\n"
+" struct guestfs_chunk (encoded as XDR)\n"
+" length of chunk\n"
+" struct guestfs_chunk (encoded as XDR)\n"
+" ...\n"
+" length of chunk\n"
+" struct guestfs_chunk (with data.data_len == 0)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2327
+msgid ""
+"The final chunk has the C<data_len> field set to zero. Additionally a flag "
+"is set in the final chunk to indicate either successful completion or early "
+"cancellation."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2331
+msgid ""
+"At time of writing there are no functions that have more than one FileIn "
+"parameter. However this is (theoretically) supported, by sending the "
+"sequence of chunks for each FileIn parameter one after another (from left to"
+" right)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2336
+msgid ""
+"Both the library (sender) I<and> the daemon (receiver) may cancel the "
+"transfer. The library does this by sending a chunk with a special flag set "
+"to indicate cancellation. When the daemon sees this, it cancels the whole "
+"RPC, does I<not> send any reply, and goes back to reading the next request."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2342
+msgid ""
+"The daemon may also cancel. It does this by writing a special word "
+"C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
+"the transfer, and if it gets it, it will cancel the transfer (it sends a "
+"cancel chunk). The special word is chosen so that even if cancellation "
+"happens right at the end of the transfer (after the library has finished "
+"writing and has started listening for the reply), the \"spurious\" cancel "
+"flag will not be confused with the reply message."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2351
+msgid ""
+"This protocol allows the transfer of arbitrary sized files (no 32 bit "
+"limit), and also files where the size is not known in advance (eg. from "
+"pipes or sockets). However the chunks are rather small "
+"(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need"
+" to keep much in memory."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:2357
+msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2359
+msgid ""
+"The protocol for FileOut parameters is exactly the same as for FileIn "
+"parameters, but with the roles of daemon and library reversed."
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2362
+#, no-wrap
+msgid ""
+" total length (header + ret,\n"
+" but not including the length word itself,\n"
+" and not including the chunks)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_ret (encoded as XDR)\n"
+" sequence of chunks for FileOut param #0\n"
+" sequence of chunks for FileOut param #1 etc.\n"
+"\n"
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:2370
+msgid "INITIAL MESSAGE"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2372
+msgid ""
+"When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
+"which indicates that the guest and daemon is alive. This is what "
+"L</guestfs_launch> waits for."
+msgstr ""
+
+#. type: =head3
+#: ../src/guestfs.pod:2376
+msgid "PROGRESS NOTIFICATION MESSAGES"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2378
+msgid ""
+"The daemon may send progress notification messages at any time. These are "
+"distinguished by the normal length word being replaced by "
+"C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2382
+msgid ""
+"The library turns them into progress callbacks (see "
+"L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
+"them if not."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2386
+msgid ""
+"The daemon self-limits the frequency of progress messages it sends (see "
+"C<daemon/proto.c:notify_progress>). Not all calls generate progress "
+"messages."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2390
+msgid "LIBGUESTFS VERSION NUMBERS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2392
+msgid ""
+"Since April 2010, libguestfs has started to make separate development and "
+"stable releases, along with corresponding branches in our git repository. "
+"These separate releases can be identified by version number:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2397
+#, no-wrap
+msgid ""
+" even numbers for stable: 1.2.x, 1.4.x, ...\n"
+" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
+" |\n"
+" v\n"
+" 1 . 3 . 5\n"
+" ^ ^\n"
+" | |\n"
+" | `-------- sub-version\n"
+" |\n"
+" `------ always '1' because we don't change the ABI\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2408
+msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2410
+msgid ""
+"As time passes we cherry pick fixes from the development branch and backport"
+" those into the stable branch, the effect being that the stable branch "
+"should get more stable and less buggy over time. So the stable releases are"
+" ideal for people who don't need new features but would just like the "
+"software to work."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2416
+msgid "Our criteria for backporting changes are:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2422
+msgid ""
+"Documentation changes which don't affect any code are backported unless the "
+"documentation refers to a future feature which is not in stable."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2428
+msgid ""
+"Bug fixes which are not controversial, fix obvious problems, and have been "
+"well tested are backported."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2433
+msgid ""
+"Simple rearrangements of code which shouldn't affect how it works get "
+"backported. This is so that the code in the two branches doesn't get too "
+"far out of step, allowing us to backport future fixes more easily."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2439
+msgid ""
+"We I<don't> backport new features, new APIs, new tools etc, except in one "
+"exceptional case: the new feature is required in order to implement an "
+"important bug fix."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2445
+msgid ""
+"A new stable branch starts when we think the new features in development are"
+" substantial and compelling enough over the current stable branch to warrant"
+" it. When that happens we create new stable and development versions 1.N.0 "
+"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
+"stable at this point, but by backporting fixes from development, that branch"
+" will stabilize over time."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2453
+msgid "EXTENDING LIBGUESTFS"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2455
+msgid "ADDING A NEW API ACTION"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2457
+msgid ""
+"Large amounts of boilerplate code in libguestfs (RPC, bindings, "
+"documentation) are generated, and this makes it easy to extend the "
+"libguestfs API."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2461
+msgid "To add a new API action there are two changes:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2467
+msgid ""
+"You need to add a description of the call (name, parameters, return type, "
+"tests, documentation) to C<generator/generator_actions.ml>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2470
+msgid ""
+"There are two sorts of API action, depending on whether the call goes "
+"through to the daemon in the appliance, or is serviced entirely by the "
+"library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the"
+" former, since the sync is done in the appliance. L</guestfs_set_trace> is "
+"an example of the latter, since a trace flag is maintained in the handle and"
+" all tracing is done on the library side."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2478
+msgid ""
+"Most new actions are of the first type, and get added to the "
+"C<daemon_functions> list. Each function has a unique procedure number used "
+"in the RPC protocol which is assigned to that action when we publish "
+"libguestfs and cannot be reused. Take the latest procedure number and "
+"increment it."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2484
+msgid ""
+"For library-only actions of the second type, add to the "
+"C<non_daemon_functions> list. Since these functions are serviced by the "
+"library and do not travel over the RPC mechanism to the daemon, these "
+"functions do not need a procedure number, and so the procedure number is set"
+" to C<-1>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2492
+msgid "Implement the action (in C):"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2494
+msgid ""
+"For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
+"C<daemon/> directory."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2497
+msgid ""
+"For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
+"(note: double underscore) in the C<src/> directory."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2500
+msgid "In either case, use another function as an example of what to do."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2504
+msgid "After making these changes, use C<make> to compile."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2506
+msgid ""
+"Note that you don't need to implement the RPC, language bindings, manual "
+"pages or anything else. It's all automatically generated from the OCaml "
+"description."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2510
+msgid "ADDING TESTS FOR AN API ACTION"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2512
+msgid ""
+"You can supply zero or as many tests as you want per API call. The tests "
+"can either be added as part of the API description "
+"(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
+"drop a script into C<regressions/>. Note that adding a script to "
+"C<regressions/> is slower, so if possible use the first method."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2518
+msgid ""
+"The following describes the test environment used when you add an API test "
+"in C<generator_actions.ml>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2521
+msgid "The test environment has 4 block devices:"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2525
+msgid "C</dev/sda> 500MB"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2527
+msgid "General block device for testing."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2529
+msgid "C</dev/sdb> 50MB"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2531
+msgid ""
+"C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
+"operations."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2534
+msgid "C</dev/sdc> 10MB"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2536
+msgid "Used in a few tests where two block devices are needed."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2538
+msgid "C</dev/sdd>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2540
+msgid "ISO with fixed content (see C<images/test.iso>)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2544
+msgid ""
+"To be able to run the tests in a reasonable amount of time, the libguestfs "
+"appliance and block devices are reused between tests. So don't try testing "
+"L</guestfs_kill_subprocess> :-x"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2548
+msgid ""
+"Each test starts with an initial scenario, selected using one of the "
+"C<Init*> expressions, described in C<generator/generator_types.ml>. These "
+"initialize the disks mentioned above in a particular way as documented in "
+"C<generator_types.ml>. You should not assume anything about the previous "
+"contents of other disks that are not initialized."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2554
+msgid ""
+"You can add a prerequisite clause to any individual test. This is a run-"
+"time check, which, if it fails, causes the test to be skipped. Useful if "
+"testing a command which might not work on all variations of libguestfs "
+"builds. A test that has prerequisite of C<Always> means to run "
+"unconditionally."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2560
+msgid ""
+"In addition, packagers can skip individual tests by setting environment "
+"variables before running C<make check>."
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2563
+#, no-wrap
+msgid ""
+" SKIP_TEST_<CMD>_<NUM>=1\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2565
+msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2567
+msgid "or:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2569
+#, no-wrap
+msgid ""
+" SKIP_TEST_<CMD>=1\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2571
+msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2573
+msgid "Packagers can run only certain tests by setting for example:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2575
+#, no-wrap
+msgid ""
+" TEST_ONLY=\"vfs_type zerofree\"\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2577
+msgid ""
+"See C<capitests/tests.c> for more details of how these environment variables"
+" work."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2580
+msgid "DEBUGGING NEW API ACTIONS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2582
+msgid "Test new actions work before submitting them."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2584
+msgid "You can use guestfish to try out new commands."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2586
+msgid ""
+"Debugging the daemon is a problem because it runs inside a minimal "
+"environment. However you can fprintf messages in the daemon to stderr, and "
+"they will show up if you use C<guestfish -v>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2590
+msgid "FORMATTING CODE AND OTHER CONVENTIONS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2592
+msgid ""
+"Our C source code generally adheres to some basic code-formatting "
+"conventions. The existing code base is not totally consistent on this "
+"front, but we do prefer that contributed code be formatted similarly. In "
+"short, use spaces-not-TABs for indentation, use 2 spaces for each "
+"indentation level, and other than that, follow the K&R style."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2598
+msgid ""
+"If you use Emacs, add the following to one of one of your start-up files "
+"(e.g., ~/.emacs), to help ensure that you get indentation right:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2601
+#, no-wrap
+msgid ""
+" ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
+" ;;; Exceptions: Makefile and ChangeLog modes.\n"
+" (add-hook 'find-file-hook\n"
+" '(lambda () (if (and buffer-file-name\n"
+" (string-match \"/libguestfs\\\\>\"\n"
+" (buffer-file-name))\n"
+" (not (string-equal mode-name \"Change Log\"))\n"
+" (not (string-equal mode-name \"Makefile\")))\n"
+" (setq indent-tabs-mode nil))))\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2611
+#, no-wrap
+msgid ""
+" ;;; When editing C sources in libguestfs, use this style.\n"
+" (defun libguestfs-c-mode ()\n"
+" \"C mode with adjusted defaults for use with libguestfs.\"\n"
+" (interactive)\n"
+" (c-set-style \"K&R\")\n"
+" (setq c-indent-level 2)\n"
+" (setq c-basic-offset 2))\n"
+" (add-hook 'c-mode-hook\n"
+" '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
+" (buffer-file-name))\n"
+" (libguestfs-c-mode))))\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2623
+msgid "Enable warnings when compiling (and fix any problems this finds):"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2626
+#, no-wrap
+msgid ""
+" ./configure --enable-gcc-warnings\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2628
+msgid "Useful targets are:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2630
+#, no-wrap
+msgid ""
+" make syntax-check # checks the syntax of the C code\n"
+" make check # runs the test suite\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2633
+msgid "DAEMON CUSTOM PRINTF FORMATTERS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2635
+msgid ""
+"In the daemon code we have created custom printf formatters C<%Q> and C<%R>,"
+" which are used to do shell quoting."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2640
+msgid "%Q"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2642
+msgid ""
+"Simple shell quoted string. Any spaces or other shell characters are "
+"escaped for you."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2645
+msgid "%R"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2647
+msgid ""
+"Same as C<%Q> except the string is treated as a path which is prefixed by "
+"the sysroot."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2652 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
+msgid "For example:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2654
+#, no-wrap
+msgid ""
+" asprintf (&cmd, \"cat %R\", path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2656
+msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2658
+msgid ""
+"I<Note:> Do I<not> use these when you are passing parameters to the "
+"C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
+"because they are not passed via the shell (instead, straight to exec). You "
+"probably want to use the C<sysroot_path()> function however."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2664
+msgid "SUBMITTING YOUR NEW API ACTIONS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2666
+msgid ""
+"Submit patches to the mailing list: "
+"L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
+"L<rjones@redhat.com>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2670
+msgid "INTERNATIONALIZATION (I18N) SUPPORT"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2672
+msgid "We support i18n (gettext anyhow) in the library."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2674
+msgid ""
+"However many messages come from the daemon, and we don't translate those at "
+"the moment. One reason is that the appliance generally has all locale files"
+" removed from it, because they take up a lot of space. So we'd have to "
+"readd some of those, as well as copying our PO files into the appliance."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2680
+msgid ""
+"Debugging messages are never translated, since they are intended for the "
+"programmers."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2683
+msgid "SOURCE CODE SUBDIRECTORIES"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2687 ../src/guestfs-actions.pod:6174
+#: ../fish/guestfish-actions.pod:4072
+msgid "C<appliance>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2689
+msgid "The libguestfs appliance, build scripts and so on."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2691
+msgid "C<capitests>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2693
+msgid "Automated tests of the C API."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2695
+msgid "C<cat>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2697
+msgid ""
+"The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
+"documentation."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2700
+msgid "C<caution>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2702
+msgid ""
+"Safety and liveness tests of components that libguestfs depends upon (not of"
+" libguestfs itself). Mainly this is for qemu and the kernel."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2705
+msgid "C<contrib>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2707
+msgid "Outside contributions, experimental parts."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2709
+msgid "C<daemon>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2711
+msgid ""
+"The daemon that runs inside the libguestfs appliance and carries out "
+"actions."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2714
+msgid "C<df>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2716
+msgid "L<virt-df(1)> command and documentation."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2718
+msgid "C<edit>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2720
+msgid "L<virt-edit(1)> command and documentation."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2722
+msgid "C<examples>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2724
+msgid "C API example code."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2726
+msgid "C<fish>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2728
+msgid ""
+"L<guestfish(1)>, the command-line shell, and various shell scripts built on "
+"top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L"
+"<virt-tar-out(1)>."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2732
+msgid "C<fuse>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2734
+msgid ""
+"L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2736
+msgid "C<generator>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2738
+msgid ""
+"The crucially important generator, used to automatically generate large "
+"amounts of boilerplate C code for things like RPC and bindings."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2741
+msgid "C<images>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2743
+msgid "Files used by the test suite."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2745
+msgid "Some \"phony\" guest images which we test against."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2747
+msgid "C<inspector>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2749
+msgid "L<virt-inspector(1)>, the virtual machine image inspector."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2751
+msgid "C<logo>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2753
+msgid "Logo used on the website. The fish is called Arthur by the way."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2755
+msgid "C<m4>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2757
+msgid "M4 macros used by autoconf."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2759
+msgid "C<po>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2761
+msgid "Translations of simple gettext strings."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2763
+msgid "C<po-docs>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2765
+msgid ""
+"The build infrastructure and PO files for translations of manpages and POD "
+"files. Eventually this will be combined with the C<po> directory, but that "
+"is rather complicated."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2769
+msgid "C<regressions>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2771
+msgid "Regression tests."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2773
+msgid "C<rescue>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2775
+msgid "L<virt-rescue(1)> command and documentation."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2777
+msgid "C<src>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2779
+msgid "Source code to the C library."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2781
+msgid "C<tools>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2783
+msgid ""
+"Command line tools written in Perl (L<virt-resize(1)> and many others)."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2785
+msgid "C<test-tool>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2787
+msgid ""
+"Test tool for end users to test if their qemu/kernel combination will work "
+"with libguestfs."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2790
+msgid "C<csharp>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2792
+msgid "C<haskell>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2794
+msgid "C<java>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2796
+msgid "C<ocaml>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2798
+msgid "C<php>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2800
+msgid "C<perl>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2802
+msgid "C<python>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2804
+msgid "C<ruby>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2806
+msgid "Language bindings."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2810
+msgid "LIMITS"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2812
+msgid "PROTOCOL LIMITS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2814
+msgid ""
+"Internally libguestfs uses a message-based protocol to pass API calls and "
+"their responses to and from a small \"appliance\" (see L</INTERNALS> for "
+"plenty more detail about this). The maximum message size used by the "
+"protocol is slightly less than 4 MB. For some API calls you may need to be "
+"aware of this limit. The API calls which may be affected are individually "
+"documented, with a link back to this section of the documentation."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2822
+msgid ""
+"A simple call such as L</guestfs_cat> returns its result (the file data) in "
+"a simple string. Because this string is at some point internally encoded as"
+" a message, the maximum size that it can return is slightly under 4 MB. If "
+"the requested file is larger than this then you will get an error."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2828
+msgid ""
+"In order to transfer large files into and out of the guest filesystem, you "
+"need to use particular calls that support this. The sections L</UPLOADING> "
+"and L</DOWNLOADING> document how to do this."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2832
+msgid ""
+"You might also consider mounting the disk image using our FUSE filesystem "
+"support (L<guestmount(1)>)."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2835
+msgid "MAXIMUM NUMBER OF DISKS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2837
+msgid ""
+"When using virtio disks (the default) the current limit is B<25> disks."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2840
+msgid ""
+"Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31"
+" slots. However febootstrap only understands disks with names C</dev/vda> "
+"through C</dev/vdz> (26 letters) and it reserves one disk for its own "
+"purposes."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2845
+msgid ""
+"We are working to substantially raise this limit in future versions but it "
+"requires complex changes to qemu."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2848
+msgid ""
+"In future versions of libguestfs it should also be possible to \"hot plug\" "
+"disks (add and remove disks after calling L</guestfs_launch>). This also "
+"requires changes to qemu."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2852
+msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2854
+msgid "Virtio limits the maximum number of partitions per disk to B<15>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2856
+msgid ""
+"This is because it reserves 4 bits for the minor device number (thus "
+"C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2859
+msgid ""
+"If you attach a disk with more than 15 partitions, the extra partitions are "
+"ignored by libguestfs."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2862
+msgid "MAXIMUM SIZE OF A DISK"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2864
+msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2866
+msgid ""
+"We have tested block devices up to 1 exabyte (2**60 or "
+"1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
+"filesystem."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2870
+msgid ""
+"Although libguestfs probably does not impose any limit, the underlying host "
+"storage will. If you store disk images on a host ext4 filesystem, then the "
+"maximum size will be limited by the maximum ext4 file size (currently 16 "
+"TB). If you store disk images as host logical volumes then you are limited "
+"by the maximum size of an LV."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2876
+msgid ""
+"For the hugest disk image files, we recommend using XFS on the host for "
+"storage."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2879
+msgid "MAXIMUM SIZE OF A PARTITION"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2881
+msgid ""
+"The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector numbers."
+" Assuming a 512 byte sector size, this means that MBR cannot address a "
+"partition located beyond 2 TB on the disk."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2885
+msgid ""
+"It is recommended that you use GPT partitions on disks which are larger than"
+" this size. GPT uses 64 bit sector numbers and so can address partitions "
+"which are theoretically larger than the largest disk we could support."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2890
+msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2892
+msgid ""
+"This depends on the filesystem type. libguestfs itself does not impose any "
+"known limit. Consult Wikipedia or the filesystem documentation to find out "
+"what these limits are."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2896
+msgid "MAXIMUM UPLOAD AND DOWNLOAD"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2898
+msgid ""
+"The API functions L</guestfs_upload>, L</guestfs_download>, "
+"L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
+"uploads and downloads."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:2902
+msgid "INSPECTION LIMITS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2904
+msgid ""
+"The inspection code has several arbitrary limits on things like the size of "
+"Windows Registry hive it will read, and the length of product name. These "
+"are intended to stop a malicious guest from consuming arbitrary amounts of "
+"memory and disk space on the host, and should not be reached in practice. "
+"See the source code for more information."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2910 ../fish/guestfish.pod:1075
+#: ../test-tool/libguestfs-test-tool.pod:82
+msgid "ENVIRONMENT VARIABLES"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1106
+msgid "LIBGUESTFS_APPEND"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2916 ../fish/guestfish.pod:1108
+msgid "Pass additional options to the guest kernel."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2918 ../fish/guestfish.pod:1110
+msgid "LIBGUESTFS_DEBUG"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2920
+msgid ""
+"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
+"effect as calling C<guestfs_set_verbose (g, 1)>."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2923 ../fish/guestfish.pod:1115
+msgid "LIBGUESTFS_MEMSIZE"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2925 ../fish/guestfish.pod:1117
+msgid ""
+"Set the memory allocated to the qemu process, in megabytes. For example:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2928 ../fish/guestfish.pod:1120
+#, no-wrap
+msgid ""
+" LIBGUESTFS_MEMSIZE=700\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2930 ../fish/guestfish.pod:1122
+msgid "LIBGUESTFS_PATH"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2932
+msgid ""
+"Set the path that libguestfs uses to search for a supermin appliance. See "
+"the discussion of paths in section L</PATH> above."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2935 ../fish/guestfish.pod:1127
+msgid "LIBGUESTFS_QEMU"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2937 ../fish/guestfish.pod:1129
+msgid ""
+"Set the default qemu binary that libguestfs uses. If not set, then the qemu"
+" which was found at compile time by the configure script is used."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2941
+msgid "See also L</QEMU WRAPPERS> above."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2943 ../fish/guestfish.pod:1133
+msgid "LIBGUESTFS_TRACE"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2945
+msgid ""
+"Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
+"effect as calling C<guestfs_set_trace (g, 1)>."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:2948 ../fish/guestfish.pod:1142
+msgid "TMPDIR"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2950 ../fish/guestfish.pod:1144
+msgid ""
+"Location of temporary directory, defaults to C</tmp> except for the cached "
+"supermin appliance which defaults to C</var/tmp>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2953 ../fish/guestfish.pod:1147
+msgid ""
+"If libguestfs was compiled to use the supermin appliance then the real "
+"appliance is cached in this directory, shared between all handles belonging "
+"to the same EUID. You can use C<$TMPDIR> to configure another directory to "
+"use in case C</var/tmp> is not large enough."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2961 ../fish/guestfish.pod:1214
+#: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
+#: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
+#: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
+#: ../tools/virt-list-partitions.pl:257
+msgid "SEE ALSO"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2963
+msgid ""
+"L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L"
+"<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L"
+"<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L"
+"<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L"
+"<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
+"rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
+"win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
+"L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2990
+msgid ""
+"Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
+"L<lvm(8)>, L<disktype(1)>."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:2997 ../tools/virt-win-reg.pl:759
+#: ../tools/virt-make-fs.pl:553
+msgid "BUGS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2999
+msgid "To get a list of bugs against libguestfs use this link:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3001
+msgid ""
+"L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3003
+msgid "To report a new bug against libguestfs use this link:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3005
+msgid ""
+"L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3007
+msgid "When reporting a bug, please check:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3013
+msgid "That the bug hasn't been reported already."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3017
+msgid "That you are testing a recent version."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3021
+msgid "Describe the bug accurately, and give a way to reproduce it."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3025
+msgid ""
+"Run libguestfs-test-tool and paste the B<complete, unedited> output into the"
+" bug report."
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:3030 ../fish/guestfish.pod:1238
+#: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
+msgid "AUTHORS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3032 ../fish/guestfish.pod:1240
+#: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
+msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
+msgstr ""
+
+#. type: =head1
+#: ../src/guestfs.pod:3034 ../fish/guestfish.pod:1242
+#: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
+#: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
+#: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
+#: ../tools/virt-list-partitions.pl:273
+msgid "COPYRIGHT"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3036 ../fish/guestfish.pod:1244
+#: ../test-tool/libguestfs-test-tool.pod:99
+msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3039
+msgid ""
+"This library is free software; you can redistribute it and/or modify it "
+"under the terms of the GNU Lesser General Public License as published by the"
+" Free Software Foundation; either version 2 of the License, or (at your "
+"option) any later version."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3044
+msgid ""
+"This library is distributed in the hope that it will be useful, but WITHOUT "
+"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
+"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License"
+" for more details."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3049
+msgid ""
+"You should have received a copy of the GNU Lesser General Public License "
+"along with this library; if not, write to the Free Software Foundation, "
+"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1
+msgid "guestfs_add_cdrom"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_cdrom (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
+msgid "This function adds a virtual CD-ROM disk image to the guest."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
+msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:17
+msgid ""
+"This call checks for the existence of C<filename>. This stops you from "
+"specifying other types of drive which are supported by qemu such as C<nbd:> "
+"and C<http:> URLs. To specify those, use the general C<guestfs_config> call"
+" instead."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:24
+msgid ""
+"If you just want to add an ISO file (often you use this as an efficient way "
+"to transfer large files into the guest), then you should probably use "
+"C<guestfs_add_drive_ro> instead."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
+#: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
+#: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
+#: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
+#: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
+#: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
+#: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
+#: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
+#: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
+#: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
+#: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
+#: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
+#: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
+#: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
+#: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
+#: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
+#: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
+#: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
+#: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
+#: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
+#: ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2483
+#: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2579
+#: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3634
+#: ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3848
+#: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3875
+#: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3904
+#: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:4012
+#: ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4049
+#: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4095
+#: ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4149
+#: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4203
+#: ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4251
+#: ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4280
+#: ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4312
+#: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4425
+#: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4489
+#: ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4525
+#: ../src/guestfs-actions.pod:4541 ../src/guestfs-actions.pod:4555
+#: ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4586
+#: ../src/guestfs-actions.pod:4601 ../src/guestfs-actions.pod:4621
+#: ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4764
+#: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814
+#: ../src/guestfs-actions.pod:4833 ../src/guestfs-actions.pod:4845
+#: ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4875
+#: ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4905
+#: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4973
+#: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5032
+#: ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5063
+#: ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5158
+#: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5248
+#: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5300
+#: ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5452
+#: ../src/guestfs-actions.pod:5509 ../src/guestfs-actions.pod:5531
+#: ../src/guestfs-actions.pod:5549 ../src/guestfs-actions.pod:5581
+#: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5664
+#: ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:5691
+#: ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:5999
+#: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6032
+#: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6058
+#: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6084
+#: ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6121
+#: ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6159
+#: ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6207
+#: ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6248
+#: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6288
+#: ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324
+#: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6369
+#: ../src/guestfs-actions.pod:6393 ../src/guestfs-actions.pod:6412
+#: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6455
+#: ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6489
+#: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6556
+#: ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6711
+#: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6844
+#: ../src/guestfs-actions.pod:6857 ../src/guestfs-actions.pod:6870
+#: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905
+#: ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:6931
+#: ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:7005
+#: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7038
+#: ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7071
+#: ../src/guestfs-actions.pod:7084 ../src/guestfs-actions.pod:7104
+#: ../src/guestfs-actions.pod:7140 ../src/guestfs-actions.pod:7154
+#: ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7208
+#: ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7260
+#: ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7412
+#: ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7441
+#: ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7509
+#: ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7587
+#: ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7670
+#: ../src/guestfs-actions.pod:7694 ../src/guestfs-actions.pod:7761
+#: ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7809
+msgid "This function returns 0 on success or -1 on error."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
+#: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
+#: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
+msgid ""
+"This function is deprecated. In new code, use the C<add_drive_opts> call "
+"instead."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
+#: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
+#: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
+#: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4945
+#: ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5253
+#: ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:6564
+#: ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6656
+#: ../src/guestfs-actions.pod:7592 ../src/guestfs-actions.pod:7702
+#: ../src/guestfs-actions.pod:7872 ../fish/guestfish-actions.pod:31
+#: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
+#: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346
+#: ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3085
+#: ../fish/guestfish-actions.pod:3292 ../fish/guestfish-actions.pod:3406
+#: ../fish/guestfish-actions.pod:3454 ../fish/guestfish-actions.pod:4349
+#: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
+#: ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:5081
+#: ../fish/guestfish-actions.pod:5179
+msgid ""
+"Deprecated functions will not be removed from the API, but the fact that "
+"they are deprecated indicates that there are problems with correct use of "
+"these functions."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
+#: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
+#: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2190
+#: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3641
+#: ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:6209
+#: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6457
+#: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7073
+#: ../src/guestfs-actions.pod:7596
+msgid "(Added in 0.3)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:41
+msgid "guestfs_add_domain"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:43
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_domain (guestfs_h *g,\n"
+" const char *dom,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
+#: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2824
+#: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4959
+#: ../src/guestfs-actions.pod:5176
+msgid ""
+"You may supply a list of optional arguments to this call. Use zero or more "
+"of the following pairs of parameters, and terminate the list with C<-1> on "
+"its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:53
+#, no-wrap
+msgid ""
+" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
+" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
+" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
+" GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
+" GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:59
+msgid ""
+"This function adds the disk(s) attached to the named libvirt domain C<dom>."
+" It works by connecting to libvirt, requesting the domain and domain XML "
+"from libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on"
+" each one."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
+msgid ""
+"The number of disks added is returned. This operation is atomic: if an "
+"error is returned, then no disks are added."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
+msgid ""
+"This function does some minimal checks to make sure the libvirt domain is "
+"not running (unless C<readonly> is true). In a future version we will try "
+"to acquire the libvirt lock on each disk."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
+msgid ""
+"Disks must be accessible locally. This often means that adding disks from a"
+" remote libvirt connection (see L<http://libvirt.org/remote.html>) will "
+"fail unless those disks are accessible via the same device path locally too."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
+msgid ""
+"The optional C<libvirturi> parameter sets the libvirt URI (see "
+"L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
+"default libvirt URI (or one set through an environment variable, see the "
+"libvirt documentation for full details)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
+msgid ""
+"The optional C<live> flag controls whether this call will try to connect to "
+"a running virtual machine C<guestfsd> process if it sees a suitable "
+"E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
+"the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING"
+" DAEMONS> for more information."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
+msgid ""
+"If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
+"passed instead of the domain name. The C<dom> string is treated as a UUID "
+"first and looked up, and if that lookup fails then we treat C<dom> as a name"
+" as usual."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:94
+msgid ""
+"The other optional parameters are passed directly through to "
+"C<guestfs_add_drive_opts>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
+#: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
+#: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
+#: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
+#: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
+#: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2099
+#: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177
+#: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2942
+#: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:5135
+#: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5761
+#: ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:7181
+#: ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7620
+#: ../src/guestfs-actions.pod:7633
+msgid "On error this function returns -1."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:99
+msgid "(Added in 1.7.4)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:101
+msgid "guestfs_add_domain_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:103
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_domain_va (guestfs_h *g,\n"
+" const char *dom,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:108
+msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
+#: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
+#: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
+#: ../src/guestfs-actions.pod:2908 ../src/guestfs-actions.pod:2920
+#: ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4717
+#: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:4999
+#: ../src/guestfs-actions.pod:5225 ../src/guestfs-actions.pod:5236
+msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:112
+msgid "guestfs_add_domain_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:114
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_domain_argv (guestfs_h *g,\n"
+" const char *dom,\n"
+" const struct guestfs_add_domain_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:119
+msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:123
+msgid "guestfs_add_drive"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:125
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:129
+msgid ""
+"This function is the equivalent of calling C<guestfs_add_drive_opts> with no"
+" optional parameters, so the disk is added writable, with the format being "
+"detected automatically."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:133
+msgid ""
+"Automatic detection of the format opens you up to a potential security hole "
+"when dealing with untrusted raw-format images. See CVE-2010-3851 and "
+"RHBZ#642934. Specifying the format closes this security hole. Therefore "
+"you should think about replacing calls to this function with calls to "
+"C<guestfs_add_drive_opts>, and specifying the format."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:144
+msgid "guestfs_add_drive_opts"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:146
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive_opts (guestfs_h *g,\n"
+" const char *filename,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:156
+#, no-wrap
+msgid ""
+" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
+" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
+msgid ""
+"This function adds a virtual machine disk image C<filename> to libguestfs. "
+"The first time you call this function, the disk appears as C</dev/sda>, the "
+"second time as C</dev/sdb>, and so on."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
+msgid ""
+"You don't necessarily need to be root when using libguestfs. However you "
+"obviously do need sufficient permissions to access the filename for whatever"
+" operations you want to perform (ie. read access if you just want to read "
+"the image or write access if you want to modify the image)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
+msgid "This call checks that C<filename> exists."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4653
+#: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
+msgid "The optional arguments are:"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
+msgid "C<readonly>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
+msgid ""
+"If true then the image is treated as read-only. Writes are still allowed, "
+"but they are stored in a temporary snapshot overlay which is discarded at "
+"the end. The disk that you add is not modified."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
+msgid "C<format>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:185
+msgid ""
+"This forces the image format. If you omit this (or use C<guestfs_add_drive>"
+" or C<guestfs_add_drive_ro>) then the format is automatically detected. "
+"Possible formats include C<raw> and C<qcow2>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
+msgid ""
+"Automatic detection of the format opens you up to a potential security hole "
+"when dealing with untrusted raw-format images. See CVE-2010-3851 and "
+"RHBZ#642934. Specifying the format closes this security hole."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
+msgid "C<iface>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:196
+msgid ""
+"This rarely-used option lets you emulate the behaviour of the deprecated "
+"C<guestfs_add_drive_with_if> call (q.v.)"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:203
+msgid "(Added in 1.5.23)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:205
+msgid "guestfs_add_drive_opts_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:207
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive_opts_va (guestfs_h *g,\n"
+" const char *filename,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:212
+msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:216
+msgid "guestfs_add_drive_opts_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:218
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive_opts_argv (guestfs_h *g,\n"
+" const char *filename,\n"
+" const struct guestfs_add_drive_opts_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:223
+msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:227
+msgid "guestfs_add_drive_ro"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:229
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive_ro (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:233
+msgid ""
+"This function is the equivalent of calling C<guestfs_add_drive_opts> with "
+"the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
+"disk is added read-only, with the format being detected automatically."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:240
+msgid "(Added in 1.0.38)"