Debian Codegraph @

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