Edit D:\app\Administrator\product\11.2.0\dbhome_1\perl\html\lib\diagnostics.html

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>splain - produce verbose warning diagnostics</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body style="background-color: white">
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" style="background-color: #cccccc" valign="middle">
<big>&nbsp;splain - produce verbose warning diagnostics</big>
</td></tr>
</table>

<div name="index">
<a name="__index__"></a>

<ul>

<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<ul>

<li><a href="#the_diagnostics_pragma">The <code>diagnostics</code> Pragma</a></li>
		<li><a href="#the_splain_program">The splain Program</a></li>
	</ul>

<li><a href="#examples">EXAMPLES</a></li>
	<li><a href="#internals">INTERNALS</a></li>
	<li><a href="#bugs">BUGS</a></li>
	<li><a href="#author">AUTHOR</a></li>
</ul>

<h1><a name="name">NAME</a></h1>
diagnostics, splain - produce verbose warning diagnostics


<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
Using the <code>diagnostics</code> pragma:
<pre>
 use diagnostics;
 use diagnostics -verbose;</pre>
<pre>
 enable diagnostics;
 disable diagnostics;</pre>
Using the <code>splain</code> standalone filter program:
<pre>
 perl program 2&gt;diag.out
 splain [-v] [-p] diag.out</pre>
Using diagnostics to get stack traces from a misbehaving script:
<pre>
 perl -Mdiagnostics=-traceonly my_script.pl</pre>


<hr />
<h1><a name="description">DESCRIPTION</a></h1>


<h2><a name="the_diagnostics_pragma">The <code>diagnostics</code> Pragma</a></h2>
This module extends the terse diagnostics normally emitted by both the
perl compiler and the perl interpreter (from running perl with a -w 
switch or <code>use warnings</code>), augmenting them with the more
explicative and endearing descriptions found in <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perldiag.html">the perldiag manpage</a>. Like the
other pragmata, it affects the compilation phase of your program rather
than merely the execution phase.
To use in your program as a pragma, merely invoke
<pre>
 use diagnostics;</pre>
