.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "libguestfs-test-tool 1"
.TH libguestfs-test-tool 1 "2013-12-07" "libguestfs-1.18.1" "Virtualization Support"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
libguestfs\-test\-tool \- Diagnostics for libguestfs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& libguestfs\-test\-tool [\-\-options]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
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.
.PP
If you suspect a problem in libguestfs, then just run:
.PP
.Vb 1
\& libguestfs\-test\-tool
.Ve
.PP
It will print lots of diagnostic messages.
.PP
If it runs to completion successfully, you will see this near the end:
.PP
.Vb 1
\& ===== TEST FINISHED OK =====
.Ve
.PP
and the test tool will exit with code 0.
.PP
If it fails (and/or exits with non-zero error code), please paste the
\&\fIcomplete, unedited\fR output of the test tool into a bug report. More
information about reporting bugs can be found on the
website.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Display short usage information and exit.
.IP "\fB\-\-qemu qemu_binary\fR" 4
.IX Item "--qemu qemu_binary"
If you have downloaded another qemu binary, point this option at the
full path of the binary to try it.
.IP "\fB\-\-qemudir qemu_source_dir\fR" 4
.IX Item "--qemudir qemu_source_dir"
If you have compiled qemu from source, point this option at the source
directory to try it.
.IP "\fB\-t N\fR" 4
.IX Item "-t N"
.PD 0
.IP "\fB\-\-timeout N\fR" 4
.IX Item "--timeout N"
.PD
Set the launch timeout to \f(CW\*(C`N\*(C'\fR seconds. The default is 600 seconds
(10 minutes) which does not usually need to be adjusted.
.IP "\fB\-V\fR" 4
.IX Item "-V"
.PD 0
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
.PD
Display the libguestfs version number and exit.
.SH "TRYING OUT A DIFFERENT VERSION OF QEMU"
.IX Header "TRYING OUT A DIFFERENT VERSION OF QEMU"
If you have compiled another version of qemu from source and would
like to try that, then you can use the \fI\-\-qemudir\fR option to point to
the qemu source directory.
.PP
If you have downloaded a qemu binary from somewhere, use the \fI\-\-qemu\fR
option to point to the binary.
.PP
Note when using these options, you can ignore the business of qemu
wrapper scripts (\*(L"\s-1QEMU\s0 \s-1WRAPPERS\s0\*(R" in \fIguestfs\fR\|(3)), since
libguestfs-test-tool writes a wrapper script for you if one is needed.
.SH "TRYING OUT A DIFFERENT KERNEL"
.IX Header "TRYING OUT A DIFFERENT KERNEL"
If you are using febootstrap ≥ 3.8 then you can select which
kernel libguestfs tries. You do this by setting the environment
variables \f(CW\*(C`FEBOOTSTRAP_KERNEL\*(C'\fR and/or \f(CW\*(C`FEBOOTSTRAP_MODULES\*(C'\fR.
.PP
Refer to \*(L"\s-1ENVIRONMENT\s0 \s-1VARIABLES\s0\*(R" in \fIfebootstrap\-supermin\-helper\fR\|(8)
for further information.
.SH "SELF-DIAGNOSIS"
.IX Header "SELF-DIAGNOSIS"
Refer to \*(L"\s-1APPLIANCE\s0 \s-1BOOT\s0 \s-1PROCESS\s0\*(R" in \fIguestfs\fR\|(3) to understand the
messages produced by libguestfs-test-tool and/or possible errors.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
libguestfs-test-tool returns \fI0\fR if the tests completed without
error, or \fI1\fR if there was an error.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
For the full list of environment variables which may affect
libguestfs, please see the \fIguestfs\fR\|(3) manual page.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIguestfs\fR\|(3),
,
.
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones (\f(CW\*(C`rjones at redhat dot com\*(C'\fR)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2009\-2012 Red Hat Inc.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, \s-1MA\s0 02110\-1301 \s-1USA\s0.