Debian Codegraph @

upstream/debian-unstable/man3/Pod::Text::Termcap.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Pod::Text::Termcap 3perl"
58 .TH Pod::Text::Termcap 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Pod::Text::Termcap \- Convert POD data to ASCII text with format escapes
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& use Pod::Text::Termcap;
69 \& my $parser = Pod::Text::Termcap\->new (sentence => 0, width => 78);
70 \&
71 \& # Read POD from STDIN and write to STDOUT.
72 \& $parser\->parse_from_filehandle;
73 \&
74 \& # Read POD from file.pod and write to file.txt.
75 \& $parser\->parse_from_file (\*(Aqfile.pod\*(Aq, \*(Aqfile.txt\*(Aq);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
80 text using the correct termcap escape sequences for the current terminal.
81 Apart from the format codes, it in all ways functions like Pod::Text. See
82 Pod::Text for details and available options.
83 .PP
84 This module uses Term::Cap to find the correct terminal settings. See the
85 documentation of that module for how it finds terminal database information
86 and how to override that behavior if necessary. If unable to find control
87 strings for bold and underscore formatting, that formatting is skipped,
88 resulting in the same output as Pod::Text.
89 .SH COMPATIBILITY
90 .IX Header "COMPATIBILITY"
91 Pod::Text::Termcap 0.04 (based on Pod::Parser) was the first version of
92 this module included with Perl, in Perl 5.6.0.
93 .PP
94 The current API based on Pod::Simple was added in Pod::Text::Termcap 2.00.
95 Pod::Text::Termcap 2.01 was included in Perl 5.9.3, the first version of Perl
96 to incorporate those changes.
97 .PP
98 Several problems with wrapping and line length were fixed as recently as
99 Pod::Text::Termcap 4.11, included in Perl 5.29.1.
100 .PP
101 Pod::Text::Termcap 4.13 stopped setting the TERMPATH environment variable
102 during module load. It also stopped falling back on VT100 escape sequences if
103 Term::Cap was not able to find usable escape sequences, instead producing
104 unformatted output for better results on dumb terminals. The next version to
105 be incorporated into Perl, 4.14, was included in Perl 5.31.8.
106 .PP
107 This module inherits its API and most behavior from Pod::Text, so the details
108 in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Termcap
109 have had the same module version since 4.00, included in Perl 5.23.7. (They
110 unfortunately diverge in confusing ways prior to that.)
111 .SH AUTHOR
112 .IX Header "AUTHOR"
113 Russ Allbery <[email protected]>
114 .SH "COPYRIGHT AND LICENSE"
115 .IX Header "COPYRIGHT AND LICENSE"
116 Copyright 1999, 2001\-2002, 2004, 2006, 2008\-2009, 2014\-2015, 2018\-2019, 2022
117 Russ Allbery <[email protected]>
118 .PP
119 This program is free software; you may redistribute it and/or modify it
120 under the same terms as Perl itself.
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 Pod::Text, Pod::Simple, Term::Cap
124 .PP
125 The current version of this module is always available from its web site at
126 <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
127 Perl core distribution as of 5.6.0.