.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::NeedsDisplay 3pm"
.TH Test::NeedsDisplay 3pm "2015-12-29" "perl v5.22.1" "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"
Test::NeedsDisplay \- Ensure that tests needing a display have one
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your Makefile.PL...
.PP
.Vb 2
\&  use inc::Module::Install; 
\&  # ... or whatever else you use
\&  
\&  # Check for a display
\&  use Test::NeedsDisplay;
\&  
\&  # ... your Makefile.PL content as normal
.Ve
.PP
And again in each test script that loads Wx
.PP
.Vb 1
\&  #!/usr/bin/perl
\&  
\&  use strict;
\&  
\&  use Test::NeedsDisplay;
\&  
\&  # Test content as normal...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
When testing \s-1GUI\s0 applications, sometimes applications or modules
absolutely insist on a display, even just to load a module without
actually showing any objects.
.PP
Regardless, this makes \s-1GUI\s0 applications pretty much impossible to
build and test on headless or automated systems. And it fails to
the point of not even running the Makefile.PL script because
a dependency needs a display so it can be loaded to find a version.
.PP
In these situations, what is needed is a fake display.
.PP
The \f(CW\*(C`Test::NeedsDisplay\*(C'\fR module will search around and try to find
a way to load some sort of display that can be used for the testing.
.SS "Strategies for Finding a Display"
.IX Subsection "Strategies for Finding a Display"
At this time, only a single method is used (and a very simple one).
.PP
Debian Linux has a script called \f(CW\*(C`xvfb\-run\*(C'\fR which is a wrapper for
the \f(CW\*(C`xvfb\*(C'\fR, a virtual X server which uses the linux frame buffer.
.PP
When loaded without a viable display, the module will re-exec the
same script using something like (for example) \f(CW\*(C`xvfb\-run test.t\*(C'\fR.
.PP
As such, it should be loaded as early as possible, before anything
has a chance to change script parameters. These params will be
resent through to the script again.
.SH "METHODS"
.IX Header "METHODS"
There are no methods. You simply use the module as early as possible,
probably right after \f(CW\*(C`use strict;\*(C'\fR and make sure to load it with
only default params.
.PP
Specifically, need must \fBalways\fR load it before you set the test plan,
otherwise the test script will report two plans, and the harness will
complain about it and die.
.PP
.Vb 2
\&  # Use it like this ...
\&  use Test::NeedsDisplay;
\&  
\&  # ... not like this ...
\&  use Test::NeedsDisplay \*(Aqanything\*(Aq;
\&  
\&  # ... and not like this.
\&  use Test::NeedsDisplay ();
.Ve
.PP
And that's all there is to do. The module will take care of the rest.
.SH "TO DO"
.IX Header "TO DO"
\&\- Find alternative ways to launch a display on different platforms
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs should be reported via the \s-1CPAN\s0 bug tracker at
.PP
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-NeedsDisplay>
.PP
For other issues, contact the author.
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005 \- 2009 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.