Debian Codegraph @

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