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