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