test-tool/libguestfs-test-tool.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 libguestfs-test-tool - End user tests for libguestfs
   6
   7 =head1 SYNOPSIS
   8
   9  libguestfs-test-tool [--options]
  10
  11 =head1 DESCRIPTION
  12
  13 libguestfs-test-tool is a test program shipped with libguestfs to end
  14 users and developers, to allow them to check basic libguestfs
  15 functionality is working.  This is needed because libguestfs
  16 occasionally breaks for reasons beyond our control: usually because of
  17 changes in the underlying qemu or kernel packages, or the host
  18 environment.
  19
  20 If you suspect a problem in libguestfs, then just run:
  21
  22  libguestfs-test-tool
  23
  24 It will print lots of diagnostic messages.
  25
  26 If it runs to completion successfully, you will see this near the end:
  27
  28  ===== TEST FINISHED OK =====
  29
  30 and the test tool will exit with code 0.
  31
  32 If it fails (and/or exits with non-zero error code), please paste the
  33 B<complete, unedited> output of the test tool into a bug report.  More
  34 information about reporting bugs can be found on the
  35 L<http://libguestfs.org/> website.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item I<--help>
  42
  43 Display short usage information and exit.
  44
  45 =item I<--qemu qemu_binary>
  46
  47 If you have downloaded another qemu binary, point this option at the
  48 full path of the binary to try it.
  49
  50 =item I<--qemudir qemu_source_dir>
  51
  52 If you have compiled qemu from source, point this option at the source
  53 directory to try it.
  54
  55 =item I<--timeout N>
  56
  57 Set the launch timeout to C<N> seconds.  The default is 120 seconds
  58 which does not usually need to be adjusted unless your machine is very
  59 slow.
  60
  61 =back
  62
  63 =head1 TRYING OUT A DIFFERENT VERSION OF QEMU
  64
  65 If you have compiled another version of qemu from source and would
  66 like to try that, then you can use the I<--qemudir> option to point to
  67 the qemu source directory.
  68
  69 If you have downloaded a qemu binary from somewhere, use the I<--qemu>
  70 option to point to the binary.
  71
  72 When using an alternate qemu with libguestfs, usually you would need
  73 to write a qemu wrapper script (see section I<QEMU WRAPPERS> in
  74 L<guestfs(3)>).  libguestfs-test-tool writes a temporary qemu wrapper
  75 script when you use either of the I<--qemudir> or I<--qemu> options.
  76
  77 =head1 EXIT CODE
  78
  79 libguestfs-test-tool returns I<0> if the tests completed without
  80 error, or I<1> if there was an error.
  81
  82 =head1 ENVIRONMENT VARIABLES
  83
  84 For the full list of environment variables which may affect
  85 libguestfs, please see the L<guestfs(3)> manual page.
  86
  87 =head1 SEE ALSO
  88
  89 L<guestfs(3)>,
  90 L<http://libguestfs.org/>,
  91 L<http://qemu.org/>.
  92
  93 =head1 AUTHORS
  94
  95 Richard W.M. Jones (C<rjones at redhat dot com>)
  96
  97 =head1 COPYRIGHT
  98
  99 Copyright (C) 2009-2011 Red Hat Inc.
 100 L<http://libguestfs.org/>
 101
 102 This program is free software; you can redistribute it and/or modify
 103 it under the terms of the GNU General Public License as published by
 104 the Free Software Foundation; either version 2 of the License, or
 105 (at your option) any later version.
 106
 107 This program is distributed in the hope that it will be useful,
 108 but WITHOUT ANY WARRANTY; without even the implied warranty of
 109 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 110 GNU General Public License for more details.
 111
 112 You should have received a copy of the GNU General Public License
 113 along with this program; if not, write to the Free Software
 114 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.