Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Formatter::TAP.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 "Test2::Formatter::TAP 3pm"
61 .TH Test2::Formatter::TAP 3pm 2025-06-24 "perl v5.42.0" "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 Test2::Formatter::TAP \- Standard TAP formatter
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This is what takes events and turns them into TAP.
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 2
74 \& use Test2::Formatter::TAP;
75 \& my $tap = Test2::Formatter::TAP\->new();
76 \&
77 \& # Switch to utf8
78 \& $tap\->encoding(\*(Aqutf8\*(Aq);
79 \&
80 \& $tap\->write($event, $number); # Output an event
81 .Ve
82 .SH METHODS
83 .IX Header "METHODS"
84 .ie n .IP "$bool = $tap\->no_numbers" 4
85 .el .IP "\f(CW$bool\fR = \f(CW$tap\fR\->no_numbers" 4
86 .IX Item "$bool = $tap->no_numbers"
87 .PD 0
88 .ie n .IP $tap\->set_no_numbers($bool) 4
89 .el .IP \f(CW$tap\fR\->set_no_numbers($bool) 4
90 .IX Item "$tap->set_no_numbers($bool)"
91 .PD
92 Use to turn numbers on and off.
93 .ie n .IP "$arrayref = $tap\->handles" 4
94 .el .IP "\f(CW$arrayref\fR = \f(CW$tap\fR\->handles" 4
95 .IX Item "$arrayref = $tap->handles"
96 .PD 0
97 .ie n .IP $tap\->set_handles(\e@handles); 4
98 .el .IP \f(CW$tap\fR\->set_handles(\e@handles); 4
99 .IX Item "$tap->set_handles(@handles);"
100 .PD
101 Can be used to get/set the filehandles. Indexes are identified by the
102 \&\f(CW\*(C`OUT_STD\*(C'\fR and \f(CW\*(C`OUT_ERR\*(C'\fR constants.
103 .ie n .IP "$encoding = $tap\->encoding" 4
104 .el .IP "\f(CW$encoding\fR = \f(CW$tap\fR\->encoding" 4
105 .IX Item "$encoding = $tap->encoding"
106 .PD 0
107 .ie n .IP $tap\->encoding($encoding) 4
108 .el .IP \f(CW$tap\fR\->encoding($encoding) 4
109 .IX Item "$tap->encoding($encoding)"
110 .PD
111 Get or set the encoding. By default no encoding is set, the original settings
112 of STDOUT and STDERR are used.
113 .Sp
114 This directly modifies the stored filehandles, it does not create new ones.
115 .ie n .IP "$tap\->write($e, $num)" 4
116 .el .IP "\f(CW$tap\fR\->write($e, \f(CW$num\fR)" 4
117 .IX Item "$tap->write($e, $num)"
118 Write an event to the console.
119 .SH SOURCE
120 .IX Header "SOURCE"
121 The source code repository for Test2 can be found at
122 <https://github.com/Test\-More/test\-more/>.
123 .SH MAINTAINERS
124 .IX Header "MAINTAINERS"
125 .IP "Chad Granum <[email protected]>" 4
126 .IX Item "Chad Granum <[email protected]>"
127 .SH AUTHORS
128 .IX Header "AUTHORS"
129 .IP "Chad Granum <[email protected]>" 4
130 .IX Item "Chad Granum <[email protected]>"
131 .PD 0
132 .IP "Kent Fredric <[email protected]>" 4
133 .IX Item "Kent Fredric <[email protected]>"
134 .PD
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Copyright Chad Granum <[email protected]>.
138 .PP
139 This program is free software; you can redistribute it and/or
140 modify it under the same terms as Perl itself.
141 .PP
142 See <https://dev.perl.org/licenses/>