Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Text::Termcap.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Text::Termcap 3pm"
61 .TH Pod::Text::Termcap 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Text::Termcap \- Convert POD data to ASCII text with format escapes
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Pod::Text::Termcap;
72 \& my $parser = Pod::Text::Termcap\->new (sentence => 0, width => 78);
73 \&
74 \& # Read POD from STDIN and write to STDOUT.
75 \& $parser\->parse_from_filehandle;
76 \&
77 \& # Read POD from file.pod and write to file.txt.
78 \& $parser\->parse_from_file (\*(Aqfile.pod\*(Aq, \*(Aqfile.txt\*(Aq);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
83 text using the correct termcap escape sequences for the current terminal.
84 Apart from the format codes, it in all ways functions like Pod::Text. See
85 Pod::Text for details and available options.
86 .PP
87 This module uses Term::Cap to find the correct terminal settings. See the
88 documentation of that module for how it finds terminal database information
89 and how to override that behavior if necessary. If unable to find control
90 strings for bold and underscore formatting, that formatting is skipped,
91 resulting in the same output as Pod::Text.
92 .SH COMPATIBILITY
93 .IX Header "COMPATIBILITY"
94 Pod::Text::Termcap 0.04 (based on Pod::Parser) was the first version of
95 this module included with Perl, in Perl 5.6.0.
96 .PP
97 The current API based on Pod::Simple was added in Pod::Text::Termcap 2.00.
98 Pod::Text::Termcap 2.01 was included in Perl 5.9.3, the first version of Perl
99 to incorporate those changes.
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 Several problems with wrapping and line length were fixed as recently as
108 Pod::Text::Termcap 6.0.0.
109 .PP
110 This module inherits its API and most behavior from Pod::Text, so the details
111 in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Termcap
112 have had the same module version since 4.00, included in Perl 5.23.7. (They
113 unfortunately diverge in confusing ways prior to that.)
114 .SH CAVEATS
115 .IX Header "CAVEATS"
116 Line wrapping is done only at ASCII spaces and tabs, rather than using a
117 correct Unicode\-aware line wrapping algorithm.
118 .SH AUTHOR
119 .IX Header "AUTHOR"
120 Russ Allbery <[email protected]>
121 .SH "COPYRIGHT AND LICENSE"
122 .IX Header "COPYRIGHT AND LICENSE"
123 Copyright 1999, 2001\-2002, 2004, 2006, 2008\-2009, 2014\-2015, 2018\-2019, 2022,
124 2024 Russ Allbery <[email protected]>
125 .PP
126 This program is free software; you may redistribute it and/or modify it
127 under the same terms as Perl itself.
128 .SH "SEE ALSO"
129 .IX Header "SEE ALSO"
130 Pod::Text, Pod::Simple, Term::Cap
131 .PP
132 The current version of this module is always available from its web site at
133 <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
134 Perl core distribution as of 5.6.0.