at the start (or near the start) of your program. (Note 
that this does enable perl's -w flag.) Your whole
compilation will then be subject(ed :-) to the enhanced diagnostics.
These still go out STDERR.
Due to the interaction between runtime and compiletime issues,
and because it's probably not a very good idea anyway,
you may not use <code>no diagnostics</code> to turn them off at compiletime.
However, you may control their behaviour at runtime using the 
<code>disable()</code> and <code>enable()</code> methods to turn them off and on respectively.
The -verbose flag first prints out the <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perldiag.html">the perldiag manpage</a> introduction before
any other diagnostics. The $diagnostics::PRETTY variable can generate nicer
escape sequences for pagers.
Warnings dispatched from perl itself (or more accurately, those that match
descriptions found in <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perldiag.html">the perldiag manpage</a>) are only displayed once (no duplicate
descriptions). User code generated warnings a la <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#warn"><code>warn()</code></a> are unaffected,
allowing duplicate user messages to be displayed.
This module also adds a stack trace to the error message when perl dies.
This is useful for pinpointing what caused the death. The -traceonly (or
just -t) flag turns off the explanations of warning messages leaving just
the stack traces. So if your script is dieing, run it again with
<pre>
 perl -Mdiagnostics=-traceonly my_bad_script</pre>
to see the call stack at the time of death. By supplying the -warntrace
(or just -w) flag, any warnings emitted will also come with a stack
trace.


<h2><a name="the_splain_program">The splain Program</a></h2>
While apparently a whole nuther program, splain is actually nothing
more than a link to the (executable) diagnostics.pm module, as well as
a link to the diagnostics.pod documentation. The -v flag is like
the <code>use diagnostics -verbose</code> directive.
The -p flag is like the
$diagnostics::PRETTY variable. Since you're post-processing with 
splain, there's no sense in being able to <code>enable()</code> or <code>disable()</code> processing.
Output from splain is directed to STDOUT, unlike the pragma.


<hr />
<h1><a name="examples">EXAMPLES</a></h1>
The following file is certain to trigger a few errors at both
runtime and compiletime:
<pre>
 use diagnostics;
 print NOWHERE &quot;nothing\n&quot;;
 print STDERR &quot;\n\tThis message should be unadorned.\n&quot;;
 warn &quot;\tThis is a user warning&quot;;
 print &quot;\nDIAGNOSTIC TESTER: Please enter a &lt;CR&gt; here: &quot;;
 my $a, $b = scalar &lt;STDIN&gt;;
 print &quot;\n&quot;;
 print $x/$y;</pre>
If you prefer to run your program first and look at its problem
afterwards, do this:
<pre>
 perl -w test.pl 2&gt;test.out
 ./splain &lt; test.out</pre>
Note that this is not in general possible in shells of more dubious heritage, 
as the theoretical
<pre>
 (perl -w test.pl &gt;/dev/tty) &gt;&amp; test.out
 ./splain &lt; test.out</pre>
Because you just moved the existing stdout to somewhere else.
If you don't want to modify your source code, but still have on-the-fly
warnings, do this:
<pre>
 exec 3&gt;&amp;1; perl -w test.pl 2&gt;&amp;1 1&gt;&amp;3 3&gt;&amp;- | splain 1&gt;&amp;2 3&gt;&amp;-</pre>
Nifty, eh?
If you want to control warnings on the fly, do something like this.
Make sure you do the <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#use"><code>use</code></a> first, or you won't be able to get
at the <code>enable()</code> or <code>disable()</code> methods.
<pre>
 use diagnostics; # checks entire compilation phase 
 print &quot;\ntime for 1st bogus diags: SQUAWKINGS\n&quot;;
 print BOGUS1 'nada';
 print &quot;done with 1st bogus\n&quot;;</pre>
<pre>
 disable diagnostics; # only turns off runtime warnings
 print &quot;\ntime for 2nd bogus: (squelched)\n&quot;;
 print BOGUS2 'nada';
 print &quot;done with 2nd bogus\n&quot;;</pre>
<pre>
 enable diagnostics; # turns back on runtime warnings
 print &quot;\ntime for 3rd bogus: SQUAWKINGS\n&quot;;
 print BOGUS3 'nada';
 print &quot;done with 3rd bogus\n&quot;;</pre>
<pre>
 disable diagnostics;
 print &quot;\ntime for 4th bogus: (squelched)\n&quot;;
 print BOGUS4 'nada';
 print &quot;done with 4th bogus\n&quot;;</pre>


<hr />
<h1><a name="internals">INTERNALS</a></h1>
Diagnostic messages derive from the perldiag.pod file when available at
runtime. Otherwise, they may be embedded in the file itself when the
splain package is built. See the Makefile for details.
If an extant $SIG{__WARN__} handler is discovered, it will continue
to be honored, but only after the diagnostics::splainthis() function 
(the module's $SIG{__WARN__} interceptor) has had its way with your
warnings.
There is a $diagnostics::DEBUG variable you may set if you're desperately
curious what sorts of things are being intercepted.
<pre>
 BEGIN { $diagnostics::DEBUG = 1 }</pre>


<hr />
<h1><a name="bugs">BUGS</a></h1>
Not being able to say &quot;no diagnostics&quot; is annoying, but may not be
insurmountable.
The <code>-pretty</code> directive is called too late to affect matters.
You have to do this instead, and before you load the module.
<pre>
 BEGIN { $diagnostics::PRETTY = 1 }</pre>
I could start up faster by delaying compilation until it should be
needed, but this gets a &quot;panic: top_level&quot; when using the pragma form
in Perl 5.001e.
While it's true that this documentation is somewhat subserious, if you use
a program named splain, you should expect a bit of whimsy.


<hr />
<h1><a name="author">AUTHOR</a></h1>
Tom Christiansen &lt;<a href="mailto:tchrist@mox.perl.com">tchrist@mox.perl.com</a>&gt;, 25 June 1995.
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" style="background-color: #cccccc" valign="middle">
<big>&nbsp;splain - produce verbose warning diagnostics</big>
</td></tr>
</table>

</body>

</html>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de