1Pod::Text::Color(3pm) Perl Programmers Reference Guide Pod::Text::Color(3pm)
2
3
4
6 Pod::Text::Color - Convert POD data to formatted color ASCII text
7
9 use Pod::Text::Color;
10 my $parser = Pod::Text::Color->new (sentence => 0, width => 78);
11
12 # Read POD from STDIN and write to STDOUT.
13 $parser->parse_from_filehandle;
14
15 # Read POD from file.pod and write to file.txt.
16 $parser->parse_from_file ('file.pod', 'file.txt');
17
19 Pod::Text::Color is a simple subclass of Pod::Text that highlights out‐
20 put text using ANSI color escape sequences. Apart from the color, it
21 in all ways functions like Pod::Text. See Pod::Text for details and
22 available options.
23
24 Term::ANSIColor is used to get colors and therefore must be installed
25 to use this module.
26
28 This is just a basic proof of concept. It should be seriously expanded
29 to support configurable coloration via options passed to the construc‐
30 tor, and pod2text should be taught about those.
31
33 Pod::Text, Pod::Parser
34
35 The current version of this module is always available from its web
36 site at <http://www.eyrie.org/~eagle/software/podlators/>. It is also
37 part of the Perl core distribution as of 5.6.0.
38
40 Russ Allbery <rra@stanford.edu>.
41
43 Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>.
44
45 This program is free software; you may redistribute it and/or modify it
46 under the same terms as Perl itself.
47
48
49
50perl v5.8.8 2001-09-21 Pod::Text::Color(3pm)