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

NOTES

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

SEE ALSO

32       Pod::Text, Pod::Simple, Term::Cap
33
34       The current version of this module is always available from its web
35       site at <http://www.eyrie.org/~eagle/software/podlators/>.  It is also
36       part of the Perl core distribution as of 5.6.0.
37

AUTHOR

39       Russ Allbery <rra@stanford.edu>.
40

42       Copyright 1999, 2001, 2002, 2004, 2006, 2008, 2009 Russ Allbery
43       <rra@stanford.edu>.
44
45       This program is free software; you may redistribute it and/or modify it
46       under the same terms as Perl itself.
47
48
49
50perl v5.16.3                      2013-01-02             Pod::Text::Termcap(3)
Impressum