home *** CD-ROM | disk | FTP | other *** search
/ Chip: Windows 2000 Professional Resource Kit / W2KPRK.iso / apps / perl / ActivePerl.exe / data.z / perlvar.pod < prev    next >
Encoding:
Text File  |  1999-10-14  |  33.6 KB  |  1,013 lines

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