This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Mangled patch, needed hand-tweaks, along with binmode for rs.t:
[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 Setting $/ to a reference to an integer, scalar containing an integer, or
226 scalar that's convertable to an integer will attempt to read records
227 instead of lines, with the maximum record size being the referenced
228 integer. So this:
229
230     $/ = \32768; # or \"32768", or \$var_containing_32768
231     open(FILE, $myfile);
232     $_ = <FILE>;
233
234 will read a record of no more than 32768 bytes from FILE. If you're not
235 reading from a record-oriented file (or your OS doesn't have
236 record-oriented files), then you'll likely get a full chunk of data with
237 every read. If a record is larger than the record size you've set, you'll
238 get the record back in pieces.
239
240 On VMS, record reads are done with the equivalent of C<sysread>, so it's
241 best not to mix record and non-record reads on the same file. (This is
242 likely not a problem, as any file you'd want to read in record mode is
243 proably usable in line mode) Non-VMS systems perform normal I/O, so
244 it's safe to mix record and non-record reads of a file.
245
246 =item autoflush HANDLE EXPR
247
248 =item $OUTPUT_AUTOFLUSH
249
250 =item $|
251
252 If set to nonzero, forces a flush right away and after every write or print on the
253 currently selected output channel.  Default is 0 (regardless of whether
254 the channel is actually buffered by the system or not; C<$|> tells you
255 only whether you've asked Perl explicitly to flush after each write).
256 Note that STDOUT will typically be line buffered if output is to the
257 terminal and block buffered otherwise.  Setting this variable is useful
258 primarily when you are outputting to a pipe, such as when you are running
259 a Perl script under rsh and want to see the output as it's happening.  This
260 has no effect on input buffering.
261 (Mnemonic: when you want your pipes to be piping hot.)
262
263 =item output_field_separator HANDLE EXPR
264
265 =item $OUTPUT_FIELD_SEPARATOR
266
267 =item $OFS
268
269 =item $,
270
271 The output field separator for the print operator.  Ordinarily the
272 print operator simply prints out the comma-separated fields you
273 specify.  To get behavior more like B<awk>, set this variable
274 as you would set B<awk>'s OFS variable to specify what is printed
275 between fields.  (Mnemonic: what is printed when there is a , in your
276 print statement.)
277
278 =item output_record_separator HANDLE EXPR
279
280 =item $OUTPUT_RECORD_SEPARATOR
281
282 =item $ORS
283
284 =item $\
285
286 The output record separator for the print operator.  Ordinarily the
287 print operator simply prints out the comma-separated fields you
288 specify, with no trailing newline or record separator assumed.
289 To get behavior more like B<awk>, set this variable as you would
290 set B<awk>'s ORS variable to specify what is printed at the end of the
291 print.  (Mnemonic: you set "C<$\>" instead of adding \n at the end of the
292 print.  Also, it's just like C<$/>, but it's what you get "back" from
293 Perl.)
294
295 =item $LIST_SEPARATOR
296
297 =item $"
298
299 This is like "C<$,>" except that it applies to array values interpolated
300 into a double-quoted string (or similar interpreted string).  Default
301 is a space.  (Mnemonic: obvious, I think.)
302
303 =item $SUBSCRIPT_SEPARATOR
304
305 =item $SUBSEP
306
307 =item $;
308
309 The subscript separator for multidimensional array emulation.  If you
310 refer to a hash element as
311
312     $foo{$a,$b,$c}
313
314 it really means
315
316     $foo{join($;, $a, $b, $c)}
317
318 But don't put
319
320     @foo{$a,$b,$c}      # a slice--note the @
321
322 which means
323
324     ($foo{$a},$foo{$b},$foo{$c})
325
326 Default is "\034", the same as SUBSEP in B<awk>.  Note that if your
327 keys contain binary data there might not be any safe value for "C<$;>".
328 (Mnemonic: comma (the syntactic subscript separator) is a
329 semi-semicolon.  Yeah, I know, it's pretty lame, but "C<$,>" is already
330 taken for something more important.)
331
332 Consider using "real" multidimensional arrays.
333
334 =item $OFMT
335
336 =item $#
337
338 The output format for printed numbers.  This variable is a half-hearted
339 attempt to emulate B<awk>'s OFMT variable.  There are times, however,
340 when B<awk> and Perl have differing notions of what is in fact
341 numeric.  The initial value is %.I<n>g, where I<n> is the value
342 of the macro DBL_DIG from your system's F<float.h>.  This is different from
343 B<awk>'s default OFMT setting of %.6g, so you need to set "C<$#>"
344 explicitly to get B<awk>'s value.  (Mnemonic: # is the number sign.)
345
346 Use of "C<$#>" is deprecated.
347
348 =item format_page_number HANDLE EXPR
349
350 =item $FORMAT_PAGE_NUMBER
351
352 =item $%
353
354 The current page number of the currently selected output channel.
355 (Mnemonic: % is page number in B<nroff>.)
356
357 =item format_lines_per_page HANDLE EXPR
358
359 =item $FORMAT_LINES_PER_PAGE
360
361 =item $=
362
363 The current page length (printable lines) of the currently selected
364 output channel.  Default is 60.  (Mnemonic: = has horizontal lines.)
365
366 =item format_lines_left HANDLE EXPR
367
368 =item $FORMAT_LINES_LEFT
369
370 =item $-
371
372 The number of lines left on the page of the currently selected output
373 channel.  (Mnemonic: lines_on_page - lines_printed.)
374
375 =item format_name HANDLE EXPR
376
377 =item $FORMAT_NAME
378
379 =item $~
380
381 The name of the current report format for the currently selected output
382 channel.  Default is name of the filehandle.  (Mnemonic: brother to
383 "C<$^>".)
384
385 =item format_top_name HANDLE EXPR
386
387 =item $FORMAT_TOP_NAME
388
389 =item $^
390
391 The name of the current top-of-page format for the currently selected
392 output channel.  Default is name of the filehandle with _TOP
393 appended.  (Mnemonic: points to top of page.)
394
395 =item format_line_break_characters HANDLE EXPR
396
397 =item $FORMAT_LINE_BREAK_CHARACTERS
398
399 =item $:
400
401 The current set of characters after which a string may be broken to
402 fill continuation fields (starting with ^) in a format.  Default is
403 S<" \n-">, to break on whitespace or hyphens.  (Mnemonic: a "colon" in
404 poetry is a part of a line.)
405
406 =item format_formfeed HANDLE EXPR
407
408 =item $FORMAT_FORMFEED
409
410 =item $^L
411
412 What formats output to perform a form feed.  Default is \f.
413
414 =item $ACCUMULATOR
415
416 =item $^A
417
418 The current value of the write() accumulator for format() lines.  A format
419 contains formline() commands that put their result into C<$^A>.  After
420 calling its format, write() prints out the contents of C<$^A> and empties.
421 So you never actually see the contents of C<$^A> unless you call
422 formline() yourself and then look at it.  See L<perlform> and
423 L<perlfunc/formline()>.
424
425 =item $CHILD_ERROR
426
427 =item $?
428
429 The status returned by the last pipe close, backtick (C<``>) command,
430 or system() operator.  Note that this is the status word returned by
431 the wait() system call (or else is made up to look like it).  Thus,
432 the exit value of the subprocess is actually (C<$? E<gt>E<gt> 8>), and
433 C<$? & 255> gives which signal, if any, the process died from, and
434 whether there was a core dump.  (Mnemonic: similar to B<sh> and
435 B<ksh>.)
436
437 Additionally, if the C<h_errno> variable is supported in C, its value
438 is returned via $? if any of the C<gethost*()> functions fail.
439
440 Note that if you have installed a signal handler for C<SIGCHLD>, the
441 value of C<$?> will usually be wrong outside that handler.
442
443 Inside an C<END> subroutine C<$?> contains the value that is going to be
444 given to C<exit()>.  You can modify C<$?> in an C<END> subroutine to
445 change the exit status of the script.
446
447 Under VMS, the pragma C<use vmsish 'status'> makes C<$?> reflect the
448 actual VMS exit status, instead of the default emulation of POSIX
449 status.
450
451 =item $OS_ERROR
452
453 =item $ERRNO
454
455 =item $!
456
457 If used in a numeric context, yields the current value of errno, with
458 all the usual caveats.  (This means that you shouldn't depend on the
459 value of C<$!> to be anything in particular unless you've gotten a
460 specific error return indicating a system error.)  If used in a string
461 context, yields the corresponding system error string.  You can assign
462 to C<$!> to set I<errno> if, for instance, you want C<"$!"> to return the
463 string for error I<n>, or you want to set the exit value for the die()
464 operator.  (Mnemonic: What just went bang?)
465
466 =item $EXTENDED_OS_ERROR
467
468 =item $^E
469
470 Error information specific to the current operating system.  At
471 the moment, this differs from C<$!> under only VMS, OS/2, and Win32
472 (and for MacPerl).  On all other platforms, C<$^E> is always just
473 the same as C<$!>.
474
475 Under VMS, C<$^E> provides the VMS status value from the last
476 system error.  This is more specific information about the last
477 system error than that provided by C<$!>.  This is particularly
478 important when C<$!> is set to B<EVMSERR>.
479
480 Under OS/2, C<$^E> is set to the error code of the last call to
481 OS/2 API either via CRT, or directly from perl.
482
483 Under Win32, C<$^E> always returns the last error information
484 reported by the Win32 call C<GetLastError()> which describes
485 the last error from within the Win32 API.  Most Win32-specific
486 code will report errors via C<$^E>.  ANSI C and UNIX-like calls
487 set C<errno> and so most portable Perl code will report errors
488 via C<$!>. 
489
490 Caveats mentioned in the description of C<$!> generally apply to
491 C<$^E>, also.  (Mnemonic: Extra error explanation.)
492
493 =item $EVAL_ERROR
494
495 =item $@
496
497 The Perl syntax error message from the last eval() command.  If null, the
498 last eval() parsed and executed correctly (although the operations you
499 invoked may have failed in the normal fashion).  (Mnemonic: Where was
500 the syntax error "at"?)
501
502 Note that warning messages are not collected in this variable.  You can,
503 however, set up a routine to process warnings by setting C<$SIG{__WARN__}>
504 as described below.
505
506 =item $PROCESS_ID
507
508 =item $PID
509
510 =item $$
511
512 The process number of the Perl running this script.  (Mnemonic: same
513 as shells.)
514
515 =item $REAL_USER_ID
516
517 =item $UID
518
519 =item $<
520
521 The real uid of this process.  (Mnemonic: it's the uid you came I<FROM>,
522 if you're running setuid.)
523
524 =item $EFFECTIVE_USER_ID
525
526 =item $EUID
527
528 =item $>
529
530 The effective uid of this process.  Example:
531
532     $< = $>;            # set real to effective uid
533     ($<,$>) = ($>,$<);  # swap real and effective uid
534
535 (Mnemonic: it's the uid you went I<TO>, if you're running setuid.)
536 Note: "C<$E<lt>>" and "C<$E<gt>>" can be swapped only on machines
537 supporting setreuid().
538
539 =item $REAL_GROUP_ID
540
541 =item $GID
542
543 =item $(
544
545 The real gid of this process.  If you are on a machine that supports
546 membership in multiple groups simultaneously, gives a space separated
547 list of groups you are in.  The first number is the one returned by
548 getgid(), and the subsequent ones by getgroups(), one of which may be
549 the same as the first number.
550
551 However, a value assigned to "C<$(>" must be a single number used to
552 set the real gid.  So the value given by "C<$(>" should I<not> be assigned
553 back to "C<$(>" without being forced numeric, such as by adding zero.
554
555 (Mnemonic: parentheses are used to I<GROUP> things.  The real gid is the
556 group you I<LEFT>, if you're running setgid.)
557
558 =item $EFFECTIVE_GROUP_ID
559
560 =item $EGID
561
562 =item $)
563
564 The effective gid of this process.  If you are on a machine that
565 supports membership in multiple groups simultaneously, gives a space
566 separated list of groups you are in.  The first number is the one
567 returned by getegid(), and the subsequent ones by getgroups(), one of
568 which may be the same as the first number.
569
570 Similarly, a value assigned to "C<$)>" must also be a space-separated
571 list of numbers.  The first number is used to set the effective gid, and
572 the rest (if any) are passed to setgroups().  To get the effect of an
573 empty list for setgroups(), just repeat the new effective gid; that is,
574 to force an effective gid of 5 and an effectively empty setgroups()
575 list, say C< $) = "5 5" >.
576
577 (Mnemonic: parentheses are used to I<GROUP> things.  The effective gid
578 is the group that's I<RIGHT> for you, if you're running setgid.)
579
580 Note: "C<$E<lt>>", "C<$E<gt>>", "C<$(>" and "C<$)>" can be set only on
581 machines that support the corresponding I<set[re][ug]id()> routine.  "C<$(>"
582 and "C<$)>" can be swapped only on machines supporting setregid().
583
584 =item $PROGRAM_NAME
585
586 =item $0
587
588 Contains the name of the file containing the Perl script being
589 executed.  On some operating systems
590 assigning to "C<$0>" modifies the argument area that the ps(1)
591 program sees.  This is more useful as a way of indicating the
592 current program state than it is for hiding the program you're running.
593 (Mnemonic: same as B<sh> and B<ksh>.)
594
595 =item $[
596
597 The index of the first element in an array, and of the first character
598 in a substring.  Default is 0, but you could set it to 1 to make
599 Perl behave more like B<awk> (or Fortran) when subscripting and when
600 evaluating the index() and substr() functions.  (Mnemonic: [ begins
601 subscripts.)
602
603 As of Perl 5, assignment to "C<$[>" is treated as a compiler directive,
604 and cannot influence the behavior of any other file.  Its use is
605 discouraged.
606
607 =item $PERL_VERSION
608
609 =item $]
610
611 The version + patchlevel / 1000 of the Perl interpreter.  This variable
612 can be used to determine whether the Perl interpreter executing a
613 script is in the right range of versions.  (Mnemonic: Is this version
614 of perl in the right bracket?)  Example:
615
616     warn "No checksumming!\n" if $] < 3.019;
617
618 See also the documentation of C<use VERSION> and C<require VERSION>
619 for a convenient way to fail if the Perl interpreter is too old.
620
621 =item $DEBUGGING
622
623 =item $^D
624
625 The current value of the debugging flags.  (Mnemonic: value of B<-D>
626 switch.)
627
628 =item $SYSTEM_FD_MAX
629
630 =item $^F
631
632 The maximum system file descriptor, ordinarily 2.  System file
633 descriptors are passed to exec()ed processes, while higher file
634 descriptors are not.  Also, during an open(), system file descriptors are
635 preserved even if the open() fails.  (Ordinary file descriptors are
636 closed before the open() is attempted.)  Note that the close-on-exec
637 status of a file descriptor will be decided according to the value of
638 C<$^F> at the time of the open, not the time of the exec.
639
640 =item $^H
641
642 The current set of syntax checks enabled by C<use strict> and other block
643 scoped compiler hints.  See the documentation of C<strict> for more details.
644
645 =item $INPLACE_EDIT
646
647 =item $^I
648
649 The current value of the inplace-edit extension.  Use C<undef> to disable
650 inplace editing.  (Mnemonic: value of B<-i> switch.)
651
652 =item $^M
653
654 By default, running out of memory it is not trappable.  However, if
655 compiled for this, Perl may use the contents of C<$^M> as an emergency
656 pool after die()ing with this message.  Suppose that your Perl were
657 compiled with -DPERL_EMERGENCY_SBRK and used Perl's malloc.  Then
658
659     $^M = 'a' x (1<<16);
660
661 would allocate a 64K buffer for use when in emergency.  See the F<INSTALL>
662 file for information on how to enable this option.  As a disincentive to
663 casual use of this advanced feature, there is no L<English> long name for
664 this variable.
665
666 =item $OSNAME
667
668 =item $^O
669
670 The name of the operating system under which this copy of Perl was
671 built, as determined during the configuration process.  The value
672 is identical to C<$Config{'osname'}>.
673
674 =item $PERLDB
675
676 =item $^P
677
678 The internal variable for debugging support.  Different bits mean the
679 following (subject to change): 
680
681 =over 6
682
683 =item 0x01
684
685 Debug subroutine enter/exit.
686
687 =item 0x02
688
689 Line-by-line debugging.
690
691 =item 0x04
692
693 Switch off optimizations.
694
695 =item 0x08
696
697 Preserve more data for future interactive inspections.
698
699 =item 0x10
700
701 Keep info about source lines on which a subroutine is defined.
702
703 =item 0x20
704
705 Start with single-step on.
706
707 =back
708
709 Note that some bits may be relevent at compile-time only, some at
710 run-time only. This is a new mechanism and the details may change.
711
712 =item $^S
713
714 Current state of the interpreter.  Undefined if parsing of the current
715 module/eval is not finished (may happen in $SIG{__DIE__} and
716 $SIG{__WARN__} handlers).  True if inside an eval, otherwise false.
717
718 =item $BASETIME
719
720 =item $^T
721
722 The time at which the script began running, in seconds since the
723 epoch (beginning of 1970).  The values returned by the B<-M>, B<-A>,
724 and B<-C> filetests are
725 based on this value.
726
727 =item $WARNING
728
729 =item $^W
730
731 The current value of the warning switch, either TRUE or FALSE.
732 (Mnemonic: related to the B<-w> switch.)
733
734 =item $EXECUTABLE_NAME
735
736 =item $^X
737
738 The name that the Perl binary itself was executed as, from C's C<argv[0]>.
739
740 =item $ARGV
741
742 contains the name of the current file when reading from E<lt>E<gt>.
743
744 =item @ARGV
745
746 The array @ARGV contains the command line arguments intended for the
747 script.  Note that C<$#ARGV> is the generally number of arguments minus
748 one, because C<$ARGV[0]> is the first argument, I<NOT> the command name.  See
749 "C<$0>" for the command name.
750
751 =item @INC
752
753 The array @INC contains the list of places to look for Perl scripts to
754 be evaluated by the C<do EXPR>, C<require>, or C<use> constructs.  It
755 initially consists of the arguments to any B<-I> command line switches,
756 followed by the default Perl library, probably F</usr/local/lib/perl>,
757 followed by ".", to represent the current directory.  If you need to
758 modify this at runtime, you should use the C<use lib> pragma
759 to get the machine-dependent library properly loaded also:
760
761     use lib '/mypath/libdir/';
762     use SomeMod;
763
764 =item @_
765
766 Within a subroutine the array @_ contains the parameters passed to that
767 subroutine. See L<perlsub>.
768
769 =item %INC
770
771 The hash %INC contains entries for each filename that has
772 been included via C<do> or C<require>.  The key is the filename you
773 specified, and the value is the location of the file actually found.
774 The C<require> command uses this array to determine whether a given file
775 has already been included.
776
777 =item %ENV  $ENV{expr}
778
779 The hash %ENV contains your current environment.  Setting a
780 value in C<ENV> changes the environment for child processes.
781
782 =item %SIG  $SIG{expr}
783
784 The hash %SIG is used to set signal handlers for various
785 signals.  Example:
786
787     sub handler {       # 1st argument is signal name
788         my($sig) = @_;
789         print "Caught a SIG$sig--shutting down\n";
790         close(LOG);
791         exit(0);
792     }
793
794     $SIG{'INT'}  = \&handler;
795     $SIG{'QUIT'} = \&handler;
796     ...
797     $SIG{'INT'} = 'DEFAULT';    # restore default action
798     $SIG{'QUIT'} = 'IGNORE';    # ignore SIGQUIT
799
800 The %SIG array contains values for only the signals actually set within
801 the Perl script.  Here are some other examples:
802
803     $SIG{"PIPE"} = Plumber;     # SCARY!!
804     $SIG{"PIPE"} = "Plumber";   # assumes main::Plumber (not recommended)
805     $SIG{"PIPE"} = \&Plumber;   # just fine; assume current Plumber
806     $SIG{"PIPE"} = Plumber();   # oops, what did Plumber() return??
807
808 The one marked scary is problematic because it's a bareword, which means
809 sometimes it's a string representing the function, and sometimes it's
810 going to call the subroutine call right then and there!  Best to be sure
811 and quote it or take a reference to it.  *Plumber works too.  See L<perlsub>.
812
813 If your system has the sigaction() function then signal handlers are
814 installed using it.  This means you get reliable signal handling.  If
815 your system has the SA_RESTART flag it is used when signals handlers are
816 installed.  This means that system calls for which it is supported
817 continue rather than returning when a signal arrives.  If you want your
818 system calls to be interrupted by signal delivery then do something like
819 this:
820
821     use POSIX ':signal_h';
822
823     my $alarm = 0;
824     sigaction SIGALRM, new POSIX::SigAction sub { $alarm = 1 }
825         or die "Error setting SIGALRM handler: $!\n";
826
827 See L<POSIX>.
828
829 Certain internal hooks can be also set using the %SIG hash.  The
830 routine indicated by C<$SIG{__WARN__}> is called when a warning message is
831 about to be printed.  The warning message is passed as the first
832 argument.  The presence of a __WARN__ hook causes the ordinary printing
833 of warnings to STDERR to be suppressed.  You can use this to save warnings
834 in a variable, or turn warnings into fatal errors, like this:
835
836     local $SIG{__WARN__} = sub { die $_[0] };
837     eval $proggie;
838
839 The routine indicated by C<$SIG{__DIE__}> is called when a fatal exception
840 is about to be thrown.  The error message is passed as the first
841 argument.  When a __DIE__ hook routine returns, the exception
842 processing continues as it would have in the absence of the hook,
843 unless the hook routine itself exits via a C<goto>, a loop exit, or a die().
844 The C<__DIE__> handler is explicitly disabled during the call, so that you
845 can die from a C<__DIE__> handler.  Similarly for C<__WARN__>.
846
847 Note that the C<$SIG{__DIE__}> hook is called even inside eval()ed
848 blocks/strings.  See L<perlfunc/die> and L<perlvar/$^S> for how to
849 circumvent this.
850
851 Note that C<__DIE__>/C<__WARN__> handlers are very special in one
852 respect: they may be called to report (probable) errors found by the
853 parser.  In such a case the parser may be in inconsistent state, so
854 any attempt to evaluate Perl code from such a handler will probably
855 result in a segfault.  This means that calls which result/may-result
856 in parsing Perl should be used with extreme causion, like this:
857
858     require Carp if defined $^S;
859     Carp::confess("Something wrong") if defined &Carp::confess;
860     die "Something wrong, but could not load Carp to give backtrace...
861          To see backtrace try starting Perl with -MCarp switch";
862
863 Here the first line will load Carp I<unless> it is the parser who
864 called the handler.  The second line will print backtrace and die if
865 Carp was available.  The third line will be executed only if Carp was
866 not available.
867
868 See L<perlfunc/die>, L<perlfunc/warn> and L<perlfunc/eval> for
869 additional info.
870
871 =back