Debian Codegraph @

upstream/debian-unstable/man3/English.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 "English 3perl"
58 .TH English 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 English \- use nice English (or awk) names for ugly punctuation variables
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 6
68 \& use English;
69 \& use English qw( \-no_match_vars ) ; # Avoids regex performance
70 \& # penalty in perl 5.18 and
71 \& # earlier
72 \& ...
73 \& if ($ERRNO =~ /denied/) { ... }
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 This module provides aliases for the built-in variables whose
78 names no one seems to like to read. Variables with side-effects
79 which get triggered just by accessing them (like \f(CW$0\fR) will still
80 be affected.
81 .PP
82 For those variables that have an \fBawk\fR version, both long
83 and short English alternatives are provided. For example,
84 the \f(CW$/\fR variable can be referred to either \f(CW$RS\fR or
85 \&\f(CW$INPUT_RECORD_SEPARATOR\fR if you are using the English module.
86 .PP
87 See perlvar for a complete list of these.
88 .SH PERFORMANCE
89 .IX Header "PERFORMANCE"
90 NOTE: This was fixed in perl 5.20. Mentioning these three variables no
91 longer makes a speed difference. This section still applies if your code
92 is to run on perl 5.18 or earlier.
93 .PP
94 This module can provoke sizeable inefficiencies for regular expressions,
95 due to unfortunate implementation details. If performance matters in
96 your application and you don't need \f(CW$PREMATCH\fR, \f(CW$MATCH\fR, or \f(CW$POSTMATCH\fR,
97 try doing
98 .PP
99 .Vb 1
100 \& use English qw( \-no_match_vars ) ;
101 .Ve
102 .PP
103 \&. \fBIt is especially important to do this in modules to avoid penalizing
104 all applications which use them.\fR