Pod::Text::Color(3pm) Perl Programmers Reference Guide Pod::Text::Color(3pm)
NAME
Pod::Text::Color - Convert POD data to formatted color ASCII text
SYNOPSIS
use Pod::Text::Color;
my $parser = Pod::Text::Color->new (sentence => 0, width => 78);
# Read POD from STDIN and write to STDOUT.
$parser->parse_from_filehandle;
# Read POD from file.pod and write to file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');
DESCRIPTION
Pod::Text::Color is a simple subclass of Pod::Text that highlights
output text using ANSI color escape sequences. Apart from the color,
it in all ways functions like Pod::Text. See Pod::Text for details and
available options.
Term::ANSIColor is used to get colors and therefore must be installed
to use this module.
COMPATIBILITY
Pod::Text::Color 0.05 (based on Pod::Parser) was the first version of
this module included with Perl, in Perl 5.6.0.
The current API based on Pod::Simple was added in Pod::Text::Color
2.00. Pod::Text::Color 2.01 was included in Perl 5.9.3, the first
version of Perl to incorporate those changes.
Several problems with wrapping and line length were fixed as recently
as Pod::Text::Color 4.11, included in Perl 5.29.1.
This module inherits its API and most behavior from Pod::Text, so the
details in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and
Pod::Text::Color have had the same module version since 4.00, included
in Perl 5.23.7. (They unfortunately diverge in confusing ways prior to
that.)
AUTHOR
Russ Allbery <rra@cpan.org>.
COPYRIGHT AND LICENSE
Copyright 1999, 2001, 2004, 2006, 2008, 2009, 2018-2019, 2022 Russ
Allbery <rra@cpan.org>
This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.
SEE ALSO
Pod::Text(3), Pod::Simple(3)
The current version of this module is always available from its web
site at <https://www.eyrie.org/~eagle/software/podlators/>. It is also
part of the Perl core distribution as of 5.6.0.
perl v5.38.2 2023-11-28 Pod::Text::Color(3pm)
perl 5.38.2 - Generated Tue Dec 10 16:38:33 CST 2024