summaryrefslogtreecommitdiff
path: root/lib/Text/Abbrev.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Text/Abbrev.pm')
-rw-r--r--lib/Text/Abbrev.pm22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/Text/Abbrev.pm b/lib/Text/Abbrev.pm
index 77370d37c3..d12dfb36a6 100644
--- a/lib/Text/Abbrev.pm
+++ b/lib/Text/Abbrev.pm
@@ -2,6 +2,28 @@ package Text::Abbrev;
require 5.000;
require Exporter;
+=head1 NAME
+
+abbrev - create an abbreviation table from a list
+
+=head1 SYNOPSIS
+
+ use Abbrev;
+ abbrev *HASH, LIST
+
+
+=head1 DESCRIPTION
+
+Stores all unambiguous truncations of each element of LIST
+as keys key in the associative array indicated by C<*hash>.
+The values are the original list elements.
+
+=head1 EXAMPLE
+
+ abbrev(*hash,qw("list edit send abort gripe"));
+
+=cut
+
@ISA = qw(Exporter);
@EXPORT = qw(abbrev);