X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FEnglish.pm;h=d82ba2cf52f2c002a75990e72276c03c45b369da;hb=567d72c2df905d84d6219727bd9345d2314e6b6e;hp=d40d28af7d008cfad3b6f1bbba2da1343c4a9a50;hpb=748a93069b3d16374a9859d1456065dd3ae11394;p=p5sagit%2Fp5-mst-13.2.git

diff --git a/lib/English.pm b/lib/English.pm
index d40d28a..d82ba2c 100644
--- a/lib/English.pm
+++ b/lib/English.pm
@@ -3,6 +3,32 @@ package English;
 require Exporter;
 @ISA = (Exporter);
 
+=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.
+
+=cut
+
 local $^W = 0;
 
 # Grandfather $NAME import