Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Pod::Text::Color

Name Pod::Text::Color
Version 4.11
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Pod/Text/Color.pm
Is Core No
Search CPAN for this module Pod::Text::Color
Documentation Pod::Text::Color
Module Details Pod::Text::Color


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 the Pod::Text manpage 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.


AUTHOR

Russ Allbery <rra@cpan.org>.


COPYRIGHT AND LICENSE

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

the Pod::Text manpage, the Pod::Simple manpage

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 Diver brought to you by ScriptSolutions.com © 1997- 2024