286ea261fc37b01022c60421b7527ebf63847190
[perl.git] / pod / perlvar.pod
1 =head1 NAME
2
3 perlvar - Perl predefined variables
4
5 =head1 DESCRIPTION
6
7 =head2 The Syntax of Variable Names
8
9 Variable names in Perl can have several formats.  Usually, they
10 must begin with a letter or underscore, in which case they can be
11 arbitrarily long (up to an internal limit of 251 characters) and
12 may contain letters, digits, underscores, or the special sequence
13 C<::> or C<'>.  In this case, the part before the last C<::> or
14 C<'> is taken to be a I<package qualifier>; see L<perlmod>.
15
16 Perl variable names may also be a sequence of digits or a single
17 punctuation or control character.  These names are all reserved for
18 special uses by Perl; for example, the all-digits names are used
19 to hold data captured by backreferences after a regular expression
20 match.  Perl has a special syntax for the single-control-character
21 names: It understands C<^X> (caret C<X>) to mean the control-C<X>
22 character.  For example, the notation C<$^W> (dollar-sign caret
23 C<W>) is the scalar variable whose name is the single character
24 control-C<W>.  This is better than typing a literal control-C<W>
25 into your program.
26
27 Since Perl v5.6.0, Perl variable names may be alphanumeric
28 strings that begin with control characters (or better yet, a caret).
29 These variables must be written in the form C<${^Foo}>; the braces
30 are not optional.  C<${^Foo}> denotes the scalar variable whose
31 name is a control-C<F> followed by two C<o>'s.  These variables are
32 reserved for future special uses by Perl, except for the ones that
33 begin with C<^_> (control-underscore or caret-underscore).  No
34 control-character name that begins with C<^_> will acquire a special
35 meaning in any future version of Perl; such names may therefore be
36 used safely in programs.  C<$^_> itself, however, I<is> reserved.
37
38 Perl identifiers that begin with digits, control characters, or
39 punctuation characters are exempt from the effects of the C<package>
40 declaration and are always forced to be in package C<main>; they are
41 also exempt from C<strict 'vars'> errors.  A few other names are also
42 exempt in these ways:
43
44     ENV      STDIN
45     INC      STDOUT
46     ARGV     STDERR
47     ARGVOUT
48     SIG
49
50 In particular, the special C<${^_XYZ}> variables are always taken
51 to be in package C<main>, regardless of any C<package> declarations
52 presently in scope.
53
54 =head1 SPECIAL VARIABLES
55
56 The following names have special meaning to Perl.  Most punctuation
57 names have reasonable mnemonics, or analogs in the shells.
58 Nevertheless, if you wish to use long variable names, you need only say:
59
60     use English;
61
62 at the top of your program.  This aliases all the short names to the long
63 names in the current package.  Some even have medium names, generally
64 borrowed from B<awk>.  To avoid a performance hit, if you don't need the
65 C<$PREMATCH>, C<$MATCH>, or C<$POSTMATCH> it's best to use the C<English>
66 module without them:
67
68     use English '-no_match_vars';
69
70 Before you continue, note the sort order for variables.  In general, we
71 first list the variables in case-insensitive, almost-lexigraphical
72 order (ignoring the C<{> or C<^> preceding words, as in C<${^UNICODE}>
73 or C<$^T>), although C<$_> and C<@_> move up to the top of the pile.
74 For variables with the same identifier, we list it in order of scalar,
75 array, hash, and bareword.
76
77 =head2 General Variables
78
79 =over 8
80
81 =item $ARG
82
83 =item $_
84 X<$_> X<$ARG>
85
86 The default input and pattern-searching space.  The following pairs are
87 equivalent:
88
89     while (<>) {...}    # equivalent only in while!
90     while (defined($_ = <>)) {...}
91
92     /^Subject:/
93     $_ =~ /^Subject:/
94
95     tr/a-z/A-Z/
96     $_ =~ tr/a-z/A-Z/
97
98     chomp
99     chomp($_)
100
101 Here are the places where Perl will assume C<$_> even if you don't use it:
102
103 =over 3
104
105 =item *
106
107 The following functions use C<$_> as a default argument:
108
109 abs, alarm, chomp, chop, chr, chroot,
110 cos, defined, eval, evalbytes, exp, fc, glob, hex, int, lc,
111 lcfirst, length, log, lstat, mkdir, oct, ord, pos, print, printf,
112 quotemeta, readlink, readpipe, ref, require, reverse (in scalar context only),
113 rmdir, say, sin, split (for its second
114 argument), sqrt, stat, study, uc, ucfirst,
115 unlink, unpack.
116
117 =item *
118
119 All file tests (C<-f>, C<-d>) except for C<-t>, which defaults to STDIN.
120 See L<perlfunc/-X>
121
122 =item *
123
124 The pattern matching operations C<m//>, C<s///> and C<tr///> (aka C<y///>)
125 when used without an C<=~> operator.
126
127 =item *
128
129 The default iterator variable in a C<foreach> loop if no other
130 variable is supplied.
131
132 =item *
133
134 The implicit iterator variable in the C<grep()> and C<map()> functions.
135
136 =item *
137
138 The implicit variable of C<given()>.
139
140 =item *
141
142 The default place to put the next value or input record
143 when a C<< <FH> >>, C<readline>, C<readdir> or C<each>
144 operation's result is tested by itself as the sole criterion of a C<while>
145 test.  Outside a C<while> test, this will not happen.
146
147 =back
148
149 C<$_> is by default a global variable.  However, as
150 of perl v5.10.0, you can use a lexical version of
151 C<$_> by declaring it in a file or in a block with C<my>.  Moreover,
152 declaring C<our $_> restores the global C<$_> in the current scope.  Though
153 this seemed like a good idea at the time it was introduced, lexical C<$_>
154 actually causes more problems than it solves.  If you call a function that
155 expects to be passed information via C<$_>, it may or may not work,
156 depending on how the function is written, there not being any easy way to
157 solve this.  Just avoid lexical C<$_>, unless you are feeling particularly
158 masochistic.  For this reason lexical C<$_> is still experimental and will
159 produce a warning unless warnings have been disabled.  As with other
160 experimental features, the behavior of lexical C<$_> is subject to change
161 without notice, including change into a fatal error.
162
163 Mnemonic: underline is understood in certain operations.
164
165 =item @ARG
166
167 =item @_
168 X<@_> X<@ARG>
169
170 Within a subroutine the array C<@_> contains the parameters passed to
171 that subroutine.  Inside a subroutine, C<@_> is the default array for
172 the array operators C<push>, C<pop>, C<shift>, and C<unshift>.
173
174 See L<perlsub>.
175
176 =item $LIST_SEPARATOR
177
178 =item $"
179 X<$"> X<$LIST_SEPARATOR>
180
181 When an array or an array slice is interpolated into a double-quoted
182 string or a similar context such as C</.../>, its elements are
183 separated by this value.  Default is a space.  For example, this:
184
185     print "The array is: @array\n";
186
187 is equivalent to this:
188
189     print "The array is: " . join($", @array) . "\n";
190
191 Mnemonic: works in double-quoted context.
192
193 =item $PROCESS_ID
194
195 =item $PID
196
197 =item $$
198 X<$$> X<$PID> X<$PROCESS_ID>
199
200 The process number of the Perl running this script.  Though you I<can> set
201 this variable, doing so is generally discouraged, although it can be
202 invaluable for some testing purposes.  It will be reset automatically
203 across C<fork()> calls.
204
205 Note for Linux and Debian GNU/kFreeBSD users: Before Perl v5.16.0 perl
206 would emulate POSIX semantics on Linux systems using LinuxThreads, a
207 partial implementation of POSIX Threads that has since been superseded
208 by the Native POSIX Thread Library (NPTL).
209
210 LinuxThreads is now obsolete on Linux, and caching C<getpid()>
211 like this made embedding perl unnecessarily complex (since you'd have
212 to manually update the value of $$), so now C<$$> and C<getppid()>
213 will always return the same values as the underlying C library.
214
215 Debian GNU/kFreeBSD systems also used LinuxThreads up until and
216 including the 6.0 release, but after that moved to FreeBSD thread
217 semantics, which are POSIX-like.
218
219 To see if your system is affected by this discrepancy check if
220 C<getconf GNU_LIBPTHREAD_VERSION | grep -q NPTL> returns a false
221 value. NTPL threads preserve the POSIX semantics.
222
223 Mnemonic: same as shells.
224
225 =item $PROGRAM_NAME
226
227 =item $0
228 X<$0> X<$PROGRAM_NAME>
229
230 Contains the name of the program being executed.
231
232 On some (but not all) operating systems assigning to C<$0> modifies
233 the argument area that the C<ps> program sees.  On some platforms you
234 may have to use special C<ps> options or a different C<ps> to see the
235 changes.  Modifying the C<$0> is more useful as a way of indicating the
236 current program state than it is for hiding the program you're
237 running.
238
239 Note that there are platform-specific limitations on the maximum
240 length of C<$0>.  In the most extreme case it may be limited to the
241 space occupied by the original C<$0>.
242
243 In some platforms there may be arbitrary amount of padding, for
244 example space characters, after the modified name as shown by C<ps>.
245 In some platforms this padding may extend all the way to the original
246 length of the argument area, no matter what you do (this is the case
247 for example with Linux 2.2).
248
249 Note for BSD users: setting C<$0> does not completely remove "perl"
250 from the ps(1) output.  For example, setting C<$0> to C<"foobar"> may
251 result in C<"perl: foobar (perl)"> (whether both the C<"perl: "> prefix
252 and the " (perl)" suffix are shown depends on your exact BSD variant
253 and version).  This is an operating system feature, Perl cannot help it.
254
255 In multithreaded scripts Perl coordinates the threads so that any
256 thread may modify its copy of the C<$0> and the change becomes visible
257 to ps(1) (assuming the operating system plays along).  Note that
258 the view of C<$0> the other threads have will not change since they
259 have their own copies of it.
260
261 If the program has been given to perl via the switches C<-e> or C<-E>,
262 C<$0> will contain the string C<"-e">.
263
264 On Linux as of perl v5.14.0 the legacy process name will be set with
265 C<prctl(2)>, in addition to altering the POSIX name via C<argv[0]> as
266 perl has done since version 4.000.  Now system utilities that read the
267 legacy process name such as ps, top and killall will recognize the
268 name you set when assigning to C<$0>.  The string you supply will be
269 cut off at 16 bytes, this is a limitation imposed by Linux.
270
271 Mnemonic: same as B<sh> and B<ksh>.
272
273 =item $REAL_GROUP_ID
274
275 =item $GID
276
277 =item $(
278 X<$(> X<$GID> X<$REAL_GROUP_ID>
279
280 The real gid of this process.  If you are on a machine that supports
281 membership in multiple groups simultaneously, gives a space separated
282 list of groups you are in.  The first number is the one returned by
283 C<getgid()>, and the subsequent ones by C<getgroups()>, one of which may be
284 the same as the first number.
285
286 However, a value assigned to C<$(> must be a single number used to
287 set the real gid.  So the value given by C<$(> should I<not> be assigned
288 back to C<$(> without being forced numeric, such as by adding zero.  Note
289 that this is different to the effective gid (C<$)>) which does take a
290 list.
291
292 You can change both the real gid and the effective gid at the same
293 time by using C<POSIX::setgid()>.  Changes
294 to C<$(> require a check to C<$!>
295 to detect any possible errors after an attempted change.
296
297 Mnemonic: parentheses are used to I<group> things.  The real gid is the
298 group you I<left>, if you're running setgid.
299
300 =item $EFFECTIVE_GROUP_ID
301
302 =item $EGID
303
304 =item $)
305 X<$)> X<$EGID> X<$EFFECTIVE_GROUP_ID>
306
307 The effective gid of this process.  If you are on a machine that
308 supports membership in multiple groups simultaneously, gives a space
309 separated list of groups you are in.  The first number is the one
310 returned by C<getegid()>, and the subsequent ones by C<getgroups()>,
311 one of which may be the same as the first number.
312
313 Similarly, a value assigned to C<$)> must also be a space-separated
314 list of numbers.  The first number sets the effective gid, and
315 the rest (if any) are passed to C<setgroups()>.  To get the effect of an
316 empty list for C<setgroups()>, just repeat the new effective gid; that is,
317 to force an effective gid of 5 and an effectively empty C<setgroups()>
318 list, say C< $) = "5 5" >.
319
320 You can change both the effective gid and the real gid at the same
321 time by using C<POSIX::setgid()> (use only a single numeric argument).
322 Changes to C<$)> require a check to C<$!> to detect any possible errors
323 after an attempted change.
324
325 C<< $< >>, C<< $> >>, C<$(> and C<$)> can be set only on
326 machines that support the corresponding I<set[re][ug]id()> routine.  C<$(>
327 and C<$)> can be swapped only on machines supporting C<setregid()>.
328
329 Mnemonic: parentheses are used to I<group> things.  The effective gid
330 is the group that's I<right> for you, if you're running setgid.
331
332 =item $REAL_USER_ID
333
334 =item $UID
335
336 =item $<
337 X<< $< >> X<$UID> X<$REAL_USER_ID>
338
339 The real uid of this process.  You can change both the real uid and the
340 effective uid at the same time by using C<POSIX::setuid()>.  Since
341 changes to C<< $< >> require a system call, check C<$!> after a change
342 attempt to detect any possible errors.
343
344 Mnemonic: it's the uid you came I<from>, if you're running setuid.
345
346 =item $EFFECTIVE_USER_ID
347
348 =item $EUID
349
350 =item $>
351 X<< $> >> X<$EUID> X<$EFFECTIVE_USER_ID>
352
353 The effective uid of this process.  For example:
354
355     $< = $>;            # set real to effective uid
356     ($<,$>) = ($>,$<);  # swap real and effective uids
357
358 You can change both the effective uid and the real uid at the same
359 time by using C<POSIX::setuid()>.  Changes to C<< $> >> require a check
360 to C<$!> to detect any possible errors after an attempted change.
361
362 C<< $< >> and C<< $> >> can be swapped only on machines
363 supporting C<setreuid()>.
364
365 Mnemonic: it's the uid you went I<to>, if you're running setuid.
366
367 =item $SUBSCRIPT_SEPARATOR
368
369 =item $SUBSEP
370
371 =item $;
372 X<$;> X<$SUBSEP> X<SUBSCRIPT_SEPARATOR>
373
374 The subscript separator for multidimensional array emulation.  If you
375 refer to a hash element as
376
377     $foo{$a,$b,$c}
378
379 it really means
380
381     $foo{join($;, $a, $b, $c)}
382
383 But don't put
384
385     @foo{$a,$b,$c}      # a slice--note the @
386
387 which means
388
389     ($foo{$a},$foo{$b},$foo{$c})
390
391 Default is "\034", the same as SUBSEP in B<awk>.  If your keys contain
392 binary data there might not be any safe value for C<$;>.
393
394 Consider using "real" multidimensional arrays as described
395 in L<perllol>.
396
397 Mnemonic: comma (the syntactic subscript separator) is a semi-semicolon.
398
399 =item $a
400
401 =item $b
402 X<$a> X<$b>
403
404 Special package variables when using C<sort()>, see L<perlfunc/sort>.
405 Because of this specialness C<$a> and C<$b> don't need to be declared
406 (using C<use vars>, or C<our()>) even when using the C<strict 'vars'>
407 pragma.  Don't lexicalize them with C<my $a> or C<my $b> if you want to
408 be able to use them in the C<sort()> comparison block or function.
409
410 =item %ENV
411 X<%ENV>
412
413 The hash C<%ENV> contains your current environment.  Setting a
414 value in C<ENV> changes the environment for any child processes
415 you subsequently C<fork()> off.
416
417 =item $SYSTEM_FD_MAX
418
419 =item $^F
420 X<$^F> X<$SYSTEM_FD_MAX>
421
422 The maximum system file descriptor, ordinarily 2.  System file
423 descriptors are passed to C<exec()>ed processes, while higher file
424 descriptors are not.  Also, during an
425 C<open()>, system file descriptors are
426 preserved even if the C<open()> fails (ordinary file descriptors are
427 closed before the C<open()> is attempted).  The close-on-exec
428 status of a file descriptor will be decided according to the value of
429 C<$^F> when the corresponding file, pipe, or socket was opened, not the
430 time of the C<exec()>.
431
432 =item @F
433 X<@F>
434
435 The array C<@F> contains the fields of each line read in when autosplit
436 mode is turned on.  See L<perlrun> for the B<-a> switch.  This array
437 is package-specific, and must be declared or given a full package name
438 if not in package main when running under C<strict 'vars'>.
439
440 =item @INC
441 X<@INC>
442
443 The array C<@INC> contains the list of places that the C<do EXPR>,
444 C<require>, or C<use> constructs look for their library files.  It
445 initially consists of the arguments to any B<-I> command-line
446 switches, followed by the default Perl library, probably
447 F</usr/local/lib/perl>, followed by ".", to represent the current
448 directory.  ("." will not be appended if taint checks are enabled,
449 either by C<-T> or by C<-t>.)  If you need to modify this at runtime,
450 you should use the C<use lib> pragma to get the machine-dependent
451 library properly loaded also:
452
453     use lib '/mypath/libdir/';
454     use SomeMod;
455
456 You can also insert hooks into the file inclusion system by putting Perl
457 code directly into C<@INC>.  Those hooks may be subroutine references,
458 array references or blessed objects.  See L<perlfunc/require> for details.
459
460 =item %INC
461 X<%INC>
462
463 The hash C<%INC> contains entries for each filename included via the
464 C<do>, C<require>, or C<use> operators.  The key is the filename
465 you specified (with module names converted to pathnames), and the
466 value is the location of the file found.  The C<require>
467 operator uses this hash to determine whether a particular file has
468 already been included.
469
470 If the file was loaded via a hook (e.g. a subroutine reference, see
471 L<perlfunc/require> for a description of these hooks), this hook is
472 by default inserted into C<%INC> in place of a filename.  Note, however,
473 that the hook may have set the C<%INC> entry by itself to provide some more
474 specific info.
475
476 =item $INPLACE_EDIT
477
478 =item $^I
479 X<$^I> X<$INPLACE_EDIT>
480
481 The current value of the inplace-edit extension.  Use C<undef> to disable
482 inplace editing.
483
484 Mnemonic: value of B<-i> switch.
485
486 =item $^M
487 X<$^M>
488
489 By default, running out of memory is an untrappable, fatal error.
490 However, if suitably built, Perl can use the contents of C<$^M>
491 as an emergency memory pool after C<die()>ing.  Suppose that your Perl
492 were compiled with C<-DPERL_EMERGENCY_SBRK> and used Perl's malloc.
493 Then
494
495     $^M = 'a' x (1 << 16);
496
497 would allocate a 64K buffer for use in an emergency.  See the
498 F<INSTALL> file in the Perl distribution for information on how to
499 add custom C compilation flags when compiling perl.  To discourage casual
500 use of this advanced feature, there is no L<English|English> long name for
501 this variable.
502
503 This variable was added in Perl 5.004.
504
505 =item $OSNAME
506
507 =item $^O
508 X<$^O> X<$OSNAME>
509
510 The name of the operating system under which this copy of Perl was
511 built, as determined during the configuration process.  For examples
512 see L<perlport/PLATFORMS>.
513
514 The value is identical to C<$Config{'osname'}>.  See also L<Config>
515 and the B<-V> command-line switch documented in L<perlrun>.
516
517 In Windows platforms, C<$^O> is not very helpful: since it is always
518 C<MSWin32>, it doesn't tell the difference between
519 95/98/ME/NT/2000/XP/CE/.NET.  Use C<Win32::GetOSName()> or
520 Win32::GetOSVersion() (see L<Win32> and L<perlport>) to distinguish
521 between the variants.
522
523 This variable was added in Perl 5.003.
524
525 =item %SIG
526 X<%SIG>
527
528 The hash C<%SIG> contains signal handlers for signals.  For example:
529
530     sub handler {   # 1st argument is signal name
531         my($sig) = @_;
532         print "Caught a SIG$sig--shutting down\n";
533         close(LOG);
534         exit(0);
535         }
536
537     $SIG{'INT'}  = \&handler;
538     $SIG{'QUIT'} = \&handler;
539     ...
540     $SIG{'INT'}  = 'DEFAULT';   # restore default action
541     $SIG{'QUIT'} = 'IGNORE';    # ignore SIGQUIT
542
543 Using a value of C<'IGNORE'> usually has the effect of ignoring the
544 signal, except for the C<CHLD> signal.  See L<perlipc> for more about
545 this special case.
546
547 Here are some other examples:
548
549     $SIG{"PIPE"} = "Plumber";   # assumes main::Plumber (not
550                                 # recommended)
551     $SIG{"PIPE"} = \&Plumber;   # just fine; assume current
552                                 # Plumber
553     $SIG{"PIPE"} = *Plumber;    # somewhat esoteric
554     $SIG{"PIPE"} = Plumber();   # oops, what did Plumber()
555                                 # return??
556
557 Be sure not to use a bareword as the name of a signal handler,
558 lest you inadvertently call it.
559
560 If your system has the C<sigaction()> function then signal handlers
561 are installed using it.  This means you get reliable signal handling.
562
563 The default delivery policy of signals changed in Perl v5.8.0 from
564 immediate (also known as "unsafe") to deferred, also known as "safe
565 signals".  See L<perlipc> for more information.
566
567 Certain internal hooks can be also set using the C<%SIG> hash.  The
568 routine indicated by C<$SIG{__WARN__}> is called when a warning
569 message is about to be printed.  The warning message is passed as the
570 first argument.  The presence of a C<__WARN__> hook causes the
571 ordinary printing of warnings to C<STDERR> to be suppressed.  You can
572 use this to save warnings in a variable, or turn warnings into fatal
573 errors, like this:
574
575     local $SIG{__WARN__} = sub { die $_[0] };
576     eval $proggie;
577
578 As the C<'IGNORE'> hook is not supported by C<__WARN__>, you can
579 disable warnings using the empty subroutine:
580
581     local $SIG{__WARN__} = sub {};
582
583 The routine indicated by C<$SIG{__DIE__}> is called when a fatal
584 exception is about to be thrown.  The error message is passed as the
585 first argument.  When a C<__DIE__> hook routine returns, the exception
586 processing continues as it would have in the absence of the hook,
587 unless the hook routine itself exits via a C<goto &sub>, a loop exit,
588 or a C<die()>.  The C<__DIE__> handler is explicitly disabled during
589 the call, so that you can die from a C<__DIE__> handler.  Similarly
590 for C<__WARN__>.
591
592 Due to an implementation glitch, the C<$SIG{__DIE__}> hook is called
593 even inside an C<eval()>.  Do not use this to rewrite a pending
594 exception in C<$@>, or as a bizarre substitute for overriding
595 C<CORE::GLOBAL::die()>.  This strange action at a distance may be fixed
596 in a future release so that C<$SIG{__DIE__}> is only called if your
597 program is about to exit, as was the original intent.  Any other use is
598 deprecated.
599
600 C<__DIE__>/C<__WARN__> handlers are very special in one respect: they
601 may be called to report (probable) errors found by the parser.  In such
602 a case the parser may be in inconsistent state, so any attempt to
603 evaluate Perl code from such a handler will probably result in a
604 segfault.  This means that warnings or errors that result from parsing
605 Perl should be used with extreme caution, like this:
606
607     require Carp if defined $^S;
608     Carp::confess("Something wrong") if defined &Carp::confess;
609     die "Something wrong, but could not load Carp to give "
610       . "backtrace...\n\t"
611       . "To see backtrace try starting Perl with -MCarp switch";
612
613 Here the first line will load C<Carp> I<unless> it is the parser who
614 called the handler.  The second line will print backtrace and die if
615 C<Carp> was available.  The third line will be executed only if C<Carp> was
616 not available.
617
618 Having to even think about the C<$^S> variable in your exception
619 handlers is simply wrong.  C<$SIG{__DIE__}> as currently implemented
620 invites grievous and difficult to track down errors.  Avoid it
621 and use an C<END{}> or CORE::GLOBAL::die override instead.
622
623 See L<perlfunc/die>, L<perlfunc/warn>, L<perlfunc/eval>, and
624 L<warnings> for additional information.
625
626 =item $BASETIME
627
628 =item $^T
629 X<$^T> X<$BASETIME>
630
631 The time at which the program began running, in seconds since the
632 epoch (beginning of 1970).  The values returned by the B<-M>, B<-A>,
633 and B<-C> filetests are based on this value.
634
635 =item $PERL_VERSION
636
637 =item $^V
638 X<$^V> X<$PERL_VERSION>
639
640 The revision, version, and subversion of the Perl interpreter,
641 represented as a C<version> object.
642
643 This variable first appeared in perl v5.6.0; earlier versions of perl
644 will see an undefined value.  Before perl v5.10.0 C<$^V> was represented
645 as a v-string.
646
647 C<$^V> can be used to determine whether the Perl interpreter executing
648 a script is in the right range of versions.  For example:
649
650     warn "Hashes not randomized!\n" if !$^V or $^V lt v5.8.1
651
652 To convert C<$^V> into its string representation use C<sprintf()>'s
653 C<"%vd"> conversion:
654
655     printf "version is v%vd\n", $^V;  # Perl's version
656
657 See the documentation of C<use VERSION> and C<require VERSION>
658 for a convenient way to fail if the running Perl interpreter is too old.
659
660 See also C<$]> for an older representation of the Perl version.
661
662 This variable was added in Perl v5.6.0.
663
664 Mnemonic: use ^V for Version Control.
665
666 =item ${^WIN32_SLOPPY_STAT}
667 X<${^WIN32_SLOPPY_STAT}> X<sitecustomize> X<sitecustomize.pl>
668
669 If this variable is set to a true value, then C<stat()> on Windows will
670 not try to open the file.  This means that the link count cannot be
671 determined and file attributes may be out of date if additional
672 hardlinks to the file exist.  On the other hand, not opening the file
673 is considerably faster, especially for files on network drives.
674
675 This variable could be set in the F<sitecustomize.pl> file to
676 configure the local Perl installation to use "sloppy" C<stat()> by
677 default.  See the documentation for B<-f> in
678 L<perlrun|perlrun/"Command Switches"> for more information about site
679 customization.
680
681 This variable was added in Perl v5.10.0.
682
683 =item $EXECUTABLE_NAME
684
685 =item $^X
686 X<$^X> X<$EXECUTABLE_NAME>
687
688 The name used to execute the current copy of Perl, from C's
689 C<argv[0]> or (where supported) F</proc/self/exe>.
690
691 Depending on the host operating system, the value of C<$^X> may be
692 a relative or absolute pathname of the perl program file, or may
693 be the string used to invoke perl but not the pathname of the
694 perl program file.  Also, most operating systems permit invoking
695 programs that are not in the PATH environment variable, so there
696 is no guarantee that the value of C<$^X> is in PATH.  For VMS, the
697 value may or may not include a version number.
698
699 You usually can use the value of C<$^X> to re-invoke an independent
700 copy of the same perl that is currently running, e.g.,
701
702     @first_run = `$^X -le "print int rand 100 for 1..100"`;
703
704 But recall that not all operating systems support forking or
705 capturing of the output of commands, so this complex statement
706 may not be portable.
707
708 It is not safe to use the value of C<$^X> as a path name of a file,
709 as some operating systems that have a mandatory suffix on
710 executable files do not require use of the suffix when invoking
711 a command.  To convert the value of C<$^X> to a path name, use the
712 following statements:
713
714     # Build up a set of file names (not command names).
715     use Config;
716     my $this_perl = $^X;
717     if ($^O ne 'VMS') {
718         $this_perl .= $Config{_exe}
719           unless $this_perl =~ m/$Config{_exe}$/i;
720         }
721
722 Because many operating systems permit anyone with read access to
723 the Perl program file to make a copy of it, patch the copy, and
724 then execute the copy, the security-conscious Perl programmer
725 should take care to invoke the installed copy of perl, not the
726 copy referenced by C<$^X>.  The following statements accomplish
727 this goal, and produce a pathname that can be invoked as a
728 command or referenced as a file.
729
730     use Config;
731     my $secure_perl_path = $Config{perlpath};
732     if ($^O ne 'VMS') {
733         $secure_perl_path .= $Config{_exe}
734             unless $secure_perl_path =~ m/$Config{_exe}$/i;
735         }
736
737 =back
738
739 =head2 Variables related to regular expressions
740
741 Most of the special variables related to regular expressions are side
742 effects.  Perl sets these variables when it has a successful match, so
743 you should check the match result before using them.  For instance:
744
745     if( /P(A)TT(ER)N/ ) {
746         print "I found $1 and $2\n";
747         }
748
749 These variables are read-only and dynamically-scoped, unless we note
750 otherwise.
751
752 The dynamic nature of the regular expression variables means that
753 their value is limited to the block that they are in, as demonstrated
754 by this bit of code:
755
756     my $outer = 'Wallace and Grommit';
757     my $inner = 'Mutt and Jeff';
758
759     my $pattern = qr/(\S+) and (\S+)/;
760
761     sub show_n { print "\$1 is $1; \$2 is $2\n" }
762
763     {
764     OUTER:
765         show_n() if $outer =~ m/$pattern/;
766
767         INNER: {
768             show_n() if $inner =~ m/$pattern/;
769             }
770
771         show_n();
772     }
773
774 The output shows that while in the C<OUTER> block, the values of C<$1>
775 and C<$2> are from the match against C<$outer>.  Inside the C<INNER>
776 block, the values of C<$1> and C<$2> are from the match against
777 C<$inner>, but only until the end of the block (i.e. the dynamic
778 scope).  After the C<INNER> block completes, the values of C<$1> and
779 C<$2> return to the values for the match against C<$outer> even though
780 we have not made another match:
781
782     $1 is Wallace; $2 is Grommit
783     $1 is Mutt; $2 is Jeff
784     $1 is Wallace; $2 is Grommit
785
786 If you are using Perl v5.16 or earlier, note that C<use
787 English> imposes a considerable performance penalty on all regular
788 expression matches in a program because it uses the C<$`>, C<$&>, and
789 C<$'>, regardless of whether they occur in the scope of C<use
790 English>.  For that reason, saying C<use English> in libraries is
791 strongly discouraged unless you import it without the match variables:
792
793     use English '-no_match_vars'
794
795 The C<Devel::NYTProf> and C<Devel::FindAmpersand>
796 modules can help you find uses of these
797 problematic match variables in your code.
798
799 Since Perl v5.10.0, you can use the C</p> match operator flag and the
800 C<${^PREMATCH}>, C<${^MATCH}>, and C<${^POSTMATCH}> variables instead
801 so you only suffer the performance penalties.
802
803 If you are using Perl v5.18.0 or higher, you do not need to worry about
804 this, as the three naughty variables are no longer naughty.
805
806 =over 8
807
808 =item $<I<digits>> ($1, $2, ...)
809 X<$1> X<$2> X<$3>
810
811 Contains the subpattern from the corresponding set of capturing
812 parentheses from the last successful pattern match, not counting patterns
813 matched in nested blocks that have been exited already.
814
815 These variables are read-only and dynamically-scoped.
816
817 Mnemonic: like \digits.
818
819 =item $MATCH
820
821 =item $&
822 X<$&> X<$MATCH>
823
824 The string matched by the last successful pattern match (not counting
825 any matches hidden within a BLOCK or C<eval()> enclosed by the current
826 BLOCK).
827
828 In Perl v5.16 and earlier, the use of this variable
829 anywhere in a program imposes a considerable
830 performance penalty on all regular expression matches.  To avoid this
831 penalty, you can extract the same substring by using L</@->.  Starting
832 with Perl v5.10.0, you can use the C</p> match flag and the C<${^MATCH}>
833 variable to do the same thing for particular match operations.
834
835 This variable is read-only and dynamically-scoped.
836
837 Mnemonic: like C<&> in some editors.
838
839 =item ${^MATCH}
840 X<${^MATCH}>
841
842 This is similar to C<$&> (C<$MATCH>) except that it does not incur the
843 performance penalty associated with that variable.
844 In Perl v5.16 and earlier, it is only guaranteed
845 to return a defined value when the pattern was compiled or executed with
846 the C</p> modifier.  In Perl v5.18, the C</p> modifier does nothing, so
847 C<${^MATCH}> does the same thing as C<$MATCH>.
848
849 This variable was added in Perl v5.10.0.
850
851 This variable is read-only and dynamically-scoped.
852
853 =item $PREMATCH
854
855 =item $`
856 X<$`> X<$PREMATCH> X<${^PREMATCH}>
857
858 The string preceding whatever was matched by the last successful
859 pattern match, not counting any matches hidden within a BLOCK or C<eval>
860 enclosed by the current BLOCK.
861
862 In Perl v5.16 and earlier, the use of this variable
863 anywhere in a program imposes a considerable
864 performance penalty on all regular expression matches.  To avoid this
865 penalty, you can extract the same substring by using L</@->.  Starting
866 with Perl v5.10.0, you can use the C</p> match flag and the
867 C<${^PREMATCH}> variable to do the same thing for particular match
868 operations.
869
870 This variable is read-only and dynamically-scoped.
871
872 Mnemonic: C<`> often precedes a quoted string.
873
874 =item ${^PREMATCH}
875 X<$`> X<${^PREMATCH}>
876
877 This is similar to C<$`> ($PREMATCH) except that it does not incur the
878 performance penalty associated with that variable. 
879 In Perl v5.16 and earlier, it is only guaranteed
880 to return a defined value when the pattern was compiled or executed with
881 the C</p> modifier.  In Perl v5.18, the C</p> modifier does nothing, so
882 C<${^PREMATCH}> does the same thing as C<$PREMATCH>.
883
884 This variable was added in Perl v5.10.0
885
886 This variable is read-only and dynamically-scoped.
887
888 =item $POSTMATCH
889
890 =item $'
891 X<$'> X<$POSTMATCH> X<${^POSTMATCH}> X<@->
892
893 The string following whatever was matched by the last successful
894 pattern match (not counting any matches hidden within a BLOCK or C<eval()>
895 enclosed by the current BLOCK).  Example:
896
897     local $_ = 'abcdefghi';
898     /def/;
899     print "$`:$&:$'\n";         # prints abc:def:ghi
900
901 In Perl v5.16 and earlier, the use of this variable
902 anywhere in a program imposes a considerable
903 performance penalty on all regular expression matches.
904 To avoid this penalty, you can extract the same substring by
905 using L</@->.  Starting with Perl v5.10.0, you can use the C</p> match flag
906 and the C<${^POSTMATCH}> variable to do the same thing for particular
907 match operations.
908
909 This variable is read-only and dynamically-scoped.
910
911 Mnemonic: C<'> often follows a quoted string.
912
913 =item ${^POSTMATCH}
914 X<${^POSTMATCH}> X<$'> X<$POSTMATCH>
915
916 This is similar to C<$'> (C<$POSTMATCH>) except that it does not incur the
917 performance penalty associated with that variable.
918 In Perl v5.16 and earlier, it is only guaranteed
919 to return a defined value when the pattern was compiled or executed with
920 the C</p> modifier.  In Perl v5.18, the C</p> modifier does nothing, so
921 C<${^POSTMATCH}> does the same thing as C<$POSTMATCH>.
922
923 This variable was added in Perl v5.10.0.
924
925 This variable is read-only and dynamically-scoped.
926
927 =item $LAST_PAREN_MATCH
928
929 =item $+
930 X<$+> X<$LAST_PAREN_MATCH>
931
932 The text matched by the last bracket of the last successful search pattern.
933 This is useful if you don't know which one of a set of alternative patterns
934 matched.  For example:
935
936     /Version: (.*)|Revision: (.*)/ && ($rev = $+);
937
938 This variable is read-only and dynamically-scoped.
939
940 Mnemonic: be positive and forward looking.
941
942 =item $LAST_SUBMATCH_RESULT
943
944 =item $^N
945 X<$^N> X<$LAST_SUBMATCH_RESULT>
946
947 The text matched by the used group most-recently closed (i.e. the group
948 with the rightmost closing parenthesis) of the last successful search
949 pattern.
950
951 This is primarily used inside C<(?{...})> blocks for examining text
952 recently matched.  For example, to effectively capture text to a variable
953 (in addition to C<$1>, C<$2>, etc.), replace C<(...)> with
954
955     (?:(...)(?{ $var = $^N }))
956
957 By setting and then using C<$var> in this way relieves you from having to
958 worry about exactly which numbered set of parentheses they are.
959
960 This variable was added in Perl v5.8.0.
961
962 Mnemonic: the (possibly) Nested parenthesis that most recently closed.
963
964 =item @LAST_MATCH_END
965
966 =item @+
967 X<@+> X<@LAST_MATCH_END>
968
969 This array holds the offsets of the ends of the last successful
970 submatches in the currently active dynamic scope.  C<$+[0]> is
971 the offset into the string of the end of the entire match.  This
972 is the same value as what the C<pos> function returns when called
973 on the variable that was matched against.  The I<n>th element
974 of this array holds the offset of the I<n>th submatch, so
975 C<$+[1]> is the offset past where C<$1> ends, C<$+[2]> the offset
976 past where C<$2> ends, and so on.  You can use C<$#+> to determine
977 how many subgroups were in the last successful match.  See the
978 examples given for the C<@-> variable.
979
980 This variable was added in Perl v5.6.0.
981
982 =item %LAST_PAREN_MATCH
983
984 =item %+
985 X<%+> X<%LAST_PAREN_MATCH>
986
987 Similar to C<@+>, the C<%+> hash allows access to the named capture
988 buffers, should they exist, in the last successful match in the
989 currently active dynamic scope.
990
991 For example, C<$+{foo}> is equivalent to C<$1> after the following match:
992
993     'foo' =~ /(?<foo>foo)/;
994
995 The keys of the C<%+> hash list only the names of buffers that have
996 captured (and that are thus associated to defined values).
997
998 The underlying behaviour of C<%+> is provided by the
999 L<Tie::Hash::NamedCapture> module.
1000
1001 B<Note:> C<%-> and C<%+> are tied views into a common internal hash
1002 associated with the last successful regular expression.  Therefore mixing
1003 iterative access to them via C<each> may have unpredictable results.
1004 Likewise, if the last successful match changes, then the results may be
1005 surprising.
1006
1007 This variable was added in Perl v5.10.0.
1008
1009 This variable is read-only and dynamically-scoped.
1010
1011 =item @LAST_MATCH_START
1012
1013 =item @-
1014 X<@-> X<@LAST_MATCH_START>
1015
1016 C<$-[0]> is the offset of the start of the last successful match.
1017 C<$-[>I<n>C<]> is the offset of the start of the substring matched by
1018 I<n>-th subpattern, or undef if the subpattern did not match.
1019
1020 Thus, after a match against C<$_>, C<$&> coincides with C<substr $_, $-[0],
1021 $+[0] - $-[0]>.  Similarly, $I<n> coincides with C<substr $_, $-[n],
1022 $+[n] - $-[n]> if C<$-[n]> is defined, and $+ coincides with
1023 C<substr $_, $-[$#-], $+[$#-] - $-[$#-]>.  One can use C<$#-> to find the
1024 last matched subgroup in the last successful match.  Contrast with
1025 C<$#+>, the number of subgroups in the regular expression.  Compare
1026 with C<@+>.
1027
1028 This array holds the offsets of the beginnings of the last
1029 successful submatches in the currently active dynamic scope.
1030 C<$-[0]> is the offset into the string of the beginning of the
1031 entire match.  The I<n>th element of this array holds the offset
1032 of the I<n>th submatch, so C<$-[1]> is the offset where C<$1>
1033 begins, C<$-[2]> the offset where C<$2> begins, and so on.
1034
1035 After a match against some variable C<$var>:
1036
1037 =over 5
1038
1039 =item C<$`> is the same as C<substr($var, 0, $-[0])>
1040
1041 =item C<$&> is the same as C<substr($var, $-[0], $+[0] - $-[0])>
1042
1043 =item C<$'> is the same as C<substr($var, $+[0])>
1044
1045 =item C<$1> is the same as C<substr($var, $-[1], $+[1] - $-[1])>
1046
1047 =item C<$2> is the same as C<substr($var, $-[2], $+[2] - $-[2])>
1048
1049 =item C<$3> is the same as C<substr($var, $-[3], $+[3] - $-[3])>
1050
1051 =back
1052
1053 This variable was added in Perl v5.6.0.
1054
1055 =item %LAST_MATCH_START
1056
1057 =item %-
1058 X<%-> X<%LAST_MATCH_START>
1059
1060 Similar to C<%+>, this variable allows access to the named capture groups
1061 in the last successful match in the currently active dynamic scope.  To
1062 each capture group name found in the regular expression, it associates a
1063 reference to an array containing the list of values captured by all
1064 buffers with that name (should there be several of them), in the order
1065 where they appear.
1066
1067 Here's an example:
1068
1069     if ('1234' =~ /(?<A>1)(?<B>2)(?<A>3)(?<B>4)/) {
1070         foreach my $bufname (sort keys %-) {
1071             my $ary = $-{$bufname};
1072             foreach my $idx (0..$#$ary) {
1073                 print "\$-{$bufname}[$idx] : ",
1074                       (defined($ary->[$idx])
1075                           ? "'$ary->[$idx]'"
1076                           : "undef"),
1077                       "\n";
1078             }
1079         }
1080     }
1081
1082 would print out:
1083
1084     $-{A}[0] : '1'
1085     $-{A}[1] : '3'
1086     $-{B}[0] : '2'
1087     $-{B}[1] : '4'
1088
1089 The keys of the C<%-> hash correspond to all buffer names found in
1090 the regular expression.
1091
1092 The behaviour of C<%-> is implemented via the
1093 L<Tie::Hash::NamedCapture> module.
1094
1095 B<Note:> C<%-> and C<%+> are tied views into a common internal hash
1096 associated with the last successful regular expression.  Therefore mixing
1097 iterative access to them via C<each> may have unpredictable results.
1098 Likewise, if the last successful match changes, then the results may be
1099 surprising.
1100
1101 This variable was added in Perl v5.10.0.
1102
1103 This variable is read-only and dynamically-scoped.
1104
1105 =item $LAST_REGEXP_CODE_RESULT
1106
1107 =item $^R
1108 X<$^R> X<$LAST_REGEXP_CODE_RESULT>
1109
1110 The result of evaluation of the last successful C<(?{ code })>
1111 regular expression assertion (see L<perlre>).  May be written to.
1112
1113 This variable was added in Perl 5.005.
1114
1115 =item ${^RE_DEBUG_FLAGS}
1116 X<${^RE_DEBUG_FLAGS}>
1117
1118 The current value of the regex debugging flags.  Set to 0 for no debug output
1119 even when the C<re 'debug'> module is loaded.  See L<re> for details.
1120
1121 This variable was added in Perl v5.10.0.
1122
1123 =item ${^RE_TRIE_MAXBUF}
1124 X<${^RE_TRIE_MAXBUF}>
1125
1126 Controls how certain regex optimisations are applied and how much memory they
1127 utilize.  This value by default is 65536 which corresponds to a 512kB
1128 temporary cache.  Set this to a higher value to trade
1129 memory for speed when matching large alternations.  Set
1130 it to a lower value if you want the optimisations to
1131 be as conservative of memory as possible but still occur, and set it to a
1132 negative value to prevent the optimisation and conserve the most memory.
1133 Under normal situations this variable should be of no interest to you.
1134
1135 This variable was added in Perl v5.10.0.
1136
1137 =back
1138
1139 =head2 Variables related to filehandles
1140
1141 Variables that depend on the currently selected filehandle may be set
1142 by calling an appropriate object method on the C<IO::Handle> object,
1143 although this is less efficient than using the regular built-in
1144 variables.  (Summary lines below for this contain the word HANDLE.)
1145 First you must say
1146
1147     use IO::Handle;
1148
1149 after which you may use either
1150
1151     method HANDLE EXPR
1152
1153 or more safely,
1154
1155     HANDLE->method(EXPR)
1156
1157 Each method returns the old value of the C<IO::Handle> attribute.  The
1158 methods each take an optional EXPR, which, if supplied, specifies the
1159 new value for the C<IO::Handle> attribute in question.  If not
1160 supplied, most methods do nothing to the current value--except for
1161 C<autoflush()>, which will assume a 1 for you, just to be different.
1162
1163 Because loading in the C<IO::Handle> class is an expensive operation,
1164 you should learn how to use the regular built-in variables.
1165
1166 A few of these variables are considered "read-only".  This means that
1167 if you try to assign to this variable, either directly or indirectly
1168 through a reference, you'll raise a run-time exception.
1169
1170 You should be very careful when modifying the default values of most
1171 special variables described in this document.  In most cases you want
1172 to localize these variables before changing them, since if you don't,
1173 the change may affect other modules which rely on the default values
1174 of the special variables that you have changed.  This is one of the
1175 correct ways to read the whole file at once:
1176
1177     open my $fh, "<", "foo" or die $!;
1178     local $/; # enable localized slurp mode
1179     my $content = <$fh>;
1180     close $fh;
1181
1182 But the following code is quite bad:
1183
1184     open my $fh, "<", "foo" or die $!;
1185     undef $/; # enable slurp mode
1186     my $content = <$fh>;
1187     close $fh;
1188
1189 since some other module, may want to read data from some file in the
1190 default "line mode", so if the code we have just presented has been
1191 executed, the global value of C<$/> is now changed for any other code
1192 running inside the same Perl interpreter.
1193
1194 Usually when a variable is localized you want to make sure that this
1195 change affects the shortest scope possible.  So unless you are already
1196 inside some short C<{}> block, you should create one yourself.  For
1197 example:
1198
1199     my $content = '';
1200     open my $fh, "<", "foo" or die $!;
1201     {
1202         local $/;
1203         $content = <$fh>;
1204     }
1205     close $fh;
1206
1207 Here is an example of how your own code can go broken:
1208
1209     for ( 1..3 ){
1210         $\ = "\r\n";
1211         nasty_break();
1212         print "$_";
1213     }
1214
1215     sub nasty_break {
1216         $\ = "\f";
1217         # do something with $_
1218     }
1219
1220 You probably expect this code to print the equivalent of
1221
1222     "1\r\n2\r\n3\r\n"
1223
1224 but instead you get:
1225
1226     "1\f2\f3\f"
1227
1228 Why? Because C<nasty_break()> modifies C<$\> without localizing it
1229 first.  The value you set in  C<nasty_break()> is still there when you
1230 return.  The fix is to add C<local()> so the value doesn't leak out of
1231 C<nasty_break()>:
1232
1233     local $\ = "\f";
1234
1235 It's easy to notice the problem in such a short example, but in more
1236 complicated code you are looking for trouble if you don't localize
1237 changes to the special variables.
1238
1239 =over 8
1240
1241 =item $ARGV
1242 X<$ARGV>
1243
1244 Contains the name of the current file when reading from C<< <> >>.
1245
1246 =item @ARGV
1247 X<@ARGV>
1248
1249 The array C<@ARGV> contains the command-line arguments intended for
1250 the script.  C<$#ARGV> is generally the number of arguments minus
1251 one, because C<$ARGV[0]> is the first argument, I<not> the program's
1252 command name itself.  See L</$0> for the command name.
1253
1254 =item ARGV
1255 X<ARGV>
1256
1257 The special filehandle that iterates over command-line filenames in
1258 C<@ARGV>.  Usually written as the null filehandle in the angle operator
1259 C<< <> >>.  Note that currently C<ARGV> only has its magical effect
1260 within the C<< <> >> operator; elsewhere it is just a plain filehandle
1261 corresponding to the last file opened by C<< <> >>.  In particular,
1262 passing C<\*ARGV> as a parameter to a function that expects a filehandle
1263 may not cause your function to automatically read the contents of all the
1264 files in C<@ARGV>.
1265
1266 =item ARGVOUT
1267 X<ARGVOUT>
1268
1269 The special filehandle that points to the currently open output file
1270 when doing edit-in-place processing with B<-i>.  Useful when you have
1271 to do a lot of inserting and don't want to keep modifying C<$_>.  See
1272 L<perlrun> for the B<-i> switch.
1273
1274 =item IO::Handle->output_field_separator( EXPR )
1275
1276 =item $OUTPUT_FIELD_SEPARATOR
1277
1278 =item $OFS
1279
1280 =item $,
1281 X<$,> X<$OFS> X<$OUTPUT_FIELD_SEPARATOR>
1282
1283 The output field separator for the print operator.  If defined, this
1284 value is printed between each of print's arguments.  Default is C<undef>.
1285
1286 You cannot call C<output_field_separator()> on a handle, only as a
1287 static method.  See L<IO::Handle|IO::Handle>.
1288
1289 Mnemonic: what is printed when there is a "," in your print statement.
1290
1291 =item HANDLE->input_line_number( EXPR )
1292
1293 =item $INPUT_LINE_NUMBER
1294
1295 =item $NR
1296
1297 =item $.
1298 X<$.> X<$NR> X<$INPUT_LINE_NUMBER> X<line number>
1299
1300 Current line number for the last filehandle accessed.
1301
1302 Each filehandle in Perl counts the number of lines that have been read
1303 from it.  (Depending on the value of C<$/>, Perl's idea of what
1304 constitutes a line may not match yours.)  When a line is read from a
1305 filehandle (via C<readline()> or C<< <> >>), or when C<tell()> or
1306 C<seek()> is called on it, C<$.> becomes an alias to the line counter
1307 for that filehandle.
1308
1309 You can adjust the counter by assigning to C<$.>, but this will not
1310 actually move the seek pointer.  I<Localizing C<$.> will not localize
1311 the filehandle's line count>.  Instead, it will localize perl's notion
1312 of which filehandle C<$.> is currently aliased to.
1313
1314 C<$.> is reset when the filehandle is closed, but B<not> when an open
1315 filehandle is reopened without an intervening C<close()>.  For more
1316 details, see L<perlop/"IE<sol>O Operators">.  Because C<< <> >> never does
1317 an explicit close, line numbers increase across C<ARGV> files (but see
1318 examples in L<perlfunc/eof>).
1319
1320 You can also use C<< HANDLE->input_line_number(EXPR) >> to access the
1321 line counter for a given filehandle without having to worry about
1322 which handle you last accessed.
1323
1324 Mnemonic: many programs use "." to mean the current line number.
1325
1326 =item IO::Handle->input_record_separator( EXPR )
1327
1328 =item $INPUT_RECORD_SEPARATOR
1329
1330 =item $RS
1331
1332 =item $/
1333 X<$/> X<$RS> X<$INPUT_RECORD_SEPARATOR>
1334
1335 The input record separator, newline by default.  This influences Perl's
1336 idea of what a "line" is.  Works like B<awk>'s RS variable, including
1337 treating empty lines as a terminator if set to the null string (an
1338 empty line cannot contain any spaces or tabs).  You may set it to a
1339 multi-character string to match a multi-character terminator, or to
1340 C<undef> to read through the end of file.  Setting it to C<"\n\n">
1341 means something slightly different than setting to C<"">, if the file
1342 contains consecutive empty lines.  Setting to C<""> will treat two or
1343 more consecutive empty lines as a single empty line.  Setting to
1344 C<"\n\n"> will blindly assume that the next input character belongs to
1345 the next paragraph, even if it's a newline.
1346
1347     local $/;           # enable "slurp" mode
1348     local $_ = <FH>;    # whole file now here
1349     s/\n[ \t]+/ /g;
1350
1351 Remember: the value of C<$/> is a string, not a regex.  B<awk> has to
1352 be better for something. :-)
1353
1354 Setting C<$/> to a reference to an integer, scalar containing an
1355 integer, or scalar that's convertible to an integer will attempt to
1356 read records instead of lines, with the maximum record size being the
1357 referenced integer number of characters.  So this:
1358
1359     local $/ = \32768; # or \"32768", or \$var_containing_32768
1360     open my $fh, "<", $myfile or die $!;
1361     local $_ = <$fh>;
1362
1363 will read a record of no more than 32768 characters from $fh.  If you're
1364 not reading from a record-oriented file (or your OS doesn't have
1365 record-oriented files), then you'll likely get a full chunk of data
1366 with every read.  If a record is larger than the record size you've
1367 set, you'll get the record back in pieces.  Trying to set the record
1368 size to zero or less will cause reading in the (rest of the) whole file.
1369
1370 On VMS only, record reads bypass PerlIO layers and any associated
1371 buffering, so you must not mix record and non-record reads on the
1372 same filehandle.  Record mode mixes with line mode only when the
1373 same buffering layer is in use for both modes.
1374
1375 You cannot call C<input_record_separator()> on a handle, only as a
1376 static method.  See L<IO::Handle|IO::Handle>.
1377
1378 See also L<perlport/"Newlines">.  Also see L</$.>.
1379
1380 Mnemonic: / delimits line boundaries when quoting poetry.
1381
1382 =item IO::Handle->output_record_separator( EXPR )
1383
1384 =item $OUTPUT_RECORD_SEPARATOR
1385
1386 =item $ORS
1387
1388 =item $\
1389 X<$\> X<$ORS> X<$OUTPUT_RECORD_SEPARATOR>
1390
1391 The output record separator for the print operator.  If defined, this
1392 value is printed after the last of print's arguments.  Default is C<undef>.
1393
1394 You cannot call C<output_record_separator()> on a handle, only as a
1395 static method.  See L<IO::Handle|IO::Handle>.
1396
1397 Mnemonic: you set C<$\> instead of adding "\n" at the end of the print.
1398 Also, it's just like C<$/>, but it's what you get "back" from Perl.
1399
1400 =item HANDLE->autoflush( EXPR )
1401
1402 =item $OUTPUT_AUTOFLUSH
1403
1404 =item $|
1405 X<$|> X<autoflush> X<flush> X<$OUTPUT_AUTOFLUSH>
1406
1407 If set to nonzero, forces a flush right away and after every write or
1408 print on the currently selected output channel.  Default is 0
1409 (regardless of whether the channel is really buffered by the system or
1410 not; C<$|> tells you only whether you've asked Perl explicitly to
1411 flush after each write).  STDOUT will typically be line buffered if
1412 output is to the terminal and block buffered otherwise.  Setting this
1413 variable is useful primarily when you are outputting to a pipe or
1414 socket, such as when you are running a Perl program under B<rsh> and
1415 want to see the output as it's happening.  This has no effect on input
1416 buffering.  See L<perlfunc/getc> for that.  See L<perlfunc/select> on
1417 how to select the output channel.  See also L<IO::Handle>.
1418
1419 Mnemonic: when you want your pipes to be piping hot.
1420
1421 =item ${^LAST_FH}
1422 X<${^LAST_FH}>
1423
1424 This read-only variable contains a reference to the last-read filehandle.
1425 This is set by C<< <HANDLE> >>, C<readline>, C<tell>, C<eof> and C<seek>.
1426 This is the same handle that C<$.> and C<tell> and C<eof> without arguments
1427 use.  It is also the handle used when Perl appends ", <STDIN> line 1" to
1428 an error or warning message.
1429
1430 This variable was added in Perl v5.18.0.
1431
1432 =back
1433
1434 =head3 Variables related to formats
1435
1436 The special variables for formats are a subset of those for
1437 filehandles.  See L<perlform> for more information about Perl's
1438 formats.
1439
1440 =over 8
1441
1442 =item $ACCUMULATOR
1443
1444 =item $^A
1445 X<$^A> X<$ACCUMULATOR>
1446
1447 The current value of the C<write()> accumulator for C<format()> lines.
1448 A format contains C<formline()> calls that put their result into
1449 C<$^A>.  After calling its format, C<write()> prints out the contents
1450 of C<$^A> and empties.  So you never really see the contents of C<$^A>
1451 unless you call C<formline()> yourself and then look at it.  See
1452 L<perlform> and L<perlfunc/"formline PICTURE,LIST">.
1453
1454 =item IO::Handle->format_formfeed(EXPR)
1455
1456 =item $FORMAT_FORMFEED
1457
1458 =item $^L
1459 X<$^L> X<$FORMAT_FORMFEED>
1460
1461 What formats output as a form feed.  The default is C<\f>.
1462
1463 You cannot call C<format_formfeed()> on a handle, only as a static
1464 method.  See L<IO::Handle|IO::Handle>.
1465
1466 =item HANDLE->format_page_number(EXPR)
1467
1468 =item $FORMAT_PAGE_NUMBER
1469
1470 =item $%
1471 X<$%> X<$FORMAT_PAGE_NUMBER>
1472
1473 The current page number of the currently selected output channel.
1474
1475 Mnemonic: C<%> is page number in B<nroff>.
1476
1477 =item HANDLE->format_lines_left(EXPR)
1478
1479 =item $FORMAT_LINES_LEFT
1480
1481 =item $-
1482 X<$-> X<$FORMAT_LINES_LEFT>
1483
1484 The number of lines left on the page of the currently selected output
1485 channel.
1486
1487 Mnemonic: lines_on_page - lines_printed.
1488
1489 =item IO::Handle->format_line_break_characters EXPR
1490
1491 =item $FORMAT_LINE_BREAK_CHARACTERS
1492
1493 =item $:
1494 X<$:> X<FORMAT_LINE_BREAK_CHARACTERS>
1495
1496 The current set of characters after which a string may be broken to
1497 fill continuation fields (starting with C<^>) in a format.  The default is
1498 S<" \n-">, to break on a space, newline, or a hyphen.
1499
1500 You cannot call C<format_line_break_characters()> on a handle, only as
1501 a static method.  See L<IO::Handle|IO::Handle>.
1502
1503 Mnemonic: a "colon" in poetry is a part of a line.
1504
1505 =item HANDLE->format_lines_per_page(EXPR)
1506
1507 =item $FORMAT_LINES_PER_PAGE
1508
1509 =item $=
1510 X<$=> X<$FORMAT_LINES_PER_PAGE>
1511
1512 The current page length (printable lines) of the currently selected
1513 output channel.  The default is 60.
1514
1515 Mnemonic: = has horizontal lines.
1516
1517 =item HANDLE->format_top_name(EXPR)
1518
1519 =item $FORMAT_TOP_NAME
1520
1521 =item $^
1522 X<$^> X<$FORMAT_TOP_NAME>
1523
1524 The name of the current top-of-page format for the currently selected
1525 output channel.  The default is the name of the filehandle with C<_TOP>
1526 appended.  For example, the default format top name for the C<STDOUT>
1527 filehandle is C<STDOUT_TOP>.
1528
1529 Mnemonic: points to top of page.
1530
1531 =item HANDLE->format_name(EXPR)
1532
1533 =item $FORMAT_NAME
1534
1535 =item $~
1536 X<$~> X<$FORMAT_NAME>
1537
1538 The name of the current report format for the currently selected
1539 output channel.  The default format name is the same as the filehandle
1540 name.  For example, the default format name for the C<STDOUT>
1541 filehandle is just C<STDOUT>.
1542
1543 Mnemonic: brother to C<$^>.
1544
1545 =back
1546
1547 =head2 Error Variables
1548 X<error> X<exception>
1549
1550 The variables C<$@>, C<$!>, C<$^E>, and C<$?> contain information
1551 about different types of error conditions that may appear during
1552 execution of a Perl program.  The variables are shown ordered by
1553 the "distance" between the subsystem which reported the error and
1554 the Perl process.  They correspond to errors detected by the Perl
1555 interpreter, C library, operating system, or an external program,
1556 respectively.
1557
1558 To illustrate the differences between these variables, consider the
1559 following Perl expression, which uses a single-quoted string.  After
1560 execution of this statement, perl may have set all four special error
1561 variables:
1562
1563     eval q{
1564         open my $pipe, "/cdrom/install |" or die $!;
1565         my @res = <$pipe>;
1566         close $pipe or die "bad pipe: $?, $!";
1567     };
1568
1569 When perl executes the C<eval()> expression, it translates the
1570 C<open()>, C<< <PIPE> >>, and C<close> calls in the C run-time library
1571 and thence to the operating system kernel.  perl sets C<$!> to
1572 the C library's C<errno> if one of these calls fails.
1573
1574 C<$@> is set if the string to be C<eval>-ed did not compile (this may
1575 happen if C<open> or C<close> were imported with bad prototypes), or
1576 if Perl code executed during evaluation C<die()>d.  In these cases the
1577 value of C<$@> is the compile error, or the argument to C<die> (which
1578 will interpolate C<$!> and C<$?>).  (See also L<Fatal>, though.)
1579
1580 Under a few operating systems, C<$^E> may contain a more verbose error
1581 indicator, such as in this case, "CDROM tray not closed."  Systems that
1582 do not support extended error messages leave C<$^E> the same as C<$!>.
1583
1584 Finally, C<$?> may be set to non-0 value if the external program
1585 F</cdrom/install> fails.  The upper eight bits reflect specific error
1586 conditions encountered by the program (the program's C<exit()> value).
1587 The lower eight bits reflect mode of failure, like signal death and
1588 core dump information.  See L<wait(2)> for details.  In contrast to
1589 C<$!> and C<$^E>, which are set only if error condition is detected,
1590 the variable C<$?> is set on each C<wait> or pipe C<close>,
1591 overwriting the old value.  This is more like C<$@>, which on every
1592 C<eval()> is always set on failure and cleared on success.
1593
1594 For more details, see the individual descriptions at C<$@>, C<$!>,
1595 C<$^E>, and C<$?>.
1596
1597 =over 8
1598
1599 =item ${^CHILD_ERROR_NATIVE}
1600 X<$^CHILD_ERROR_NATIVE>
1601
1602 The native status returned by the last pipe close, backtick (C<``>)
1603 command, successful call to C<wait()> or C<waitpid()>, or from the
1604 C<system()> operator.  On POSIX-like systems this value can be decoded
1605 with the WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WIFSTOPPED,
1606 WSTOPSIG and WIFCONTINUED functions provided by the L<POSIX> module.
1607
1608 Under VMS this reflects the actual VMS exit status; i.e. it is the
1609 same as C<$?> when the pragma C<use vmsish 'status'> is in effect.
1610
1611 This variable was added in Perl v5.10.0.
1612
1613 =item $EXTENDED_OS_ERROR
1614
1615 =item $^E
1616 X<$^E> X<$EXTENDED_OS_ERROR>
1617
1618 Error information specific to the current operating system.  At the
1619 moment, this differs from C<$!> under only VMS, OS/2, and Win32 (and
1620 for MacPerl).  On all other platforms, C<$^E> is always just the same
1621 as C<$!>.
1622
1623 Under VMS, C<$^E> provides the VMS status value from the last system
1624 error.  This is more specific information about the last system error
1625 than that provided by C<$!>.  This is particularly important when C<$!>
1626 is set to B<EVMSERR>.
1627
1628 Under OS/2, C<$^E> is set to the error code of the last call to OS/2
1629 API either via CRT, or directly from perl.
1630
1631 Under Win32, C<$^E> always returns the last error information reported
1632 by the Win32 call C<GetLastError()> which describes the last error
1633 from within the Win32 API.  Most Win32-specific code will report errors
1634 via C<$^E>.  ANSI C and Unix-like calls set C<errno> and so most
1635 portable Perl code will report errors via C<$!>.
1636
1637 Caveats mentioned in the description of C<$!> generally apply to
1638 C<$^E>, also.
1639
1640 This variable was added in Perl 5.003.
1641
1642 Mnemonic: Extra error explanation.
1643
1644 =item $EXCEPTIONS_BEING_CAUGHT
1645
1646 =item $^S
1647 X<$^S> X<$EXCEPTIONS_BEING_CAUGHT>
1648
1649 Current state of the interpreter.
1650
1651         $^S         State
1652         ---------   -------------------------------------
1653         undef       Parsing module, eval, or main program
1654         true (1)    Executing an eval
1655         false (0)   Otherwise
1656
1657 The first state may happen in C<$SIG{__DIE__}> and C<$SIG{__WARN__}>
1658 handlers.
1659
1660 The English name $EXCEPTIONS_BEING_CAUGHT is slightly misleading, because
1661 the C<undef> value does not indicate whether exceptions are being caught,
1662 since compilation of the main program does not catch exceptions.
1663
1664 This variable was added in Perl 5.004.
1665
1666 =item $WARNING
1667
1668 =item $^W
1669 X<$^W> X<$WARNING>
1670
1671 The current value of the warning switch, initially true if B<-w> was
1672 used, false otherwise, but directly modifiable.
1673
1674 See also L<warnings>.
1675
1676 Mnemonic: related to the B<-w> switch.
1677
1678 =item ${^WARNING_BITS}
1679 X<${^WARNING_BITS}>
1680
1681 The current set of warning checks enabled by the C<use warnings> pragma.
1682 It has the same scoping as the C<$^H> and C<%^H> variables.  The exact
1683 values are considered internal to the L<warnings> pragma and may change
1684 between versions of Perl.
1685
1686 This variable was added in Perl v5.6.0.
1687
1688 =item $OS_ERROR
1689
1690 =item $ERRNO
1691
1692 =item $!
1693 X<$!> X<$ERRNO> X<$OS_ERROR>
1694
1695 When referenced, C<$!> retrieves the current value
1696 of the C C<errno> integer variable.
1697 If C<$!> is assigned a numerical value, that value is stored in C<errno>.
1698 When referenced as a string, C<$!> yields the system error string
1699 corresponding to C<errno>.
1700
1701 Many system or library calls set C<errno> if they fail,
1702 to indicate the cause of failure.  They usually do B<not>
1703 set C<errno> to zero if they succeed.  This means C<errno>,
1704 hence C<$!>, is meaningful only I<immediately> after a B<failure>:
1705
1706     if (open my $fh, "<", $filename) {
1707                 # Here $! is meaningless.
1708                 ...
1709     }
1710     else {
1711                 # ONLY here is $! meaningful.
1712                 ...
1713                 # Already here $! might be meaningless.
1714     }
1715     # Since here we might have either success or failure,
1716     # $! is meaningless.
1717
1718 Here, I<meaningless> means that C<$!> may be unrelated to the outcome
1719 of the C<open()> operator.  Assignment to C<$!> is similarly ephemeral.
1720 It can be used immediately before invoking the C<die()> operator,
1721 to set the exit value, or to inspect the system error string
1722 corresponding to error I<n>, or to restore C<$!> to a meaningful state.
1723
1724 Mnemonic: What just went bang?
1725
1726 =item %OS_ERROR
1727
1728 =item %ERRNO
1729
1730 =item %!
1731 X<%!> X<%OS_ERROR> X<%ERRNO>
1732
1733 Each element of C<%!> has a true value only if C<$!> is set to that
1734 value.  For example, C<$!{ENOENT}> is true if and only if the current
1735 value of C<$!> is C<ENOENT>; that is, if the most recent error was "No
1736 such file or directory" (or its moral equivalent: not all operating
1737 systems give that exact error, and certainly not all languages).  To
1738 check if a particular key is meaningful on your system, use C<exists
1739 $!{the_key}>; for a list of legal keys, use C<keys %!>.  See L<Errno>
1740 for more information, and also see L</$!>.
1741
1742 This variable was added in Perl 5.005.
1743
1744 =item $CHILD_ERROR
1745
1746 =item $?
1747 X<$?> X<$CHILD_ERROR>
1748
1749 The status returned by the last pipe close, backtick (C<``>) command,
1750 successful call to C<wait()> or C<waitpid()>, or from the C<system()>
1751 operator.  This is just the 16-bit status word returned by the
1752 traditional Unix C<wait()> system call (or else is made up to look
1753 like it).  Thus, the exit value of the subprocess is really (C<<< $? >>
1754 8 >>>), and C<$? & 127> gives which signal, if any, the process died
1755 from, and C<$? & 128> reports whether there was a core dump.
1756
1757 Additionally, if the C<h_errno> variable is supported in C, its value
1758 is returned via C<$?> if any C<gethost*()> function fails.
1759
1760 If you have installed a signal handler for C<SIGCHLD>, the
1761 value of C<$?> will usually be wrong outside that handler.
1762
1763 Inside an C<END> subroutine C<$?> contains the value that is going to be
1764 given to C<exit()>.  You can modify C<$?> in an C<END> subroutine to
1765 change the exit status of your program.  For example:
1766
1767     END {
1768         $? = 1 if $? == 255;  # die would make it 255
1769     }
1770
1771 Under VMS, the pragma C<use vmsish 'status'> makes C<$?> reflect the
1772 actual VMS exit status, instead of the default emulation of POSIX
1773 status; see L<perlvms/$?> for details.
1774
1775 Mnemonic: similar to B<sh> and B<ksh>.
1776
1777 =item $EVAL_ERROR
1778
1779 =item $@
1780 X<$@> X<$EVAL_ERROR>
1781
1782 The Perl syntax error message from the
1783 last C<eval()> operator.  If C<$@> is
1784 the null string, the last C<eval()> parsed and executed correctly
1785 (although the operations you invoked may have failed in the normal
1786 fashion).
1787
1788 Warning messages are not collected in this variable.  You can, however,
1789 set up a routine to process warnings by setting C<$SIG{__WARN__}> as
1790 described in L</%SIG>.
1791
1792 Mnemonic: Where was the syntax error "at"?
1793
1794 =back
1795
1796 =head2 Variables related to the interpreter state
1797
1798 These variables provide information about the current interpreter state.
1799
1800 =over 8
1801
1802 =item $COMPILING
1803
1804 =item $^C
1805 X<$^C> X<$COMPILING>
1806
1807 The current value of the flag associated with the B<-c> switch.
1808 Mainly of use with B<-MO=...> to allow code to alter its behavior
1809 when being compiled, such as for example to C<AUTOLOAD> at compile
1810 time rather than normal, deferred loading.  Setting
1811 C<$^C = 1> is similar to calling C<B::minus_c>.
1812
1813 This variable was added in Perl v5.6.0.
1814
1815 =item $DEBUGGING
1816
1817 =item $^D
1818 X<$^D> X<$DEBUGGING>
1819
1820 The current value of the debugging flags.  May be read or set.  Like its
1821 command-line equivalent, you can use numeric or symbolic values, eg
1822 C<$^D = 10> or C<$^D = "st">.
1823
1824 Mnemonic: value of B<-D> switch.
1825
1826 =item ${^ENCODING}
1827 X<${^ENCODING}>
1828
1829 The I<object reference> to the C<Encode> object that is used to convert
1830 the source code to Unicode.  Thanks to this variable your Perl script
1831 does not have to be written in UTF-8.  Default is I<undef>.  The direct
1832 manipulation of this variable is highly discouraged.
1833
1834 This variable was added in Perl 5.8.2.
1835
1836 =item ${^GLOBAL_PHASE}
1837 X<${^GLOBAL_PHASE}>
1838
1839 The current phase of the perl interpreter.
1840
1841 Possible values are:
1842
1843 =over 8
1844
1845 =item CONSTRUCT
1846
1847 The C<PerlInterpreter*> is being constructed via C<perl_construct>.  This
1848 value is mostly there for completeness and for use via the
1849 underlying C variable C<PL_phase>.  It's not really possible for Perl
1850 code to be executed unless construction of the interpreter is
1851 finished.
1852
1853 =item START
1854
1855 This is the global compile-time.  That includes, basically, every
1856 C<BEGIN> block executed directly or indirectly from during the
1857 compile-time of the top-level program.
1858
1859 This phase is not called "BEGIN" to avoid confusion with
1860 C<BEGIN>-blocks, as those are executed during compile-time of any
1861 compilation unit, not just the top-level program.  A new, localised
1862 compile-time entered at run-time, for example by constructs as
1863 C<eval "use SomeModule"> are not global interpreter phases, and
1864 therefore aren't reflected by C<${^GLOBAL_PHASE}>.
1865
1866 =item CHECK
1867
1868 Execution of any C<CHECK> blocks.
1869
1870 =item INIT
1871
1872 Similar to "CHECK", but for C<INIT>-blocks, not C<CHECK> blocks.
1873
1874 =item RUN
1875
1876 The main run-time, i.e. the execution of C<PL_main_root>.
1877
1878 =item END
1879
1880 Execution of any C<END> blocks.
1881
1882 =item DESTRUCT
1883
1884 Global destruction.
1885
1886 =back
1887
1888 Also note that there's no value for UNITCHECK-blocks.  That's because
1889 those are run for each compilation unit individually, and therefore is
1890 not a global interpreter phase.
1891
1892 Not every program has to go through each of the possible phases, but
1893 transition from one phase to another can only happen in the order
1894 described in the above list.
1895
1896 An example of all of the phases Perl code can see:
1897
1898     BEGIN { print "compile-time: ${^GLOBAL_PHASE}\n" }
1899
1900     INIT  { print "init-time: ${^GLOBAL_PHASE}\n" }
1901
1902     CHECK { print "check-time: ${^GLOBAL_PHASE}\n" }
1903
1904     {
1905         package Print::Phase;
1906
1907         sub new {
1908             my ($class, $time) = @_;
1909             return bless \$time, $class;
1910         }
1911
1912         sub DESTROY {
1913             my $self = shift;
1914             print "$$self: ${^GLOBAL_PHASE}\n";
1915         }
1916     }
1917
1918     print "run-time: ${^GLOBAL_PHASE}\n";
1919
1920     my $runtime = Print::Phase->new(
1921         "lexical variables are garbage collected before END"
1922     );
1923
1924     END   { print "end-time: ${^GLOBAL_PHASE}\n" }
1925
1926     our $destruct = Print::Phase->new(
1927         "package variables are garbage collected after END"
1928     );
1929
1930 This will print out
1931
1932     compile-time: START
1933     check-time: CHECK
1934     init-time: INIT
1935     run-time: RUN
1936     lexical variables are garbage collected before END: RUN
1937     end-time: END
1938     package variables are garbage collected after END: DESTRUCT
1939
1940 This variable was added in Perl 5.14.0.
1941
1942 =item $^H
1943 X<$^H>
1944
1945 WARNING: This variable is strictly for
1946 internal use only.  Its availability,
1947 behavior, and contents are subject to change without notice.
1948
1949 This variable contains compile-time hints for the Perl interpreter.  At the
1950 end of compilation of a BLOCK the value of this variable is restored to the
1951 value when the interpreter started to compile the BLOCK.
1952
1953 When perl begins to parse any block construct that provides a lexical scope
1954 (e.g., eval body, required file, subroutine body, loop body, or conditional
1955 block), the existing value of C<$^H> is saved, but its value is left unchanged.
1956 When the compilation of the block is completed, it regains the saved value.
1957 Between the points where its value is saved and restored, code that
1958 executes within BEGIN blocks is free to change the value of C<$^H>.
1959
1960 This behavior provides the semantic of lexical scoping, and is used in,
1961 for instance, the C<use strict> pragma.
1962
1963 The contents should be an integer; different bits of it are used for
1964 different pragmatic flags.  Here's an example:
1965
1966     sub add_100 { $^H |= 0x100 }
1967
1968     sub foo {
1969         BEGIN { add_100() }
1970         bar->baz($boon);
1971     }
1972
1973 Consider what happens during execution of the BEGIN block.  At this point
1974 the BEGIN block has already been compiled, but the body of C<foo()> is still
1975 being compiled.  The new value of C<$^H>
1976 will therefore be visible only while
1977 the body of C<foo()> is being compiled.
1978
1979 Substitution of C<BEGIN { add_100() }> block with:
1980
1981     BEGIN { require strict; strict->import('vars') }
1982
1983 demonstrates how C<use strict 'vars'> is implemented.  Here's a conditional
1984 version of the same lexical pragma:
1985
1986     BEGIN {
1987         require strict; strict->import('vars') if $condition
1988     }
1989
1990 This variable was added in Perl 5.003.
1991
1992 =item %^H
1993 X<%^H>
1994
1995 The C<%^H> hash provides the same scoping semantic as C<$^H>.  This makes
1996 it useful for implementation of lexically scoped pragmas.  See
1997 L<perlpragma>.
1998
1999 When putting items into C<%^H>, in order to avoid conflicting with other
2000 users of the hash there is a convention regarding which keys to use.
2001 A module should use only keys that begin with the module's name (the
2002 name of its main package) and a "/" character.  For example, a module
2003 C<Foo::Bar> should use keys such as C<Foo::Bar/baz>.
2004
2005 This variable was added in Perl v5.6.0.
2006
2007 =item ${^OPEN}
2008 X<${^OPEN}>
2009
2010 An internal variable used by PerlIO.  A string in two parts, separated
2011 by a C<\0> byte, the first part describes the input layers, the second
2012 part describes the output layers.
2013
2014 This variable was added in Perl v5.8.0.
2015
2016 =item $PERLDB
2017
2018 =item $^P
2019 X<$^P> X<$PERLDB>
2020
2021 The internal variable for debugging support.  The meanings of the
2022 various bits are subject to change, but currently indicate:
2023
2024 =over 6
2025
2026 =item 0x01
2027
2028 Debug subroutine enter/exit.
2029
2030 =item 0x02
2031
2032 Line-by-line debugging.  Causes C<DB::DB()> subroutine to be called for
2033 each statement executed.  Also causes saving source code lines (like
2034 0x400).
2035
2036 =item 0x04
2037
2038 Switch off optimizations.
2039
2040 =item 0x08
2041
2042 Preserve more data for future interactive inspections.
2043
2044 =item 0x10
2045
2046 Keep info about source lines on which a subroutine is defined.
2047
2048 =item 0x20
2049
2050 Start with single-step on.
2051
2052 =item 0x40
2053
2054 Use subroutine address instead of name when reporting.
2055
2056 =item 0x80
2057
2058 Report C<goto &subroutine> as well.
2059
2060 =item 0x100
2061
2062 Provide informative "file" names for evals based on the place they were compiled.
2063
2064 =item 0x200
2065
2066 Provide informative names to anonymous subroutines based on the place they
2067 were compiled.
2068
2069 =item 0x400
2070
2071 Save source code lines into C<@{"_<$filename"}>.
2072
2073 =back
2074
2075 Some bits may be relevant at compile-time only, some at
2076 run-time only.  This is a new mechanism and the details may change.
2077 See also L<perldebguts>.
2078
2079 =item ${^TAINT}
2080 X<${^TAINT}>
2081
2082 Reflects if taint mode is on or off.  1 for on (the program was run with
2083 B<-T>), 0 for off, -1 when only taint warnings are enabled (i.e. with
2084 B<-t> or B<-TU>).
2085
2086 This variable is read-only.
2087
2088 This variable was added in Perl v5.8.0.
2089
2090 =item ${^UNICODE}
2091 X<${^UNICODE}>
2092
2093 Reflects certain Unicode settings of Perl.  See L<perlrun>
2094 documentation for the C<-C> switch for more information about
2095 the possible values.
2096
2097 This variable is set during Perl startup and is thereafter read-only.
2098
2099 This variable was added in Perl v5.8.2.
2100
2101 =item ${^UTF8CACHE}
2102 X<${^UTF8CACHE}>
2103
2104 This variable controls the state of the internal UTF-8 offset caching code.
2105 1 for on (the default), 0 for off, -1 to debug the caching code by checking
2106 all its results against linear scans, and panicking on any discrepancy.
2107
2108 This variable was added in Perl v5.8.9.  It is subject to change or
2109 removal without notice, but is currently used to avoid recalculating the
2110 boundaries of multi-byte UTF-8-encoded characters.
2111
2112 =item ${^UTF8LOCALE}
2113 X<${^UTF8LOCALE}>
2114
2115 This variable indicates whether a UTF-8 locale was detected by perl at
2116 startup.  This information is used by perl when it's in
2117 adjust-utf8ness-to-locale mode (as when run with the C<-CL> command-line
2118 switch); see L<perlrun> for more info on this.
2119
2120 This variable was added in Perl v5.8.8.
2121
2122 =back
2123
2124 =head2 Deprecated and removed variables
2125
2126 Deprecating a variable announces the intent of the perl maintainers to
2127 eventually remove the variable from the language.  It may still be
2128 available despite its status.  Using a deprecated variable triggers
2129 a warning.
2130
2131 Once a variable is removed, its use triggers an error telling you
2132 the variable is unsupported.
2133
2134 See L<perldiag> for details about error messages.
2135
2136 =over 8
2137
2138 =item $OFMT
2139
2140 =item $#
2141 X<$#> X<$OFMT>
2142
2143 C<$#> was a variable that could be used to format printed numbers.
2144 After a deprecation cycle, its magic was removed in Perl v5.10.0 and
2145 using it now triggers a warning: C<$# is no longer supported>.
2146
2147 This is not the sigil you use in front of an array name to get the
2148 last index, like C<$#array>.  That's still how you get the last index
2149 of an array in Perl.  The two have nothing to do with each other.
2150
2151 Deprecated in Perl 5.
2152
2153 Removed in Perl v5.10.0.
2154
2155 =item $*
2156 X<$*>
2157
2158 C<$*> was a variable that you could use to enable multiline matching.
2159 After a deprecation cycle, its magic was removed in Perl v5.10.0.
2160 Using it now triggers a warning: C<$* is no longer supported>.
2161 You should use the C</s> and C</m> regexp modifiers instead.
2162
2163 Deprecated in Perl 5.
2164
2165 Removed in Perl v5.10.0.
2166
2167 =item $ARRAY_BASE
2168
2169 =item $[
2170 X<$[> X<$ARRAY_BASE>
2171
2172 This variable stores the index of the first element in an array, and
2173 of the first character in a substring.  The default is 0, but you could
2174 theoretically set it to 1 to make Perl behave more like B<awk> (or Fortran)
2175 when subscripting and when evaluating the index() and substr() functions.
2176
2177 As of release 5 of Perl, assignment to C<$[> is treated as a compiler
2178 directive, and cannot influence the behavior of any other file.
2179 (That's why you can only assign compile-time constants to it.)
2180 Its use is highly discouraged.
2181
2182 Prior to Perl v5.10.0, assignment to C<$[> could be seen from outer lexical
2183 scopes in the same file, unlike other compile-time directives (such as
2184 L<strict>).  Using local() on it would bind its value strictly to a lexical
2185 block.  Now it is always lexically scoped.
2186
2187 As of Perl v5.16.0, it is implemented by the L<arybase> module.  See
2188 L<arybase> for more details on its behaviour.
2189
2190 Under C<use v5.16>, or C<no feature "array_base">, C<$[> no longer has any
2191 effect, and always contains 0.  Assigning 0 to it is permitted, but any
2192 other value will produce an error.
2193
2194 Mnemonic: [ begins subscripts.
2195
2196 Deprecated in Perl v5.12.0.
2197
2198 =item $OLD_PERL_VERSION
2199
2200 =item $]
2201 X<$]> X<$OLD_PERL_VERSION>
2202
2203 See L</$^V> for a more modern representation of the Perl version that allows
2204 accurate string comparisons.
2205
2206 The version + patchlevel / 1000 of the Perl interpreter.  This variable
2207 can be used to determine whether the Perl interpreter executing a
2208 script is in the right range of versions:
2209
2210     warn "No checksumming!\n" if $] < 3.019;
2211
2212 The floating point representation can sometimes lead to inaccurate
2213 numeric comparisons.
2214
2215 See also the documentation of C<use VERSION> and C<require VERSION>
2216 for a convenient way to fail if the running Perl interpreter is too old.
2217
2218 Mnemonic: Is this version of perl in the right bracket?
2219
2220 =back
2221
2222 =cut