.\" -*- 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 "Test2::Formatter::TAP 3perl"
.TH Test2::Formatter::TAP 3perl 2024-03-06 "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
Test2::Formatter::TAP \- Standard TAP formatter
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is what takes events and turns them into TAP.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Test2::Formatter::TAP;
\&    my $tap = Test2::Formatter::TAP\->new();
\&
\&    # Switch to utf8
\&    $tap\->encoding(\*(Aqutf8\*(Aq);
\&
\&    $tap\->write($event, $number); # Output an event
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$bool = $tap\->no_numbers" 4
.el .IP "\f(CW$bool\fR = \f(CW$tap\fR\->no_numbers" 4
.IX Item "$bool = $tap->no_numbers"
.PD 0
.ie n .IP $tap\->set_no_numbers($bool) 4
.el .IP \f(CW$tap\fR\->set_no_numbers($bool) 4
.IX Item "$tap->set_no_numbers($bool)"
.PD
Use to turn numbers on and off.
.ie n .IP "$arrayref = $tap\->handles" 4
.el .IP "\f(CW$arrayref\fR = \f(CW$tap\fR\->handles" 4
.IX Item "$arrayref = $tap->handles"
.PD 0
.ie n .IP $tap\->set_handles(\e@handles); 4
.el .IP \f(CW$tap\fR\->set_handles(\e@handles); 4
.IX Item "$tap->set_handles(@handles);"
.PD
Can be used to get/set the filehandles. Indexes are identified by the
\&\f(CW\*(C`OUT_STD\*(C'\fR and \f(CW\*(C`OUT_ERR\*(C'\fR constants.
.ie n .IP "$encoding = $tap\->encoding" 4
.el .IP "\f(CW$encoding\fR = \f(CW$tap\fR\->encoding" 4
.IX Item "$encoding = $tap->encoding"
.PD 0
.ie n .IP $tap\->encoding($encoding) 4
.el .IP \f(CW$tap\fR\->encoding($encoding) 4
.IX Item "$tap->encoding($encoding)"
.PD
Get or set the encoding. By default no encoding is set, the original settings
of STDOUT and STDERR are used.
.Sp
This directly modifies the stored filehandles, it does not create new ones.
.ie n .IP "$tap\->write($e, $num)" 4
.el .IP "\f(CW$tap\fR\->write($e, \f(CW$num\fR)" 4
.IX Item "$tap->write($e, $num)"
Write an event to the console.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.IP "Kent Fredric <kentnl@cpan.org>" 4
.IX Item "Kent Fredric <kentnl@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2020 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR