Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Simple::Debug.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::Simple::Debug 3pm"
61 .TH Pod::Simple::Debug 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::Simple::Debug \-\- put Pod::Simple into trace/debug mode
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use Pod::Simple::Debug (5); # or some integer
72 .Ve
73 .PP
74 Or:
75 .PP
76 .Vb 4
77 \& my $debuglevel;
78 \& use Pod::Simple::Debug (\e$debuglevel, 0);
79 \& ...some stuff that uses Pod::Simple to do stuff, but which
80 \& you don\*(Aqt want debug output from...
81 \&
82 \& $debug_level = 4;
83 \& ...some stuff that uses Pod::Simple to do stuff, but which
84 \& you DO want debug output from...
85 \&
86 \& $debug_level = 0;
87 .Ve
88 .SH DESCRIPTION
89 .IX Header "DESCRIPTION"
90 This is an internal module for controlling the debug level (a.k.a. trace
91 level) of Pod::Simple. This is of interest only to Pod::Simple
92 developers.
93 .SH CAVEATS
94 .IX Header "CAVEATS"
95 Note that you should load this module \fIbefore\fR loading Pod::Simple (or
96 any Pod::Simple\-based class). If you try loading Pod::Simple::Debug
97 after &Pod::Simple::DEBUG is already defined, Pod::Simple::Debug will
98 throw a fatal error to the effect that
99 "It\*(Aqs too late to call Pod::Simple::Debug".
100 .PP
101 Note that the \f(CW\*(C`use Pod::Simple::Debug (\e$x, \fR\f(CIsomenum\fR\f(CW)\*(C'\fR mode will make
102 Pod::Simple (et al) run rather slower, since &Pod::Simple::DEBUG won\*(Aqt
103 be a constant sub anymore, and so Pod::Simple (et al) won\*(Aqt compile with
104 constant\-folding.
105 .SH GUTS
106 .IX Header "GUTS"
107 Doing this:
108 .PP
109 .Vb 1
110 \& use Pod::Simple::Debug (5); # or some integer
111 .Ve
112 .PP
113 is basically equivalent to:
114 .PP
115 .Vb 2
116 \& BEGIN { sub Pod::Simple::DEBUG () {5} } # or some integer
117 \& use Pod::Simple ();
118 .Ve
119 .PP
120 And this:
121 .PP
122 .Vb 1
123 \& use Pod::Simple::Debug (\e$debug_level,0); # or some integer
124 .Ve
125 .PP
126 is basically equivalent to this:
127 .PP
128 .Vb 4
129 \& my $debug_level;
130 \& BEGIN { $debug_level = 0 }
131 \& BEGIN { sub Pod::Simple::DEBUG () { $debug_level }
132 \& use Pod::Simple ();
133 .Ve
134 .SH "SEE ALSO"
135 .IX Header "SEE ALSO"
136 Pod::Simple
137 .PP
138 The article "Constants in Perl", in \fIThe Perl Journal\fR issue
139 21. See <http://interglacial.com/tpj/21/>
140 .SH SUPPORT
141 .IX Header "SUPPORT"
142 Questions or discussion about POD and Pod::Simple should be sent to the
143 pod\[email protected] mail list. Send an empty email to
144 pod\-people\[email protected] to subscribe.
145 .PP
146 This module is managed in an open GitHub repository,
147 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
148 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
149 .PP
150 Patches against Pod::Simple are welcome. Please send bug reports to
151 <bug\-pod\[email protected]>.
152 .SH "COPYRIGHT AND DISCLAIMERS"
153 .IX Header "COPYRIGHT AND DISCLAIMERS"
154 Copyright (c) 2002 Sean M. Burke.
155 .PP
156 This library is free software; you can redistribute it and/or modify it
157 under the same terms as Perl itself.
158 .PP
159 This program is distributed in the hope that it will be useful, but
160 without any warranty; without even the implied warranty of
161 merchantability or fitness for a particular purpose.
162 .SH AUTHOR
163 .IX Header "AUTHOR"
164 Pod::Simple was created by Sean M. Burke <[email protected]>.
165 But don\*(Aqt bother him, he\*(Aqs retired.
166 .PP
167 Pod::Simple is maintained by:
168 .IP \(bu 4
169 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
170 .IP \(bu 4
171 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
172 .IP \(bu 4
173 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR