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

AUTHOR

31       Russ Allbery <rra@cpan.org>
32

34       Copyright 1999, 2001-2002, 2004, 2006, 2008-2009, 2014-2015, 2018-2019
35       Russ Allbery <rra@cpan.org>
36
37       This program is free software; you may redistribute it and/or modify it
38       under the same terms as Perl itself.
39

SEE ALSO

41       Pod::Text, Pod::Simple, Term::Cap
42
43       The current version of this module is always available from its web
44       site at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also
45       part of the Perl core distribution as of 5.6.0.
46
47
48
49perl v5.34.0                      2022-01-21             Pod::Text::Termcap(3)
Impressum