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

ENVIRONMENT

25       This module sets the TERMPATH environment variable globally to:
26
27           $HOME/.termcap:/etc/termcap:/usr/share/misc/termcap:/usr/share/lib/termcap
28
29       if it isn't already set.  (The first entry is omitted if the HOME
30       environment variable isn't set.)  This is a (very old) workaround for
31       problems finding termcap information on older versions of Solaris, and
32       is not good module behavior.  Please do not rely on this behavior; it
33       may be dropped in a future release.
34

NOTES

36       This module uses Term::Cap to retrieve the formatting escape sequences
37       for the current terminal, and falls back on the ECMA-48 (the same in
38       this regard as ANSI X3.64 and ISO 6429, the escape codes also used by
39       DEC VT100 terminals) if the bold, underline, and reset codes aren't set
40       in the termcap information.
41

AUTHOR

43       Russ Allbery <rra@cpan.org>.
44

46       Copyright 1999, 2001-2002, 2004, 2006, 2008-2009, 2014-2015, 2018 Russ
47       Allbery <rra@cpan.org>
48
49       This program is free software; you may redistribute it and/or modify it
50       under the same terms as Perl itself.
51

SEE ALSO

53       Pod::Text, Pod::Simple, Term::Cap
54
55       The current version of this module is always available from its web
56       site at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also
57       part of the Perl core distribution as of 5.6.0.
58
59
60
61perl v5.26.3                      2018-05-07             Pod::Text::Termcap(3)
Impressum