X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=test-tool%2Flibguestfs-test-tool.pod;h=c267484631262e7c417443d1c05561ed4e98fed1;hb=782a2e0299b0c22155f0c115f94903c519040247;hp=77bd817a9faf297578b0179c2fe672d8efa14dfd;hpb=6ea263b1f141614e7693a38b13e8f368237760a2;p=libguestfs.git

diff --git a/test-tool/libguestfs-test-tool.pod b/test-tool/libguestfs-test-tool.pod
index 77bd817..c267484 100644
--- a/test-tool/libguestfs-test-tool.pod
+++ b/test-tool/libguestfs-test-tool.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-libguestfs-test-tool - End user tests for libguestfs
+libguestfs-test-tool - Diagnostics for libguestfs
 
 =head1 SYNOPSIS
 
@@ -10,12 +10,11 @@ libguestfs-test-tool - End user tests for libguestfs
 
 =head1 DESCRIPTION
 
-libguestfs-test-tool is a test program shipped with libguestfs to end
-users and developers, to allow them to check basic libguestfs
-functionality is working.  This is needed because libguestfs
-occasionally breaks for reasons beyond our control: usually because of
-changes in the underlying qemu or kernel packages, or the host
-environment.
+libguestfs-test-tool is a test program shipped with libguestfs to
+allow you to check basic libguestfs functionality is working.  This is
+needed because libguestfs occasionally breaks for reasons beyond our
+control: usually because of changes in the underlying qemu or kernel
+packages, or the host environment.
 
 If you suspect a problem in libguestfs, then just run:
 
@@ -30,7 +29,7 @@ If it runs to completion successfully, you will see this near the end:
 and the test tool will exit with code 0.
 
 If it fails (and/or exits with non-zero error code), please paste the
-B<complete, unedited> output of the test tool into a bug report.  More
+I<complete, unedited> output of the test tool into a bug report.  More
 information about reporting bugs can be found on the
 L<http://libguestfs.org/> website.
 
@@ -38,25 +37,26 @@ L<http://libguestfs.org/> website.
 
 =over 4
 
-=item I<--help>
+=item B<--help>
 
 Display short usage information and exit.
 
-=item I<--qemu qemu_binary>
+=item B<--qemu qemu_binary>
 
 If you have downloaded another qemu binary, point this option at the
 full path of the binary to try it.
 
-=item I<--qemudir qemu_source_dir>
+=item B<--qemudir qemu_source_dir>
 
 If you have compiled qemu from source, point this option at the source
 directory to try it.
 
-=item I<--timeout N>
+=item B<-t N>
 
-Set the launch timeout to C<N> seconds.  The default is 120 seconds
-which does not usually need to be adjusted unless your machine is very
-slow.
+=item B<--timeout N>
+
+Set the launch timeout to C<N> seconds.  The default is 600 seconds
+(10 minutes) which does not usually need to be adjusted.
 
 =back
 
@@ -69,12 +69,25 @@ the qemu source directory.
 If you have downloaded a qemu binary from somewhere, use the I<--qemu>
 option to point to the binary.
 
-When using an alternate qemu with libguestfs, usually you would need
-to write a qemu wrapper script (see section I<QEMU WRAPPERS> in
-L<guestfs(3)>).  libguestfs-test-tool writes a temporary qemu wrapper
-script when you use either of the I<--qemudir> or I<--qemu> options.
+Note when using these options, you can ignore the business of qemu
+wrapper scripts (L<guestfs(3)/QEMU WRAPPERS>), since
+libguestfs-test-tool writes a wrapper script for you if one is needed.
+
+=head1 TRYING OUT A DIFFERENT KERNEL
+
+If you are using febootstrap E<ge> 3.8 then you can select which
+kernel libguestfs tries.  You do this by setting the environment
+variables C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>.
+
+Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES>
+for further information.
+
+=head1 SELF-DIAGNOSIS
+
+Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the
+messages produced by libguestfs-test-tool and/or possible errors.
 
-=head1 EXIT CODE
+=head1 EXIT STATUS
 
 libguestfs-test-tool returns I<0> if the tests completed without
 error, or I<1> if there was an error.