Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "sigtrap 3" | |
132 | .TH sigtrap 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | sigtrap \- Perl pragma to enable simple signal handling | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 11 | |
138 | \& use sigtrap; | |
139 | \& use sigtrap qw(stack-trace old-interface-signals); # equivalent | |
140 | \& use sigtrap qw(BUS SEGV PIPE ABRT); | |
141 | \& use sigtrap qw(die INT QUIT); | |
142 | \& use sigtrap qw(die normal-signals); | |
143 | \& use sigtrap qw(die untrapped normal-signals); | |
144 | \& use sigtrap qw(die untrapped normal-signals | |
145 | \& stack-trace any error-signals); | |
146 | \& use sigtrap 'handler' => \e&my_handler, 'normal-signals'; | |
147 | \& use sigtrap qw(handler my_handler normal-signals | |
148 | \& stack-trace error-signals); | |
149 | .Ve | |
150 | .SH "DESCRIPTION" | |
151 | .IX Header "DESCRIPTION" | |
152 | The \fBsigtrap\fR pragma is a simple interface to installing signal | |
153 | handlers. You can have it install one of two handlers supplied by | |
154 | \&\fBsigtrap\fR itself (one which provides a Perl stack trace and one which | |
155 | simply \f(CW\*(C`die()\*(C'\fRs), or alternately you can supply your own handler for it | |
156 | to install. It can be told only to install a handler for signals which | |
157 | are either untrapped or ignored. It has a couple of lists of signals to | |
158 | trap, plus you can supply your own list of signals. | |
159 | .PP | |
160 | The arguments passed to the \f(CW\*(C`use\*(C'\fR statement which invokes \fBsigtrap\fR | |
161 | are processed in order. When a signal name or the name of one of | |
162 | \&\fBsigtrap\fR's signal lists is encountered a handler is immediately | |
163 | installed, when an option is encountered it affects subsequently | |
164 | installed handlers. | |
165 | .SH "OPTIONS" | |
166 | .IX Header "OPTIONS" | |
167 | .Sh "\s-1SIGNAL\s0 \s-1HANDLERS\s0" | |
168 | .IX Subsection "SIGNAL HANDLERS" | |
169 | These options affect which handler will be used for subsequently | |
170 | installed signals. | |
171 | .IP "\fBstack-trace\fR" 4 | |
172 | .IX Item "stack-trace" | |
173 | The handler used for subsequently installed signals outputs a Perl stack | |
174 | trace to \s-1STDERR\s0 and then tries to dump core. This is the default signal | |
175 | handler. | |
176 | .IP "\fBdie\fR" 4 | |
177 | .IX Item "die" | |
178 | The handler used for subsequently installed signals calls \f(CW\*(C`die\*(C'\fR | |
179 | (actually \f(CW\*(C`croak\*(C'\fR) with a message indicating which signal was caught. | |
180 | .IP "\fBhandler\fR \fIyour-handler\fR" 4 | |
181 | .IX Item "handler your-handler" | |
182 | \&\fIyour-handler\fR will be used as the handler for subsequently installed | |
183 | signals. \fIyour-handler\fR can be any value which is valid as an | |
184 | assignment to an element of \f(CW%SIG\fR. | |
185 | .Sh "\s-1SIGNAL\s0 \s-1LISTS\s0" | |
186 | .IX Subsection "SIGNAL LISTS" | |
187 | \&\fBsigtrap\fR has a few built-in lists of signals to trap. They are: | |
188 | .IP "\fBnormal-signals\fR" 4 | |
189 | .IX Item "normal-signals" | |
190 | These are the signals which a program might normally expect to encounter | |
191 | and which by default cause it to terminate. They are \s-1HUP\s0, \s-1INT\s0, \s-1PIPE\s0 and | |
192 | \&\s-1TERM\s0. | |
193 | .IP "\fBerror-signals\fR" 4 | |
194 | .IX Item "error-signals" | |
195 | These signals usually indicate a serious problem with the Perl | |
196 | interpreter or with your script. They are \s-1ABRT\s0, \s-1BUS\s0, \s-1EMT\s0, \s-1FPE\s0, \s-1ILL\s0, | |
197 | \&\s-1QUIT\s0, \s-1SEGV\s0, \s-1SYS\s0 and \s-1TRAP\s0. | |
198 | .IP "\fBold-interface-signals\fR" 4 | |
199 | .IX Item "old-interface-signals" | |
200 | These are the signals which were trapped by default by the old | |
201 | \&\fBsigtrap\fR interface, they are \s-1ABRT\s0, \s-1BUS\s0, \s-1EMT\s0, \s-1FPE\s0, \s-1ILL\s0, \s-1PIPE\s0, \s-1QUIT\s0, | |
202 | \&\s-1SEGV\s0, \s-1SYS\s0, \s-1TERM\s0, and \s-1TRAP\s0. If no signals or signals lists are passed to | |
203 | \&\fBsigtrap\fR, this list is used. | |
204 | .PP | |
205 | For each of these three lists, the collection of signals set to be | |
206 | trapped is checked before trapping; if your architecture does not | |
207 | implement a particular signal, it will not be trapped but rather | |
208 | silently ignored. | |
209 | .Sh "\s-1OTHER\s0" | |
210 | .IX Subsection "OTHER" | |
211 | .IP "\fBuntrapped\fR" 4 | |
212 | .IX Item "untrapped" | |
213 | This token tells \fBsigtrap\fR to install handlers only for subsequently | |
214 | listed signals which aren't already trapped or ignored. | |
215 | .IP "\fBany\fR" 4 | |
216 | .IX Item "any" | |
217 | This token tells \fBsigtrap\fR to install handlers for all subsequently | |
218 | listed signals. This is the default behavior. | |
219 | .IP "\fIsignal\fR" 4 | |
220 | .IX Item "signal" | |
221 | Any argument which looks like a signal name (that is, | |
222 | \&\f(CW\*(C`/^[A\-Z][A\-Z0\-9]*$/\*(C'\fR) indicates that \fBsigtrap\fR should install a | |
223 | handler for that name. | |
224 | .IP "\fInumber\fR" 4 | |
225 | .IX Item "number" | |
226 | Require that at least version \fInumber\fR of \fBsigtrap\fR is being used. | |
227 | .SH "EXAMPLES" | |
228 | .IX Header "EXAMPLES" | |
229 | Provide a stack trace for the old\-interface\-signals: | |
230 | .PP | |
231 | .Vb 1 | |
232 | \& use sigtrap; | |
233 | .Ve | |
234 | .PP | |
235 | Ditto: | |
236 | .PP | |
237 | .Vb 1 | |
238 | \& use sigtrap qw(stack-trace old-interface-signals); | |
239 | .Ve | |
240 | .PP | |
241 | Provide a stack trace on the 4 listed signals only: | |
242 | .PP | |
243 | .Vb 1 | |
244 | \& use sigtrap qw(BUS SEGV PIPE ABRT); | |
245 | .Ve | |
246 | .PP | |
247 | Die on \s-1INT\s0 or \s-1QUIT:\s0 | |
248 | .PP | |
249 | .Vb 1 | |
250 | \& use sigtrap qw(die INT QUIT); | |
251 | .Ve | |
252 | .PP | |
253 | Die on \s-1HUP\s0, \s-1INT\s0, \s-1PIPE\s0 or \s-1TERM:\s0 | |
254 | .PP | |
255 | .Vb 1 | |
256 | \& use sigtrap qw(die normal-signals); | |
257 | .Ve | |
258 | .PP | |
259 | Die on \s-1HUP\s0, \s-1INT\s0, \s-1PIPE\s0 or \s-1TERM\s0, except don't change the behavior for | |
260 | signals which are already trapped or ignored: | |
261 | .PP | |
262 | .Vb 1 | |
263 | \& use sigtrap qw(die untrapped normal-signals); | |
264 | .Ve | |
265 | .PP | |
266 | Die on receipt one of an of the \fBnormal-signals\fR which is currently | |
267 | \&\fBuntrapped\fR, provide a stack trace on receipt of \fBany\fR of the | |
268 | \&\fBerror-signals\fR: | |
269 | .PP | |
270 | .Vb 2 | |
271 | \& use sigtrap qw(die untrapped normal-signals | |
272 | \& stack-trace any error-signals); | |
273 | .Ve | |
274 | .PP | |
275 | Install \fImy_handler()\fR as the handler for the \fBnormal-signals\fR: | |
276 | .PP | |
277 | .Vb 1 | |
278 | \& use sigtrap 'handler', \e&my_handler, 'normal-signals'; | |
279 | .Ve | |
280 | .PP | |
281 | Install \fImy_handler()\fR as the handler for the normal\-signals, provide a | |
282 | Perl stack trace on receipt of one of the error\-signals: | |
283 | .PP | |
284 | .Vb 2 | |
285 | \& use sigtrap qw(handler my_handler normal-signals | |
286 | \& stack-trace error-signals); | |
287 | .Ve |