Debian Codegraph @

upstream/debian-unstable/man3/TAP::Formatter::Color.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "TAP::Formatter::Color 3perl"
58 .TH TAP::Formatter::Color 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 TAP::Formatter::Color \- Run Perl test scripts with color
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Note that this harness is \fIexperimental\fR. You may not like the colors I've
71 chosen and I haven't yet provided an easy way to override them.
72 .PP
73 This test harness is the same as TAP::Harness, but test results are output
74 in color. Passing tests are printed in green. Failing tests are in red.
75 Skipped tests are blue on a white background and TODO tests are printed in
76 white.
77 .PP
78 If Term::ANSIColor cannot be found (and Win32::Console::ANSI if running
79 under Windows) tests will be run without color.
80 .SH SYNOPSIS
81 .IX Header "SYNOPSIS"
82 .Vb 3
83 \& use TAP::Formatter::Color;
84 \& my $harness = TAP::Formatter::Color\->new( \e%args );
85 \& $harness\->runtests(@tests);
86 .Ve
87 .SH METHODS
88 .IX Header "METHODS"
89 .SS "Class Methods"
90 .IX Subsection "Class Methods"
91 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
92 .IX Subsection "new"
93 .PP
94 The constructor returns a new \f(CW\*(C`TAP::Formatter::Color\*(C'\fR object. If
95 Term::ANSIColor is not installed, returns undef.
96 .PP
97 \fR\f(CI\*(C`can_color\*(C'\fR\fI\fR
98 .IX Subsection "can_color"
99 .PP
100 .Vb 1
101 \& Test::Formatter::Color\->can_color()
102 .Ve
103 .PP
104 Returns a boolean indicating whether or not this module can actually
105 generate colored output. This will be false if it could not load the
106 modules needed for the current platform.
107 .PP
108 \fR\f(CI\*(C`set_color\*(C'\fR\fI\fR
109 .IX Subsection "set_color"
110 .PP
111 Set the output color.