.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Simple::Debug 3pm"
.TH Pod::Simple::Debug 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Pod::Simple::Debug \-\- put Pod::Simple into trace/debug mode
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Pod::Simple::Debug (5);  # or some integer
.Ve
.PP
Or:
.PP
.Vb 4
\& my $debuglevel;
\& use Pod::Simple::Debug (\e$debuglevel, 0);
\& ...some stuff that uses Pod::Simple to do stuff, but which
\&  you don\*(Aqt want debug output from...
\&
\& $debug_level = 4;
\& ...some stuff that uses Pod::Simple to do stuff, but which
\&  you DO want debug output from...
\&
\& $debug_level = 0;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is an internal module for controlling the debug level (a.k.a. trace
level) of Pod::Simple.  This is of interest only to Pod::Simple
developers.
.SH CAVEATS
.IX Header "CAVEATS"
Note that you should load this module \fIbefore\fR loading Pod::Simple (or
any Pod::Simple\-based class).  If you try loading Pod::Simple::Debug
after &Pod::Simple::DEBUG is already defined, Pod::Simple::Debug will
throw a fatal error to the effect that
"It's too late to call Pod::Simple::Debug".
.PP
Note that the \f(CW\*(C`use Pod::Simple::Debug (\e$x, \fR\f(CIsomenum\fR\f(CW)\*(C'\fR mode will make
Pod::Simple (et al) run rather slower, since &Pod::Simple::DEBUG won't
be a constant sub anymore, and so Pod::Simple (et al) won't compile with
constant-folding.
.SH GUTS
.IX Header "GUTS"
Doing this:
.PP
.Vb 1
\&  use Pod::Simple::Debug (5);  # or some integer
.Ve
.PP
is basically equivalent to:
.PP
.Vb 2
\&  BEGIN { sub Pod::Simple::DEBUG () {5} }  # or some integer
\&  use Pod::Simple ();
.Ve
.PP
And this:
.PP
.Vb 1
\&  use Pod::Simple::Debug (\e$debug_level,0);  # or some integer
.Ve
.PP
is basically equivalent to this:
.PP
.Vb 4
\&  my $debug_level;
\&  BEGIN { $debug_level = 0 }
\&  BEGIN { sub Pod::Simple::DEBUG () { $debug_level }
\&  use Pod::Simple ();
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple
.PP
The article "Constants in Perl", in \fIThe Perl Journal\fR issue
21.  See <http://interglacial.com/tpj/21/>
.SH SUPPORT
.IX Header "SUPPORT"
Questions or discussion about POD and Pod::Simple should be sent to the
pod\-people@perl.org mail list. Send an empty email to
pod\-people\-subscribe@perl.org to subscribe.
.PP
This module is managed in an open GitHub repository,
<https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
to clone <git://github.com/perl\-pod/pod\-simple.git> and send patches!
.PP
Patches against Pod::Simple are welcome. Please send bug reports to
<bug\-pod\-simple@rt.cpan.org>.
.SH "COPYRIGHT AND DISCLAIMERS"
.IX Header "COPYRIGHT AND DISCLAIMERS"
Copyright (c) 2002 Sean M. Burke.
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
.SH AUTHOR
.IX Header "AUTHOR"
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.
But don't bother him, he's retired.
.PP
Pod::Simple is maintained by:
.IP \(bu 4
Allison Randal \f(CW\*(C`allison@perl.org\*(C'\fR
.IP \(bu 4
Hans Dieter Pearcey \f(CW\*(C`hdp@cpan.org\*(C'\fR
.IP \(bu 4
David E. Wheeler \f(CW\*(C`dwheeler@cpan.org\*(C'\fR