perl 5.002beta2 patch: MANIFEST

[p5sagit/p5-mst-13.2.git] / lib / sigtrap.pm

diff --git a/lib/sigtrap.pm b/lib/sigtrap.pm
index 72b9cb6..dd4df90 100644 (file)
--- a/lib/sigtrap.pm
+++ b/lib/sigtrap.pm
@@ -1,5 +1,27 @@
 package sigtrap;
 
+=head1 NAME
+
+sigtrap - Perl pragma to enable stack backtrace on unexpected signals
+
+=head1 SYNOPSIS
+
+    use sigtrap;
+    use sigtrap qw(BUS SEGV PIPE SYS ABRT TRAP);
+
+=head1 DESCRIPTION
+
+The C<sigtrap> pragma initializes some default signal handlers that print
+a stack dump of your Perl program, then sends itself a SIGABRT.  This
+provides a nice starting point if something horrible goes wrong.
+
+By default, handlers are installed for the ABRT, BUS, EMT, FPE, ILL, PIPE,
+QUIT, SEGV, SYS, TERM, and TRAP signals.
+
+See L<perlmod/Pragmatic Modules>.
+
+=cut
+
 require Carp;
 
 sub import {