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


podlators documentation  | view source Contained in the podlators distribution.

Index


NAME

Top

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

SYNOPSIS

Top

    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

Top

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

Top

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

Top

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

Top

Russ Allbery <rra@stanford.edu>.

COPYRIGHT AND LICENSE

Top


podlators documentation  | view source Contained in the podlators distribution.