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