.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "English 3pm"
.TH English 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
English \- use nice English (or awk) names for ugly punctuation variables
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\&    use English;
\&    use English qw( \-no_match_vars ) ;  # Avoids regex performance
\&                                        # penalty in perl 5.18 and
\&                                        # earlier
\&    ...
\&    if ($ERRNO =~ /denied/) { ... }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides aliases for the built-in variables whose
names no one seems to like to read.  Variables with side-effects
which get triggered just by accessing them (like \f(CW$0\fR) will still 
be affected.
.PP
For those variables that have an \fBawk\fR version, both long
and short English alternatives are provided.  For example, 
the \f(CW$/\fR variable can be referred to either \f(CW$RS\fR or 
\&\f(CW$INPUT_RECORD_SEPARATOR\fR if you are using the English module.
.PP
See perlvar for a complete list of these.
.SH PERFORMANCE
.IX Header "PERFORMANCE"
NOTE: This was fixed in perl 5.20.  Mentioning these three variables no
longer makes a speed difference.  This section still applies if your code
is to run on perl 5.18 or earlier.
.PP
This module can provoke sizeable inefficiencies for regular expressions,
due to unfortunate implementation details.  If performance matters in
your application and you don't need \f(CW$PREMATCH\fR, \f(CW$MATCH\fR, or \f(CW$POSTMATCH\fR,
try doing
.PP
.Vb 1
\&   use English qw( \-no_match_vars ) ;
.Ve
.PP
\&.  \fBIt is especially important to do this in modules to avoid penalizing
all applications which use them.\fR