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