1Pod::Text::Termcap(3) User Contributed Perl DocumentationPod::Text::Termcap(3)
2
3
4

NAME

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

SYNOPSIS

9           use Pod::Text::Termcap;
10           my $parser = Pod::Text::Termcap->new (sentence => 0, width => 78);
11
12           # Read POD from STDIN and write to STDOUT.
13           $parser->parse_from_filehandle;
14
15           # Read POD from file.pod and write to file.txt.
16           $parser->parse_from_file ('file.pod', 'file.txt');
17

DESCRIPTION

19       Pod::Text::Termcap is a simple subclass of Pod::Text that highlights
20       output text using the correct termcap escape sequences for the current
21       terminal.  Apart from the format codes, it in all ways functions like
22       Pod::Text.  See Pod::Text for details and available options.
23
24       This module uses Term::Cap to find the correct terminal settings.  See
25       the documentation of that module for how it finds terminal database
26       information and how to override that behavior if necessary.  If unable
27       to find control strings for bold and underscore formatting, that
28       formatting is skipped, resulting in the same output as Pod::Text.
29

COMPATIBILITY

31       Pod::Text::Termcap 0.04 (based on Pod::Parser) was the first version of
32       this module included with Perl, in Perl 5.6.0.
33
34       The current API based on Pod::Simple was added in Pod::Text::Termcap
35       2.00.  Pod::Text::Termcap 2.01 was included in Perl 5.9.3, the first
36       version of Perl to incorporate those changes.
37
38       Several problems with wrapping and line length were fixed as recently
39       as Pod::Text::Termcap 4.11, included in Perl 5.29.1.
40
41       Pod::Text::Termcap 4.13 stopped setting the TERMPATH environment
42       variable during module load.  It also stopped falling back on VT100
43       escape sequences if Term::Cap was not able to find usable escape
44       sequences, instead producing unformatted output for better results on
45       dumb terminals.  The next version to be incorporated into Perl, 4.14,
46       was included in Perl 5.31.8.
47
48       This module inherits its API and most behavior from Pod::Text, so the
49       details in "COMPATIBILITY" in Pod::Text also apply.  Pod::Text and
50       Pod::Text::Termcap have had the same module version since 4.00,
51       included in Perl 5.23.7.  (They unfortunately diverge in confusing ways
52       prior to that.)
53

AUTHOR

55       Russ Allbery <rra@cpan.org>
56

58       Copyright 1999, 2001-2002, 2004, 2006, 2008-2009, 2014-2015, 2018-2019,
59       2022 Russ Allbery <rra@cpan.org>
60
61       This program is free software; you may redistribute it and/or modify it
62       under the same terms as Perl itself.
63

SEE ALSO

65       Pod::Text, Pod::Simple, Term::Cap
66
67       The current version of this module is always available from its web
68       site at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also
69       part of the Perl core distribution as of 5.6.0.
70
71
72
73perl v5.36.0                      2023-01-20             Pod::Text::Termcap(3)
Impressum