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<--helper /path/to/libguestfs-test-tool-helper>
  46
  47 Pass an alternate name for the helper program.  libguestfs-test-tool
  48 will normally look in the C<$libexec> directory that was configured
  49 when the tool was built.
  50
  51 =item I<--qemu qemu_binary>
  52
  53 If you have downloaded another qemu binary, point this option at the
  54 full path of the binary to try it.
  55
  56 =item I<--qemudir qemu_source_dir>
  57
  58 If you have compiled qemu from source, point this option at the source
  59 directory to try it.
  60
  61 =item I<--timeout N>
  62
  63 Set the launch timeout to C<N> seconds.  The default is 120 seconds
  64 which does not usually need to be adjusted unless your machine is very
  65 slow.
  66
  67 =back
  68
  69 =head1 TRYING OUT A DIFFERENT VERSION OF QEMU
  70
  71 If you have compiled another version of qemu from source and would
  72 like to try that, then you can use the I<--qemudir> option to point to
  73 the qemu source directory.
  74
  75 If you have downloaded a qemu binary from somewhere, use the I<--qemu>
  76 option to point to the binary.
  77
  78 When using an alternate qemu with libguestfs, usually you would need
  79 to write a qemu wrapper script (see section I<QEMU WRAPPERS> in
  80 L<guestfs(3)>).  libguestfs-test-tool writes a temporary qemu wrapper
  81 script when you use either of the I<--qemudir> or I<--qemu> options.
  82
  83 =head1 EXIT CODE
  84
  85 libguestfs-test-tool returns I<0> if the tests completed without
  86 error, or I<1> if there was an error.
  87
  88 =head1 FILES
  89
  90 =over 4
  91
  92 =item /usr/libexec/libguestfs-test-tool-helper
  93
  94 This helper program is run inside the appliance and provides
  95 additional tests.
  96
  97 =item /usr/bin/mkisofs
  98
  99 The C<mkisofs> command is required in order to construct a CD-ROM ISO
 100 file which is used as part of the tests.
 101
 102 =back
 103
 104 =head1 ENVIRONMENT VARIABLES
 105
 106 For the full list of environment variables which may affect
 107 libguestfs, please see the L<guestfs(3)> manual page.
 108
 109 =head1 SEE ALSO
 110
 111 L<guestfs(3)>,
 112 L<http://libguestfs.org/>,
 113 L<http://qemu.org/>.
 114
 115 =head1 AUTHORS
 116
 117 Richard W.M. Jones (C<rjones at redhat dot com>)
 118
 119 =head1 COPYRIGHT
 120
 121 Copyright (C) 2009 Red Hat Inc.
 122 L<http://libguestfs.org/>
 123
 124 This program is free software; you can redistribute it and/or modify
 125 it under the terms of the GNU General Public License as published by
 126 the Free Software Foundation; either version 2 of the License, or
 127 (at your option) any later version.
 128
 129 This program is distributed in the hope that it will be useful,
 130 but WITHOUT ANY WARRANTY; without even the implied warranty of
 131 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 132 GNU General Public License for more details.
 133
 134 You should have received a copy of the GNU General Public License
 135 along with this program; if not, write to the Free Software
 136 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.