Debian Codegraph @

upstream/opensuse-tumbleweed/man3/source::encoding.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 "source::encoding 3pm"
61 .TH source::encoding 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 source::encoding \-\- Declare Perl source code encoding
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& use source::encoding \*(Aqascii\*(Aq;
72 \& use source::encoding \*(Aqutf8\*(Aq;
73 \& no source::encoding;
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 These days, Perl code either generally contains only ASCII characters with
78 \&\f(CW\*(C`\ex{}\*(C'\fR and similar escapes to represent non\-ASCII, or \f(CW\*(C`use\ utf8\*(C'\fR is used
79 to indicate that the source code itself contains characters encoded as UTF\-8.
80 .PP
81 That means that a character in the source code not meeting these criteria is
82 often a typographical error. This pragma is used to tell Perl to raise an
83 error when this happens.
84 .PP
85 \&\f(CW\*(C`use\ source::encoding\ \*(Aqutf8\*(Aq\*(C'\fR is a synonym for \f(CW\*(C`use\ utf8\*(C'\fR. They may
86 be used interchangeably.
87 .PP
88 \&\f(CW\*(C`use\ source::encoding\ \*(Aqascii\*(Aq\*(C'\fR turns off any UTF\-8 expectations, and
89 raises a fatal error if any character within its scope in the input source
90 code is not ASCII (or ASCII\-equivalent on EBCDIC systems).
91 .PP
92 \&\f(CW\*(C`no\ source::encoding\*(C'\fR turns off any UTF\-8/ASCII expectations for the
93 remainder of its scope. The meaning of non\-ASCII characters is then
94 undefined.
95 .PP
96 \&\f(CW\*(C`use\ source::encoding\ \*(Aqascii\*(Aq\*(C'\fR is automatically enabled within the
97 lexical scope of a \f(CW\*(C`use\ v5.41.0\*(C'\fR or higher.
98 .SH "SEE ALSO"
99 .IX Header "SEE ALSO"
100 utf8