summaryrefslogtreecommitdiff
path: root/pod/modpods/English.pod
diff options
context:
space:
mode:
Diffstat (limited to 'pod/modpods/English.pod')
-rw-r--r--pod/modpods/English.pod24
1 files changed, 24 insertions, 0 deletions
diff --git a/pod/modpods/English.pod b/pod/modpods/English.pod
new file mode 100644
index 0000000000..d6b26beaf2
--- /dev/null
+++ b/pod/modpods/English.pod
@@ -0,0 +1,24 @@
+=head1 NAME
+
+English - use nice English (or awk) names for ugly punctuation variables
+
+=head1 SYNOPSIS
+
+ use English;
+ ...
+ if ($ERRNO =~ /denied/) { ... }
+
+=head1 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 $0) will still
+be affected.
+
+For those variables that have an B<awk> version, both long
+and short English alternatives are provided. For example,
+the C<$/> variable can be referred to either $RS or
+$INPUT_RECORD_SEPARATOR if you are using the English module.
+
+See L<perlvar> for a complete list of these.
+