This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
b9737794371d8353189e0e03d083fd9c13597ab6
[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<-eE> 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> or 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 todo
319 perltodo mentions Unicode in %ENV and filenames. I guess that these will be
320 options e and f (or F).
321
322 For example, C<-COE> and C<-C6> will both turn on UTF-8-ness on both
323 STDOUT and STDERR.  Repeating letters is just redundant, not cumulative
324 nor toggling.
325
326 The C<io> options mean that any subsequent open() (or similar I/O
327 operations) will have the C<:utf8> PerlIO layer implicitly applied
328 to them, in other words, UTF-8 is expected from any input stream,
329 and UTF-8 is produced to any output stream.  This is just the default,
330 with explicit layers in open() and with binmode() one can manipulate
331 streams as usual.
332
333 C<-C> on its own (not followed by any number or option list), or the
334 empty string C<""> for the C<PERL_UNICODE> environment variable, has the
335 same effect as C<-CSDL>.  In other words, the standard I/O handles and
336 the default C<open()> layer are UTF-8-fied B<but> only if the locale
337 environment variables indicate a UTF-8 locale.  This behaviour follows
338 the I<implicit> (and problematic) UTF-8 behaviour of Perl 5.8.0.
339
340 You can use C<-C0> (or C<"0"> for C<PERL_UNICODE>) to explicitly
341 disable all the above Unicode features.
342
343 The read-only magic variable C<${^UNICODE}> reflects the numeric value
344 of this setting.  This is variable is set during Perl startup and is
345 thereafter read-only.  If you want runtime effects, use the three-arg
346 open() (see L<perlfunc/open>), the two-arg binmode() (see L<perlfunc/binmode>),
347 and the C<open> pragma (see L<open>).
348
349 (In Perls earlier than 5.8.1 the C<-C> switch was a Win32-only switch
350 that enabled the use of Unicode-aware "wide system call" Win32 APIs.
351 This feature was practically unused, however, and the command line
352 switch was therefore "recycled".)
353
354 =item B<-c>
355 X<-c>
356
357 causes Perl to check the syntax of the program and then exit without
358 executing it.  Actually, it I<will> execute C<BEGIN>, C<CHECK>, and
359 C<use> blocks, because these are considered as occurring outside the
360 execution of your program.  C<INIT> and C<END> blocks, however, will
361 be skipped.
362
363 =item B<-d>
364 X<-d> X<-dt>
365
366 =item B<-dt>
367
368 runs the program under the Perl debugger.  See L<perldebug>.
369 If B<t> is specified, it indicates to the debugger that threads
370 will be used in the code being debugged.
371
372 =item B<-d:>I<foo[=bar,baz]>
373 X<-d> X<-dt>
374
375 =item B<-dt:>I<foo[=bar,baz]>
376
377 runs the program under the control of a debugging, profiling, or
378 tracing module installed as Devel::foo. E.g., B<-d:DProf> executes
379 the program using the Devel::DProf profiler.  As with the B<-M>
380 flag, options may be passed to the Devel::foo package where they
381 will be received and interpreted by the Devel::foo::import routine.
382 The comma-separated list of options must follow a C<=> character.
383 If B<t> is specified, it indicates to the debugger that threads
384 will be used in the code being debugged.
385 See L<perldebug>.
386
387 =item B<-D>I<letters>
388 X<-D> X<DEBUGGING> X<-DDEBUGGING>
389
390 =item B<-D>I<number>
391
392 sets debugging flags.  To watch how it executes your program, use
393 B<-Dtls>.  (This works only if debugging is compiled into your
394 Perl.)  Another nice value is B<-Dx>, which lists your compiled
395 syntax tree.  And B<-Dr> displays compiled regular expressions;
396 the format of the output is explained in L<perldebguts>.
397
398 As an alternative, specify a number instead of list of letters (e.g.,
399 B<-D14> is equivalent to B<-Dtls>):
400
401         1  p  Tokenizing and parsing (with v, displays parse stack)
402         2  s  Stack snapshots (with v, displays all stacks)
403         4  l  Context (loop) stack processing
404         8  t  Trace execution
405        16  o  Method and overloading resolution
406        32  c  String/numeric conversions
407        64  P  Print profiling info, preprocessor command for -P, source file input state
408       128  m  Memory allocation
409       256  f  Format processing
410       512  r  Regular expression parsing and execution
411      1024  x  Syntax tree dump
412      2048  u  Tainting checks
413      4096     (Obsolete, previously used for LEAKTEST)
414      8192  H  Hash dump -- usurps values()
415     16384  X  Scratchpad allocation
416     32768  D  Cleaning up
417     65536  S  Thread synchronization
418    131072  T  Tokenising
419    262144  R  Include reference counts of dumped variables (eg when using -Ds)
420    524288  J  Do not s,t,P-debug (Jump over) opcodes within package DB
421   1048576  v  Verbose: use in conjunction with 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" message
425
426 All these flags require B<-DDEBUGGING> when you compile the Perl
427 executable (but see L<Devel::Peek>, L<re> which may change this).
428 See the F<INSTALL> file in the Perl source distribution
429 for how to do this.  This flag is automatically set if you include B<-g>
430 option when C<Configure> asks you about optimizer/debugger flags.
431
432 If you're just trying to get a print out of each line of Perl code
433 as it executes, the way that C<sh -x> provides for shell scripts,
434 you can't use Perl's B<-D> switch.  Instead do this
435
436   # If you have "env" utility
437   env PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
438
439   # Bourne shell syntax
440   $ PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
441
442   # csh syntax
443   % (setenv PERLDB_OPTS "NonStop=1 AutoTrace=1 frame=2"; perl -dS program)
444
445 See L<perldebug> for details and variations.
446
447 =item B<-e> I<commandline>
448 X<-e>
449
450 may be used to enter one line of program.  If B<-e> is given, Perl
451 will not look for a filename in the argument list.  Multiple B<-e>
452 commands may be given to build up a multi-line script.  Make sure
453 to use semicolons where you would in a normal program.
454
455 =item B<-E> I<commandline>
456 X<-E>
457
458 behaves just like B<-e>, except that it implicitly enables all
459 optional features (in the main compilation unit). See L<feature>.
460
461 =item B<-f>
462 X<-f>
463
464 Disable executing F<$Config{sitelib}/sitecustomize.pl> at startup.
465
466 Perl can be built so that it by default will try to execute
467 F<$Config{sitelib}/sitecustomize.pl> at startup.  This is a hook that
468 allows the sysadmin to customize how perl behaves.  It can for
469 instance be used to add entries to the @INC array to make perl find
470 modules in non-standard locations.
471
472 =item B<-F>I<pattern>
473 X<-F>
474
475 specifies the pattern to split on if B<-a> is also in effect.  The
476 pattern may be surrounded by C<//>, C<"">, or C<''>, otherwise it will be
477 put in single quotes. You can't use literal whitespace in the pattern.
478
479 =item B<-h>
480 X<-h>
481
482 prints a summary of the options.
483
484 =item B<-i>[I<extension>]
485 X<-i> X<in-place>
486
487 specifies that files processed by the C<E<lt>E<gt>> construct are to be
488 edited in-place.  It does this by renaming the input file, opening the
489 output file by the original name, and selecting that output file as the
490 default for print() statements.  The extension, if supplied, is used to
491 modify the name of the old file to make a backup copy, following these
492 rules:
493
494 If no extension is supplied, no backup is made and the current file is
495 overwritten.
496
497 If the extension doesn't contain a C<*>, then it is appended to the
498 end of the current filename as a suffix.  If the extension does
499 contain one or more C<*> characters, then each C<*> is replaced
500 with the current filename.  In Perl terms, you could think of this
501 as:
502
503     ($backup = $extension) =~ s/\*/$file_name/g;
504
505 This allows you to add a prefix to the backup file, instead of (or in
506 addition to) a suffix:
507
508     $ perl -pi'orig_*' -e 's/bar/baz/' fileA    # backup to 'orig_fileA'
509
510 Or even to place backup copies of the original files into another
511 directory (provided the directory already exists):
512
513     $ perl -pi'old/*.orig' -e 's/bar/baz/' fileA # backup to 'old/fileA.orig'
514
515 These sets of one-liners are equivalent:
516
517     $ perl -pi -e 's/bar/baz/' fileA            # overwrite current file
518     $ perl -pi'*' -e 's/bar/baz/' fileA         # overwrite current file
519
520     $ perl -pi'.orig' -e 's/bar/baz/' fileA     # backup to 'fileA.orig'
521     $ perl -pi'*.orig' -e 's/bar/baz/' fileA    # backup to 'fileA.orig'
522
523 From the shell, saying
524
525     $ perl -p -i.orig -e "s/foo/bar/; ... "
526
527 is the same as using the program:
528
529     #!/usr/bin/perl -pi.orig
530     s/foo/bar/;
531
532 which is equivalent to
533
534     #!/usr/bin/perl
535     $extension = '.orig';
536     LINE: while (<>) {
537         if ($ARGV ne $oldargv) {
538             if ($extension !~ /\*/) {
539                 $backup = $ARGV . $extension;
540             }
541             else {
542                 ($backup = $extension) =~ s/\*/$ARGV/g;
543             }
544             rename($ARGV, $backup);
545             open(ARGVOUT, ">$ARGV");
546             select(ARGVOUT);
547             $oldargv = $ARGV;
548         }
549         s/foo/bar/;
550     }
551     continue {
552         print;  # this prints to original filename
553     }
554     select(STDOUT);
555
556 except that the B<-i> form doesn't need to compare $ARGV to $oldargv to
557 know when the filename has changed.  It does, however, use ARGVOUT for
558 the selected filehandle.  Note that STDOUT is restored as the default
559 output filehandle after the loop.
560
561 As shown above, Perl creates the backup file whether or not any output
562 is actually changed.  So this is just a fancy way to copy files:
563
564     $ perl -p -i'/some/file/path/*' -e 1 file1 file2 file3...
565 or
566     $ perl -p -i'.orig' -e 1 file1 file2 file3...
567
568 You can use C<eof> without parentheses to locate the end of each input
569 file, in case you want to append to each file, or reset line numbering
570 (see example in L<perlfunc/eof>).
571
572 If, for a given file, Perl is unable to create the backup file as
573 specified in the extension then it will skip that file and continue on
574 with the next one (if it exists).
575
576 For a discussion of issues surrounding file permissions and B<-i>,
577 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?>.
578
579 You cannot use B<-i> to create directories or to strip extensions from
580 files.
581
582 Perl does not expand C<~> in filenames, which is good, since some
583 folks use it for their backup files:
584
585     $ perl -pi~ -e 's/foo/bar/' file1 file2 file3...
586
587 Note that because B<-i> renames or deletes the original file before
588 creating a new file of the same name, UNIX-style soft and hard links will
589 not be preserved.
590
591 Finally, the B<-i> switch does not impede execution when no
592 files are given on the command line.  In this case, no backup is made
593 (the original file cannot, of course, be determined) and processing
594 proceeds from STDIN to STDOUT as might be expected.
595
596 =item B<-I>I<directory>
597 X<-I> X<@INC>
598
599 Directories specified by B<-I> are prepended to the search path for
600 modules (C<@INC>), and also tells the C preprocessor where to search for
601 include files.  The C preprocessor is invoked with B<-P>; by default it
602 searches /usr/include and /usr/lib/perl.
603
604 =item B<-l>[I<octnum>]
605 X<-l> X<$/> X<$\>
606
607 enables automatic line-ending processing.  It has two separate
608 effects.  First, it automatically chomps C<$/> (the input record
609 separator) when used with B<-n> or B<-p>.  Second, it assigns C<$\>
610 (the output record separator) to have the value of I<octnum> so
611 that any print statements will have that separator added back on.
612 If I<octnum> is omitted, sets C<$\> to the current value of
613 C<$/>.  For instance, to trim lines to 80 columns:
614
615     perl -lpe 'substr($_, 80) = ""'
616
617 Note that the assignment C<$\ = $/> is done when the switch is processed,
618 so the input record separator can be different than the output record
619 separator if the B<-l> switch is followed by a B<-0> switch:
620
621     gnufind / -print0 | perl -ln0e 'print "found $_" if -p'
622
623 This sets C<$\> to newline and then sets C<$/> to the null character.
624
625 =item B<-m>[B<->]I<module>
626 X<-m> X<-M>
627
628 =item B<-M>[B<->]I<module>
629
630 =item B<-M>[B<->]I<'module ...'>
631
632 =item B<-[mM]>[B<->]I<module=arg[,arg]...>
633
634 B<-m>I<module> executes C<use> I<module> C<();> before executing your
635 program.
636
637 B<-M>I<module> executes C<use> I<module> C<;> before executing your
638 program.  You can use quotes to add extra code after the module name,
639 e.g., C<'-Mmodule qw(foo bar)'>.
640
641 If the first character after the B<-M> or B<-m> is a dash (C<->)
642 then the 'use' is replaced with 'no'.
643
644 A little builtin syntactic sugar means you can also say
645 B<-mmodule=foo,bar> or B<-Mmodule=foo,bar> as a shortcut for
646 C<'-Mmodule qw(foo bar)'>.  This avoids the need to use quotes when
647 importing symbols.  The actual code generated by B<-Mmodule=foo,bar> is
648 C<use module split(/,/,q{foo,bar})>.  Note that the C<=> form
649 removes the distinction between B<-m> and B<-M>.
650
651 A consequence of this is that B<-MFoo=number> never does a version check
652 (unless C<Foo::import()> itself is set up to do a version check, which
653 could happen for example if Foo inherits from Exporter.)
654
655 =item B<-n>
656 X<-n>
657
658 causes Perl to assume the following loop around your program, which
659 makes it iterate over filename arguments somewhat like B<sed -n> or
660 B<awk>:
661
662   LINE:
663     while (<>) {
664         ...             # your program goes here
665     }
666
667 Note that the lines are not printed by default.  See B<-p> to have
668 lines printed.  If a file named by an argument cannot be opened for
669 some reason, Perl warns you about it and moves on to the next file.
670
671 Here is an efficient way to delete all files that haven't been modified for
672 at least a week:
673
674     find . -mtime +7 -print | perl -nle unlink
675
676 This is faster than using the B<-exec> switch of B<find> because you don't
677 have to start a process on every filename found.  It does suffer from
678 the bug of mishandling newlines in pathnames, which you can fix if
679 you follow the example under B<-0>.
680
681 C<BEGIN> and C<END> blocks may be used to capture control before or after
682 the implicit program loop, just as in B<awk>.
683
684 =item B<-p>
685 X<-p>
686
687 causes Perl to assume the following loop around your program, which
688 makes it iterate over filename arguments somewhat like B<sed>:
689
690
691   LINE:
692     while (<>) {
693         ...             # your program goes here
694     } continue {
695         print or die "-p destination: $!\n";
696     }
697
698 If a file named by an argument cannot be opened for some reason, Perl
699 warns you about it, and moves on to the next file.  Note that the
700 lines are printed automatically.  An error occurring during printing is
701 treated as fatal.  To suppress printing use the B<-n> switch.  A B<-p>
702 overrides a B<-n> switch.
703
704 C<BEGIN> and C<END> blocks may be used to capture control before or after
705 the implicit loop, just as in B<awk>.
706
707 =item B<-P>
708 X<-P>
709
710 B<NOTE: Use of -P is strongly discouraged because of its inherent
711 problems, including poor portability.>
712
713 This option causes your program to be run through the C preprocessor before
714 compilation by Perl.  Because both comments and B<cpp> directives begin
715 with the # character, you should avoid starting comments with any words
716 recognized by the C preprocessor such as C<"if">, C<"else">, or C<"define">.
717
718 If you're considering using C<-P>, you might also want to look at the
719 Filter::cpp module from CPAN.
720
721 The problems of -P include, but are not limited to:
722
723 =over 10
724
725 =item *
726
727 The C<#!> line is stripped, so any switches there don't apply.
728
729 =item *
730
731 A C<-P> on a C<#!> line doesn't work.
732
733 =item *
734
735 B<All> lines that begin with (whitespace and) a C<#> but
736 do not look like cpp commands, are stripped, including anything
737 inside Perl strings, regular expressions, and here-docs .
738
739 =item *
740
741 In some platforms the C preprocessor knows too much: it knows about
742 the C++ -style until-end-of-line comments starting with C<"//">.
743 This will cause problems with common Perl constructs like
744
745     s/foo//;
746
747 because after -P this will became illegal code
748
749     s/foo
750
751 The workaround is to use some other quoting separator than C<"/">,
752 like for example C<"!">:
753
754     s!foo!!;
755
756
757
758 =item *
759
760 It requires not only a working C preprocessor but also a working
761 F<sed>.  If not on UNIX, you are probably out of luck on this.
762
763 =item *
764
765 Script line numbers are not preserved.
766
767 =item *
768
769 The C<-x> does not work with C<-P>.
770
771 =back
772
773 =item B<-s>
774 X<-s>
775
776 enables rudimentary switch parsing for switches on the command
777 line after the program name but before any filename arguments (or before
778 an argument of B<-->).  Any switch found there is removed from @ARGV and sets the
779 corresponding variable in the Perl program.  The following program
780 prints "1" if the program is invoked with a B<-xyz> switch, and "abc"
781 if it is invoked with B<-xyz=abc>.
782
783     #!/usr/bin/perl -s
784     if ($xyz) { print "$xyz\n" }
785
786 Do note that a switch like B<--help> creates the variable ${-help}, which is not compliant
787 with C<strict refs>.  Also, when using this option on a script with
788 warnings enabled you may get a lot of spurious "used only once" warnings.
789
790 =item B<-S>
791 X<-S>
792
793 makes Perl use the PATH environment variable to search for the
794 program (unless the name of the program contains directory separators).
795
796 On some platforms, this also makes Perl append suffixes to the
797 filename while searching for it.  For example, on Win32 platforms,
798 the ".bat" and ".cmd" suffixes are appended if a lookup for the
799 original name fails, and if the name does not already end in one
800 of those suffixes.  If your Perl was compiled with DEBUGGING turned
801 on, using the -Dp switch to Perl shows how the search progresses.
802
803 Typically this is used to emulate #! startup on platforms that don't
804 support #!.  Its also convenient when debugging a script that uses #!,
805 and is thus normally found by the shell's $PATH search mechanism.
806
807 This example works on many platforms that have a shell compatible with
808 Bourne shell:
809
810     #!/usr/bin/perl
811     eval 'exec /usr/bin/perl -wS $0 ${1+"$@"}'
812             if $running_under_some_shell;
813
814 The system ignores the first line and feeds the program to F</bin/sh>,
815 which proceeds to try to execute the Perl program as a shell script.
816 The shell executes the second line as a normal shell command, and thus
817 starts up the Perl interpreter.  On some systems $0 doesn't always
818 contain the full pathname, so the B<-S> tells Perl to search for the
819 program if necessary.  After Perl locates the program, it parses the
820 lines and ignores them because the variable $running_under_some_shell
821 is never true.  If the program will be interpreted by csh, you will need
822 to replace C<${1+"$@"}> with C<$*>, even though that doesn't understand
823 embedded spaces (and such) in the argument list.  To start up sh rather
824 than csh, some systems may have to replace the #! line with a line
825 containing just a colon, which will be politely ignored by Perl.  Other
826 systems can't control that, and need a totally devious construct that
827 will work under any of B<csh>, B<sh>, or Perl, such as the following:
828
829         eval '(exit $?0)' && eval 'exec perl -wS $0 ${1+"$@"}'
830         & eval 'exec /usr/bin/perl -wS $0 $argv:q'
831                 if $running_under_some_shell;
832
833 If the filename supplied contains directory separators (i.e., is an
834 absolute or relative pathname), and if that file is not found,
835 platforms that append file extensions will do so and try to look
836 for the file with those extensions added, one by one.
837
838 On DOS-like platforms, if the program does not contain directory
839 separators, it will first be searched for in the current directory
840 before being searched for on the PATH.  On Unix platforms, the
841 program will be searched for strictly on the PATH.
842
843 =item B<-t>
844 X<-t>
845
846 Like B<-T>, but taint checks will issue warnings rather than fatal
847 errors.  These warnings can be controlled normally with C<no warnings
848 qw(taint)>.
849
850 B<NOTE: this is not a substitute for -T.> This is meant only to be
851 used as a temporary development aid while securing legacy code:
852 for real production code and for new secure code written from scratch
853 always use the real B<-T>.
854
855 =item B<-T>
856 X<-T>
857
858 forces "taint" checks to be turned on so you can test them.  Ordinarily
859 these checks are done only when running setuid or setgid.  It's a
860 good idea to turn them on explicitly for programs that run on behalf
861 of someone else whom you might not necessarily trust, such as CGI
862 programs or any internet servers you might write in Perl.  See
863 L<perlsec> for details.  For security reasons, this option must be
864 seen by Perl quite early; usually this means it must appear early
865 on the command line or in the #! line for systems which support
866 that construct.
867
868 =item B<-u>
869 X<-u>
870
871 This obsolete switch causes Perl to dump core after compiling your
872 program.  You can then in theory take this core dump and turn it
873 into an executable file by using the B<undump> program (not supplied).
874 This speeds startup at the expense of some disk space (which you
875 can minimize by stripping the executable).  (Still, a "hello world"
876 executable comes out to about 200K on my machine.)  If you want to
877 execute a portion of your program before dumping, use the dump()
878 operator instead.  Note: availability of B<undump> is platform
879 specific and may not be available for a specific port of Perl.
880
881 This switch has been superseded in favor of the new Perl code
882 generator backends to the compiler.  See L<B> and L<B::Bytecode>
883 for details.
884
885 =item B<-U>
886 X<-U>
887
888 allows Perl to do unsafe operations.  Currently the only "unsafe"
889 operations are attempting to unlink directories while running as 
890 superuser, and running setuid programs with fatal taint checks turned
891 into warnings.  Note that the B<-w> switch (or the C<$^W> variable) 
892 must be used along with this option to actually I<generate> the
893 taint-check warnings.  
894
895 =item B<-v>
896 X<-v>
897
898 prints the version and patchlevel of your perl executable.
899
900 =item B<-V>
901 X<-V>
902
903 prints summary of the major perl configuration values and the current
904 values of @INC.
905
906 =item B<-V:>I<configvar>
907
908 Prints to STDOUT the value of the named configuration variable(s),
909 with multiples when your configvar argument looks like a regex (has
910 non-letters).  For example:
911
912     $ perl -V:libc
913         libc='/lib/libc-2.2.4.so';
914     $ perl -V:lib.
915         libs='-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc';
916         libc='/lib/libc-2.2.4.so';
917     $ perl -V:lib.*
918         libpth='/usr/local/lib /lib /usr/lib';
919         libs='-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc';
920         lib_ext='.a';
921         libc='/lib/libc-2.2.4.so';
922         libperl='libperl.a';
923         ....
924
925 Additionally, extra colons can be used to control formatting.  A
926 trailing colon suppresses the linefeed and terminator ';', allowing
927 you to embed queries into shell commands.  (mnemonic: PATH separator
928 ':'.)
929
930     $ echo "compression-vars: " `perl -V:z.*: ` " are here !"
931     compression-vars:  zcat='' zip='zip'  are here !
932
933 A leading colon removes the 'name=' part of the response, this allows
934 you to map to the name you need.  (mnemonic: empty label)
935
936     $ echo "goodvfork="`./perl -Ilib -V::usevfork`
937     goodvfork=false;
938
939 Leading and trailing colons can be used together if you need
940 positional parameter values without the names.  Note that in the case
941 below, the PERL_API params are returned in alphabetical order.
942
943     $ echo building_on `perl -V::osname: -V::PERL_API_.*:` now
944     building_on 'linux' '5' '1' '9' now
945
946 =item B<-w>
947 X<-w>
948
949 prints warnings about dubious constructs, such as variable names
950 that are mentioned only once and scalar variables that are used
951 before being set, redefined subroutines, references to undefined
952 filehandles or filehandles opened read-only that you are attempting
953 to write on, values used as a number that don't look like numbers,
954 using an array as though it were a scalar, if your subroutines
955 recurse more than 100 deep, and innumerable other things.
956
957 This switch really just enables the internal C<$^W> variable.  You
958 can disable or promote into fatal errors specific warnings using
959 C<__WARN__> hooks, as described in L<perlvar> and L<perlfunc/warn>.
960 See also L<perldiag> and L<perltrap>.  A new, fine-grained warning
961 facility is also available if you want to manipulate entire classes
962 of warnings; see L<warnings> or L<perllexwarn>.
963
964 =item B<-W>
965 X<-W>
966
967 Enables all warnings regardless of C<no warnings> or C<$^W>.
968 See L<perllexwarn>.
969
970 =item B<-X>
971 X<-X>
972
973 Disables all warnings regardless of C<use warnings> or C<$^W>.
974 See L<perllexwarn>.
975
976 =item B<-x>
977 X<-x>
978
979 =item B<-x> I<directory>
980
981 tells Perl that the program is embedded in a larger chunk of unrelated
982 ASCII text, such as in a mail message.  Leading garbage will be
983 discarded until the first line that starts with #! and contains the
984 string "perl".  Any meaningful switches on that line will be applied.
985 If a directory name is specified, Perl will switch to that directory
986 before running the program.  The B<-x> switch controls only the
987 disposal of leading garbage.  The program must be terminated with
988 C<__END__> if there is trailing garbage to be ignored (the program
989 can process any or all of the trailing garbage via the DATA filehandle
990 if desired).
991
992 =back
993
994 =head1 ENVIRONMENT
995 X<perl, environment variables>
996
997 =over 12
998
999 =item HOME
1000 X<HOME>
1001
1002 Used if chdir has no argument.
1003
1004 =item LOGDIR
1005 X<LOGDIR>
1006
1007 Used if chdir has no argument and HOME is not set.
1008
1009 =item PATH
1010 X<PATH>
1011
1012 Used in executing subprocesses, and in finding the program if B<-S> is
1013 used.
1014
1015 =item PERL5LIB
1016 X<PERL5LIB>
1017
1018 A list of directories in which to look for Perl library
1019 files before looking in the standard library and the current
1020 directory.  Any architecture-specific directories under the specified
1021 locations are automatically included if they exist.  If PERL5LIB is not
1022 defined, PERLLIB is used.  Directories are separated (like in PATH) by
1023 a colon on unixish platforms and by a semicolon on Windows (the proper
1024 path separator being given by the command C<perl -V:path_sep>).
1025
1026 When running taint checks (either because the program was running setuid
1027 or setgid, or the B<-T> switch was used), neither variable is used.
1028 The program should instead say:
1029
1030     use lib "/my/directory";
1031
1032 =item PERL5OPT
1033 X<PERL5OPT>
1034
1035 Command-line options (switches).  Switches in this variable are taken
1036 as if they were on every Perl command line.  Only the B<-[CDIMUdmtwA]>
1037 switches are allowed.  When running taint checks (because the program
1038 was running setuid or setgid, or the B<-T> switch was used), this
1039 variable is ignored.  If PERL5OPT begins with B<-T>, tainting will be
1040 enabled, and any subsequent options ignored.
1041
1042 =item PERLIO
1043 X<PERLIO>
1044
1045 A space (or colon) separated list of PerlIO layers. If perl is built
1046 to use PerlIO system for IO (the default) these layers effect perl's IO.
1047
1048 It is conventional to start layer names with a colon e.g. C<:perlio> to
1049 emphasise their similarity to variable "attributes". But the code that parses
1050 layer specification strings (which is also used to decode the PERLIO
1051 environment variable) treats the colon as a separator.
1052
1053 An unset or empty PERLIO is equivalent to C<:stdio>.
1054
1055 The list becomes the default for I<all> perl's IO. Consequently only built-in
1056 layers can appear in this list, as external layers (such as :encoding()) need
1057 IO in  order to load them!. See L<"open pragma"|open> for how to add external
1058 encodings as defaults.
1059
1060 The layers that it makes sense to include in the PERLIO environment
1061 variable are briefly summarised below. For more details see L<PerlIO>.
1062
1063 =over 8
1064
1065 =item :bytes
1066 X<:bytes>
1067
1068 A pseudolayer that turns I<off> the C<:utf8> flag for the layer below.
1069 Unlikely to be useful on its own in the global PERLIO environment variable.
1070 You perhaps were thinking of C<:crlf:bytes> or C<:perlio:bytes>.
1071
1072 =item :crlf
1073 X<:crlf>
1074
1075 A layer which does CRLF to "\n" translation distinguishing "text" and
1076 "binary" files in the manner of MS-DOS and similar operating systems.
1077 (It currently does I<not> mimic MS-DOS as far as treating of Control-Z
1078 as being an end-of-file marker.)
1079
1080 =item :mmap
1081 X<:mmap>
1082
1083 A layer which implements "reading" of files by using C<mmap()> to
1084 make (whole) file appear in the process's address space, and then
1085 using that as PerlIO's "buffer".
1086
1087 =item :perlio
1088 X<:perlio>
1089
1090 This is a re-implementation of "stdio-like" buffering written as a
1091 PerlIO "layer".  As such it will call whatever layer is below it for
1092 its operations (typically C<:unix>).
1093
1094 =item :pop
1095 X<:pop>
1096
1097 An experimental pseudolayer that removes the topmost layer.
1098 Use with the same care as is reserved for nitroglycerin.
1099
1100 =item :raw
1101 X<:raw>
1102
1103 A pseudolayer that manipulates other layers.  Applying the C<:raw>
1104 layer is equivalent to calling C<binmode($fh)>.  It makes the stream
1105 pass each byte as-is without any translation.  In particular CRLF
1106 translation, and/or :utf8 intuited from locale are disabled.
1107
1108 Unlike in the earlier versions of Perl C<:raw> is I<not>
1109 just the inverse of C<:crlf> - other layers which would affect the
1110 binary nature of the stream are also removed or disabled.
1111
1112 =item :stdio
1113 X<:stdio>
1114
1115 This layer provides PerlIO interface by wrapping system's ANSI C "stdio"
1116 library calls. The layer provides both buffering and IO.
1117 Note that C<:stdio> layer does I<not> do CRLF translation even if that
1118 is platforms normal behaviour. You will need a C<:crlf> layer above it
1119 to do that.
1120
1121 =item :unix
1122 X<:unix>
1123
1124 Low level layer which calls C<read>, C<write> and C<lseek> etc.
1125
1126 =item :utf8
1127 X<:utf8>
1128
1129 A pseudolayer that turns on a flag on the layer below to tell perl
1130 that output should be in utf8 and that input should be regarded as
1131 already in utf8 form.  May be useful in PERLIO environment
1132 variable to make UTF-8 the default. (To turn off that behaviour
1133 use C<:bytes> layer.)
1134
1135 =item :win32
1136 X<:win32>
1137
1138 On Win32 platforms this I<experimental> layer uses native "handle" IO
1139 rather than unix-like numeric file descriptor layer. Known to be
1140 buggy in this release.
1141
1142 =back
1143
1144 On all platforms the default set of layers should give acceptable results.
1145
1146 For UNIX platforms that will equivalent of "unix perlio" or "stdio".
1147 Configure is setup to prefer "stdio" implementation if system's library
1148 provides for fast access to the buffer, otherwise it uses the "unix perlio"
1149 implementation.
1150
1151 On Win32 the default in this release is "unix crlf". Win32's "stdio"
1152 has a number of bugs/mis-features for perl IO which are somewhat
1153 C compiler vendor/version dependent. Using our own C<crlf> layer as
1154 the buffer avoids those issues and makes things more uniform.
1155 The C<crlf> layer provides CRLF to/from "\n" conversion as well as
1156 buffering.
1157
1158 This release uses C<unix> as the bottom layer on Win32 and so still uses C
1159 compiler's numeric file descriptor routines. There is an experimental native
1160 C<win32> layer which is expected to be enhanced and should eventually be
1161 the default under Win32.
1162
1163 =item PERLIO_DEBUG
1164 X<PERLIO_DEBUG>
1165
1166 If set to the name of a file or device then certain operations of PerlIO
1167 sub-system will be logged to that file (opened as append). Typical uses
1168 are UNIX:
1169
1170    PERLIO_DEBUG=/dev/tty perl script ...
1171
1172 and Win32 approximate equivalent:
1173
1174    set PERLIO_DEBUG=CON
1175    perl script ...
1176
1177 This functionality is disabled for setuid scripts and for scripts run
1178 with B<-T>.
1179
1180 =item PERLLIB
1181 X<PERLLIB>
1182
1183 A list of directories in which to look for Perl library
1184 files before looking in the standard library and the current directory.
1185 If PERL5LIB is defined, PERLLIB is not used.
1186
1187 =item PERL5DB
1188 X<PERL5DB>
1189
1190 The command used to load the debugger code.  The default is:
1191
1192         BEGIN { require 'perl5db.pl' }
1193
1194 =item PERL5DB_THREADED
1195 X<PERL5DB_THREADED>
1196
1197 If set to a true value, indicates to the debugger that the code being
1198 debugged uses threads.
1199
1200 =item PERL5SHELL (specific to the Win32 port)
1201 X<PERL5SHELL>
1202
1203 May be set to an alternative shell that perl must use internally for
1204 executing "backtick" commands or system().  Default is C<cmd.exe /x/d/c>
1205 on WindowsNT and C<command.com /c> on Windows95.  The value is considered
1206 to be space-separated.  Precede any character that needs to be protected
1207 (like a space or backslash) with a backslash.
1208
1209 Note that Perl doesn't use COMSPEC for this purpose because
1210 COMSPEC has a high degree of variability among users, leading to
1211 portability concerns.  Besides, perl can use a shell that may not be
1212 fit for interactive use, and setting COMSPEC to such a shell may
1213 interfere with the proper functioning of other programs (which usually
1214 look in COMSPEC to find a shell fit for interactive use).
1215
1216 =item PERL_ALLOW_NON_IFS_LSP (specific to the Win32 port)
1217 X<PERL_ALLOW_NON_IFS_LSP>
1218
1219 Set to 1 to allow the use of non-IFS compatible LSP's.
1220 Perl normally searches for an IFS-compatible LSP because this is required
1221 for its emulation of Windows sockets as real filehandles.  However, this may
1222 cause problems if you have a firewall such as McAfee Guardian which requires
1223 all applications to use its LSP which is not IFS-compatible, because clearly
1224 Perl will normally avoid using such an LSP.
1225 Setting this environment variable to 1 means that Perl will simply use the
1226 first suitable LSP enumerated in the catalog, which keeps McAfee Guardian
1227 happy (and in that particular case Perl still works too because McAfee
1228 Guardian's LSP actually plays some other games which allow applications
1229 requiring IFS compatibility to work).
1230
1231 =item PERL_DEBUG_MSTATS
1232 X<PERL_DEBUG_MSTATS>
1233
1234 Relevant only if perl is compiled with the malloc included with the perl
1235 distribution (that is, if C<perl -V:d_mymalloc> is 'define').
1236 If set, this causes memory statistics to be dumped after execution.  If set
1237 to an integer greater than one, also causes memory statistics to be dumped
1238 after compilation.
1239
1240 =item PERL_DESTRUCT_LEVEL
1241 X<PERL_DESTRUCT_LEVEL>
1242
1243 Relevant only if your perl executable was built with B<-DDEBUGGING>,
1244 this controls the behavior of global destruction of objects and other
1245 references.  See L<perlhack/PERL_DESTRUCT_LEVEL> for more information.
1246
1247 =item PERL_DL_NONLAZY
1248 X<PERL_DL_NONLAZY>
1249
1250 Set to one to have perl resolve B<all> undefined symbols when it loads
1251 a dynamic library.  The default behaviour is to resolve symbols when
1252 they are used.  Setting this variable is useful during testing of
1253 extensions as it ensures that you get an error on misspelled function
1254 names even if the test suite doesn't call it.
1255
1256 =item PERL_ENCODING
1257 X<PERL_ENCODING>
1258
1259 If using the C<encoding> pragma without an explicit encoding name, the
1260 PERL_ENCODING environment variable is consulted for an encoding name.
1261
1262 =item PERL_HASH_SEED
1263 X<PERL_HASH_SEED>
1264
1265 (Since Perl 5.8.1.)  Used to randomise Perl's internal hash function.
1266 To emulate the pre-5.8.1 behaviour, set to an integer (zero means
1267 exactly the same order as 5.8.0).  "Pre-5.8.1" means, among other
1268 things, that hash keys will be ordered the same between different runs
1269 of Perl.
1270
1271 The default behaviour is to randomise unless the PERL_HASH_SEED is set.
1272 If Perl has been compiled with C<-DUSE_HASH_SEED_EXPLICIT>, the default
1273 behaviour is B<not> to randomise unless the PERL_HASH_SEED is set.
1274
1275 If PERL_HASH_SEED is unset or set to a non-numeric string, Perl uses
1276 the pseudorandom seed supplied by the operating system and libraries.
1277 This means that each different run of Perl will have a different
1278 ordering of the results of keys(), values(), and each().
1279
1280 B<Please note that the hash seed is sensitive information>. Hashes are
1281 randomized to protect against local and remote attacks against Perl
1282 code. By manually setting a seed this protection may be partially or
1283 completely lost.
1284
1285 See L<perlsec/"Algorithmic Complexity Attacks"> and
1286 L</PERL_HASH_SEED_DEBUG> for more information.
1287
1288 =item PERL_HASH_SEED_DEBUG
1289 X<PERL_HASH_SEED_DEBUG>
1290
1291 (Since Perl 5.8.1.)  Set to one to display (to STDERR) the value of
1292 the hash seed at the beginning of execution.  This, combined with
1293 L</PERL_HASH_SEED> is intended to aid in debugging nondeterministic
1294 behavior caused by hash randomization.
1295
1296 B<Note that the hash seed is sensitive information>: by knowing it one
1297 can craft a denial-of-service attack against Perl code, even remotely,
1298 see L<perlsec/"Algorithmic Complexity Attacks"> for more information.
1299 B<Do not disclose the hash seed> to people who don't need to know it.
1300 See also hash_seed() of L<Hash::Util>.
1301
1302 =item PERL_ROOT (specific to the VMS port)
1303 X<PERL_ROOT>
1304
1305 A translation concealed rooted logical name that contains perl and the
1306 logical device for the @INC path on VMS only.  Other logical names that
1307 affect perl on VMS include PERLSHR, PERL_ENV_TABLES, and
1308 SYS$TIMEZONE_DIFFERENTIAL but are optional and discussed further in
1309 L<perlvms> and in F<README.vms> in the Perl source distribution.
1310
1311 =item PERL_SIGNALS
1312 X<PERL_SIGNALS>
1313
1314 In Perls 5.8.1 and later.  If set to C<unsafe> the pre-Perl-5.8.0
1315 signals behaviour (immediate but unsafe) is restored.  If set to
1316 C<safe> the safe (or deferred) signals are used.
1317 See L<perlipc/"Deferred Signals (Safe Signals)">.
1318
1319 =item PERL_UNICODE
1320 X<PERL_UNICODE>
1321
1322 Equivalent to the B<-C> command-line switch.  Note that this is not
1323 a boolean variable-- setting this to C<"1"> is not the right way to
1324 "enable Unicode" (whatever that would mean).  You can use C<"0"> to
1325 "disable Unicode", though (or alternatively unset PERL_UNICODE in
1326 your shell before starting Perl).  See the description of the C<-C>
1327 switch for more information.
1328
1329 =item SYS$LOGIN (specific to the VMS port)
1330 X<SYS$LOGIN>
1331
1332 Used if chdir has no argument and HOME and LOGDIR are not set.
1333
1334 =back
1335
1336 Perl also has environment variables that control how Perl handles data
1337 specific to particular natural languages.  See L<perllocale>.
1338
1339 Apart from these, Perl uses no other environment variables, except
1340 to make them available to the program being executed, and to child
1341 processes.  However, programs running setuid would do well to execute
1342 the following lines before doing anything else, just to keep people
1343 honest:
1344
1345     $ENV{PATH}  = '/bin:/usr/bin';    # or whatever you need
1346     $ENV{SHELL} = '/bin/sh' if exists $ENV{SHELL};
1347     delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};