Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Plugin::UTF8.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::Plugin::UTF8 3pm"
61 .TH Test2::Plugin::UTF8 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 Test2::Plugin::UTF8 \- Test2 plugin to test with utf8.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 When used, this plugin will make tests work with utf8. This includes
71 turning on the utf8 pragma and updating the Test2 output formatter to
72 use utf8.
73 .SH SYNOPSIS
74 .IX Header "SYNOPSIS"
75 .Vb 1
76 \& use Test2::Plugin::UTF8;
77 .Ve
78 .PP
79 This is similar to:
80 .PP
81 .Vb 5
82 \& use utf8;
83 \& BEGIN {
84 \& require Test2::Tools::Encoding;
85 \& Test2::Tools::Encoding::set_encoding(\*(Aqutf8\*(Aq);
86 \& }
87 .Ve
88 .PP
89 You can also disable the utf8 import by using \*(Aqencoding_only\*(Aq to only enable
90 utf8 encoding on the output format.
91 .PP
92 .Vb 1
93 \& use Test2::Plugin::UTF8 qw(encoding_only);
94 .Ve
95 .SH "import options"
96 .IX Header "import options"
97 .SS encoding_only
98 .IX Subsection "encoding_only"
99 Does not import utf8 in your test and only enables the encoding mode on the output.
100 .SH NOTES
101 .IX Header "NOTES"
102 This module currently sets output handles to have the \*(Aq:utf8\*(Aq output
103 layer. Some might prefer \*(Aq:encoding(utf\-8)\*(Aq which is more strict about
104 verifying characters. There is a debate about whether or not encoding
105 to utf8 from perl internals can ever fail, so it may not matter. This
106 was also chosen because the alternative causes threads to segfault,
107 see perlbug 31923 <https://rt.perl.org/Public/Bug/Display.html?id=31923>.
108 .SH SOURCE
109 .IX Header "SOURCE"
110 The source code repository for Test2\-Suite can be found at
111 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
112 .SH MAINTAINERS
113 .IX Header "MAINTAINERS"
114 .IP "Chad Granum <[email protected]>" 4
115 .IX Item "Chad Granum <[email protected]>"
116 .SH AUTHORS
117 .IX Header "AUTHORS"
118 .IP "Chad Granum <[email protected]>" 4
119 .IX Item "Chad Granum <[email protected]>"
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright Chad Granum <[email protected]>.
123 .PP
124 This program is free software; you can redistribute it and/or
125 modify it under the same terms as Perl itself.
126 .PP
127 See \fIhttp://dev.perl.org/licenses/\fR