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