[inseparable changes from patch to perl 5.004_04]
[p5sagit/p5-mst-13.2.git] / pod / perlvar.pod
1 =head1 NAME
2
3 perlvar - Perl predefined variables
4
5 =head1 DESCRIPTION
6
7 =head2 Predefined Names
8
9 The following names have special meaning to Perl.  Most of the
10 punctuation names have reasonable mnemonics, or analogues in one of
11 the shells.  Nevertheless, if you wish to use the long variable names,
12 you just need to say
13
14     use English;
15
16 at the top of your program.  This will alias all the short names to the
17 long names in the current package.  Some of them even have medium names,
18 generally borrowed from B<awk>.
19
20 To go a step further, those variables that depend on the currently
21 selected filehandle may instead (and preferably) be set by calling an
22 object method on the FileHandle object.  (Summary lines below for this
23 contain the word HANDLE.)  First you must say
24
25     use FileHandle;
26
27 after which you may use either
28
29     method HANDLE EXPR
30
31 or
32
33     HANDLE->method(EXPR)
34
35 Each of the methods returns the old value of the FileHandle attribute.
36 The methods each take an optional EXPR, which if supplied specifies the
37 new value for the FileHandle attribute in question.  If not supplied,
38 most of the methods do nothing to the current value, except for
39 autoflush(), which will assume a 1 for you, just to be different.
40
41 A few of these variables are considered "read-only".  This means that if
42 you try to assign to this variable, either directly or indirectly through
43 a reference, you'll raise a run-time exception.
44
45 The following list is ordered by scalar variables first, then the
46 arrays, then the hashes (except $^M was added in the wrong place).
47 This is somewhat obscured by the fact that %ENV and %SIG are listed as
48 $ENV{expr} and $SIG{expr}.
49
50
51 =over 8
52
53 =item $ARG
54
55 =item $_
56
57 The default input and pattern-searching space.  The following pairs are
58 equivalent:
59
60     while (<>) {...}    # equivalent in only while!
61     while (defined($_ = <>)) {...}
62
63     /^Subject:/
64     $_ =~ /^Subject:/
65
66     tr/a-z/A-Z/
67     $_ =~ tr/a-z/A-Z/
68
69     chop
70     chop($_)
71
72 Here are the places where Perl will assume $_ even if you
73 don't use it:
74
75 =over 3
76
77 =item *
78
79 Various unary functions, including functions like ord() and int(), as well
80 as the all file tests (C<-f>, C<-d>) except for C<-t>, which defaults to
81 STDIN.
82
83 =item *
84
85 Various list functions like print() and unlink().
86
87 =item *
88
89 The pattern matching operations C<m//>, C<s///>, and C<tr///> when used
90 without an C<=~> operator.
91
92 =item *
93
94 The default iterator variable in a C<foreach> loop if no other
95 variable is supplied.
96
97 =item *
98
99 The implicit iterator variable in the grep() and map() functions.
100
101 =item *
102
103 The default place to put an input record when a C<E<lt>FHE<gt>>
104 operation's result is tested by itself as the sole criterion of a C<while>
105 test.  Note that outside of a C<while> test, this will not happen.
106
107 =back
108
109 (Mnemonic: underline is understood in certain operations.)
110
111 =back
112
113 =over 8
114
115 =item $E<lt>I<digit>E<gt>
116
117 Contains the subpattern from the corresponding set of parentheses in
118 the last pattern matched, not counting patterns matched in nested
119 blocks that have been exited already.  (Mnemonic: like \digit.)
120 These variables are all read-only.
121
122 =item $MATCH
123
124 =item $&
125
126 The string matched by the last successful pattern match (not counting
127 any matches hidden within a BLOCK or eval() enclosed by the current
128 BLOCK).  (Mnemonic: like & in some editors.)  This variable is read-only.
129
130 =item $PREMATCH
131
132 =item $`
133
134 The string preceding whatever was matched by the last successful
135 pattern match (not counting any matches hidden within a BLOCK or eval
136 enclosed by the current BLOCK).  (Mnemonic: C<`> often precedes a quoted
137 string.)  This variable is read-only.
138
139 =item $POSTMATCH
140
141 =item $'
142
143 The string following whatever was matched by the last successful
144 pattern match (not counting any matches hidden within a BLOCK or eval()
145 enclosed by the current BLOCK).  (Mnemonic: C<'> often follows a quoted
146 string.)  Example:
147
148     $_ = 'abcdefghi';
149     /def/;
150     print "$`:$&:$'\n";         # prints abc:def:ghi
151
152 This variable is read-only.
153
154 =item $LAST_PAREN_MATCH
155
156 =item $+
157
158 The last bracket matched by the last search pattern.  This is useful if
159 you don't know which of a set of alternative patterns matched.  For
160 example:
161
162     /Version: (.*)|Revision: (.*)/ && ($rev = $+);
163
164 (Mnemonic: be positive and forward looking.)
165 This variable is read-only.
166
167 =item $MULTILINE_MATCHING
168
169 =item $*
170
171 Set to 1 to do multi-line matching within a string, 0 to tell Perl
172 that it can assume that strings contain a single line, for the purpose
173 of optimizing pattern matches.  Pattern matches on strings containing
174 multiple newlines can produce confusing results when "C<$*>" is 0.  Default
175 is 0.  (Mnemonic: * matches multiple things.)  Note that this variable
176 influences the interpretation of only "C<^>" and "C<$>".  A literal newline can
177 be searched for even when C<$* == 0>.
178
179 Use of "C<$*>" is deprecated in modern perls.
180
181 =item input_line_number HANDLE EXPR
182
183 =item $INPUT_LINE_NUMBER
184
185 =item $NR
186
187 =item $.
188
189 The current input line number for the last file handle from
190 which you read (or performed a C<seek> or C<tell> on).  An
191 explicit close on a filehandle resets the line number.  Because
192 "C<E<lt>E<gt>>" never does an explicit close, line numbers increase
193 across ARGV files (but see examples under eof()).  Localizing C<$.> has
194 the effect of also localizing Perl's notion of "the last read
195 filehandle".  (Mnemonic: many programs use "." to mean the current line
196 number.)
197
198 =item input_record_separator HANDLE EXPR
199
200 =item $INPUT_RECORD_SEPARATOR
201
202 =item $RS
203
204 =item $/
205
206 The input record separator, newline by default.  Works like B<awk>'s RS
207 variable, including treating empty lines as delimiters if set to the
208 null string.  (Note: An empty line cannot contain any spaces or tabs.)
209 You may set it to a multi-character string to match a multi-character
210 delimiter, or to C<undef> to read to end of file.  Note that setting it
211 to C<"\n\n"> means something slightly different than setting it to
212 C<"">, if the file contains consecutive empty lines.  Setting it to
213 C<""> will treat two or more consecutive empty lines as a single empty
214 line.  Setting it to C<"\n\n"> will blindly assume that the next input
215 character belongs to the next paragraph, even if it's a newline.
216 (Mnemonic: / is used to delimit line boundaries when quoting poetry.)
217
218     undef $/;
219     $_ = <FH>;          # whole file now here
220     s/\n[ \t]+/ /g;
221
222 Remember: the value of $/ is a string, not a regexp.  AWK has to be
223 better for something :-)
224
225 =item autoflush HANDLE EXPR
226
227 =item $OUTPUT_AUTOFLUSH
228
229 =item $|
230
231 If set to nonzero, forces a flush right away and after every write or print on the
232 currently selected output channel.  Default is 0 (regardless of whether
233 the channel is actually buffered by the system or not; C<$|> tells you
234 only whether you've asked Perl explicitly to flush after each write).
235 Note that STDOUT will typically be line buffered if output is to the
236 terminal and block buffered otherwise.  Setting this variable is useful
237 primarily when you are outputting to a pipe, such as when you are running
238 a Perl script under rsh and want to see the output as it's happening.  This
239 has no effect on input buffering.
240 (Mnemonic: when you want your pipes to be piping hot.)
241
242 =item output_field_separator HANDLE EXPR
243
244 =item $OUTPUT_FIELD_SEPARATOR
245
246 =item $OFS
247
248 =item $,
249
250 The output field separator for the print operator.  Ordinarily the
251 print operator simply prints out the comma-separated fields you
252 specify.  To get behavior more like B<awk>, set this variable
253 as you would set B<awk>'s OFS variable to specify what is printed
254 between fields.  (Mnemonic: what is printed when there is a , in your
255 print statement.)
256
257 =item output_record_separator HANDLE EXPR
258
259 =item $OUTPUT_RECORD_SEPARATOR
260
261 =item $ORS
262
263 =item $\
264
265 The output record separator for the print operator.  Ordinarily the
266 print operator simply prints out the comma-separated fields you
267 specify, with no trailing newline or record separator assumed.
268 To get behavior more like B<awk>, set this variable as you would
269 set B<awk>'s ORS variable to specify what is printed at the end of the
270 print.  (Mnemonic: you set "C<$\>" instead of adding \n at the end of the
271 print.  Also, it's just like C<$/>, but it's what you get "back" from
272 Perl.)
273
274 =item $LIST_SEPARATOR
275
276 =item $"
277
278 This is like "C<$,>" except that it applies to array values interpolated
279 into a double-quoted string (or similar interpreted string).  Default
280 is a space.  (Mnemonic: obvious, I think.)
281
282 =item $SUBSCRIPT_SEPARATOR
283
284 =item $SUBSEP
285
286 =item $;
287
288 The subscript separator for multidimensional array emulation.  If you
289 refer to a hash element as
290
291     $foo{$a,$b,$c}
292
293 it really means
294
295     $foo{join($;, $a, $b, $c)}
296
297 But don't put
298
299     @foo{$a,$b,$c}      # a slice--note the @
300
301 which means
302
303     ($foo{$a},$foo{$b},$foo{$c})
304
305 Default is "\034", the same as SUBSEP in B<awk>.  Note that if your
306 keys contain binary data there might not be any safe value for "C<$;>".
307 (Mnemonic: comma (the syntactic subscript separator) is a
308 semi-semicolon.  Yeah, I know, it's pretty lame, but "C<$,>" is already
309 taken for something more important.)
310
311 Consider using "real" multidimensional arrays.
312
313 =item $OFMT
314
315 =item $#
316
317 The output format for printed numbers.  This variable is a half-hearted
318 attempt to emulate B<awk>'s OFMT variable.  There are times, however,
319 when B<awk> and Perl have differing notions of what is in fact
320 numeric.  The initial value is %.I<n>g, where I<n> is the value
321 of the macro DBL_DIG from your system's F<float.h>.  This is different from
322 B<awk>'s default OFMT setting of %.6g, so you need to set "C<$#>"
323 explicitly to get B<awk>'s value.  (Mnemonic: # is the number sign.)
324
325 Use of "C<$#>" is deprecated.
326
327 =item format_page_number HANDLE EXPR
328
329 =item $FORMAT_PAGE_NUMBER
330
331 =item $%
332
333 The current page number of the currently selected output channel.
334 (Mnemonic: % is page number in B<nroff>.)
335
336 =item format_lines_per_page HANDLE EXPR
337
338 =item $FORMAT_LINES_PER_PAGE
339
340 =item $=
341
342 The current page length (printable lines) of the currently selected
343 output channel.  Default is 60.  (Mnemonic: = has horizontal lines.)
344
345 =item format_lines_left HANDLE EXPR
346
347 =item $FORMAT_LINES_LEFT
348
349 =item $-
350
351 The number of lines left on the page of the currently selected output
352 channel.  (Mnemonic: lines_on_page - lines_printed.)
353
354 =item format_name HANDLE EXPR
355
356 =item $FORMAT_NAME
357
358 =item $~
359
360 The name of the current report format for the currently selected output
361 channel.  Default is name of the filehandle.  (Mnemonic: brother to
362 "C<$^>".)
363
364 =item format_top_name HANDLE EXPR
365
366 =item $FORMAT_TOP_NAME
367
368 =item $^
369
370 The name of the current top-of-page format for the currently selected
371 output channel.  Default is name of the filehandle with _TOP
372 appended.  (Mnemonic: points to top of page.)
373
374 =item format_line_break_characters HANDLE EXPR
375
376 =item $FORMAT_LINE_BREAK_CHARACTERS
377
378 =item $:
379
380 The current set of characters after which a string may be broken to
381 fill continuation fields (starting with ^) in a format.  Default is
382 S<" \n-">, to break on whitespace or hyphens.  (Mnemonic: a "colon" in
383 poetry is a part of a line.)
384
385 =item format_formfeed HANDLE EXPR
386
387 =item $FORMAT_FORMFEED
388
389 =item $^L
390
391 What formats output to perform a form feed.  Default is \f.
392
393 =item $ACCUMULATOR
394
395 =item $^A
396
397 The current value of the write() accumulator for format() lines.  A format
398 contains formline() commands that put their result into C<$^A>.  After
399 calling its format, write() prints out the contents of C<$^A> and empties.
400 So you never actually see the contents of C<$^A> unless you call
401 formline() yourself and then look at it.  See L<perlform> and
402 L<perlfunc/formline()>.
403
404 =item $CHILD_ERROR
405
406 =item $?
407
408 The status returned by the last pipe close, backtick (C<``>) command,
409 or system() operator.  Note that this is the status word returned by
410 the wait() system call (or else is made up to look like it).  Thus,
411 the exit value of the subprocess is actually (C<$? E<gt>E<gt> 8>), and
412 C<$? & 255> gives which signal, if any, the process died from, and
413 whether there was a core dump.  (Mnemonic: similar to B<sh> and
414 B<ksh>.)
415
416 Note that if you have installed a signal handler for C<SIGCHLD>, the
417 value of C<$?> will usually be wrong outside that handler.
418
419 Inside an C<END> subroutine C<$?> contains the value that is going to be
420 given to C<exit()>.  You can modify C<$?> in an C<END> subroutine to
421 change the exit status of the script.
422
423 Under VMS, the pragma C<use vmsish 'status'> makes C<$?> reflect the
424 actual VMS exit status, instead of the default emulation of POSIX
425 status.
426
427 =item $OS_ERROR
428
429 =item $ERRNO
430
431 =item $!
432
433 If used in a numeric context, yields the current value of errno, with
434 all the usual caveats.  (This means that you shouldn't depend on the
435 value of "C<$!>" to be anything in particular unless you've gotten a
436 specific error return indicating a system error.)  If used in a string
437 context, yields the corresponding system error string.  You can assign
438 to "C<$!>" to set I<errno> if, for instance, you want "C<$!>" to return the
439 string for error I<n>, or you want to set the exit value for the die()
440 operator.  (Mnemonic: What just went bang?)
441
442 =item $EXTENDED_OS_ERROR
443
444 =item $^E
445
446 More specific information about the last system error than that provided by
447 C<$!>, if available.  (If not, it's just C<$!> again.)
448 At the moment, this differs from C<$!> under only VMS and OS/2, where it
449 provides the VMS status value from the last system error, and OS/2 error
450 code of the last call to OS/2 API either via CRT, or directly from perl.  The
451 caveats mentioned in the description of C<$!> apply here, too.
452 (Mnemonic: Extra error explanation.)
453
454 =item $EVAL_ERROR
455
456 =item $@
457
458 The Perl syntax error message from the last eval() command.  If null, the
459 last eval() parsed and executed correctly (although the operations you
460 invoked may have failed in the normal fashion).  (Mnemonic: Where was
461 the syntax error "at"?)
462
463 Note that warning messages are not collected in this variable.  You can,
464 however, set up a routine to process warnings by setting C<$SIG{__WARN__}>
465 as described below.
466
467 =item $PROCESS_ID
468
469 =item $PID
470
471 =item $$
472
473 The process number of the Perl running this script.  (Mnemonic: same
474 as shells.)
475
476 =item $REAL_USER_ID
477
478 =item $UID
479
480 =item $<
481
482 The real uid of this process.  (Mnemonic: it's the uid you came I<FROM>,
483 if you're running setuid.)
484
485 =item $EFFECTIVE_USER_ID
486
487 =item $EUID
488
489 =item $>
490
491 The effective uid of this process.  Example:
492
493     $< = $>;            # set real to effective uid
494     ($<,$>) = ($>,$<);  # swap real and effective uid
495
496 (Mnemonic: it's the uid you went I<TO>, if you're running setuid.)
497 Note: "C<$E<lt>>" and "C<$E<gt>>" can be swapped only on machines
498 supporting setreuid().
499
500 =item $REAL_GROUP_ID
501
502 =item $GID
503
504 =item $(
505
506 The real gid of this process.  If you are on a machine that supports
507 membership in multiple groups simultaneously, gives a space separated
508 list of groups you are in.  The first number is the one returned by
509 getgid(), and the subsequent ones by getgroups(), one of which may be
510 the same as the first number.
511
512 However, a value assigned to "C<$(>" must be a single number used to
513 set the real gid.  So the value given by "C<$(>" should I<not> be assigned
514 back to "C<$(>" without being forced numeric, such as by adding zero.
515
516 (Mnemonic: parentheses are used to I<GROUP> things.  The real gid is the
517 group you I<LEFT>, if you're running setgid.)
518
519 =item $EFFECTIVE_GROUP_ID
520
521 =item $EGID
522
523 =item $)
524
525 The effective gid of this process.  If you are on a machine that
526 supports membership in multiple groups simultaneously, gives a space
527 separated list of groups you are in.  The first number is the one
528 returned by getegid(), and the subsequent ones by getgroups(), one of
529 which may be the same as the first number.
530
531 Similarly, a value assigned to "C<$)>" must also be a space-separated
532 list of numbers.  The first number is used to set the effective gid, and
533 the rest (if any) are passed to setgroups().  To get the effect of an
534 empty list for setgroups(), just repeat the new effective gid; that is,
535 to force an effective gid of 5 and an effectively empty setgroups()
536 list, say C< $) = "5 5" >.
537
538 (Mnemonic: parentheses are used to I<GROUP> things.  The effective gid
539 is the group that's I<RIGHT> for you, if you're running setgid.)
540
541 Note: "C<$E<lt>>", "C<$E<gt>>", "C<$(>" and "C<$)>" can be set only on
542 machines that support the corresponding I<set[re][ug]id()> routine.  "C<$(>"
543 and "C<$)>" can be swapped only on machines supporting setregid().
544
545 =item $PROGRAM_NAME
546
547 =item $0
548
549 Contains the name of the file containing the Perl script being
550 executed.  On some operating systems
551 assigning to "C<$0>" modifies the argument area that the ps(1)
552 program sees.  This is more useful as a way of indicating the
553 current program state than it is for hiding the program you're running.
554 (Mnemonic: same as B<sh> and B<ksh>.)
555
556 =item $[
557
558 The index of the first element in an array, and of the first character
559 in a substring.  Default is 0, but you could set it to 1 to make
560 Perl behave more like B<awk> (or Fortran) when subscripting and when
561 evaluating the index() and substr() functions.  (Mnemonic: [ begins
562 subscripts.)
563
564 As of Perl 5, assignment to "C<$[>" is treated as a compiler directive,
565 and cannot influence the behavior of any other file.  Its use is
566 discouraged.
567
568 =item $PERL_VERSION
569
570 =item $]
571
572 The version + patchlevel / 1000 of the Perl interpreter.  This variable
573 can be used to determine whether the Perl interpreter executing a
574 script is in the right range of versions.  (Mnemonic: Is this version
575 of perl in the right bracket?)  Example:
576
577     warn "No checksumming!\n" if $] < 3.019;
578
579 See also the documentation of C<use VERSION> and C<require VERSION>
580 for a convenient way to fail if the Perl interpreter is too old.
581
582 =item $DEBUGGING
583
584 =item $^D
585
586 The current value of the debugging flags.  (Mnemonic: value of B<-D>
587 switch.)
588
589 =item $SYSTEM_FD_MAX
590
591 =item $^F
592
593 The maximum system file descriptor, ordinarily 2.  System file
594 descriptors are passed to exec()ed processes, while higher file
595 descriptors are not.  Also, during an open(), system file descriptors are
596 preserved even if the open() fails.  (Ordinary file descriptors are
597 closed before the open() is attempted.)  Note that the close-on-exec
598 status of a file descriptor will be decided according to the value of
599 C<$^F> at the time of the open, not the time of the exec.
600
601 =item $^H
602
603 The current set of syntax checks enabled by C<use strict> and other block
604 scoped compiler hints.  See the documentation of C<strict> for more details.
605
606 =item $INPLACE_EDIT
607
608 =item $^I
609
610 The current value of the inplace-edit extension.  Use C<undef> to disable
611 inplace editing.  (Mnemonic: value of B<-i> switch.)
612
613 =item $^M
614
615 By default, running out of memory it is not trappable.  However, if
616 compiled for this, Perl may use the contents of C<$^M> as an emergency
617 pool after die()ing with this message.  Suppose that your Perl were
618 compiled with -DPERL_EMERGENCY_SBRK and used Perl's malloc.  Then
619
620     $^M = 'a' x (1<<16);
621
622 would allocate a 64K buffer for use when in emergency.  See the F<INSTALL>
623 file for information on how to enable this option.  As a disincentive to
624 casual use of this advanced feature, there is no L<English> long name for
625 this variable.
626
627 =item $OSNAME
628
629 =item $^O
630
631 The name of the operating system under which this copy of Perl was
632 built, as determined during the configuration process.  The value
633 is identical to C<$Config{'osname'}>.
634
635 =item $PERLDB
636
637 =item $^P
638
639 The internal variable for debugging support.  Different bits mean the
640 following (subject to change): 
641
642 =over 6
643
644 =item 0x01
645
646 Debug subroutine enter/exit.
647
648 =item 0x02
649
650 Line-by-line debugging.
651
652 =item 0x04
653
654 Switch off optimizations.
655
656 =item 0x08
657
658 Preserve more data for future interactive inspections.
659
660 =item 0x10
661
662 Keep info about source lines on which a subroutine is defined.
663
664 =item 0x20
665
666 Start with single-step on.
667
668 =back
669
670 Note that some bits may be relevent at compile-time only, some at
671 run-time only. This is a new mechanism and the details may change.
672
673 =item $^S
674
675 Current state of the interpreter.  Undefined if parsing of the current
676 module/eval is not finished (may happen in $SIG{__DIE__} and
677 $SIG{__WARN__} handlers).  True if inside an eval, othewise false.
678
679 =item $BASETIME
680
681 =item $^T
682
683 The time at which the script began running, in seconds since the
684 epoch (beginning of 1970).  The values returned by the B<-M>, B<-A>,
685 and B<-C> filetests are
686 based on this value.
687
688 =item $WARNING
689
690 =item $^W
691
692 The current value of the warning switch, either TRUE or FALSE.
693 (Mnemonic: related to the B<-w> switch.)
694
695 =item $EXECUTABLE_NAME
696
697 =item $^X
698
699 The name that the Perl binary itself was executed as, from C's C<argv[0]>.
700
701 =item $ARGV
702
703 contains the name of the current file when reading from E<lt>E<gt>.
704
705 =item @ARGV
706
707 The array @ARGV contains the command line arguments intended for the
708 script.  Note that C<$#ARGV> is the generally number of arguments minus
709 one, because C<$ARGV[0]> is the first argument, I<NOT> the command name.  See
710 "C<$0>" for the command name.
711
712 =item @INC
713
714 The array @INC contains the list of places to look for Perl scripts to
715 be evaluated by the C<do EXPR>, C<require>, or C<use> constructs.  It
716 initially consists of the arguments to any B<-I> command line switches,
717 followed by the default Perl library, probably F</usr/local/lib/perl>,
718 followed by ".", to represent the current directory.  If you need to
719 modify this at runtime, you should use the C<use lib> pragma
720 to get the machine-dependent library properly loaded also:
721
722     use lib '/mypath/libdir/';
723     use SomeMod;
724
725 =item @_
726
727 Within a subroutine the array @_ contains the parameters passed to that
728 subroutine. See L<perlsub>.
729
730 =item %INC
731
732 The hash %INC contains entries for each filename that has
733 been included via C<do> or C<require>.  The key is the filename you
734 specified, and the value is the location of the file actually found.
735 The C<require> command uses this array to determine whether a given file
736 has already been included.
737
738 =item %ENV  $ENV{expr}
739
740 The hash %ENV contains your current environment.  Setting a
741 value in C<ENV> changes the environment for child processes.
742
743 =item %SIG  $SIG{expr}
744
745 The hash %SIG is used to set signal handlers for various
746 signals.  Example:
747
748     sub handler {       # 1st argument is signal name
749         my($sig) = @_;
750         print "Caught a SIG$sig--shutting down\n";
751         close(LOG);
752         exit(0);
753     }
754
755     $SIG{'INT'}  = \&handler;
756     $SIG{'QUIT'} = \&handler;
757     ...
758     $SIG{'INT'} = 'DEFAULT';    # restore default action
759     $SIG{'QUIT'} = 'IGNORE';    # ignore SIGQUIT
760
761 The %SIG array contains values for only the signals actually set within
762 the Perl script.  Here are some other examples:
763
764     $SIG{"PIPE"} = Plumber;     # SCARY!!
765     $SIG{"PIPE"} = "Plumber";   # assumes main::Plumber (not recommended)
766     $SIG{"PIPE"} = \&Plumber;   # just fine; assume current Plumber
767     $SIG{"PIPE"} = Plumber();   # oops, what did Plumber() return??
768
769 The one marked scary is problematic because it's a bareword, which means
770 sometimes it's a string representing the function, and sometimes it's
771 going to call the subroutine call right then and there!  Best to be sure
772 and quote it or take a reference to it.  *Plumber works too.  See L<perlsub>.
773
774 If your system has the sigaction() function then signal handlers are
775 installed using it.  This means you get reliable signal handling.  If
776 your system has the SA_RESTART flag it is used when signals handlers are
777 installed.  This means that system calls for which it is supported
778 continue rather than returning when a signal arrives.  If you want your
779 system calls to be interrupted by signal delivery then do something like
780 this:
781
782     use POSIX ':signal_h';
783
784     my $alarm = 0;
785     sigaction SIGALRM, new POSIX::SigAction sub { $alarm = 1 }
786         or die "Error setting SIGALRM handler: $!\n";
787
788 See L<POSIX>.
789
790 Certain internal hooks can be also set using the %SIG hash.  The
791 routine indicated by C<$SIG{__WARN__}> is called when a warning message is
792 about to be printed.  The warning message is passed as the first
793 argument.  The presence of a __WARN__ hook causes the ordinary printing
794 of warnings to STDERR to be suppressed.  You can use this to save warnings
795 in a variable, or turn warnings into fatal errors, like this:
796
797     local $SIG{__WARN__} = sub { die $_[0] };
798     eval $proggie;
799
800 The routine indicated by C<$SIG{__DIE__}> is called when a fatal exception
801 is about to be thrown.  The error message is passed as the first
802 argument.  When a __DIE__ hook routine returns, the exception
803 processing continues as it would have in the absence of the hook,
804 unless the hook routine itself exits via a C<goto>, a loop exit, or a die().
805 The C<__DIE__> handler is explicitly disabled during the call, so that you
806 can die from a C<__DIE__> handler.  Similarly for C<__WARN__>.
807
808 Note that the C<$SIG{__DIE__}> hook is called even inside eval()ed
809 blocks/strings.  See L<perlfunc/die>, L<perlvar/$^S> for how to
810 circumvent this.
811
812 Note that C<__DIE__>/C<__WARN__> handlers are very special in one
813 respect: they may be called to report (probable) errors found by the
814 parser.  In such a case the parser may be in inconsistent state, so
815 any attempt to evaluate Perl code from such a handler will probably
816 result in a segfault.  This means that calls which result/may-result
817 in parsing Perl should be used with extreme causion, like this:
818
819     require Carp if defined $^S;
820     Carp::confess("Something wrong") if defined &Carp::confess;
821     die "Something wrong, but could not load Carp to give backtrace...
822          To see backtrace try starting Perl with -MCarp switch";
823
824 Here the first line will load Carp I<unless> it is the parser who
825 called the handler.  The second line will print backtrace and die if
826 Carp was available.  The third line will be executed only if Carp was
827 not available.
828
829 See L<perlfunc/die>, L<perlfunc/warn> and L<perlfunc/eval> for
830 additional info.
831
832 =back