Commit | Line | Data |
d7fcd4ce |
1 | README for Pod::Escapes |
2 | Time-stamp: "2004-04-27 19:55:10 ADT" |
3 | |
4 | NAME |
5 | Pod::Escapes -- for resolving Pod E<...> sequences |
6 | |
7 | SYNOPSIS |
8 | use Pod::Escapes qw(e2char); |
9 | ...la la la, parsing POD, la la la... |
10 | $text = e2char($e_node->label); |
11 | unless(defined $text) { |
12 | print "Unknown E sequence \"", $e_node->label, "\"!"; |
13 | } |
14 | ...else print/interpolate $text... |
15 | |
16 | DESCRIPTION |
17 | This module provides things that are useful in decoding Pod E<...> |
18 | sequences. Presumably, it should be used only by Pod parsers and/or |
19 | formatters. |
20 | |
21 | By default, Pod::Escapes exports none of its symbols. But you can request |
22 | any of them to be exported. Either request them individually, as with `use |
23 | Pod::Escapes qw(symbolname symbolname2...);', or you can do `use |
24 | Pod::Escapes qw(:ALL);' to get all exportable symbols. |
25 | |
26 | [...] |
27 | |
28 | CAVEATS |
29 | On Perl versions before 5.7, Unicode characters with a value over 255 (like |
30 | lambda or emdash) can't be conveyed. This module does work under such early |
31 | Perl versions, but in the place of each such character, you get a "?". |
32 | Latin-1 characters (characters 160-255) are unaffected. |
33 | |
34 | SEE ALSO |
35 | perlpod |
36 | |
37 | perlpodspec |
38 | |
39 | Text::Unidecode |
40 | |
41 | [...] |
42 | |
43 | |
44 | PREREQUISITES |
45 | |
46 | This suite requires Perl 5; I've only used it under Perl 5.004, so for |
47 | anything lower, you're on your own. |
48 | |
49 | Pod::Escapes doesn't use any nonstandard modules. |
50 | |
51 | |
52 | INSTALLATION |
53 | |
54 | You install Pod::Escapes, as you would install any perl module |
55 | library, by running these commands: |
56 | |
57 | perl Makefile.PL |
58 | make |
59 | make test |
60 | make install |
61 | |
62 | If you want to install a private copy of Pod::Escapes in your home |
63 | directory, then you should try to produce the initial Makefile with |
64 | something like this command: |
65 | |
66 | perl Makefile.PL LIB=~/perl |
67 | |
68 | |
69 | DOCUMENTATION |
70 | |
71 | POD-format documentation is included in Escapes.pm. POD is readable |
72 | with the 'perldoc' utility. See ChangeLog for recent changes. |
73 | |
74 | |
75 | MACPERL INSTALLATION NOTES |
76 | |
77 | Don't bother with the makefiles. Just make a Pod directory in your |
78 | MacPerl site_lib or lib directory, and move Escapes.pm into there. |
79 | |
80 | |
81 | SUPPORT |
82 | |
83 | Questions, bug reports, useful code bits, and suggestions for |
84 | Pod::Escapes should just be sent to me at sburke@cpan.org |
85 | |
86 | |
87 | AVAILABILITY |
88 | |
89 | The latest version of Pod::Escapes is available from the |
90 | Comprehensive Perl Archive Network (CPAN). Visit |
91 | <http://www.perl.com/CPAN/> to find a CPAN site near you. |