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