Debian Codegraph @

upstream/opensuse-tumbleweed/man3/TAP::Formatter::Color.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "TAP::Formatter::Color 3pm"
61 .TH TAP::Formatter::Color 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 TAP::Formatter::Color \- Run Perl test scripts with color
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 Note that this harness is \fIexperimental\fR. You may not like the colors I\*(Aqve
74 chosen and I haven\*(Aqt yet provided an easy way to override them.
75 .PP
76 This test harness is the same as TAP::Harness, but test results are output
77 in color. Passing tests are printed in green. Failing tests are in red.
78 Skipped tests are blue on a white background and TODO tests are printed in
79 white.
80 .PP
81 If Term::ANSIColor cannot be found (and Win32::Console::ANSI if running
82 under Windows) tests will be run without color.
83 .SH SYNOPSIS
84 .IX Header "SYNOPSIS"
85 .Vb 3
86 \& use TAP::Formatter::Color;
87 \& my $harness = TAP::Formatter::Color\->new( \e%args );
88 \& $harness\->runtests(@tests);
89 .Ve
90 .SH METHODS
91 .IX Header "METHODS"
92 .SS "Class Methods"
93 .IX Subsection "Class Methods"
94 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
95 .IX Subsection "new"
96 .PP
97 The constructor returns a new \f(CW\*(C`TAP::Formatter::Color\*(C'\fR object. If
98 Term::ANSIColor is not installed, returns undef.
99 .PP
100 \fR\f(CI\*(C`can_color\*(C'\fR\fI\fR
101 .IX Subsection "can_color"
102 .PP
103 .Vb 1
104 \& Test::Formatter::Color\->can_color()
105 .Ve
106 .PP
107 Returns a boolean indicating whether or not this module can actually
108 generate colored output. This will be false if it could not load the
109 modules needed for the current platform.
110 .PP
111 \fR\f(CI\*(C`set_color\*(C'\fR\fI\fR
112 .IX Subsection "set_color"
113 .PP
114 Set the output color.