This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
2cb95afe0507d79a9111d24372e3ee8370123e4e
[perl5.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 Additionally, if the C<h_errno> variable is supported in C, its value
417 is returned via $? if any of the C<gethost*()> functions fail.
418
419 Note that if you have installed a signal handler for C<SIGCHLD>, the
420 value of C<$?> will usually be wrong outside that handler.
421
422 Inside an C<END> subroutine C<$?> contains the value that is going to be
423 given to C<exit()>.  You can modify C<$?> in an C<END> subroutine to
424 change the exit status of the script.
425
426 Under VMS, the pragma C<use vmsish 'status'> makes C<$?> reflect the
427 actual VMS exit status, instead of the default emulation of POSIX
428 status.
429
430 =item $OS_ERROR
431
432 =item $ERRNO
433
434 =item $!
435
436 If used in a numeric context, yields the current value of errno, with
437 all the usual caveats.  (This means that you shouldn't depend on the
438 value of C<$!> to be anything in particular unless you've gotten a
439 specific error return indicating a system error.)  If used in a string
440 context, yields the corresponding system error string.  You can assign
441 to C<$!> to set I<errno> if, for instance, you want C<"$!"> to return the
442 string for error I<n>, or you want to set the exit value for the die()
443 operator.  (Mnemonic: What just went bang?)
444
445 =item $EXTENDED_OS_ERROR
446
447 =item $^E
448
449 Error information specific to the current operating system.  At
450 the moment, this differs from C<$!> under only VMS, OS/2, and Win32
451 (and for MacPerl).  On all other platforms, C<$^E> is always just
452 the same as C<$!>.
453
454 Under VMS, C<$^E> provides the VMS status value from the last
455 system error.  This is more specific information about the last
456 system error than that provided by C<$!>.  This is particularly
457 important when C<$!> is set to B<EVMSERR>.
458
459 Under OS/2, C<$^E> is set to the error code of the last call to
460 OS/2 API either via CRT, or directly from perl.
461
462 Under Win32, C<$^E> always returns the last error information
463 reported by the Win32 call C<GetLastError()> which describes
464 the last error from within the Win32 API.  Most Win32-specific
465 code will report errors via C<$^E>.  ANSI C and UNIX-like calls
466 set C<errno> and so most portable Perl code will report errors
467 via C<$!>. 
468
469 Caveats mentioned in the description of C<$!> generally apply to
470 C<$^E>, also.  (Mnemonic: Extra error explanation.)
471
472 =item $EVAL_ERROR
473
474 =item $@
475
476 The Perl syntax error message from the last eval() command.  If null, the
477 last eval() parsed and executed correctly (although the operations you
478 invoked may have failed in the normal fashion).  (Mnemonic: Where was
479 the syntax error "at"?)
480
481 Note that warning messages are not collected in this variable.  You can,
482 however, set up a routine to process warnings by setting C<$SIG{__WARN__}>
483 as described below.
484
485 =item $PROCESS_ID
486
487 =item $PID
488
489 =item $$
490
491 The process number of the Perl running this script.  (Mnemonic: same
492 as shells.)
493
494 =item $REAL_USER_ID
495
496 =item $UID
497
498 =item $<
499
500 The real uid of this process.  (Mnemonic: it's the uid you came I<FROM>,
501 if you're running setuid.)
502
503 =item $EFFECTIVE_USER_ID
504
505 =item $EUID
506
507 =item $>
508
509 The effective uid of this process.  Example:
510
511     $< = $>;            # set real to effective uid
512     ($<,$>) = ($>,$<);  # swap real and effective uid
513
514 (Mnemonic: it's the uid you went I<TO>, if you're running setuid.)
515 Note: "C<$E<lt>>" and "C<$E<gt>>" can be swapped only on machines
516 supporting setreuid().
517
518 =item $REAL_GROUP_ID
519
520 =item $GID
521
522 =item $(
523
524 The real gid of this process.  If you are on a machine that supports
525 membership in multiple groups simultaneously, gives a space separated
526 list of groups you are in.  The first number is the one returned by
527 getgid(), and the subsequent ones by getgroups(), one of which may be
528 the same as the first number.
529
530 However, a value assigned to "C<$(>" must be a single number used to
531 set the real gid.  So the value given by "C<$(>" should I<not> be assigned
532 back to "C<$(>" without being forced numeric, such as by adding zero.
533
534 (Mnemonic: parentheses are used to I<GROUP> things.  The real gid is the
535 group you I<LEFT>, if you're running setgid.)
536
537 =item $EFFECTIVE_GROUP_ID
538
539 =item $EGID
540
541 =item $)
542
543 The effective gid of this process.  If you are on a machine that
544 supports membership in multiple groups simultaneously, gives a space
545 separated list of groups you are in.  The first number is the one
546 returned by getegid(), and the subsequent ones by getgroups(), one of
547 which may be the same as the first number.
548
549 Similarly, a value assigned to "C<$)>" must also be a space-separated
550 list of numbers.  The first number is used to set the effective gid, and
551 the rest (if any) are passed to setgroups().  To get the effect of an
552 empty list for setgroups(), just repeat the new effective gid; that is,
553 to force an effective gid of 5 and an effectively empty setgroups()
554 list, say C< $) = "5 5" >.
555
556 (Mnemonic: parentheses are used to I<GROUP> things.  The effective gid
557 is the group that's I<RIGHT> for you, if you're running setgid.)
558
559 Note: "C<$E<lt>>", "C<$E<gt>>", "C<$(>" and "C<$)>" can be set only on
560 machines that support the corresponding I<set[re][ug]id()> routine.  "C<$(>"
561 and "C<$)>" can be swapped only on machines supporting setregid().
562
563 =item $PROGRAM_NAME
564
565 =item $0
566
567 Contains the name of the file containing the Perl script being
568 executed.  On some operating systems
569 assigning to "C<$0>" modifies the argument area that the ps(1)
570 program sees.  This is more useful as a way of indicating the
571 current program state than it is for hiding the program you're running.
572 (Mnemonic: same as B<sh> and B<ksh>.)
573
574 =item $[
575
576 The index of the first element in an array, and of the first character
577 in a substring.  Default is 0, but you could set it to 1 to make
578 Perl behave more like B<awk> (or Fortran) when subscripting and when
579 evaluating the index() and substr() functions.  (Mnemonic: [ begins
580 subscripts.)
581
582 As of Perl 5, assignment to "C<$[>" is treated as a compiler directive,
583 and cannot influence the behavior of any other file.  Its use is
584 discouraged.
585
586 =item $PERL_VERSION
587
588 =item $]
589
590 The version + patchlevel / 1000 of the Perl interpreter.  This variable
591 can be used to determine whether the Perl interpreter executing a
592 script is in the right range of versions.  (Mnemonic: Is this version
593 of perl in the right bracket?)  Example:
594
595     warn "No checksumming!\n" if $] < 3.019;
596
597 See also the documentation of C<use VERSION> and C<require VERSION>
598 for a convenient way to fail if the Perl interpreter is too old.
599
600 =item $DEBUGGING
601
602 =item $^D
603
604 The current value of the debugging flags.  (Mnemonic: value of B<-D>
605 switch.)
606
607 =item $SYSTEM_FD_MAX
608
609 =item $^F
610
611 The maximum system file descriptor, ordinarily 2.  System file
612 descriptors are passed to exec()ed processes, while higher file
613 descriptors are not.  Also, during an open(), system file descriptors are
614 preserved even if the open() fails.  (Ordinary file descriptors are
615 closed before the open() is attempted.)  Note that the close-on-exec
616 status of a file descriptor will be decided according to the value of
617 C<$^F> at the time of the open, not the time of the exec.
618
619 =item $^H
620
621 The current set of syntax checks enabled by C<use strict> and other block
622 scoped compiler hints.  See the documentation of C<strict> for more details.
623
624 =item $INPLACE_EDIT
625
626 =item $^I
627
628 The current value of the inplace-edit extension.  Use C<undef> to disable
629 inplace editing.  (Mnemonic: value of B<-i> switch.)
630
631 =item $^M
632
633 By default, running out of memory it is not trappable.  However, if
634 compiled for this, Perl may use the contents of C<$^M> as an emergency
635 pool after die()ing with this message.  Suppose that your Perl were
636 compiled with -DPERL_EMERGENCY_SBRK and used Perl's malloc.  Then
637
638     $^M = 'a' x (1<<16);
639
640 would allocate a 64K buffer for use when in emergency.  See the F<INSTALL>
641 file for information on how to enable this option.  As a disincentive to
642 casual use of this advanced feature, there is no L<English> long name for
643 this variable.
644
645 =item $OSNAME
646
647 =item $^O
648
649 The name of the operating system under which this copy of Perl was
650 built, as determined during the configuration process.  The value
651 is identical to C<$Config{'osname'}>.
652
653 =item $PERLDB
654
655 =item $^P
656
657 The internal variable for debugging support.  Different bits mean the
658 following (subject to change): 
659
660 =over 6
661
662 =item 0x01
663
664 Debug subroutine enter/exit.
665
666 =item 0x02
667
668 Line-by-line debugging.
669
670 =item 0x04
671
672 Switch off optimizations.
673
674 =item 0x08
675
676 Preserve more data for future interactive inspections.
677
678 =item 0x10
679
680 Keep info about source lines on which a subroutine is defined.
681
682 =item 0x20
683
684 Start with single-step on.
685
686 =back
687
688 Note that some bits may be relevent at compile-time only, some at
689 run-time only. This is a new mechanism and the details may change.
690
691 =item $^S
692
693 Current state of the interpreter.  Undefined if parsing of the current
694 module/eval is not finished (may happen in $SIG{__DIE__} and
695 $SIG{__WARN__} handlers).  True if inside an eval, otherwise false.
696
697 =item $BASETIME
698
699 =item $^T
700
701 The time at which the script began running, in seconds since the
702 epoch (beginning of 1970).  The values returned by the B<-M>, B<-A>,
703 and B<-C> filetests are
704 based on this value.
705
706 =item $WARNING
707
708 =item $^W
709
710 The current value of the warning switch, either TRUE or FALSE.
711 (Mnemonic: related to the B<-w> switch.)
712
713 =item $EXECUTABLE_NAME
714
715 =item $^X
716
717 The name that the Perl binary itself was executed as, from C's C<argv[0]>.
718
719 =item $ARGV
720
721 contains the name of the current file when reading from E<lt>E<gt>.
722
723 =item @ARGV
724
725 The array @ARGV contains the command line arguments intended for the
726 script.  Note that C<$#ARGV> is the generally number of arguments minus
727 one, because C<$ARGV[0]> is the first argument, I<NOT> the command name.  See
728 "C<$0>" for the command name.
729
730 =item @INC
731
732 The array @INC contains the list of places to look for Perl scripts to
733 be evaluated by the C<do EXPR>, C<require>, or C<use> constructs.  It
734 initially consists of the arguments to any B<-I> command line switches,
735 followed by the default Perl library, probably F</usr/local/lib/perl>,
736 followed by ".", to represent the current directory.  If you need to
737 modify this at runtime, you should use the C<use lib> pragma
738 to get the machine-dependent library properly loaded also:
739
740     use lib '/mypath/libdir/';
741     use SomeMod;
742
743 =item @_
744
745 Within a subroutine the array @_ contains the parameters passed to that
746 subroutine. See L<perlsub>.
747
748 =item %INC
749
750 The hash %INC contains entries for each filename that has
751 been included via C<do> or C<require>.  The key is the filename you
752 specified, and the value is the location of the file actually found.
753 The C<require> command uses this array to determine whether a given file
754 has already been included.
755
756 =item %ENV  $ENV{expr}
757
758 The hash %ENV contains your current environment.  Setting a
759 value in C<ENV> changes the environment for child processes.
760
761 =item %SIG  $SIG{expr}
762
763 The hash %SIG is used to set signal handlers for various
764 signals.  Example:
765
766     sub handler {       # 1st argument is signal name
767         my($sig) = @_;
768         print "Caught a SIG$sig--shutting down\n";
769         close(LOG);
770         exit(0);
771     }
772
773     $SIG{'INT'}  = \&handler;
774     $SIG{'QUIT'} = \&handler;
775     ...
776     $SIG{'INT'} = 'DEFAULT';    # restore default action
777     $SIG{'QUIT'} = 'IGNORE';    # ignore SIGQUIT
778
779 The %SIG array contains values for only the signals actually set within
780 the Perl script.  Here are some other examples:
781
782     $SIG{"PIPE"} = Plumber;     # SCARY!!
783     $SIG{"PIPE"} = "Plumber";   # assumes main::Plumber (not recommended)
784     $SIG{"PIPE"} = \&Plumber;   # just fine; assume current Plumber
785     $SIG{"PIPE"} = Plumber();   # oops, what did Plumber() return??
786
787 The one marked scary is problematic because it's a bareword, which means
788 sometimes it's a string representing the function, and sometimes it's
789 going to call the subroutine call right then and there!  Best to be sure
790 and quote it or take a reference to it.  *Plumber works too.  See L<perlsub>.
791
792 If your system has the sigaction() function then signal handlers are
793 installed using it.  This means you get reliable signal handling.  If
794 your system has the SA_RESTART flag it is used when signals handlers are
795 installed.  This means that system calls for which it is supported
796 continue rather than returning when a signal arrives.  If you want your
797 system calls to be interrupted by signal delivery then do something like
798 this:
799
800     use POSIX ':signal_h';
801
802     my $alarm = 0;
803     sigaction SIGALRM, new POSIX::SigAction sub { $alarm = 1 }
804         or die "Error setting SIGALRM handler: $!\n";
805
806 See L<POSIX>.
807
808 Certain internal hooks can be also set using the %SIG hash.  The
809 routine indicated by C<$SIG{__WARN__}> is called when a warning message is
810 about to be printed.  The warning message is passed as the first
811 argument.  The presence of a __WARN__ hook causes the ordinary printing
812 of warnings to STDERR to be suppressed.  You can use this to save warnings
813 in a variable, or turn warnings into fatal errors, like this:
814
815     local $SIG{__WARN__} = sub { die $_[0] };
816     eval $proggie;
817
818 The routine indicated by C<$SIG{__DIE__}> is called when a fatal exception
819 is about to be thrown.  The error message is passed as the first
820 argument.  When a __DIE__ hook routine returns, the exception
821 processing continues as it would have in the absence of the hook,
822 unless the hook routine itself exits via a C<goto>, a loop exit, or a die().
823 The C<__DIE__> handler is explicitly disabled during the call, so that you
824 can die from a C<__DIE__> handler.  Similarly for C<__WARN__>.
825
826 Note that the C<$SIG{__DIE__}> hook is called even inside eval()ed
827 blocks/strings.  See L<perlfunc/die> and L<perlvar/$^S> for how to
828 circumvent this.
829
830 Note that C<__DIE__>/C<__WARN__> handlers are very special in one
831 respect: they may be called to report (probable) errors found by the
832 parser.  In such a case the parser may be in inconsistent state, so
833 any attempt to evaluate Perl code from such a handler will probably
834 result in a segfault.  This means that calls which result/may-result
835 in parsing Perl should be used with extreme causion, like this:
836
837     require Carp if defined $^S;
838     Carp::confess("Something wrong") if defined &Carp::confess;
839     die "Something wrong, but could not load Carp to give backtrace...
840          To see backtrace try starting Perl with -MCarp switch";
841
842 Here the first line will load Carp I<unless> it is the parser who
843 called the handler.  The second line will print backtrace and die if
844 Carp was available.  The third line will be executed only if Carp was
845 not available.
846
847 See L<perlfunc/die>, L<perlfunc/warn> and L<perlfunc/eval> for
848 additional info.
849
850 =back