X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfs.pod;h=7396644d4648e73ef13d7b015389151a332fa247;hp=70082da468c4c5a193141c5c699be8f3598fc1ae;hb=acf9000252da7f4f3fde693ecc03461007cf0bf9;hpb=64a5ae0e969754c709974104a83e6d1dbb4c2764 diff --git a/guestfs.pod b/guestfs.pod index 70082da..7396644 100644 --- a/guestfs.pod +++ b/guestfs.pod @@ -237,6 +237,60 @@ situations. This returns the current out of memory handler. +=head1 PATH + +Libguestfs needs a kernel and initrd.img, which it finds by looking +along an internal path. + +By default it looks for these in the directory C<$libdir/guestfs> +(eg. C or C). + +Use C or set the environment variable +C to change the directories that libguestfs will +search in. The value is a colon-separated list of paths. The current +directory is I searched unless the path contains an empty element +or C<.>. For example C would +search the current directory and then C. + +=head2 guestfs_set_path + + void guestfs_set_path (guestfs_h *handle, const char *path); + +Set the path that libguestfs searches for kernel and initrd.img. + +The default is C<$libdir/guestfs> unless overridden by setting +C environment variable. + +The string C is stashed in the libguestfs handle, so the caller +must make sure it remains valid for the lifetime of the handle. + +Setting C to C restores the default path. + +=head2 guestfs_get_path + + const char *guestfs_get_path (guestfs_h *handle); + +Return the current search path. + +This is always non-NULL. If it wasn't set already, then this will +return the default path. + +=head1 AUTOSYNC + +=head2 guestfs_set_autosync + + void guestfs_set_autosync (guestfs_h *handle, int autosync); + +If C is true, this enables autosync. Libguestfs will make a +best effort attempt to run C when the handle is closed +(also if the program exits without closing handles). + +=head2 guestfs_get_autosync + + int guestfs_get_autosync (guestfs_h *handle); + +Get the autosync flag. + =head1 VERBOSE MESSAGES =head2 guestfs_set_verbose @@ -258,6 +312,10 @@ This returns the verbose messages flag. @ACTIONS@ +=head1 STRUCTURES + +@STRUCTS@ + =head1 STATE MACHINE AND LOW-LEVEL EVENT API Internally, libguestfs is implemented by running a virtual machine @@ -534,13 +592,28 @@ function, eg. C. In those cases, ignore this call. This isn't documented. Please see the libguestfs-select and libguestfs-glib implementations. -=head1 SEE ALSO +=head1 ENVIRONMENT VARIABLES + +=over 4 + +=item LIBGUESTFS_DEBUG -L +Set C to enable verbose messages. This +has the same effect as calling C. +=item LIBGUESTFS_PATH +Set the path that libguestfs uses to search for kernel and initrd.img. +See the discussion of paths in C above. +=back + +=head1 SEE ALSO +L, +L, +L, +L. =head1 AUTHORS