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