man pages section 3: Library Interfaces and Headers

Pod::Text::Termcap (3)

Name

Pod::Text::Termcap - Convert POD data to ASCII text with format escapes

Synopsis

use Pod::Text::Termcap;
my $parser = Pod::Text::Termcap->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::Termcap(3)



NAME
       Pod::Text::Termcap - Convert POD data to ASCII text with format escapes

SYNOPSIS
           use Pod::Text::Termcap;
           my $parser = Pod::Text::Termcap->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::Termcap is a simple subclass of Pod::Text that highlights
       output text using the correct termcap escape sequences for the current
       terminal.  Apart from the format codes, it in all ways functions like
       Pod::Text.  See Pod::Text for details and available options.

       This module uses Term::Cap to find the correct terminal settings.  See
       the documentation of that module for how it finds terminal database
       information and how to override that behavior if necessary.  If unable
       to find control strings for bold and underscore formatting, that
       formatting is skipped, resulting in the same output as Pod::Text.

AUTHOR
       Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE
       Copyright 1999, 2001-2002, 2004, 2006, 2008-2009, 2014-2015, 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, Term::Cap

       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::Termcap(3)