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