Pod::Text::Color(3p) Perl Programmers Reference Guide Pod::Text::Color(3p)

Pod::Text::Color(3p) Perl Programmers Reference Guide Pod::Text::Color(3p) #

Pod::Text::Color(3p) Perl Programmers Reference Guide Pod::Text::Color(3p)

NNAAMMEE #

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

SSYYNNOOPPSSIISS #

     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');

DDEESSCCRRIIPPTTIIOONN #

 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.

BBUUGGSS #

 This is just a basic proof of concept.  It should be seriously expanded
 to support configurable coloration via options passed to the constructor,
 and ppoodd22tteexxtt should be taught about those.

AAUUTTHHOORR #

 Russ Allbery <rra@cpan.org>.

CCOOPPYYRRIIGGHHTT AANNDD LLIICCEENNSSEE #

 Copyright 1999, 2001, 2004, 2006, 2008, 2009, 2018-2019 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.

SSEEEE AALLSSOO #

 Pod::Text, Pod::Simple

 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.36.3 2021-03-02 Pod::Text::Color(3p)