Debian Codegraph @

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