man pages section 3: Library Interfaces and Headers

Pod::Text::Color (3)

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

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



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.

AUTHOR
       Russ Allbery <rra@cpan.org>.

COPYRIGHT AND LICENSE
       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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

SEE ALSO
       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.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14               Pod::Text::Color(3)