Pod::Text::Termcap(3pm) Perl Programmers Reference Guide
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.
COMPATIBILITY
Pod::Text::Termcap 0.04 (based on Pod::Parser) was the first version of
this module included with Perl, in Perl 5.6.0.
The current API based on Pod::Simple was added in Pod::Text::Termcap
2.00. Pod::Text::Termcap 2.01 was included in Perl 5.9.3, the first
version of Perl to incorporate those changes.
Several problems with wrapping and line length were fixed as recently
as Pod::Text::Termcap 4.11, included in Perl 5.29.1.
Pod::Text::Termcap 4.13 stopped setting the TERMPATH environment
variable during module load. It also stopped falling back on VT100
escape sequences if Term::Cap was not able to find usable escape
sequences, instead producing unformatted output for better results on
dumb terminals. The next version to be incorporated into Perl, 4.14,
was included in Perl 5.31.8.
This module inherits its API and most behavior from Pod::Text, so the
details in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and
Pod::Text::Termcap have had the same module version since 4.00,
included in Perl 5.23.7. (They unfortunately diverge in confusing ways
prior to that.)
AUTHOR
Russ Allbery <rra@cpan.org>
COPYRIGHT AND LICENSE
Copyright 1999, 2001-2002, 2004, 2006, 2008-2009, 2014-2015, 2018-2019,
2022 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
Pod::Text(3), Pod::Simple(3), Term::Cap(3)
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 v5.38.2 2023-11-28 Pod::Text::Termcap(3pm)
perl 5.38.2 - Generated Tue Dec 10 16:40:17 CST 2024