Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Text::Color.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::Color 3pm"
61 .TH Pod::Text::Color 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::Color \- Convert POD data to formatted color ASCII text
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Pod::Text::Color;
72 \& my $parser = Pod::Text::Color\->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::Color is a simple subclass of Pod::Text that highlights output
83 text using ANSI color escape sequences. Apart from the color, it in all
84 ways functions like Pod::Text. See Pod::Text for details and available
85 options.
86 .PP
87 Term::ANSIColor is used to get colors and therefore must be installed to use
88 this module.
89 .SH COMPATIBILITY
90 .IX Header "COMPATIBILITY"
91 Pod::Text::Color 0.05 (based on Pod::Parser) was the first version of this
92 module included with Perl, in Perl 5.6.0.
93 .PP
94 The current API based on Pod::Simple was added in Pod::Text::Color 2.00.
95 Pod::Text::Color 2.01 was included in Perl 5.9.3, the first version of Perl to
96 incorporate those changes.
97 .PP
98 Several problems with wrapping and line length were fixed as recently as
99 Pod::Text::Color 6.0.0.
100 .PP
101 This module inherits its API and most behavior from Pod::Text, so the details
102 in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Color have
103 had the same module version since 4.00, included in Perl 5.23.7. (They
104 unfortunately diverge in confusing ways prior to that.)
105 .SH CAVEATS
106 .IX Header "CAVEATS"
107 Line wrapping is done only at ASCII spaces and tabs, rather than using a
108 correct Unicode\-aware line wrapping algorithm.
109 .SH AUTHOR
110 .IX Header "AUTHOR"
111 Russ Allbery <[email protected]>.
112 .SH "COPYRIGHT AND LICENSE"
113 .IX Header "COPYRIGHT AND LICENSE"
114 Copyright 1999, 2001, 2004, 2006, 2008, 2009, 2018\-2019, 2022, 2024 Russ
115 Allbery <[email protected]>
116 .PP
117 This program is free software; you may redistribute it and/or modify it
118 under the same terms as Perl itself.
119 .SH "SEE ALSO"
120 .IX Header "SEE ALSO"
121 Pod::Text, Pod::Simple
122 .PP
123 The current version of this module is always available from its web site at
124 <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
125 Perl core distribution as of 5.6.0.