summaryrefslogtreecommitdiff
path: root/cpan/Pod-Escapes/README
diff options
context:
space:
mode:
authorNicholas Clark <nick@ccl4.org>2009-10-02 14:38:00 +0100
committerNicholas Clark <nick@ccl4.org>2009-10-02 14:38:00 +0100
commitefe15bf0980629945e70e47a4eaaffc5bdc49b7d (patch)
treea7f7c100e2319561c38f1c1c6e0bafbd63829fec /cpan/Pod-Escapes/README
parent9b7a10575018a218ebb7a89f80d9771db035413e (diff)
downloadperl-efe15bf0980629945e70e47a4eaaffc5bdc49b7d.tar.gz
Move Pod::Escapes from ext/ to cpan/
Diffstat (limited to 'cpan/Pod-Escapes/README')
-rw-r--r--cpan/Pod-Escapes/README91
1 files changed, 91 insertions, 0 deletions
diff --git a/cpan/Pod-Escapes/README b/cpan/Pod-Escapes/README
new file mode 100644
index 0000000000..d044647b14
--- /dev/null
+++ b/cpan/Pod-Escapes/README
@@ -0,0 +1,91 @@
+README for Pod::Escapes
+ Time-stamp: "2004-04-27 19:55:10 ADT"
+
+NAME
+ Pod::Escapes -- for resolving Pod E<...> sequences
+
+SYNOPSIS
+ use Pod::Escapes qw(e2char);
+ ...la la la, parsing POD, la la la...
+ $text = e2char($e_node->label);
+ unless(defined $text) {
+ print "Unknown E sequence \"", $e_node->label, "\"!";
+ }
+ ...else print/interpolate $text...
+
+DESCRIPTION
+ This module provides things that are useful in decoding Pod E<...>
+ sequences. Presumably, it should be used only by Pod parsers and/or
+ formatters.
+
+ By default, Pod::Escapes exports none of its symbols. But you can request
+ any of them to be exported. Either request them individually, as with `use
+ Pod::Escapes qw(symbolname symbolname2...);', or you can do `use
+ Pod::Escapes qw(:ALL);' to get all exportable symbols.
+
+[...]
+
+CAVEATS
+ On Perl versions before 5.7, Unicode characters with a value over 255 (like
+ lambda or emdash) can't be conveyed. This module does work under such early
+ Perl versions, but in the place of each such character, you get a "?".
+ Latin-1 characters (characters 160-255) are unaffected.
+
+SEE ALSO
+ perlpod
+
+ perlpodspec
+
+ Text::Unidecode
+
+[...]
+
+
+PREREQUISITES
+
+This suite requires Perl 5; I've only used it under Perl 5.004, so for
+anything lower, you're on your own.
+
+Pod::Escapes doesn't use any nonstandard modules.
+
+
+INSTALLATION
+
+You install Pod::Escapes, as you would install any perl module
+library, by running these commands:
+
+ perl Makefile.PL
+ make
+ make test
+ make install
+
+If you want to install a private copy of Pod::Escapes in your home
+directory, then you should try to produce the initial Makefile with
+something like this command:
+
+ perl Makefile.PL LIB=~/perl
+
+
+DOCUMENTATION
+
+POD-format documentation is included in Escapes.pm. POD is readable
+with the 'perldoc' utility. See ChangeLog for recent changes.
+
+
+MACPERL INSTALLATION NOTES
+
+Don't bother with the makefiles. Just make a Pod directory in your
+MacPerl site_lib or lib directory, and move Escapes.pm into there.
+
+
+SUPPORT
+
+Questions, bug reports, useful code bits, and suggestions for
+Pod::Escapes should just be sent to me at sburke@cpan.org
+
+
+AVAILABILITY
+
+The latest version of Pod::Escapes is available from the
+Comprehensive Perl Archive Network (CPAN). Visit
+<http://www.perl.com/CPAN/> to find a CPAN site near you.