.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Devel::SimpleTrace 3pm" .TH Devel::SimpleTrace 3pm "2022-10-22" "perl v5.34.0" "User Contributed Perl Documentation" .\" 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" Devel::SimpleTrace \- See where you code warns and dies using stack traces .SH "VERSION" .IX Header "VERSION" Version 0.08 .SH "SYNOPSIS" .IX Header "SYNOPSIS" On the command-line: .PP .Vb 1 \& perl \-wMDevel::SimpleTrace program_with_strange_errors.pl .Ve .PP Inside a module: .PP .Vb 1 \& use Devel::SimpleTrace; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module can be used to more easily spot the place where a program or a module generates errors. Its use is extremely simple, reduced to just \f(CW\*(C`use\*(C'\fRing it. .PP This is achieved by modifying the functions \f(CW\*(C`warn()\*(C'\fR and \f(CW\*(C`die()\*(C'\fR in order to replace the standard messages by complete stack traces that precisely indicates how and where the error or warning occurred. Other than this, their use should stay unchanged, even when using \&\f(CW\*(C`die()\*(C'\fR inside \f(CW\*(C`eval()\*(C'\fR. .SH "OPTIONS" .IX Header "OPTIONS" Options can be set at import time using: .PP .Vb 1 \& perl \-wMDevel::SimpleTrace=option1,option2 .Ve .PP or .PP .Vb 1 \& use Devel::SimpleTrace qw(option1 option2); .Ve .PP Available options are: .ie n .IP """showrefs""" 4 .el .IP "\f(CWshowrefs\fR" 4 .IX Item "showrefs" Using this option will tell \f(CW\*(C`Devel::SimpleTrace\*(C'\fR to stringify objects and references passed in argument to \f(CW\*(C`die()\*(C'\fR. This option is disabled by default in order to leave objects and references untouched. .SH "EXAMPLE" .IX Header "EXAMPLE" For example, \f(CW\*(C`HTTP::Proxy\*(C'\fR 0.14 suffered from strange warnings, and its author Philippe Bruhat had a hard time trying to understand where they could come from. .PP .Vb 2 \& getsockname() on closed socket Symbol::GEN7 at /System/Library/Perl/darwin/IO/Socket.pm line 186. \& Use of uninitialized value in numeric ne (!=) at /Library/Perl/HTTP/Daemon.pm line 53. .Ve .PP Hmm.. There's obviously something wrong here, but spotting the right line is not easy. .PP Re-running the same script, unchanged, by just adding \f(CW\*(C`\-MDevel::SimpleTrace\*(C'\fR to \f(CW\*(C`perl\*(C'\fR arguments produces the following output: .PP .Vb 10 \& getsockname() on closed socket Symbol::GEN7 \& at IO::Socket::sockname(/System/Library/Perl/darwin/IO/Socket.pm:186) \& at IO::Socket::INET::sockport(/System/Library/Perl/IO/Socket/INET.pm:231) \& at HTTP::Daemon::url(/Library/Perl/HTTP/Daemon.pm:52) \& at HTTP::Daemon::ClientConn::get_request(/Library/Perl/HTTP/Daemon.pm:139) \& at HTTP::Proxy::serve_connections(/Library/Perl/HTTP/Proxy.pm:500) \& at HTTP::Proxy::start(/Library/Perl/HTTP/Proxy.pm:392) \& at t::Utils::fork_proxy(t/Utils.pm:72) \& at main::(t/50standard.t:138) \& Use of uninitialized value in numeric ne (!=) \& at HTTP::Daemon::url(/Library/Perl/HTTP/Daemon.pm:53) \& at HTTP::Daemon::ClientConn::get_request(/Library/Perl/HTTP/Daemon.pm:139) \& at HTTP::Proxy::serve_connections(/Library/Perl/HTTP/Proxy.pm:500) \& at HTTP::Proxy::start(/Library/Perl/HTTP/Proxy.pm:392) \& at t::Utils::fork_proxy(t/Utils.pm:72) \& at main::(t/50standard.t:138) .Ve .PP Aha! Much better. Finding the bug is now a trivial task \f(CW\*(C`;\-)\*(C'\fR .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP "Unknown option: %s" 4 .el .IP "Unknown option: \f(CW%s\fR" 4 .IX Item "Unknown option: %s" \&\fB(W)\fR This warning occurs if you try to set an unknown option. .SH "CAVEATS" .IX Header "CAVEATS" This module is currently not compatible with other modules that also work by overriding \f(CW\*(C`die()\*(C'\fR and \f(CW\*(C`warn()\*(C'\fR, like \f(CW\*(C`CGI::Carp\*(C'\fR. .SH "AUTHOR" .IX Header "AUTHOR" Se\*'bastien Aperghis-Tramoni .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-Devel\-SimpleTrace@rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Devel::SimpleTrace is Copyright (C)2004\-2011 Se\*'bastien Aperghis-Tramoni. .PP This program is free software. You can redistribute it and/or modify it under the same terms as Perl itself.