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