Create perldelta for 5.14.3
[perl.git] / pod / perlrun.pod
1 =head1 NAME
2
3 perlrun - how to execute the Perl interpreter
4
5 =head1 SYNOPSIS
6
7 B<perl> S<[ B<-sTtuUWX> ]>
8         S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
9         S<[ B<-cw> ] [ B<-d>[B<t>][:I<debugger>] ] [ B<-D>[I<number/list>] ]>
10         S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal/hexadecimal>] ]>
11         S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ] [ B<-f> ]>
12         S<[ B<-C [I<number/list>] >]>
13         S<[ B<-S> ]>
14         S<[ B<-x>[I<dir>] ]>
15         S<[ B<-i>[I<extension>] ]>
16         S<[ [B<-e>|B<-E>] I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
17
18 =head1 DESCRIPTION
19
20 The normal way to run a Perl program is by making it directly
21 executable, or else by passing the name of the source file as an
22 argument on the command line.  (An interactive Perl environment
23 is also possible--see L<perldebug> for details on how to do that.)
24 Upon startup, Perl looks for your program in one of the following
25 places:
26
27 =over 4
28
29 =item 1.
30
31 Specified line by line via B<-e> or B<-E> switches on the command line.
32
33 =item 2.
34
35 Contained in the file specified by the first filename on the command line.
36 (Note that systems supporting the C<#!> notation invoke interpreters this
37 way. See L<Location of Perl>.)
38
39 =item 3.
40
41 Passed in implicitly via standard input.  This works only if there are
42 no filename arguments--to pass arguments to a STDIN-read program you
43 must explicitly specify a "-" for the program name.
44
45 =back
46
47 With methods 2 and 3, Perl starts parsing the input file from the
48 beginning, unless you've specified a B<-x> switch, in which case it
49 scans for the first line starting with C<#!> and containing the word
50 "perl", and starts there instead.  This is useful for running a program
51 embedded in a larger message.  (In this case you would indicate the end
52 of the program using the C<__END__> token.)
53
54 The C<#!> line is always examined for switches as the line is being
55 parsed.  Thus, if you're on a machine that allows only one argument
56 with the C<#!> line, or worse, doesn't even recognize the C<#!> line, you
57 still can get consistent switch behaviour regardless of how Perl was
58 invoked, even if B<-x> was used to find the beginning of the program.
59
60 Because historically some operating systems silently chopped off
61 kernel interpretation of the C<#!> line after 32 characters, some
62 switches may be passed in on the command line, and some may not;
63 you could even get a "-" without its letter, if you're not careful.
64 You probably want to make sure that all your switches fall either
65 before or after that 32-character boundary.  Most switches don't
66 actually care if they're processed redundantly, but getting a "-"
67 instead of a complete switch could cause Perl to try to execute
68 standard input instead of your program.  And a partial B<-I> switch
69 could also cause odd results.
70
71 Some switches do care if they are processed twice, for instance
72 combinations of B<-l> and B<-0>.  Either put all the switches after
73 the 32-character boundary (if applicable), or replace the use of
74 B<-0>I<digits> by C<BEGIN{ $/ = "\0digits"; }>.
75
76 Parsing of the C<#!> switches starts wherever "perl" is mentioned in the line.
77 The sequences "-*" and "- " are specifically ignored so that you could,
78 if you were so inclined, say
79
80     #!/bin/sh
81     #! -*-perl-*-
82     eval 'exec perl -x -wS $0 ${1+"$@"}'
83         if 0;
84
85 to let Perl see the B<-p> switch.
86
87 A similar trick involves the I<env> program, if you have it.
88
89     #!/usr/bin/env perl
90
91 The examples above use a relative path to the perl interpreter,
92 getting whatever version is first in the user's path.  If you want
93 a specific version of Perl, say, perl5.005_57, you should place
94 that directly in the C<#!> line's path.
95
96 If the C<#!> line does not contain the word "perl", the program named after
97 the C<#!> is executed instead of the Perl interpreter.  This is slightly
98 bizarre, but it helps people on machines that don't do C<#!>, because they
99 can tell a program that their SHELL is F</usr/bin/perl>, and Perl will then
100 dispatch the program to the correct interpreter for them.
101
102 After locating your program, Perl compiles the entire program to an
103 internal form.  If there are any compilation errors, execution of the
104 program is not attempted.  (This is unlike the typical shell script,
105 which might run part-way through before finding a syntax error.)
106
107 If the program is syntactically correct, it is executed.  If the program
108 runs off the end without hitting an exit() or die() operator, an implicit
109 C<exit(0)> is provided to indicate successful completion.
110
111 =head2 #! and quoting on non-Unix systems
112 X<hashbang> X<#!>
113
114 Unix's C<#!> technique can be simulated on other systems:
115
116 =over 4
117
118 =item OS/2
119
120 Put
121
122     extproc perl -S -your_switches
123
124 as the first line in C<*.cmd> file (B<-S> due to a bug in cmd.exe's
125 `extproc' handling).
126
127 =item MS-DOS
128
129 Create a batch file to run your program, and codify it in
130 C<ALTERNATE_SHEBANG> (see the F<dosish.h> file in the source
131 distribution for more information).
132
133 =item Win95/NT
134
135 The Win95/NT installation, when using the ActiveState installer for Perl,
136 will modify the Registry to associate the F<.pl> extension with the perl
137 interpreter.  If you install Perl by other means (including building from
138 the sources), you may have to modify the Registry yourself.  Note that
139 this means you can no longer tell the difference between an executable
140 Perl program and a Perl library file.
141
142 =item VMS
143
144 Put
145
146     $ perl -mysw 'f$env("procedure")' 'p1' 'p2' 'p3' 'p4' 'p5' 'p6' 'p7' 'p8' !
147     $ exit++ + ++$status != 0 and $exit = $status = undef;
148
149 at the top of your program, where B<-mysw> are any command line switches you
150 want to pass to Perl.  You can now invoke the program directly, by saying
151 C<perl program>, or as a DCL procedure, by saying C<@program> (or implicitly
152 via F<DCL$PATH> by just using the name of the program).
153
154 This incantation is a bit much to remember, but Perl will display it for
155 you if you say C<perl "-V:startperl">.
156
157 =back
158
159 Command-interpreters on non-Unix systems have rather different ideas
160 on quoting than Unix shells.  You'll need to learn the special
161 characters in your command-interpreter (C<*>, C<\> and C<"> are
162 common) and how to protect whitespace and these characters to run
163 one-liners (see B<-e> below).
164
165 On some systems, you may have to change single-quotes to double ones,
166 which you must I<not> do on Unix or Plan 9 systems.  You might also
167 have to change a single % to a %%.
168
169 For example:
170
171     # Unix
172     perl -e 'print "Hello world\n"'
173
174     # MS-DOS, etc.
175     perl -e "print \"Hello world\n\""
176
177     # VMS
178     perl -e "print ""Hello world\n"""
179
180 The problem is that none of this is reliable: it depends on the
181 command and it is entirely possible neither works.  If I<4DOS> were
182 the command shell, this would probably work better:
183
184     perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>""
185
186 B<CMD.EXE> in Windows NT slipped a lot of standard Unix functionality in
187 when nobody was looking, but just try to find documentation for its
188 quoting rules.
189
190 There is no general solution to all of this.  It's just a mess.
191
192 =head2 Location of Perl
193 X<perl, location of interpreter>
194
195 It may seem obvious to say, but Perl is useful only when users can
196 easily find it.  When possible, it's good for both F</usr/bin/perl>
197 and F</usr/local/bin/perl> to be symlinks to the actual binary.  If
198 that can't be done, system administrators are strongly encouraged
199 to put (symlinks to) perl and its accompanying utilities into a
200 directory typically found along a user's PATH, or in some other
201 obvious and convenient place.
202
203 In this documentation, C<#!/usr/bin/perl> on the first line of the program
204 will stand in for whatever method works on your system.  You are
205 advised to use a specific path if you care about a specific version.
206
207     #!/usr/local/bin/perl5.00554
208
209 or if you just want to be running at least version, place a statement
210 like this at the top of your program:
211
212     use 5.005_54;
213
214 =head2 Command Switches
215 X<perl, command switches> X<command switches>
216
217 As with all standard commands, a single-character switch may be
218 clustered with the following switch, if any.
219
220     #!/usr/bin/perl -spi.orig   # same as -s -p -i.orig
221
222 Switches include:
223
224 =over 5
225
226 =item B<-0>[I<octal/hexadecimal>]
227 X<-0> X<$/>
228
229 specifies the input record separator (C<$/>) as an octal or
230 hexadecimal number.  If there are no digits, the null character is the
231 separator.  Other switches may precede or follow the digits.  For
232 example, if you have a version of I<find> which can print filenames
233 terminated by the null character, you can say this:
234
235     find . -name '*.orig' -print0 | perl -n0e unlink
236
237 The special value 00 will cause Perl to slurp files in paragraph mode.
238 Any value 0400 or above will cause Perl to slurp files whole, but by convention
239 the value 0777 is the one normally used for this purpose.
240
241 You can also specify the separator character using hexadecimal notation:
242 B<-0xI<HHH...>>, where the C<I<H>> are valid hexadecimal digits.  Unlike
243 the octal form, this one may be used to specify any Unicode character, even
244 those beyond 0xFF.  So if you I<really> want a record separator of 0777,
245 specify it as B<-0x1FF>.  (This means that you cannot use the B<-x> option
246 with a directory name that consists of hexadecimal digits, or else Perl
247 will think you have specified a hex number to B<-0>.)
248
249 =item B<-a>
250 X<-a> X<autosplit>
251
252 turns on autosplit mode when used with a B<-n> or B<-p>.  An implicit
253 split command to the @F array is done as the first thing inside the
254 implicit while loop produced by the B<-n> or B<-p>.
255
256     perl -ane 'print pop(@F), "\n";'
257
258 is equivalent to
259
260     while (<>) {
261         @F = split(' ');
262         print pop(@F), "\n";
263     }
264
265 An alternate delimiter may be specified using B<-F>.
266
267 =item B<-C [I<number/list>]>
268 X<-C>
269
270 The B<-C> flag controls some of the Perl Unicode features.
271
272 As of 5.8.1, the B<-C> can be followed either by a number or a list
273 of option letters.  The letters, their numeric values, and effects
274 are as follows; listing the letters is equal to summing the numbers.
275
276     I     1   STDIN is assumed to be in UTF-8
277     O     2   STDOUT will be in UTF-8
278     E     4   STDERR will be in UTF-8
279     S     7   I + O + E
280     i     8   UTF-8 is the default PerlIO layer for input streams
281     o    16   UTF-8 is the default PerlIO layer for output streams
282     D    24   i + o
283     A    32   the @ARGV elements are expected to be strings encoded
284               in UTF-8
285     L    64   normally the "IOEioA" are unconditional,
286               the L makes them conditional on the locale environment
287               variables (the LC_ALL, LC_TYPE, and LANG, in the order
288               of decreasing precedence) -- if the variables indicate
289               UTF-8, then the selected "IOEioA" are in effect
290     a   256   Set ${^UTF8CACHE} to -1, to run the UTF-8 caching code in
291               debugging mode.
292
293 =for documenting_the_underdocumented
294 perl.h gives W/128 as PERL_UNICODE_WIDESYSCALLS "/* for Sarathy */"
295
296 =for todo
297 perltodo mentions Unicode in %ENV and filenames. I guess that these will be
298 options e and f (or F).
299
300 For example, B<-COE> and B<-C6> will both turn on UTF-8-ness on both
301 STDOUT and STDERR.  Repeating letters is just redundant, not cumulative
302 nor toggling.
303
304 The C<io> options mean that any subsequent open() (or similar I/O
305 operations) in the current file scope will have the C<:utf8> PerlIO layer
306 implicitly applied to them, in other words, UTF-8 is expected from any
307 input stream, and UTF-8 is produced to any output stream.  This is just
308 the default, with explicit layers in open() and with binmode() one can
309 manipulate streams as usual.
310
311 B<-C> on its own (not followed by any number or option list), or the
312 empty string C<""> for the C<PERL_UNICODE> environment variable, has the
313 same effect as B<-CSDL>.  In other words, the standard I/O handles and
314 the default C<open()> layer are UTF-8-fied I<but> only if the locale
315 environment variables indicate a UTF-8 locale.  This behaviour follows
316 the I<implicit> (and problematic) UTF-8 behaviour of Perl 5.8.0.
317
318 You can use B<-C0> (or C<"0"> for C<PERL_UNICODE>) to explicitly
319 disable all the above Unicode features.
320
321 The read-only magic variable C<${^UNICODE}> reflects the numeric value
322 of this setting.  This variable is set during Perl startup and is
323 thereafter read-only.  If you want runtime effects, use the three-arg
324 open() (see L<perlfunc/open>), the two-arg binmode() (see L<perlfunc/binmode>),
325 and the C<open> pragma (see L<open>).
326
327 (In Perls earlier than 5.8.1 the B<-C> switch was a Win32-only switch
328 that enabled the use of Unicode-aware "wide system call" Win32 APIs.
329 This feature was practically unused, however, and the command line
330 switch was therefore "recycled".)
331
332 B<Note:> Since perl 5.10.1, if the B<-C> option is used on the C<#!> line,
333 it must be specified on the command line as well, since the standard streams
334 are already set up at this point in the execution of the perl interpreter.
335 You can also use binmode() to set the encoding of an I/O stream.
336
337 =item B<-c>
338 X<-c>
339
340 causes Perl to check the syntax of the program and then exit without
341 executing it.  Actually, it I<will> execute and C<BEGIN>, C<UNITCHECK>,
342 or C<CHECK> blocks and any C<use> statements: these are considered as
343 occurring outside the execution of your program.  C<INIT> and C<END>
344 blocks, however, will be skipped.
345
346 =item B<-d>
347 X<-d> X<-dt>
348
349 =item B<-dt>
350
351 runs the program under the Perl debugger.  See L<perldebug>.
352 If B<t> is specified, it indicates to the debugger that threads
353 will be used in the code being debugged.
354
355 =item B<-d:>I<MOD[=bar,baz]>
356 X<-d> X<-dt>
357
358 =item B<-dt:>I<MOD[=bar,baz]>
359
360 runs the program under the control of a debugging, profiling, or tracing
361 module installed as C<Devel::I<MOD>>. E.g., B<-d:DProf> executes the
362 program using the C<Devel::DProf> profiler.  As with the B<-M> flag, options
363 may be passed to the C<Devel::I<MOD>> package where they will be received
364 and interpreted by the C<Devel::I<MOD>::import> routine.  Again, like B<-M>,
365 use -B<-d:-I<MOD>> to call C<Devel::I<MOD>::unimport> instead of import.  The
366 comma-separated list of options must follow a C<=> character.  If B<t> is
367 specified, it indicates to the debugger that threads will be used in the
368 code being debugged.  See L<perldebug>.
369
370 =item B<-D>I<letters>
371 X<-D> X<DEBUGGING> X<-DDEBUGGING>
372
373 =item B<-D>I<number>
374
375 sets debugging flags.  To watch how it executes your program, use
376 B<-Dtls>.  (This works only if debugging is compiled into your
377 Perl.)  Another nice value is B<-Dx>, which lists your compiled
378 syntax tree.  And B<-Dr> displays compiled regular expressions;
379 the format of the output is explained in L<perldebguts>.
380
381 As an alternative, specify a number instead of list of letters (e.g.,
382 B<-D14> is equivalent to B<-Dtls>):
383
384         1  p  Tokenizing and parsing (with v, displays parse stack)
385         2  s  Stack snapshots (with v, displays all stacks)
386         4  l  Context (loop) stack processing
387         8  t  Trace execution
388        16  o  Method and overloading resolution
389        32  c  String/numeric conversions
390        64  P  Print profiling info, source file input state
391       128  m  Memory and SV allocation
392       256  f  Format processing
393       512  r  Regular expression parsing and execution
394      1024  x  Syntax tree dump
395      2048  u  Tainting checks
396      4096  U  Unofficial, User hacking (reserved for private, unreleased use)
397      8192  H  Hash dump -- usurps values()
398     16384  X  Scratchpad allocation
399     32768  D  Cleaning up
400    131072  T  Tokenizing
401    262144  R  Include reference counts of dumped variables (eg when using -Ds)
402    524288  J  show s,t,P-debug (don't Jump over) on opcodes within package DB
403   1048576  v  Verbose: use in conjunction with other flags
404   2097152  C  Copy On Write
405   4194304  A  Consistency checks on internal structures
406   8388608  q  quiet - currently only suppresses the "EXECUTING" message
407  16777216  M  trace smart match resolution
408  33554432  B  dump suBroutine definitions, including special Blocks like BEGIN
409
410 All these flags require B<-DDEBUGGING> when you compile the Perl
411 executable (but see C<:opd> in L<Devel::Peek> or L<re/'debug' mode>
412 which may change this).
413 See the F<INSTALL> file in the Perl source distribution
414 for how to do this.  This flag is automatically set if you include B<-g>
415 option when C<Configure> asks you about optimizer/debugger flags.
416
417 If you're just trying to get a print out of each line of Perl code
418 as it executes, the way that C<sh -x> provides for shell scripts,
419 you can't use Perl's B<-D> switch.  Instead do this
420
421   # If you have "env" utility
422   env PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
423
424   # Bourne shell syntax
425   $ PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
426
427   # csh syntax
428   % (setenv PERLDB_OPTS "NonStop=1 AutoTrace=1 frame=2"; perl -dS program)
429
430 See L<perldebug> for details and variations.
431
432 =item B<-e> I<commandline>
433 X<-e>
434
435 may be used to enter one line of program.  If B<-e> is given, Perl
436 will not look for a filename in the argument list.  Multiple B<-e>
437 commands may be given to build up a multi-line script.  Make sure
438 to use semicolons where you would in a normal program.
439
440 =item B<-E> I<commandline>
441 X<-E>
442
443 behaves just like B<-e>, except that it implicitly enables all
444 optional features (in the main compilation unit). See L<feature>.
445
446 =item B<-f>
447 X<-f> X<sitecustomize> X<sitecustomize.pl>
448
449 Disable executing F<$Config{sitelib}/sitecustomize.pl> at startup.
450
451 Perl can be built so that it by default will try to execute
452 F<$Config{sitelib}/sitecustomize.pl> at startup (in a BEGIN block).
453 This is a hook that allows the sysadmin to customize how Perl behaves.
454 It can for instance be used to add entries to the @INC array to make Perl
455 find modules in non-standard locations.
456
457 Perl actually inserts the following code:
458
459     BEGIN {
460         do { local $!; -f "$Config{sitelib}/sitecustomize.pl"; }
461             && do "$Config{sitelib}/sitecustomize.pl";
462     }
463
464 Since it is an actual C<do> (not a C<require>), F<sitecustomize.pl>
465 doesn't need to return a true value. The code is run in package C<main>,
466 in its own lexical scope. However, if the script dies, C<$@> will not
467 be set.
468
469 The value of C<$Config{sitelib}> is also determined in C code and not
470 read from C<Config.pm>, which is not loaded.
471
472 The code is executed I<very> early. For example, any changes made to
473 C<@INC> will show up in the output of `perl -V`. Of course, C<END>
474 blocks will be likewise executed very late.
475
476 To determine at runtime if this capability has been compiled in your
477 perl, you can check the value of C<$Config{usesitecustomize}>.
478
479 =item B<-F>I<pattern>
480 X<-F>
481
482 specifies the pattern to split on if B<-a> is also in effect.  The
483 pattern may be surrounded by C<//>, C<"">, or C<''>, otherwise it will be
484 put in single quotes. You can't use literal whitespace in the pattern.
485
486 =item B<-h>
487 X<-h>
488
489 prints a summary of the options.
490
491 =item B<-i>[I<extension>]
492 X<-i> X<in-place>
493
494 specifies that files processed by the C<E<lt>E<gt>> construct are to be
495 edited in-place.  It does this by renaming the input file, opening the
496 output file by the original name, and selecting that output file as the
497 default for print() statements.  The extension, if supplied, is used to
498 modify the name of the old file to make a backup copy, following these
499 rules:
500
501 If no extension is supplied, no backup is made and the current file is
502 overwritten.
503
504 If the extension doesn't contain a C<*>, then it is appended to the
505 end of the current filename as a suffix.  If the extension does
506 contain one or more C<*> characters, then each C<*> is replaced
507 with the current filename.  In Perl terms, you could think of this
508 as:
509
510     ($backup = $extension) =~ s/\*/$file_name/g;
511
512 This allows you to add a prefix to the backup file, instead of (or in
513 addition to) a suffix:
514
515     $ perl -pi'orig_*' -e 's/bar/baz/' fileA    # backup to 'orig_fileA'
516
517 Or even to place backup copies of the original files into another
518 directory (provided the directory already exists):
519
520     $ perl -pi'old/*.orig' -e 's/bar/baz/' fileA # backup to 'old/fileA.orig'
521
522 These sets of one-liners are equivalent:
523
524     $ perl -pi -e 's/bar/baz/' fileA            # overwrite current file
525     $ perl -pi'*' -e 's/bar/baz/' fileA         # overwrite current file
526
527     $ perl -pi'.orig' -e 's/bar/baz/' fileA     # backup to 'fileA.orig'
528     $ perl -pi'*.orig' -e 's/bar/baz/' fileA    # backup to 'fileA.orig'
529
530 From the shell, saying
531
532     $ perl -p -i.orig -e "s/foo/bar/; ... "
533
534 is the same as using the program:
535
536     #!/usr/bin/perl -pi.orig
537     s/foo/bar/;
538
539 which is equivalent to
540
541     #!/usr/bin/perl
542     $extension = '.orig';
543     LINE: while (<>) {
544         if ($ARGV ne $oldargv) {
545             if ($extension !~ /\*/) {
546                 $backup = $ARGV . $extension;
547             }
548             else {
549                 ($backup = $extension) =~ s/\*/$ARGV/g;
550             }
551             rename($ARGV, $backup);
552             open(ARGVOUT, ">$ARGV");
553             select(ARGVOUT);
554             $oldargv = $ARGV;
555         }
556         s/foo/bar/;
557     }
558     continue {
559         print;  # this prints to original filename
560     }
561     select(STDOUT);
562
563 except that the B<-i> form doesn't need to compare $ARGV to $oldargv to
564 know when the filename has changed.  It does, however, use ARGVOUT for
565 the selected filehandle.  Note that STDOUT is restored as the default
566 output filehandle after the loop.
567
568 As shown above, Perl creates the backup file whether or not any output
569 is actually changed.  So this is just a fancy way to copy files:
570
571     $ perl -p -i'/some/file/path/*' -e 1 file1 file2 file3...
572 or
573     $ perl -p -i'.orig' -e 1 file1 file2 file3...
574
575 You can use C<eof> without parentheses to locate the end of each input
576 file, in case you want to append to each file, or reset line numbering
577 (see example in L<perlfunc/eof>).
578
579 If, for a given file, Perl is unable to create the backup file as
580 specified in the extension then it will skip that file and continue on
581 with the next one (if it exists).
582
583 For a discussion of issues surrounding file permissions and B<-i>,
584 see L<perlfaq5/Why does Perl let me delete read-only files?  Why does -i clobber protected files?  Isn't this a bug in Perl?>.
585
586 You cannot use B<-i> to create directories or to strip extensions from
587 files.
588
589 Perl does not expand C<~> in filenames, which is good, since some
590 folks use it for their backup files:
591
592     $ perl -pi~ -e 's/foo/bar/' file1 file2 file3...
593
594 Note that because B<-i> renames or deletes the original file before
595 creating a new file of the same name, Unix-style soft and hard links will
596 not be preserved.
597
598 Finally, the B<-i> switch does not impede execution when no
599 files are given on the command line.  In this case, no backup is made
600 (the original file cannot, of course, be determined) and processing
601 proceeds from STDIN to STDOUT as might be expected.
602
603 =item B<-I>I<directory>
604 X<-I> X<@INC>
605
606 Directories specified by B<-I> are prepended to the search path for
607 modules (C<@INC>).
608
609 =item B<-l>[I<octnum>]
610 X<-l> X<$/> X<$\>
611
612 enables automatic line-ending processing.  It has two separate
613 effects.  First, it automatically chomps C<$/> (the input record
614 separator) when used with B<-n> or B<-p>.  Second, it assigns C<$\>
615 (the output record separator) to have the value of I<octnum> so
616 that any print statements will have that separator added back on.
617 If I<octnum> is omitted, sets C<$\> to the current value of
618 C<$/>.  For instance, to trim lines to 80 columns:
619
620     perl -lpe 'substr($_, 80) = ""'
621
622 Note that the assignment C<$\ = $/> is done when the switch is processed,
623 so the input record separator can be different than the output record
624 separator if the B<-l> switch is followed by a B<-0> switch:
625
626     gnufind / -print0 | perl -ln0e 'print "found $_" if -p'
627
628 This sets C<$\> to newline and then sets C<$/> to the null character.
629
630 =item B<-m>[B<->]I<module>
631 X<-m> X<-M>
632
633 =item B<-M>[B<->]I<module>
634
635 =item B<-M>[B<->]I<'module ...'>
636
637 =item B<-[mM]>[B<->]I<module=arg[,arg]...>
638
639 B<-m>I<module> executes C<use> I<module> C<();> before executing your
640 program.
641
642 B<-M>I<module> executes C<use> I<module> C<;> before executing your
643 program.  You can use quotes to add extra code after the module name,
644 e.g., C<'-MI<MODULE> qw(foo bar)'>.
645
646 If the first character after the B<-M> or B<-m> is a dash (B<->)
647 then the 'use' is replaced with 'no'.
648
649 A little builtin syntactic sugar means you can also say
650 B<-mI<MODULE>=foo,bar> or B<-MI<MODULE>=foo,bar> as a shortcut for
651 B<'-MI<MODULE> qw(foo bar)'>.  This avoids the need to use quotes when
652 importing symbols.  The actual code generated by B<-MI<MODULE>=foo,bar> is
653 C<use module split(/,/,q{foo,bar})>.  Note that the C<=> form
654 removes the distinction between B<-m> and B<-M>.
655
656 A consequence of this is that B<-MI<MODULE>=number> never does a version check,
657 unless C<I<MODULE>::import()> itself is set up to do a version check, which
658 could happen for example if I<MODULE> inherits from L<Exporter>.
659
660 =item B<-n>
661 X<-n>
662
663 causes Perl to assume the following loop around your program, which
664 makes it iterate over filename arguments somewhat like I<sed -n> or
665 I<awk>:
666
667   LINE:
668     while (<>) {
669         ...             # your program goes here
670     }
671
672 Note that the lines are not printed by default.  See B<-p> to have
673 lines printed.  If a file named by an argument cannot be opened for
674 some reason, Perl warns you about it and moves on to the next file.
675
676 Also note that C<< <> >> passes command line arguments to
677 L<perlfunc/open>, which doesn't necessarily interpret them as file names.
678 See  L<perlop> for possible security implications.
679
680 Here is an efficient way to delete all files that haven't been modified for
681 at least a week:
682
683     find . -mtime +7 -print | perl -nle unlink
684
685 This is faster than using the B<-exec> switch of I<find> because you don't
686 have to start a process on every filename found.  It does suffer from
687 the bug of mishandling newlines in pathnames, which you can fix if
688 you follow the example under B<-0>.
689
690 C<BEGIN> and C<END> blocks may be used to capture control before or after
691 the implicit program loop, just as in I<awk>.
692
693 =item B<-p>
694 X<-p>
695
696 causes Perl to assume the following loop around your program, which
697 makes it iterate over filename arguments somewhat like I<sed>:
698
699
700   LINE:
701     while (<>) {
702         ...             # your program goes here
703     } continue {
704         print or die "-p destination: $!\n";
705     }
706
707 If a file named by an argument cannot be opened for some reason, Perl
708 warns you about it, and moves on to the next file.  Note that the
709 lines are printed automatically.  An error occurring during printing is
710 treated as fatal.  To suppress printing use the B<-n> switch.  A B<-p>
711 overrides a B<-n> switch.
712
713 C<BEGIN> and C<END> blocks may be used to capture control before or after
714 the implicit loop, just as in I<awk>.
715
716 =item B<-s>
717 X<-s>
718
719 enables rudimentary switch parsing for switches on the command
720 line after the program name but before any filename arguments (or before
721 an argument of B<-->).  Any switch found there is removed from @ARGV and sets the
722 corresponding variable in the Perl program.  The following program
723 prints "1" if the program is invoked with a B<-xyz> switch, and "abc"
724 if it is invoked with B<-xyz=abc>.
725
726     #!/usr/bin/perl -s
727     if ($xyz) { print "$xyz\n" }
728
729 Do note that a switch like B<--help> creates the variable C<${-help}>, which is not compliant
730 with C<use strict "refs">.  Also, when using this option on a script with
731 warnings enabled you may get a lot of spurious "used only once" warnings.
732
733 =item B<-S>
734 X<-S>
735
736 makes Perl use the PATH environment variable to search for the
737 program unless the name of the program contains path separators.
738
739 On some platforms, this also makes Perl append suffixes to the
740 filename while searching for it.  For example, on Win32 platforms,
741 the ".bat" and ".cmd" suffixes are appended if a lookup for the
742 original name fails, and if the name does not already end in one
743 of those suffixes.  If your Perl was compiled with C<DEBUGGING> turned
744 on, using the B<-Dp> switch to Perl shows how the search progresses.
745
746 Typically this is used to emulate C<#!> startup on platforms that don't
747 support C<#!>.  It's also convenient when debugging a script that uses C<#!>,
748 and is thus normally found by the shell's $PATH search mechanism.
749
750 This example works on many platforms that have a shell compatible with
751 Bourne shell:
752
753     #!/usr/bin/perl
754     eval 'exec /usr/bin/perl -wS $0 ${1+"$@"}'
755             if $running_under_some_shell;
756
757 The system ignores the first line and feeds the program to F</bin/sh>,
758 which proceeds to try to execute the Perl program as a shell script.
759 The shell executes the second line as a normal shell command, and thus
760 starts up the Perl interpreter.  On some systems $0 doesn't always
761 contain the full pathname, so the B<-S> tells Perl to search for the
762 program if necessary.  After Perl locates the program, it parses the
763 lines and ignores them because the variable $running_under_some_shell
764 is never true.  If the program will be interpreted by csh, you will need
765 to replace C<${1+"$@"}> with C<$*>, even though that doesn't understand
766 embedded spaces (and such) in the argument list.  To start up I<sh> rather
767 than I<csh>, some systems may have to replace the C<#!> line with a line
768 containing just a colon, which will be politely ignored by Perl.  Other
769 systems can't control that, and need a totally devious construct that
770 will work under any of I<csh>, I<sh>, or Perl, such as the following:
771
772         eval '(exit $?0)' && eval 'exec perl -wS $0 ${1+"$@"}'
773         & eval 'exec /usr/bin/perl -wS $0 $argv:q'
774                 if $running_under_some_shell;
775
776 If the filename supplied contains directory separators (and so is an
777 absolute or relative pathname), and if that file is not found,
778 platforms that append file extensions will do so and try to look
779 for the file with those extensions added, one by one.
780
781 On DOS-like platforms, if the program does not contain directory
782 separators, it will first be searched for in the current directory
783 before being searched for on the PATH.  On Unix platforms, the
784 program will be searched for strictly on the PATH.
785
786 =item B<-t>
787 X<-t>
788
789 Like B<-T>, but taint checks will issue warnings rather than fatal
790 errors.  These warnings can now be controlled normally with C<no warnings
791 qw(taint)>.
792
793 B<Note: This is not a substitute for C<-T>!> This is meant to be
794 used I<only> as a temporary development aid while securing legacy code:
795 for real production code and for new secure code written from scratch,
796 always use the real B<-T>.
797
798 =item B<-T>
799 X<-T>
800
801 turns on "taint" so you can test them.  Ordinarily
802 these checks are done only when running setuid or setgid.  It's a
803 good idea to turn them on explicitly for programs that run on behalf
804 of someone else whom you might not necessarily trust, such as CGI
805 programs or any internet servers you might write in Perl.  See
806 L<perlsec> for details.  For security reasons, this option must be
807 seen by Perl quite early; usually this means it must appear early
808 on the command line or in the C<#!> line for systems which support
809 that construct.
810
811 =item B<-u>
812 X<-u>
813
814 This switch causes Perl to dump core after compiling your
815 program.  You can then in theory take this core dump and turn it
816 into an executable file by using the I<undump> program (not supplied).
817 This speeds startup at the expense of some disk space (which you
818 can minimize by stripping the executable).  (Still, a "hello world"
819 executable comes out to about 200K on my machine.)  If you want to
820 execute a portion of your program before dumping, use the dump()
821 operator instead.  Note: availability of I<undump> is platform
822 specific and may not be available for a specific port of Perl.
823
824 =item B<-U>
825 X<-U>
826
827 allows Perl to do unsafe operations.  Currently the only "unsafe"
828 operations are attempting to unlink directories while running as superuser
829 and running setuid programs with fatal taint checks turned into warnings.
830 Note that warnings must be enabled along with this option to actually
831 I<generate> the taint-check warnings.
832
833 =item B<-v>
834 X<-v>
835
836 prints the version and patchlevel of your perl executable.
837
838 =item B<-V>
839 X<-V>
840
841 prints summary of the major perl configuration values and the current
842 values of @INC.
843
844 =item B<-V:>I<configvar>
845
846 Prints to STDOUT the value of the named configuration variable(s),
847 with multiples when your C<I<configvar>> argument looks like a regex (has
848 non-letters).  For example:
849
850     $ perl -V:libc
851         libc='/lib/libc-2.2.4.so';
852     $ perl -V:lib.
853         libs='-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc';
854         libc='/lib/libc-2.2.4.so';
855     $ perl -V:lib.*
856         libpth='/usr/local/lib /lib /usr/lib';
857         libs='-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc';
858         lib_ext='.a';
859         libc='/lib/libc-2.2.4.so';
860         libperl='libperl.a';
861         ....
862
863 Additionally, extra colons can be used to control formatting.  A
864 trailing colon suppresses the linefeed and terminator ";", allowing
865 you to embed queries into shell commands.  (mnemonic: PATH separator
866 ":".)
867
868     $ echo "compression-vars: " `perl -V:z.*: ` " are here !"
869     compression-vars:  zcat='' zip='zip'  are here !
870
871 A leading colon removes the "name=" part of the response, this allows
872 you to map to the name you need.  (mnemonic: empty label)
873
874     $ echo "goodvfork="`./perl -Ilib -V::usevfork`
875     goodvfork=false;
876
877 Leading and trailing colons can be used together if you need
878 positional parameter values without the names.  Note that in the case
879 below, the C<PERL_API> params are returned in alphabetical order.
880
881     $ echo building_on `perl -V::osname: -V::PERL_API_.*:` now
882     building_on 'linux' '5' '1' '9' now
883
884 =item B<-w>
885 X<-w>
886
887 prints warnings about dubious constructs, such as variable names
888 mentioned only once and scalar variables used
889 before being set; redefined subroutines; references to undefined
890 filehandles; filehandles opened read-only that you are attempting
891 to write on; values used as a number that don't I<look> like numbers;
892 using an array as though it were a scalar; if your subroutines
893 recurse more than 100 deep; and innumerable other things.
894
895 This switch really just enables the global C<$^W> variable; normally,
896 the lexically scoped C<use warnings> pragma is preferred. You
897 can disable or promote into fatal errors specific warnings using
898 C<__WARN__> hooks, as described in L<perlvar> and L<perlfunc/warn>.
899 See also L<perldiag> and L<perltrap>.  A fine-grained warning
900 facility is also available if you want to manipulate entire classes
901 of warnings; see L<warnings> or L<perllexwarn>.
902
903 =item B<-W>
904 X<-W>
905
906 Enables all warnings regardless of C<no warnings> or C<$^W>.
907 See L<perllexwarn>.
908
909 =item B<-X>
910 X<-X>
911
912 Disables all warnings regardless of C<use warnings> or C<$^W>.
913 See L<perllexwarn>.
914
915 =item B<-x>
916 X<-x>
917
918 =item B<-x>I<directory>
919
920 tells Perl that the program is embedded in a larger chunk of unrelated
921 text, such as in a mail message.  Leading garbage will be
922 discarded until the first line that starts with C<#!> and contains the
923 string "perl".  Any meaningful switches on that line will be applied.
924
925 All references to line numbers by the program (warnings, errors, ...)
926 will treat the C<#!> line as the first line.
927 Thus a warning on the 2nd line of the program, which is on the 100th
928 line in the file will be reported as line 2, not as line 100.
929 This can be overridden by using the C<#line> directive.
930 (See L<perlsyn/"Plain Old Comments (Not!)">)
931
932 If a directory name is specified, Perl will switch to that directory
933 before running the program.  The B<-x> switch controls only the
934 disposal of leading garbage.  The program must be terminated with
935 C<__END__> if there is trailing garbage to be ignored;  the program
936 can process any or all of the trailing garbage via the C<DATA> filehandle
937 if desired.
938
939 The directory, if specified, must appear immediately following the B<-x>
940 with no intervening whitespace.
941
942 =back
943
944 =head1 ENVIRONMENT
945 X<perl, environment variables>
946
947 =over 12
948
949 =item HOME
950 X<HOME>
951
952 Used if C<chdir> has no argument.
953
954 =item LOGDIR
955 X<LOGDIR>
956
957 Used if C<chdir> has no argument and HOME is not set.
958
959 =item PATH
960 X<PATH>
961
962 Used in executing subprocesses, and in finding the program if B<-S> is
963 used.
964
965 =item PERL5LIB
966 X<PERL5LIB>
967
968 A list of directories in which to look for Perl library
969 files before looking in the standard library and the current
970 directory.  Any architecture-specific directories under the specified
971 locations are automatically included if they exist, with this lookup
972 done at interpreter startup time.
973
974 If PERL5LIB is not defined, PERLLIB is used.  Directories are separated
975 (like in PATH) by a colon on Unixish platforms and by a semicolon on
976 Windows (the proper path separator being given by the command C<perl
977 -V:I<path_sep>>).
978
979 When running taint checks, either because the program was running setuid or
980 setgid, or the B<-T> or B<-t> switch was specified, neither PERL5LIB nor
981 PERLLIB is consulted. The program should instead say:
982
983     use lib "/my/directory";
984
985 =item PERL5OPT
986 X<PERL5OPT>
987
988 Command-line options (switches).  Switches in this variable are treated
989 as if they were on every Perl command line.  Only the B<-[CDIMUdmtwW]>
990 switches are allowed.  When running taint checks (either because the
991 program was running setuid or setgid, or because the B<-T> or B<-t>
992 switch was used), this variable is ignored.  If PERL5OPT begins with
993 B<- T>, tainting will be enabled and subsequent options ignored.  If
994 PERL5OPT begins with B<-t>, tainting will be enabled, a writable dot
995 removed from @INC, and subsequent options honored.
996
997 =item PERLIO
998 X<PERLIO>
999
1000 A space (or colon) separated list of PerlIO layers. If perl is built
1001 to use PerlIO system for IO (the default) these layers affect Perl's IO.
1002
1003 It is conventional to start layer names with a colon (for example, C<:perlio>) to
1004 emphasize their similarity to variable "attributes". But the code that parses
1005 layer specification strings,  which is also used to decode the PERLIO
1006 environment variable, treats the colon as a separator.
1007
1008 An unset or empty PERLIO is equivalent to the default set of layers for
1009 your platform; for example, C<:unix:perlio> on Unix-like systems
1010 and C<:unix:crlf> on Windows and other DOS-like systems.
1011
1012 The list becomes the default for I<all> Perl's IO. Consequently only built-in
1013 layers can appear in this list, as external layers (such as C<:encoding()>) need
1014 IO in  order to load them!. See L<"open pragma"|open> for how to add external
1015 encodings as defaults.
1016
1017 Layers it makes sense to include in the PERLIO environment
1018 variable are briefly summarized below. For more details see L<PerlIO>.
1019
1020 =over 8
1021
1022 =item :bytes
1023 X<:bytes>
1024
1025 A pseudolayer that turns the C<:utf8> flag I<off> for the layer below;
1026 unlikely to be useful on its own in the global PERLIO environment variable.
1027 You perhaps were thinking of C<:crlf:bytes> or C<:perlio:bytes>.
1028
1029 =item :crlf
1030 X<:crlf>
1031
1032 A layer which does CRLF to C<"\n"> translation distinguishing "text" and
1033 "binary" files in the manner of MS-DOS and similar operating systems.
1034 (It currently does I<not> mimic MS-DOS as far as treating of Control-Z
1035 as being an end-of-file marker.)
1036
1037 =item :mmap
1038 X<:mmap>
1039
1040 A layer that implements "reading" of files by using I<mmap>(2) to
1041 make an entire file appear in the process's address space, and then
1042 using that as PerlIO's "buffer".
1043
1044 =item :perlio
1045 X<:perlio>
1046
1047 This is a re-implementation of stdio-like buffering written as a
1048 PerlIO layer.  As such it will call whatever layer is below it for
1049 its operations, typically C<:unix>.
1050
1051 =item :pop
1052 X<:pop>
1053
1054 An experimental pseudolayer that removes the topmost layer.
1055 Use with the same care as is reserved for nitroglycerine.
1056
1057 =item :raw
1058 X<:raw>
1059
1060 A pseudolayer that manipulates other layers.  Applying the C<:raw>
1061 layer is equivalent to calling C<binmode($fh)>.  It makes the stream
1062 pass each byte as-is without translation.  In particular, both CRLF
1063 translation and intuiting C<:utf8> from the locale are disabled.
1064
1065 Unlike in earlier versions of Perl, C<:raw> is I<not>
1066 just the inverse of C<:crlf>: other layers which would affect the
1067 binary nature of the stream are also removed or disabled.
1068
1069 =item :stdio
1070 X<:stdio>
1071
1072 This layer provides a PerlIO interface by wrapping system's ANSI C "stdio"
1073 library calls. The layer provides both buffering and IO.
1074 Note that the C<:stdio> layer does I<not> do CRLF translation even if that
1075 is the platform's normal behaviour. You will need a C<:crlf> layer above it
1076 to do that.
1077
1078 =item :unix
1079 X<:unix>
1080
1081 Low-level layer that calls C<read>, C<write>, C<lseek>, etc.
1082
1083 =item :utf8
1084 X<:utf8>
1085
1086 A pseudolayer that enables a flag in the layer below to tell Perl
1087 that output should be in utf8 and that input should be regarded as
1088 already in valid utf8 form. B<WARNING: It does not check for validity and as such
1089 should be handled with extreme caution for input, because security violations
1090 can occur with non-shortest UTF-8 encodings, etc.> Generally C<:encoding(utf8)> is
1091 the best option when reading UTF-8 encoded data.
1092
1093 =item :win32
1094 X<:win32>
1095
1096 On Win32 platforms this I<experimental> layer uses native "handle" IO
1097 rather than a Unix-like numeric file descriptor layer. Known to be
1098 buggy in this release (5.14).
1099
1100 =back
1101
1102 The default set of layers should give acceptable results on all platforms
1103
1104 For Unix platforms that will be the equivalent of "unix perlio" or "stdio".
1105 Configure is set up to prefer the "stdio" implementation if the system's library
1106 provides for fast access to the buffer; otherwise, it uses the "unix perlio"
1107 implementation.
1108
1109 On Win32 the default in this release (5.14) is "unix crlf". Win32's "stdio"
1110 has a number of bugs/mis-features for Perl IO which are somewhat depending
1111 on the version and vendor of the C compiler. Using our own C<crlf> layer as
1112 the buffer avoids those issues and makes things more uniform.  The C<crlf>
1113 layer provides CRLF conversion as well as buffering.
1114
1115 This release (5.14) uses C<unix> as the bottom layer on Win32, and so still
1116 uses the C compiler's numeric file descriptor routines. There is an
1117 experimental native C<win32> layer, which is expected to be enhanced and
1118 should eventually become the default under Win32.
1119
1120 The PERLIO environment variable is completely ignored when Perl
1121 is run in taint mode.
1122
1123 =item PERLIO_DEBUG
1124 X<PERLIO_DEBUG>
1125
1126 If set to the name of a file or device, certain operations of PerlIO
1127 subsystem will be logged to that file, which is opened in append mode
1128 Typical uses are in Unix:
1129
1130    % env PERLIO_DEBUG=/dev/tty perl script ...
1131
1132 and under Win32, the approximately equivalent:
1133
1134    > set PERLIO_DEBUG=CON
1135    perl script ...
1136
1137 This functionality is disabled for setuid scripts and for scripts run
1138 with B<-T>.
1139
1140 =item PERLLIB
1141 X<PERLLIB>
1142
1143 A list of directories in which to look for Perl library
1144 files before looking in the standard library and the current directory.
1145 If PERL5LIB is defined, PERLLIB is not used.
1146
1147 The PERLLIB environment variable is completely ignored when Perl
1148 is run in taint mode.
1149
1150 =item PERL5DB
1151 X<PERL5DB>
1152
1153 The command used to load the debugger code.  The default is:
1154
1155         BEGIN { require "perl5db.pl" }
1156
1157 The PERL5DB environment variable is only used when Perl is started with
1158 a bare B<-d> switch.
1159
1160 =item PERL5DB_THREADED
1161 X<PERL5DB_THREADED>
1162
1163 If set to a true value, indicates to the debugger that the code being
1164 debugged uses threads.
1165
1166 =item PERL5SHELL (specific to the Win32 port)
1167 X<PERL5SHELL>
1168
1169 On Win32 ports only, may be set to an alternative shell that Perl must use
1170 internally for executing "backtick" commands or system().  Default is
1171 C<cmd.exe /x/d/c> on WindowsNT and C<command.com /c> on Windows95.  The
1172 value is considered space-separated.  Precede any character that
1173 needs to be protected, like a space or backslash, with another backslash.
1174
1175 Note that Perl doesn't use COMSPEC for this purpose because
1176 COMSPEC has a high degree of variability among users, leading to
1177 portability concerns.  Besides, Perl can use a shell that may not be
1178 fit for interactive use, and setting COMSPEC to such a shell may
1179 interfere with the proper functioning of other programs (which usually
1180 look in COMSPEC to find a shell fit for interactive use).
1181
1182 Before Perl 5.10.0 and 5.8.8, PERL5SHELL was not taint checked
1183 when running external commands.  It is recommended that
1184 you explicitly set (or delete) C<$ENV{PERL5SHELL}> when running
1185 in taint mode under Windows.
1186
1187 =item PERL_ALLOW_NON_IFS_LSP (specific to the Win32 port)
1188 X<PERL_ALLOW_NON_IFS_LSP>
1189
1190 Set to 1 to allow the use of non-IFS compatible LSPs (Layered Service Providers).
1191 Perl normally searches for an IFS-compatible LSP because this is required
1192 for its emulation of Windows sockets as real filehandles.  However, this may
1193 cause problems if you have a firewall such as I<McAfee Guardian>, which requires
1194 that all applications use its LSP but which is not IFS-compatible, because clearly
1195 Perl will normally avoid using such an LSP.
1196
1197 Setting this environment variable to 1 means that Perl will simply use the
1198 first suitable LSP enumerated in the catalog, which keeps I<McAfee Guardian>
1199 happy--and in that particular case Perl still works too because I<McAfee
1200 Guardian>'s LSP actually plays other games which allow applications
1201 requiring IFS compatibility to work.
1202
1203 =item PERL_DEBUG_MSTATS
1204 X<PERL_DEBUG_MSTATS>
1205
1206 Relevant only if Perl is compiled with the C<malloc> included with the Perl
1207 distribution; that is, if C<perl -V:d_mymalloc> is "define".
1208
1209 If set, this dumps out memory statistics after execution.  If set
1210 to an integer greater than one, also dumps out memory statistics
1211 after compilation.
1212
1213 =item PERL_DESTRUCT_LEVEL
1214 X<PERL_DESTRUCT_LEVEL>
1215
1216 Relevant only if your Perl executable was built with B<-DDEBUGGING>,
1217 this controls the behaviour of global destruction of objects and other
1218 references.  See L<perlhacktips/PERL_DESTRUCT_LEVEL> for more information.
1219
1220 =item PERL_DL_NONLAZY
1221 X<PERL_DL_NONLAZY>
1222
1223 Set to C<"1"> to have Perl resolve I<all> undefined symbols when it loads
1224 a dynamic library.  The default behaviour is to resolve symbols when
1225 they are used.  Setting this variable is useful during testing of
1226 extensions, as it ensures that you get an error on misspelled function
1227 names even if the test suite doesn't call them.
1228
1229 =item PERL_ENCODING
1230 X<PERL_ENCODING>
1231
1232 If using the C<use encoding> pragma without an explicit encoding name, the
1233 PERL_ENCODING environment variable is consulted for an encoding name.
1234
1235 =item PERL_HASH_SEED
1236 X<PERL_HASH_SEED>
1237
1238 (Since Perl 5.8.1.)  Used to randomize Perl's internal hash function.
1239 To emulate the pre-5.8.1 behaviour, set to an integer; C<"0"> means
1240 exactly the same order as in 5.8.0.  "Pre-5.8.1" means, among other
1241 things, that hash keys will always have the same ordering between
1242 different runs of Perl.
1243
1244 Most hashes by default return elements in the same order as in Perl 5.8.0.
1245 On a hash by hash basis, if pathological data is detected during a hash
1246 key insertion, then that hash will switch to an alternative random hash
1247 seed.
1248
1249 The default behaviour is to randomize unless the PERL_HASH_SEED is set.
1250 If Perl has been compiled with B<-DUSE_HASH_SEED_EXPLICIT>, the default
1251 behaviour is I<not> to randomize unless the PERL_HASH_SEED is set.
1252
1253 If PERL_HASH_SEED is unset or set to a non-numeric string, Perl uses
1254 the pseudorandom seed supplied by the operating system and libraries.
1255
1256 B<PLEASE NOTE: The hash seed is sensitive information>. Hashes are
1257 randomized to protect against local and remote attacks against Perl
1258 code. By manually setting a seed, this protection may be partially or
1259 completely lost.
1260
1261 See L<perlsec/"Algorithmic Complexity Attacks"> and
1262 L</PERL_HASH_SEED_DEBUG> for more information.
1263
1264 =item PERL_HASH_SEED_DEBUG
1265 X<PERL_HASH_SEED_DEBUG>
1266
1267 (Since Perl 5.8.1.)  Set to C<"1"> to display (to STDERR) the value of
1268 the hash seed at the beginning of execution.  This, combined with
1269 L</PERL_HASH_SEED> is intended to aid in debugging nondeterministic
1270 behaviour caused by hash randomization.
1271
1272 B<Note that the hash seed is sensitive information>: by knowing it, one
1273 can craft a denial-of-service attack against Perl code, even remotely;
1274 see L<perlsec/"Algorithmic Complexity Attacks"> for more information.
1275 B<Do not disclose the hash seed> to people who don't need to know it.
1276 See also hash_seed() in L<Hash::Util>.
1277
1278 =item PERL_MEM_LOG
1279 X<PERL_MEM_LOG>
1280
1281 If your Perl was configured with B<-Accflags=-DPERL_MEM_LOG>, setting
1282 the environment variable C<PERL_MEM_LOG> enables logging debug
1283 messages. The value has the form C<< <I<number>>[m][s][t] >>, where
1284 C<I<number>> is the file descriptor number you want to write to (2 is
1285 default), and the combination of letters specifies that you want
1286 information about (m)emory and/or (s)v, optionally with
1287 (t)imestamps. For example, C<PERL_MEM_LOG=1mst> logs all
1288 information to stdout. You can write to other opened file descriptors
1289 in a variety of ways:
1290
1291   $ 3>foo3 PERL_MEM_LOG=3m perl ...
1292
1293 =item PERL_ROOT (specific to the VMS port)
1294 X<PERL_ROOT>
1295
1296 A translation-concealed rooted logical name that contains Perl and the
1297 logical device for the @INC path on VMS only.  Other logical names that
1298 affect Perl on VMS include PERLSHR, PERL_ENV_TABLES, and
1299 SYS$TIMEZONE_DIFFERENTIAL, but are optional and discussed further in
1300 L<perlvms> and in F<README.vms> in the Perl source distribution.
1301
1302 =item PERL_SIGNALS
1303 X<PERL_SIGNALS>
1304
1305 Available in Perls 5.8.1 and later.  If set to C<"unsafe">, the pre-Perl-5.8.0
1306 signal behaviour (which is immediate but unsafe) is restored.  If set
1307 to C<safe>, then safe (but deferred) signals are used.  See
1308 L<perlipc/"Deferred Signals (Safe Signals)">.
1309
1310 =item PERL_UNICODE
1311 X<PERL_UNICODE>
1312
1313 Equivalent to the B<-C> command-line switch.  Note that this is not
1314 a boolean variable. Setting this to C<"1"> is not the right way to
1315 "enable Unicode" (whatever that would mean).  You can use C<"0"> to
1316 "disable Unicode", though (or alternatively unset PERL_UNICODE in
1317 your shell before starting Perl).  See the description of the B<-C>
1318 switch for more information.
1319
1320 =item SYS$LOGIN (specific to the VMS port)
1321 X<SYS$LOGIN>
1322
1323 Used if chdir has no argument and HOME and LOGDIR are not set.
1324
1325 =back
1326
1327 Perl also has environment variables that control how Perl handles data
1328 specific to particular natural languages; see L<perllocale>.
1329
1330 Perl and its various modules and components, including its test frameworks,
1331 may sometimes make use of certain other environment variables.  Some of
1332 these are specific to a particular platform.  Please consult the
1333 appropriate module documentation and any documentation for your platform
1334 (like L<perlsolaris>, L<perllinux>, L<perlmacosx>, L<perlwin32>, etc) for
1335 variables peculiar to those specific situations.
1336
1337 Perl makes all environment variables available to the program being
1338 executed, and passes these along to any child processes it starts.
1339 However, programs running setuid would do well to execute the following
1340 lines before doing anything else, just to keep people honest:
1341
1342     $ENV{PATH}  = "/bin:/usr/bin";    # or whatever you need
1343     $ENV{SHELL} = "/bin/sh" if exists $ENV{SHELL};
1344     delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};