Pod::Simple::Debug

Pod::Simple::Debug(3)User Contributed Perl DocumentationPod::Simple::Debug(3)



NAME
       Pod::Simple::Debug -- put Pod::Simple into trace/debug mode

SYNOPSIS
	use Pod::Simple::Debug (5);  # or some integer

       Or:

	my $debuglevel;
	use Pod::Simple::Debug (\$debuglevel, 0);
	...some stuff that uses Pod::Simple to do stuff, but which
	 you don’t 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;

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.

CAVEATS
       Note that you should load this module before 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 s too late to call
       Pod::Simple::Debug".

       Note that the "use Pod::Simple::Debug (\$x, somenum)" 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.

GUTS
       Doing this:

	 use Pod::Simple::Debug (5);  # or some integer

       is basically equivalent to:

	 BEGIN { sub Pod::Simple::DEBUG () {5} }  # or some integer
	 use Pod::Simple ();

       And this:

	 use Pod::Simple::Debug (\$debug_level,0);  # or some integer

       is basically equivalent to this:

	 my $debug_level;
	 BEGIN { $debug_level = 0 }
	 BEGIN { sub Pod::Simple::DEBUG () { $debug_level }
	 use Pod::Simple ();

SEE ALSO
       Pod::Simple

       The article "Constants in Perl", in The Perl Journal issue 21.  See
       <http://www.sysadminmag.com/tpj/issues/vol5_5/>

COPYRIGHT AND DISCLAIMERS
       Copyright (c) 2002 Sean M. Burke.  All rights reserved.

       This library is free software; you can redistribute it and/or modify
       it under the same terms as Perl itself.

       This program is distributed in the hope that it will be useful, but
       without any warranty; without even the implied warranty of mer-
       chantability or fitness for a particular purpose.

AUTHOR
       Sean M. Burke "sburke@cpan.org"



perl v5.8.8			  2006-07-07		Pod::Simple::Debug(3)