.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LIBVIRT-TCK 1p"
.TH LIBVIRT-TCK 1p "2011-11-13" "perl v5.12.4" "User Contributed Perl Documentation"
.\" 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"
libvirt\-tck \- libvirt Technology Compatability Kit
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& # libvirt\-tck [OPTIONS]
.Ve
.PP
Run with default config, probing for \s-1URI\s0 to use
.PP
.Vb 1
\& # libvirt\-tck
.Ve
.PP
Run with a custom config
.PP
.Vb 1
\& # libvirt\-tck \-\-config /etc/libvirt/other.cfg
.Ve
.PP
Run with verbose progress information
.PP
.Vb 1
\& # libvirt\-tck \-v
.Ve
.PP
Generate a formal \s-1XML\s0 document of results
.PP
.Vb 1
\& # libvirt\-tck \-\-format xml
.Ve
.PP
Generate a JUnit \s-1XML\s0 document of results
.PP
.Vb 1
\& # libvirt\-tck \-\-format junit
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`libvirt\-tck\*(C'\fR (libvirt Technology Compatability Kit) command
provides the primary mechanism to run the functional, integration
test suite for libvirt drivers.
.SS "\s-1WARNING\s0"
.IX Subsection "WARNING"
There now follows a few words of warning
.PP
The test suite needs to have a completely 'clean' initial
starting state. If your host already has virtual machines
defined and/or running this will cause problems. The test
suite will detect this and refuse to run, allowing you to
remove any preexisting guests. Alternatively you can pass
the \-\-force option and libvirt will \s-1DELETE\s0 \s-1EVERYTHING\s0 it
finds.
.PP
To repeat: \s-1ALL\s0 \s-1YOUR\s0 \s-1EXISTING\s0 \s-1DOMAINS\s0, \s-1NETWORKS\s0, \s-1STORAGE\s0 \s-1POOLS\s0
\&\s-1WILL\s0 \s-1BE\s0 \s-1DELETED\s0 \s-1IF\s0 \s-1YOU\s0 \s-1USE\s0 \s-1THE\s0 \-\-force \s-1OPTION\s0.
.PP
The warning is now complete, continue reading
.SS "\s-1OPTIONS\s0"
.IX Subsection "OPTIONS"
If invoked without any arguments the test suite will run using
the default configuration file from \f(CW\*(C`/etc/libvirt\-tck/default.cfg\*(C'\fR
and will allow libvirt to probe for the hypervisor driver to
run. If a reliably repeatable test result set is desired, it is
recommended to always give an explicit libvirt connection \s-1URI\s0
to choose the driver. The following options are available when
running the \f(CW\*(C`libvirt\-tck\*(C'\fR command
.IP "\-v, \-\-verbose" 4
.IX Item "-v, --verbose"
Display fine details of individual test progresss. Without this
only the name of each test will be printed, along with details
of failures.
.IP "\-q, \-\-quiet" 4
.IX Item "-q, --quiet"
Do not display any information about test progress, not even
the name of each test case
.IP "\-c, \-\-config \s-1FILE\s0" 4
.IX Item "-c, --config FILE"
Specify the name of the configuration file to use, rather than
the default \f(CW\*(C`/etc/libvirt\-tck/default.cfg\*(C'\fR
.IP "\-\-format text|html|xml|junit" 4
.IX Item "--format text|html|xml|junit"
Choose the output format for the test results. The default format
is \f(CW\*(C`text\*(C'\fR, producing human readable results on the console. The
\&\f(CW\*(C`html\*(C'\fR option dumps an \s-1HTML\s0 file of results to \s-1STDOUT\s0, while the
\&\f(CW\*(C`xml\*(C'\fR option generates a formal \s-1XML\s0 document of results.
.IP "\-\-force" 4
.IX Item "--force"
Forcably remove all running guest domains and all persistent guest
domain configuration files before running any tests. The test suite
requires a pristine install, so all existing managed objects must
be removed before running. This switch will instruct libvirt-tck
to automatically remove all guest domains. \s-1YOU\s0 \s-1WILL\s0 \s-1NOT\s0 \s-1GET\s0 \s-1YOUR\s0
\&\s-1EXISTING\s0 \s-1GUEST\s0 \s-1DOMAINS\s0 \s-1BACK\s0 \s-1IF\s0 \s-1THIS\s0 \s-1HAPPENS\s0. \s-1THEY\s0 \s-1WILL\s0 \s-1BE\s0 \s-1GONE\s0
\&\s-1FOREVER\s0. \s-1USE\s0 \s-1AT\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1RISK\s0.
.IP "\-t, \-\-testdir \s-1PATH\s0" 4
.IX Item "-t, --testdir PATH"
Specify an alternate directory path in which to find the test
scripts to be run. If omitted, defaults to \f(CW\*(C`/usr/share/libvirt\-tck/tests\*(C'\fR
.IP "\-a, \-\-archive \s-1FILE\s0" 4
.IX Item "-a, --archive FILE"
Generate an archive containing all the raw test results. The
filename given should end in either \f(CW\*(C`.bz\*(C'\fR, \f(CW\*(C`.tar.gz\*(C'\fR or
\&\f(CW\*(C`.tgz\*(C'\fR
.IP "\-\-timer" 4
.IX Item "--timer"
Print elapsed time after each test.
.SH "AUTHORS"
.IX Header "AUTHORS"
Written by Daniel P. Berrange <berrange@redhat.com>
.SH "BUGS"
.IX Header "BUGS"
Probably. Report any bugs found to your \s-1OS\s0 distribution's bug
tracker or the libvirt mailing list http://www.redhat.com/mailman/listinfo/libvir\-list <http://www.redhat.com/mailman/listinfo/libvir-list>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) 2009 Daniel P. Berrange
Copyright (C) 2009 Red Hat, Inc.
.PP
\&\f(CW\*(C`libvirt\-tck\*(C'\fR is distributed under the terms of the \s-1GNU\s0 \s-1GPL\s0 v2+. This
is free software; see the source for copying conditions.  There is \s-1NO\s0
warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0  A  \s-1PARTICULAR\s0
\&\s-1PURPOSE\s0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`prove\*(C'\fR. If you need more fine grained control over running the tests,
then set the \s-1LIBVIRT_TCK_CONFIG\s0 environment variable to point to your
configuration file, and then run the \f(CW\*(C`prove\*(C'\fR command passing in
the path to the test scripts to run.