3 perlrun - how to execute the Perl interpreter
7 B<perl> S<[ B<-CsTtuUWX> ]>
8 S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
9 S<[ B<-cw> ] [ B<-d>[:I<debugger>] ] [ B<-D>[I<number/list>] ]>
10 S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal>] ]>
11 S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ]>
15 S<[ B<-i>[I<extension>] ]>
16 S<[ B<-e> I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
20 The normal way to run a Perl program is by making it directly
21 executable, or else by passing the name of the source file as an
22 argument on the command line. (An interactive Perl environment
23 is also possible--see L<perldebug> for details on how to do that.)
24 Upon startup, Perl looks for your program in one of the following
31 Specified line by line via B<-e> switches on the command line.
35 Contained in the file specified by the first filename on the command line.
36 (Note that systems supporting the #! notation invoke interpreters this
37 way. See L<Location of Perl>.)
41 Passed in implicitly via standard input. This works only if there are
42 no filename arguments--to pass arguments to a STDIN-read program you
43 must explicitly specify a "-" for the program name.
47 With methods 2 and 3, Perl starts parsing the input file from the
48 beginning, unless you've specified a B<-x> switch, in which case it
49 scans for the first line starting with #! and containing the word
50 "perl", and starts there instead. This is useful for running a program
51 embedded in a larger message. (In this case you would indicate the end
52 of the program using the C<__END__> token.)
54 The #! line is always examined for switches as the line is being
55 parsed. Thus, if you're on a machine that allows only one argument
56 with the #! line, or worse, doesn't even recognize the #! line, you
57 still can get consistent switch behavior regardless of how Perl was
58 invoked, even if B<-x> was used to find the beginning of the program.
60 Because historically some operating systems silently chopped off
61 kernel interpretation of the #! line after 32 characters, some
62 switches may be passed in on the command line, and some may not;
63 you could even get a "-" without its letter, if you're not careful.
64 You probably want to make sure that all your switches fall either
65 before or after that 32-character boundary. Most switches don't
66 actually care if they're processed redundantly, but getting a "-"
67 instead of a complete switch could cause Perl to try to execute
68 standard input instead of your program. And a partial B<-I> switch
69 could also cause odd results.
71 Some switches do care if they are processed twice, for instance
72 combinations of B<-l> and B<-0>. Either put all the switches after
73 the 32-character boundary (if applicable), or replace the use of
74 B<-0>I<digits> by C<BEGIN{ $/ = "\0digits"; }>.
76 Parsing of the #! switches starts wherever "perl" is mentioned in the line.
77 The sequences "-*" and "- " are specifically ignored so that you could,
78 if you were so inclined, say
80 #!/bin/sh -- # -*- perl -*- -p
81 eval 'exec perl -wS $0 ${1+"$@"}'
82 if $running_under_some_shell;
84 to let Perl see the B<-p> switch.
86 A similar trick involves the B<env> program, if you have it.
90 The examples above use a relative path to the perl interpreter,
91 getting whatever version is first in the user's path. If you want
92 a specific version of Perl, say, perl5.005_57, you should place
93 that directly in the #! line's path.
95 If the #! line does not contain the word "perl", the program named after
96 the #! is executed instead of the Perl interpreter. This is slightly
97 bizarre, but it helps people on machines that don't do #!, because they
98 can tell a program that their SHELL is F</usr/bin/perl>, and Perl will then
99 dispatch the program to the correct interpreter for them.
101 After locating your program, Perl compiles the entire program to an
102 internal form. If there are any compilation errors, execution of the
103 program is not attempted. (This is unlike the typical shell script,
104 which might run part-way through before finding a syntax error.)
106 If the program is syntactically correct, it is executed. If the program
107 runs off the end without hitting an exit() or die() operator, an implicit
108 C<exit(0)> is provided to indicate successful completion.
110 =head2 #! and quoting on non-Unix systems
112 Unix's #! technique can be simulated on other systems:
120 extproc perl -S -your_switches
122 as the first line in C<*.cmd> file (B<-S> due to a bug in cmd.exe's
127 Create a batch file to run your program, and codify it in
128 C<ALTERNATIVE_SHEBANG> (see the F<dosish.h> file in the source
129 distribution for more information).
133 The Win95/NT installation, when using the ActiveState installer for Perl,
134 will modify the Registry to associate the F<.pl> extension with the perl
135 interpreter. If you install Perl by other means (including building from
136 the sources), you may have to modify the Registry yourself. Note that
137 this means you can no longer tell the difference between an executable
138 Perl program and a Perl library file.
142 A Macintosh perl program will have the appropriate Creator and
143 Type, so that double-clicking them will invoke the perl application.
149 $ perl -mysw 'f$env("procedure")' 'p1' 'p2' 'p3' 'p4' 'p5' 'p6' 'p7' 'p8' !
150 $ exit++ + ++$status != 0 and $exit = $status = undef;
152 at the top of your program, where B<-mysw> are any command line switches you
153 want to pass to Perl. You can now invoke the program directly, by saying
154 C<perl program>, or as a DCL procedure, by saying C<@program> (or implicitly
155 via F<DCL$PATH> by just using the name of the program).
157 This incantation is a bit much to remember, but Perl will display it for
158 you if you say C<perl "-V:startperl">.
162 Command-interpreters on non-Unix systems have rather different ideas
163 on quoting than Unix shells. You'll need to learn the special
164 characters in your command-interpreter (C<*>, C<\> and C<"> are
165 common) and how to protect whitespace and these characters to run
166 one-liners (see B<-e> below).
168 On some systems, you may have to change single-quotes to double ones,
169 which you must I<not> do on Unix or Plan9 systems. You might also
170 have to change a single % to a %%.
175 perl -e 'print "Hello world\n"'
178 perl -e "print \"Hello world\n\""
181 print "Hello world\n"
182 (then Run "Myscript" or Shift-Command-R)
185 perl -e "print ""Hello world\n"""
187 The problem is that none of this is reliable: it depends on the
188 command and it is entirely possible neither works. If B<4DOS> were
189 the command shell, this would probably work better:
191 perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>""
193 B<CMD.EXE> in Windows NT slipped a lot of standard Unix functionality in
194 when nobody was looking, but just try to find documentation for its
197 Under the Macintosh, it depends which environment you are using. The MacPerl
198 shell, or MPW, is much like Unix shells in its support for several
199 quoting variants, except that it makes free use of the Macintosh's non-ASCII
200 characters as control characters.
202 There is no general solution to all of this. It's just a mess.
204 =head2 Location of Perl
206 It may seem obvious to say, but Perl is useful only when users can
207 easily find it. When possible, it's good for both F</usr/bin/perl>
208 and F</usr/local/bin/perl> to be symlinks to the actual binary. If
209 that can't be done, system administrators are strongly encouraged
210 to put (symlinks to) perl and its accompanying utilities into a
211 directory typically found along a user's PATH, or in some other
212 obvious and convenient place.
214 In this documentation, C<#!/usr/bin/perl> on the first line of the program
215 will stand in for whatever method works on your system. You are
216 advised to use a specific path if you care about a specific version.
218 #!/usr/local/bin/perl5.00554
220 or if you just want to be running at least version, place a statement
221 like this at the top of your program:
225 =head2 Command Switches
227 As with all standard commands, a single-character switch may be
228 clustered with the following switch, if any.
230 #!/usr/bin/perl -spi.orig # same as -s -p -i.orig
236 =item B<-0>[I<digits>]
238 specifies the input record separator (C<$/>) as an octal number. If there are
239 no digits, the null character is the separator. Other switches may
240 precede or follow the digits. For example, if you have a version of
241 B<find> which can print filenames terminated by the null character, you
244 find . -name '*.orig' -print0 | perl -n0e unlink
246 The special value 00 will cause Perl to slurp files in paragraph mode.
247 The value 0777 will cause Perl to slurp files whole because there is no
248 legal character with that value.
252 turns on autosplit mode when used with a B<-n> or B<-p>. An implicit
253 split command to the @F array is done as the first thing inside the
254 implicit while loop produced by the B<-n> or B<-p>.
256 perl -ane 'print pop(@F), "\n";'
265 An alternate delimiter may be specified using B<-F>.
269 enables Perl to use the native wide character APIs on the target system.
270 The magic variable C<${^WIDE_SYSTEM_CALLS}> reflects the state of
271 this switch. See L<perlvar/"${^WIDE_SYSTEM_CALLS}">.
273 This feature is currently only implemented on the Win32 platform.
277 causes Perl to check the syntax of the program and then exit without
278 executing it. Actually, it I<will> execute C<BEGIN>, C<CHECK>, and
279 C<use> blocks, because these are considered as occurring outside the
280 execution of your program. C<INIT> and C<END> blocks, however, will
285 runs the program under the Perl debugger. See L<perldebug>.
287 =item B<-d:>I<foo[=bar,baz]>
289 runs the program under the control of a debugging, profiling, or
290 tracing module installed as Devel::foo. E.g., B<-d:DProf> executes
291 the program using the Devel::DProf profiler. As with the B<-M>
292 flag, options may be passed to the Devel::foo package where they
293 will be received and interpreted by the Devel::foo::import routine.
294 The comma-separated list of options must follow a C<=> character.
297 =item B<-D>I<letters>
301 sets debugging flags. To watch how it executes your program, use
302 B<-Dtls>. (This works only if debugging is compiled into your
303 Perl.) Another nice value is B<-Dx>, which lists your compiled
304 syntax tree. And B<-Dr> displays compiled regular expressions;
305 the format of the output is explained in L<perldebguts>.
307 As an alternative, specify a number instead of list of letters (e.g.,
308 B<-D14> is equivalent to B<-Dtls>):
310 1 p Tokenizing and parsing
312 4 l Context (loop) stack processing
314 16 o Method and overloading resolution
315 32 c String/numeric conversions
316 64 P Print preprocessor command for -P, source file input state
317 128 m Memory allocation
318 256 f Format processing
319 512 r Regular expression parsing and execution
320 1024 x Syntax tree dump
321 2048 u Tainting checks
322 4096 L Memory leaks (needs -DLEAKTEST when compiling Perl)
323 8192 H Hash dump -- usurps values()
324 16384 X Scratchpad allocation
326 65536 S Thread synchronization
328 262144 R Include reference counts of dumped variables (eg when using -Ds)
330 All these flags require B<-DDEBUGGING> when you compile the Perl
331 executable. See the F<INSTALL> file in the Perl source distribution
332 for how to do this. This flag is automatically set if you include B<-g>
333 option when C<Configure> asks you about optimizer/debugger flags.
335 If you're just trying to get a print out of each line of Perl code
336 as it executes, the way that C<sh -x> provides for shell scripts,
337 you can't use Perl's B<-D> switch. Instead do this
339 # If you have "env" utility
340 env=PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
342 # Bourne shell syntax
343 $ PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
346 % (setenv PERLDB_OPTS "NonStop=1 AutoTrace=1 frame=2"; perl -dS program)
348 See L<perldebug> for details and variations.
350 =item B<-e> I<commandline>
352 may be used to enter one line of program. If B<-e> is given, Perl
353 will not look for a filename in the argument list. Multiple B<-e>
354 commands may be given to build up a multi-line script. Make sure
355 to use semicolons where you would in a normal program.
357 =item B<-F>I<pattern>
359 specifies the pattern to split on if B<-a> is also in effect. The
360 pattern may be surrounded by C<//>, C<"">, or C<''>, otherwise it will be
361 put in single quotes.
365 prints a summary of the options.
367 =item B<-i>[I<extension>]
369 specifies that files processed by the C<E<lt>E<gt>> construct are to be
370 edited in-place. It does this by renaming the input file, opening the
371 output file by the original name, and selecting that output file as the
372 default for print() statements. The extension, if supplied, is used to
373 modify the name of the old file to make a backup copy, following these
376 If no extension is supplied, no backup is made and the current file is
379 If the extension doesn't contain a C<*>, then it is appended to the
380 end of the current filename as a suffix. If the extension does
381 contain one or more C<*> characters, then each C<*> is replaced
382 with the current filename. In Perl terms, you could think of this
385 ($backup = $extension) =~ s/\*/$file_name/g;
387 This allows you to add a prefix to the backup file, instead of (or in
388 addition to) a suffix:
390 $ perl -pi 'orig_*' -e 's/bar/baz/' fileA # backup to 'orig_fileA'
392 Or even to place backup copies of the original files into another
393 directory (provided the directory already exists):
395 $ perl -pi 'old/*.orig' -e 's/bar/baz/' fileA # backup to 'old/fileA.orig'
397 These sets of one-liners are equivalent:
399 $ perl -pi -e 's/bar/baz/' fileA # overwrite current file
400 $ perl -pi '*' -e 's/bar/baz/' fileA # overwrite current file
402 $ perl -pi '.orig' -e 's/bar/baz/' fileA # backup to 'fileA.orig'
403 $ perl -pi '*.orig' -e 's/bar/baz/' fileA # backup to 'fileA.orig'
405 From the shell, saying
407 $ perl -p -i.orig -e "s/foo/bar/; ... "
409 is the same as using the program:
411 #!/usr/bin/perl -pi.orig
414 which is equivalent to
417 $extension = '.orig';
419 if ($ARGV ne $oldargv) {
420 if ($extension !~ /\*/) {
421 $backup = $ARGV . $extension;
424 ($backup = $extension) =~ s/\*/$ARGV/g;
426 rename($ARGV, $backup);
427 open(ARGVOUT, ">$ARGV");
434 print; # this prints to original filename
438 except that the B<-i> form doesn't need to compare $ARGV to $oldargv to
439 know when the filename has changed. It does, however, use ARGVOUT for
440 the selected filehandle. Note that STDOUT is restored as the default
441 output filehandle after the loop.
443 As shown above, Perl creates the backup file whether or not any output
444 is actually changed. So this is just a fancy way to copy files:
446 $ perl -p -i '/some/file/path/*' -e 1 file1 file2 file3...
448 $ perl -p -i '.orig' -e 1 file1 file2 file3...
450 You can use C<eof> without parentheses to locate the end of each input
451 file, in case you want to append to each file, or reset line numbering
452 (see example in L<perlfunc/eof>).
454 If, for a given file, Perl is unable to create the backup file as
455 specified in the extension then it will skip that file and continue on
456 with the next one (if it exists).
458 For a discussion of issues surrounding file permissions and B<-i>,
459 see L<perlfaq5/Why does Perl let me delete read-only files? Why does -i clobber protected files? Isn't this a bug in Perl?>.
461 You cannot use B<-i> to create directories or to strip extensions from
464 Perl does not expand C<~> in filenames, which is good, since some
465 folks use it for their backup files:
467 $ perl -pi~ -e 's/foo/bar/' file1 file2 file3...
469 Finally, the B<-i> switch does not impede execution when no
470 files are given on the command line. In this case, no backup is made
471 (the original file cannot, of course, be determined) and processing
472 proceeds from STDIN to STDOUT as might be expected.
474 =item B<-I>I<directory>
476 Directories specified by B<-I> are prepended to the search path for
477 modules (C<@INC>), and also tells the C preprocessor where to search for
478 include files. The C preprocessor is invoked with B<-P>; by default it
479 searches /usr/include and /usr/lib/perl.
481 =item B<-l>[I<octnum>]
483 enables automatic line-ending processing. It has two separate
484 effects. First, it automatically chomps C<$/> (the input record
485 separator) when used with B<-n> or B<-p>. Second, it assigns C<$\>
486 (the output record separator) to have the value of I<octnum> so
487 that any print statements will have that separator added back on.
488 If I<octnum> is omitted, sets C<$\> to the current value of
489 C<$/>. For instance, to trim lines to 80 columns:
491 perl -lpe 'substr($_, 80) = ""'
493 Note that the assignment C<$\ = $/> is done when the switch is processed,
494 so the input record separator can be different than the output record
495 separator if the B<-l> switch is followed by a B<-0> switch:
497 gnufind / -print0 | perl -ln0e 'print "found $_" if -p'
499 This sets C<$\> to newline and then sets C<$/> to the null character.
501 =item B<-m>[B<->]I<module>
503 =item B<-M>[B<->]I<module>
505 =item B<-M>[B<->]I<'module ...'>
507 =item B<-[mM]>[B<->]I<module=arg[,arg]...>
509 B<-m>I<module> executes C<use> I<module> C<();> before executing your
512 B<-M>I<module> executes C<use> I<module> C<;> before executing your
513 program. You can use quotes to add extra code after the module name,
514 e.g., C<'-Mmodule qw(foo bar)'>.
516 If the first character after the B<-M> or B<-m> is a dash (C<->)
517 then the 'use' is replaced with 'no'.
519 A little builtin syntactic sugar means you can also say
520 B<-mmodule=foo,bar> or B<-Mmodule=foo,bar> as a shortcut for
521 C<'-Mmodule qw(foo bar)'>. This avoids the need to use quotes when
522 importing symbols. The actual code generated by B<-Mmodule=foo,bar> is
523 C<use module split(/,/,q{foo,bar})>. Note that the C<=> form
524 removes the distinction between B<-m> and B<-M>.
528 causes Perl to assume the following loop around your program, which
529 makes it iterate over filename arguments somewhat like B<sed -n> or
534 ... # your program goes here
537 Note that the lines are not printed by default. See B<-p> to have
538 lines printed. If a file named by an argument cannot be opened for
539 some reason, Perl warns you about it and moves on to the next file.
541 Here is an efficient way to delete all files older than a week:
543 find . -mtime +7 -print | perl -nle unlink
545 This is faster than using the B<-exec> switch of B<find> because you don't
546 have to start a process on every filename found. It does suffer from
547 the bug of mishandling newlines in pathnames, which you can fix if
550 C<BEGIN> and C<END> blocks may be used to capture control before or after
551 the implicit program loop, just as in B<awk>.
555 causes Perl to assume the following loop around your program, which
556 makes it iterate over filename arguments somewhat like B<sed>:
561 ... # your program goes here
563 print or die "-p destination: $!\n";
566 If a file named by an argument cannot be opened for some reason, Perl
567 warns you about it, and moves on to the next file. Note that the
568 lines are printed automatically. An error occurring during printing is
569 treated as fatal. To suppress printing use the B<-n> switch. A B<-p>
570 overrides a B<-n> switch.
572 C<BEGIN> and C<END> blocks may be used to capture control before or after
573 the implicit loop, just as in B<awk>.
577 B<NOTE: Use of -P is strongly discouraged because of its inherent
578 problems, including poor portability.>
580 This option causes your program to be run through the C preprocessor before
581 compilation by Perl. Because both comments and B<cpp> directives begin
582 with the # character, you should avoid starting comments with any words
583 recognized by the C preprocessor such as C<"if">, C<"else">, or C<"define">.
585 If you're considering using C<-P>, you might also want to look at the
586 Filter::cpp module from CPAN.
588 The problems of -P include, but are not limited to:
594 The C<#!> line is stripped, so any switches there don't apply.
598 A C<-P> on a C<#!> line doesn't work.
602 B<All> lines that begin with (whitespace and) a C<#> but
603 do not look like cpp commands, are stripped, including anything
604 inside Perl strings, regular expressions, and here-docs .
608 In some platforms the C preprocessor knows too much: it knows about
609 the C++ -style until-end-of-line comments starting with C<"//">.
610 This will cause problems with common Perl constructs like
614 because after -P this will became illegal code
618 The workaround is to use some other quoting separator than C<"/">,
619 like for example C<"!">:
627 It requires not only a working C preprocessor but also a working
628 F<sed>. If not on UNIX, you are probably out of luck on this.
632 Script line numbers are not preserved.
636 The C<-x> does not work with C<-P>.
642 enables rudimentary switch parsing for switches on the command
643 line after the program name but before any filename arguments (or before
644 an argument of B<-->). This means you can have switches with two leading
645 dashes (B<--help>). Any switch found there is removed from @ARGV and sets the
646 corresponding variable in the Perl program. The following program
647 prints "1" if the program is invoked with a B<-xyz> switch, and "abc"
648 if it is invoked with B<-xyz=abc>.
651 if ($xyz) { print "$xyz\n" }
653 Do note that B<--help> creates the variable ${-help}, which is not compliant
658 makes Perl use the PATH environment variable to search for the
659 program (unless the name of the program contains directory separators).
661 On some platforms, this also makes Perl append suffixes to the
662 filename while searching for it. For example, on Win32 platforms,
663 the ".bat" and ".cmd" suffixes are appended if a lookup for the
664 original name fails, and if the name does not already end in one
665 of those suffixes. If your Perl was compiled with DEBUGGING turned
666 on, using the -Dp switch to Perl shows how the search progresses.
668 Typically this is used to emulate #! startup on platforms that
669 don't support #!. This example works on many platforms that
670 have a shell compatible with Bourne shell:
673 eval 'exec /usr/bin/perl -wS $0 ${1+"$@"}'
674 if $running_under_some_shell;
676 The system ignores the first line and feeds the program to F</bin/sh>,
677 which proceeds to try to execute the Perl program as a shell script.
678 The shell executes the second line as a normal shell command, and thus
679 starts up the Perl interpreter. On some systems $0 doesn't always
680 contain the full pathname, so the B<-S> tells Perl to search for the
681 program if necessary. After Perl locates the program, it parses the
682 lines and ignores them because the variable $running_under_some_shell
683 is never true. If the program will be interpreted by csh, you will need
684 to replace C<${1+"$@"}> with C<$*>, even though that doesn't understand
685 embedded spaces (and such) in the argument list. To start up sh rather
686 than csh, some systems may have to replace the #! line with a line
687 containing just a colon, which will be politely ignored by Perl. Other
688 systems can't control that, and need a totally devious construct that
689 will work under any of B<csh>, B<sh>, or Perl, such as the following:
691 eval '(exit $?0)' && eval 'exec perl -wS $0 ${1+"$@"}'
692 & eval 'exec /usr/bin/perl -wS $0 $argv:q'
693 if $running_under_some_shell;
695 If the filename supplied contains directory separators (i.e., is an
696 absolute or relative pathname), and if that file is not found,
697 platforms that append file extensions will do so and try to look
698 for the file with those extensions added, one by one.
700 On DOS-like platforms, if the program does not contain directory
701 separators, it will first be searched for in the current directory
702 before being searched for on the PATH. On Unix platforms, the
703 program will be searched for strictly on the PATH.
707 Like B<-T>, but taint checks will issue warnings rather than fatal
708 errors. These warnings can be controlled normally with C<no warnings
711 B<NOTE: this is not a substitute for -T.> This is meant only to be
712 used as a temporary development aid while securing legacy code:
713 for real production code and for new secure code written from scratch
714 always use the real B<-T>.
718 forces "taint" checks to be turned on so you can test them. Ordinarily
719 these checks are done only when running setuid or setgid. It's a
720 good idea to turn them on explicitly for programs that run on behalf
721 of someone else whom you might not necessarily trust, such as CGI
722 programs or any internet servers you might write in Perl. See
723 L<perlsec> for details. For security reasons, this option must be
724 seen by Perl quite early; usually this means it must appear early
725 on the command line or in the #! line for systems which support
730 This obsolete switch causes Perl to dump core after compiling your
731 program. You can then in theory take this core dump and turn it
732 into an executable file by using the B<undump> program (not supplied).
733 This speeds startup at the expense of some disk space (which you
734 can minimize by stripping the executable). (Still, a "hello world"
735 executable comes out to about 200K on my machine.) If you want to
736 execute a portion of your program before dumping, use the dump()
737 operator instead. Note: availability of B<undump> is platform
738 specific and may not be available for a specific port of Perl.
740 This switch has been superseded in favor of the new Perl code
741 generator backends to the compiler. See L<B> and L<B::Bytecode>
746 allows Perl to do unsafe operations. Currently the only "unsafe"
747 operations are the unlinking of directories while running as superuser,
748 and running setuid programs with fatal taint checks turned into
749 warnings. Note that the B<-w> switch (or the C<$^W> variable) must
750 be used along with this option to actually I<generate> the
751 taint-check warnings.
755 prints the version and patchlevel of your perl executable.
759 prints summary of the major perl configuration values and the current
764 Prints to STDOUT the value of the named configuration variable.
769 will provide strong clues about what your MANPATH variable should
770 be set to in order to access the Perl documentation.
774 prints warnings about dubious constructs, such as variable names
775 that are mentioned only once and scalar variables that are used
776 before being set, redefined subroutines, references to undefined
777 filehandles or filehandles opened read-only that you are attempting
778 to write on, values used as a number that doesn't look like numbers,
779 using an array as though it were a scalar, if your subroutines
780 recurse more than 100 deep, and innumerable other things.
782 This switch really just enables the internal C<^$W> variable. You
783 can disable or promote into fatal errors specific warnings using
784 C<__WARN__> hooks, as described in L<perlvar> and L<perlfunc/warn>.
785 See also L<perldiag> and L<perltrap>. A new, fine-grained warning
786 facility is also available if you want to manipulate entire classes
787 of warnings; see L<warnings> or L<perllexwarn>.
791 Enables all warnings regardless of C<no warnings> or C<$^W>.
796 Disables all warnings regardless of C<use warnings> or C<$^W>.
799 =item B<-x> I<directory>
801 tells Perl that the program is embedded in a larger chunk of unrelated
802 ASCII text, such as in a mail message. Leading garbage will be
803 discarded until the first line that starts with #! and contains the
804 string "perl". Any meaningful switches on that line will be applied.
805 If a directory name is specified, Perl will switch to that directory
806 before running the program. The B<-x> switch controls only the
807 disposal of leading garbage. The program must be terminated with
808 C<__END__> if there is trailing garbage to be ignored (the program
809 can process any or all of the trailing garbage via the DATA filehandle
820 Used if chdir has no argument.
824 Used if chdir has no argument and HOME is not set.
828 Used in executing subprocesses, and in finding the program if B<-S> is
833 A colon-separated list of directories in which to look for Perl library
834 files before looking in the standard library and the current
835 directory. Any architecture-specific directories under the specified
836 locations are automatically included if they exist. If PERL5LIB is not
837 defined, PERLLIB is used.
839 When running taint checks (either because the program was running setuid
840 or setgid, or the B<-T> switch was used), neither variable is used.
841 The program should instead say:
843 use lib "/my/directory";
847 Command-line options (switches). Switches in this variable are taken
848 as if they were on every Perl command line. Only the B<-[DIMUdmtw]>
849 switches are allowed. When running taint checks (because the program
850 was running setuid or setgid, or the B<-T> switch was used), this
851 variable is ignored. If PERL5OPT begins with B<-T>, tainting will be
852 enabled, and any subsequent options ignored.
856 A colon-separated list of directories in which to look for Perl library
857 files before looking in the standard library and the current directory.
858 If PERL5LIB is defined, PERLLIB is not used.
862 The command used to load the debugger code. The default is:
864 BEGIN { require 'perl5db.pl' }
866 =item PERL5SHELL (specific to the Win32 port)
868 May be set to an alternative shell that perl must use internally for
869 executing "backtick" commands or system(). Default is C<cmd.exe /x/c>
870 on WindowsNT and C<command.com /c> on Windows95. The value is considered
871 to be space-separated. Precede any character that needs to be protected
872 (like a space or backslash) with a backslash.
874 Note that Perl doesn't use COMSPEC for this purpose because
875 COMSPEC has a high degree of variability among users, leading to
876 portability concerns. Besides, perl can use a shell that may not be
877 fit for interactive use, and setting COMSPEC to such a shell may
878 interfere with the proper functioning of other programs (which usually
879 look in COMSPEC to find a shell fit for interactive use).
881 =item PERL_DEBUG_MSTATS
883 Relevant only if perl is compiled with the malloc included with the perl
884 distribution (that is, if C<perl -V:d_mymalloc> is 'define').
885 If set, this causes memory statistics to be dumped after execution. If set
886 to an integer greater than one, also causes memory statistics to be dumped
889 =item PERL_DESTRUCT_LEVEL
891 Relevant only if your perl executable was built with B<-DDEBUGGING>,
892 this controls the behavior of global destruction of objects and other
893 references. See L<perlhack/PERL_DESTRUCT_LEVEL> for more information.
897 If using the C<encoding> pragma without an explicit encoding name, the
898 PERL_ENCODING environment variable is consulted for an encoding name.
900 =item PERL_ROOT (specific to the VMS port)
902 A translation concealed rooted logical name that contains perl and the
903 logical device for the @INC path on VMS only. Other logical names that
904 affect perl on VMS include PERLSHR, PERL_ENV_TABLES, and
905 SYS$TIMEZONE_DIFFERENTIAL but are optional and discussed further in
906 L<perlvms> and in F<README.vms> in the Perl source distribution.
908 =item SYS$LOGIN (specific to the VMS port)
910 Used if chdir has no argument and HOME and LOGDIR are not set.
914 Perl also has environment variables that control how Perl handles data
915 specific to particular natural languages. See L<perllocale>.
917 Apart from these, Perl uses no other environment variables, except
918 to make them available to the program being executed, and to child
919 processes. However, programs running setuid would do well to execute
920 the following lines before doing anything else, just to keep people
923 $ENV{PATH} = '/bin:/usr/bin'; # or whatever you need
924 $ENV{SHELL} = '/bin/sh' if exists $ENV{SHELL};
925 delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};