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