Debian Codegraph @

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