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