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