1Pod::Text::Color(3)   User Contributed Perl Documentation  Pod::Text::Color(3)
2
3
4

NAME

6       Pod::Text::Color - Convert POD data to formatted color ASCII text
7

SYNOPSIS

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

DESCRIPTION

19       Pod::Text::Color is a simple subclass of Pod::Text that highlights
20       output text using ANSI color escape sequences.  Apart from the color,
21       it 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

COMPATIBILITY

28       Pod::Text::Color 0.05 (based on Pod::Parser) was the first version of
29       this module included with Perl, in Perl 5.6.0.
30
31       The current API based on Pod::Simple was added in Pod::Text::Color
32       2.00.  Pod::Text::Color 2.01 was included in Perl 5.9.3, the first
33       version of Perl to incorporate those changes.
34
35       Several problems with wrapping and line length were fixed as recently
36       as Pod::Text::Color 4.11, included in Perl 5.29.1.
37
38       This module inherits its API and most behavior from Pod::Text, so the
39       details in "COMPATIBILITY" in Pod::Text also apply.  Pod::Text and
40       Pod::Text::Color have had the same module version since 4.00, included
41       in Perl 5.23.7.  (They unfortunately diverge in confusing ways prior to
42       that.)
43

AUTHOR

45       Russ Allbery <rra@cpan.org>.
46

48       Copyright 1999, 2001, 2004, 2006, 2008, 2009, 2018-2019, 2022 Russ
49       Allbery <rra@cpan.org>
50
51       This program is free software; you may redistribute it and/or modify it
52       under the same terms as Perl itself.
53

SEE ALSO

55       Pod::Text, Pod::Simple
56
57       The current version of this module is always available from its web
58       site at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also
59       part of the Perl core distribution as of 5.6.0.
60
61
62
63perl v5.38.0                      2023-07-21               Pod::Text::Color(3)
Impressum