Debian Codegraph @

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