Debian Codegraph @

upstream/debian-unstable/man3/Test2::Event::Encoding.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::Event::Encoding 3perl"
58 .TH Test2::Event::Encoding 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::Event::Encoding \- Set the encoding for the output stream
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 The encoding event is generated when a test file wants to specify the encoding
68 to be used when formatting its output. This event is intended to be produced
69 by formatter classes and used for interpreting test names, message contents,
70 etc.
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 2
74 \& use Test2::API qw/context/;
75 \& use Test2::Event::Encoding;
76 \&
77 \& my $ctx = context();
78 \& my $event = $ctx\->send_event(\*(AqEncoding\*(Aq, encoding => \*(AqUTF\-8\*(Aq);
79 .Ve
80 .SH METHODS
81 .IX Header "METHODS"
82 Inherits from Test2::Event. Also defines:
83 .ie n .IP "$encoding = $e\->encoding" 4
84 .el .IP "\f(CW$encoding\fR = \f(CW$e\fR\->encoding" 4
85 .IX Item "$encoding = $e->encoding"
86 The encoding being specified.
87 .SH SOURCE
88 .IX Header "SOURCE"
89 The source code repository for Test2 can be found at
90 <https://github.com/Test\-More/test\-more/>.
91 .SH MAINTAINERS
92 .IX Header "MAINTAINERS"
93 .IP "Chad Granum <[email protected]>" 4
94 .IX Item "Chad Granum <[email protected]>"
95 .SH AUTHORS
96 .IX Header "AUTHORS"
97 .PD 0
98 .IP "Chad Granum <[email protected]>" 4
99 .IX Item "Chad Granum <[email protected]>"
100 .PD
101 .SH COPYRIGHT
102 .IX Header "COPYRIGHT"
103 Copyright 2020 Chad Granum <[email protected]>.
104 .PP
105 This program is free software; you can redistribute it and/or
106 modify it under the same terms as Perl itself.
107 .PP
108 See <https://dev.perl.org/licenses/>