.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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 "TAP::Formatter::Color 3perl"
.TH TAP::Formatter::Color 3perl 2023-11-30 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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
TAP::Formatter::Color \- Run Perl test scripts with color
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Note that this harness is \fIexperimental\fR.  You may not like the colors I've
chosen and I haven't yet provided an easy way to override them.
.PP
This test harness is the same as TAP::Harness, but test results are output
in color.  Passing tests are printed in green.  Failing tests are in red.
Skipped tests are blue on a white background and TODO tests are printed in
white.
.PP
If Term::ANSIColor cannot be found (and Win32::Console::ANSI if running
under Windows) tests will be run without color.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use TAP::Formatter::Color;
\& my $harness = TAP::Formatter::Color\->new( \e%args );
\& $harness\->runtests(@tests);
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.PP
The constructor returns a new \f(CW\*(C`TAP::Formatter::Color\*(C'\fR object. If
Term::ANSIColor is not installed, returns undef.
.PP
\fR\f(CI\*(C`can_color\*(C'\fR\fI\fR
.IX Subsection "can_color"
.PP
.Vb 1
\&  Test::Formatter::Color\->can_color()
.Ve
.PP
Returns a boolean indicating whether or not this module can actually
generate colored output. This will be false if it could not load the
modules needed for the current platform.
.PP
\fR\f(CI\*(C`set_color\*(C'\fR\fI\fR
.IX Subsection "set_color"
.PP
Set the output color.