Content-type: text/html Man page of Pod::Text::Color

Pod::Text::Color

Section: Perl Programmers Reference Guide (3perl)
Updated: 2007-12-18
Index Return to Main Contents
 

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.  

BUGS

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

SEE ALSO

Pod::Text, Pod::Simple

The current version of this module is always available from its web site at <http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core distribution as of 5.6.0.  

AUTHOR

Russ Allbery <[email protected]>.  

COPYRIGHT AND LICENSE

Copyright 1999, 2001, 2004, 2006 by Russ Allbery <[email protected]>.

This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.


 

Index

NAME
SYNOPSIS
DESCRIPTION
BUGS
SEE ALSO
AUTHOR
COPYRIGHT AND LICENSE

This document was created by man2html, using the manual pages.
Time: 04:14:18 GMT, September 24, 2010