This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
b386498c2c7b84b8dfc7dca9b05fc53d52ed0b0f
[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>[: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 runs the program under the Perl debugger.  See L<perldebug>.
346
347 =item B<-d:>I<foo[=bar,baz]>
348
349 runs the program under the control of a debugging, profiling, or
350 tracing module installed as Devel::foo. E.g., B<-d:DProf> executes
351 the program using the Devel::DProf profiler.  As with the B<-M>
352 flag, options may be passed to the Devel::foo package where they
353 will be received and interpreted by the Devel::foo::import routine.
354 The comma-separated list of options must follow a C<=> character.
355 See L<perldebug>.
356
357 =item B<-D>I<letters>
358
359 =item B<-D>I<number>
360
361 sets debugging flags.  To watch how it executes your program, use
362 B<-Dtls>.  (This works only if debugging is compiled into your
363 Perl.)  Another nice value is B<-Dx>, which lists your compiled
364 syntax tree.  And B<-Dr> displays compiled regular expressions;
365 the format of the output is explained in L<perldebguts>.
366
367 As an alternative, specify a number instead of list of letters (e.g.,
368 B<-D14> is equivalent to B<-Dtls>):
369
370         1  p  Tokenizing and parsing (with v, displays parse stack)
371         2  s  Stack snapshots
372                 with v, displays all stacks
373         4  l  Context (loop) stack processing
374         8  t  Trace execution
375        16  o  Method and overloading resolution
376        32  c  String/numeric conversions
377        64  P  Print profiling info, preprocessor command for -P, source file input state
378       128  m  Memory allocation
379       256  f  Format processing
380       512  r  Regular expression parsing and execution
381      1024  x  Syntax tree dump
382      2048  u  Tainting checks
383      4096     (Obsolete, previously used for LEAKTEST)
384      8192  H  Hash dump -- usurps values()
385     16384  X  Scratchpad allocation
386     32768  D  Cleaning up
387     65536  S  Thread synchronization
388    131072  T  Tokenising
389    262144  R  Include reference counts of dumped variables (eg when using -Ds)
390    524288  J  Do not s,t,P-debug (Jump over) opcodes within package DB
391   1048576  v  Verbose: use in conjunction with other flags
392   2097152  C  Copy On Write
393   4194304  A  Consistency checks on internal structures
394   8388608  q  quiet - currently only suppressed the "EXECUTING" message
395
396 All these flags require B<-DDEBUGGING> when you compile the Perl
397 executable (but see L<Devel::Peek>, L<re> which may change this).
398 See the F<INSTALL> file in the Perl source distribution
399 for how to do this.  This flag is automatically set if you include B<-g>
400 option when C<Configure> asks you about optimizer/debugger flags.
401
402 If you're just trying to get a print out of each line of Perl code
403 as it executes, the way that C<sh -x> provides for shell scripts,
404 you can't use Perl's B<-D> switch.  Instead do this
405
406   # If you have "env" utility
407   env=PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
408
409   # Bourne shell syntax
410   $ PERLDB_OPTS="NonStop=1 AutoTrace=1 frame=2" perl -dS program
411
412   # csh syntax
413   % (setenv PERLDB_OPTS "NonStop=1 AutoTrace=1 frame=2"; perl -dS program)
414
415 See L<perldebug> for details and variations.
416
417 =item B<-e> I<commandline>
418
419 may be used to enter one line of program.  If B<-e> is given, Perl
420 will not look for a filename in the argument list.  Multiple B<-e>
421 commands may be given to build up a multi-line script.  Make sure
422 to use semicolons where you would in a normal program.
423
424 =item B<-F>I<pattern>
425
426 specifies the pattern to split on if B<-a> is also in effect.  The
427 pattern may be surrounded by C<//>, C<"">, or C<''>, otherwise it will be
428 put in single quotes.
429
430 =item B<-h>
431
432 prints a summary of the options.
433
434 =item B<-i>[I<extension>]
435
436 specifies that files processed by the C<E<lt>E<gt>> construct are to be
437 edited in-place.  It does this by renaming the input file, opening the
438 output file by the original name, and selecting that output file as the
439 default for print() statements.  The extension, if supplied, is used to
440 modify the name of the old file to make a backup copy, following these
441 rules:
442
443 If no extension is supplied, no backup is made and the current file is
444 overwritten.
445
446 If the extension doesn't contain a C<*>, then it is appended to the
447 end of the current filename as a suffix.  If the extension does
448 contain one or more C<*> characters, then each C<*> is replaced
449 with the current filename.  In Perl terms, you could think of this
450 as:
451
452     ($backup = $extension) =~ s/\*/$file_name/g;
453
454 This allows you to add a prefix to the backup file, instead of (or in
455 addition to) a suffix:
456
457     $ perl -pi'orig_*' -e 's/bar/baz/' fileA    # backup to 'orig_fileA'
458
459 Or even to place backup copies of the original files into another
460 directory (provided the directory already exists):
461
462     $ perl -pi'old/*.orig' -e 's/bar/baz/' fileA # backup to 'old/fileA.orig'
463
464 These sets of one-liners are equivalent:
465
466     $ perl -pi -e 's/bar/baz/' fileA            # overwrite current file
467     $ perl -pi'*' -e 's/bar/baz/' fileA         # overwrite current file
468
469     $ perl -pi'.orig' -e 's/bar/baz/' fileA     # backup to 'fileA.orig'
470     $ perl -pi'*.orig' -e 's/bar/baz/' fileA    # backup to 'fileA.orig'
471
472 From the shell, saying
473
474     $ perl -p -i.orig -e "s/foo/bar/; ... "
475
476 is the same as using the program:
477
478     #!/usr/bin/perl -pi.orig
479     s/foo/bar/;
480
481 which is equivalent to
482
483     #!/usr/bin/perl
484     $extension = '.orig';
485     LINE: while (<>) {
486         if ($ARGV ne $oldargv) {
487             if ($extension !~ /\*/) {
488                 $backup = $ARGV . $extension;
489             }
490             else {
491                 ($backup = $extension) =~ s/\*/$ARGV/g;
492             }
493             rename($ARGV, $backup);
494             open(ARGVOUT, ">$ARGV");
495             select(ARGVOUT);
496             $oldargv = $ARGV;
497         }
498         s/foo/bar/;
499     }
500     continue {
501         print;  # this prints to original filename
502     }
503     select(STDOUT);
504
505 except that the B<-i> form doesn't need to compare $ARGV to $oldargv to
506 know when the filename has changed.  It does, however, use ARGVOUT for
507 the selected filehandle.  Note that STDOUT is restored as the default
508 output filehandle after the loop.
509
510 As shown above, Perl creates the backup file whether or not any output
511 is actually changed.  So this is just a fancy way to copy files:
512
513     $ perl -p -i'/some/file/path/*' -e 1 file1 file2 file3...
514 or
515     $ perl -p -i'.orig' -e 1 file1 file2 file3...
516
517 You can use C<eof> without parentheses to locate the end of each input
518 file, in case you want to append to each file, or reset line numbering
519 (see example in L<perlfunc/eof>).
520
521 If, for a given file, Perl is unable to create the backup file as
522 specified in the extension then it will skip that file and continue on
523 with the next one (if it exists).
524
525 For a discussion of issues surrounding file permissions and B<-i>,
526 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?>.
527
528 You cannot use B<-i> to create directories or to strip extensions from
529 files.
530
531 Perl does not expand C<~> in filenames, which is good, since some
532 folks use it for their backup files:
533
534     $ perl -pi~ -e 's/foo/bar/' file1 file2 file3...
535
536 Finally, the B<-i> switch does not impede execution when no
537 files are given on the command line.  In this case, no backup is made
538 (the original file cannot, of course, be determined) and processing
539 proceeds from STDIN to STDOUT as might be expected.
540
541 =item B<-I>I<directory>
542
543 Directories specified by B<-I> are prepended to the search path for
544 modules (C<@INC>), and also tells the C preprocessor where to search for
545 include files.  The C preprocessor is invoked with B<-P>; by default it
546 searches /usr/include and /usr/lib/perl.
547
548 =item B<-l>[I<octnum>]
549
550 enables automatic line-ending processing.  It has two separate
551 effects.  First, it automatically chomps C<$/> (the input record
552 separator) when used with B<-n> or B<-p>.  Second, it assigns C<$\>
553 (the output record separator) to have the value of I<octnum> so
554 that any print statements will have that separator added back on.
555 If I<octnum> is omitted, sets C<$\> to the current value of
556 C<$/>.  For instance, to trim lines to 80 columns:
557
558     perl -lpe 'substr($_, 80) = ""'
559
560 Note that the assignment C<$\ = $/> is done when the switch is processed,
561 so the input record separator can be different than the output record
562 separator if the B<-l> switch is followed by a B<-0> switch:
563
564     gnufind / -print0 | perl -ln0e 'print "found $_" if -p'
565
566 This sets C<$\> to newline and then sets C<$/> to the null character.
567
568 =item B<-m>[B<->]I<module>
569
570 =item B<-M>[B<->]I<module>
571
572 =item B<-M>[B<->]I<'module ...'>
573
574 =item B<-[mM]>[B<->]I<module=arg[,arg]...>
575
576 B<-m>I<module> executes C<use> I<module> C<();> before executing your
577 program.
578
579 B<-M>I<module> executes C<use> I<module> C<;> before executing your
580 program.  You can use quotes to add extra code after the module name,
581 e.g., C<'-Mmodule qw(foo bar)'>.
582
583 If the first character after the B<-M> or B<-m> is a dash (C<->)
584 then the 'use' is replaced with 'no'.
585
586 A little builtin syntactic sugar means you can also say
587 B<-mmodule=foo,bar> or B<-Mmodule=foo,bar> as a shortcut for
588 C<'-Mmodule qw(foo bar)'>.  This avoids the need to use quotes when
589 importing symbols.  The actual code generated by B<-Mmodule=foo,bar> is
590 C<use module split(/,/,q{foo,bar})>.  Note that the C<=> form
591 removes the distinction between B<-m> and B<-M>.
592
593 =item B<-n>
594
595 causes Perl to assume the following loop around your program, which
596 makes it iterate over filename arguments somewhat like B<sed -n> or
597 B<awk>:
598
599   LINE:
600     while (<>) {
601         ...             # your program goes here
602     }
603
604 Note that the lines are not printed by default.  See B<-p> to have
605 lines printed.  If a file named by an argument cannot be opened for
606 some reason, Perl warns you about it and moves on to the next file.
607
608 Here is an efficient way to delete all files that haven't been modifed for
609 at least a week:
610
611     find . -mtime +7 -print | perl -nle unlink
612
613 This is faster than using the B<-exec> switch of B<find> because you don't
614 have to start a process on every filename found.  It does suffer from
615 the bug of mishandling newlines in pathnames, which you can fix if
616 you follow the example under B<-0>.
617
618 C<BEGIN> and C<END> blocks may be used to capture control before or after
619 the implicit program loop, just as in B<awk>.
620
621 =item B<-p>
622
623 causes Perl to assume the following loop around your program, which
624 makes it iterate over filename arguments somewhat like B<sed>:
625
626
627   LINE:
628     while (<>) {
629         ...             # your program goes here
630     } continue {
631         print or die "-p destination: $!\n";
632     }
633
634 If a file named by an argument cannot be opened for some reason, Perl
635 warns you about it, and moves on to the next file.  Note that the
636 lines are printed automatically.  An error occurring during printing is
637 treated as fatal.  To suppress printing use the B<-n> switch.  A B<-p>
638 overrides a B<-n> switch.
639
640 C<BEGIN> and C<END> blocks may be used to capture control before or after
641 the implicit loop, just as in B<awk>.
642
643 =item B<-P>
644
645 B<NOTE: Use of -P is strongly discouraged because of its inherent
646 problems, including poor portability.>
647
648 This option causes your program to be run through the C preprocessor before
649 compilation by Perl.  Because both comments and B<cpp> directives begin
650 with the # character, you should avoid starting comments with any words
651 recognized by the C preprocessor such as C<"if">, C<"else">, or C<"define">.
652
653 If you're considering using C<-P>, you might also want to look at the
654 Filter::cpp module from CPAN.
655
656 The problems of -P include, but are not limited to:
657
658 =over 10
659
660 =item *
661
662 The C<#!> line is stripped, so any switches there don't apply.
663
664 =item *
665
666 A C<-P> on a C<#!> line doesn't work.
667
668 =item *
669
670 B<All> lines that begin with (whitespace and) a C<#> but
671 do not look like cpp commands, are stripped, including anything
672 inside Perl strings, regular expressions, and here-docs .
673
674 =item *
675
676 In some platforms the C preprocessor knows too much: it knows about
677 the C++ -style until-end-of-line comments starting with C<"//">.
678 This will cause problems with common Perl constructs like
679
680     s/foo//;
681
682 because after -P this will became illegal code
683
684     s/foo
685
686 The workaround is to use some other quoting separator than C<"/">,
687 like for example C<"!">:
688
689     s!foo!!;
690
691
692
693 =item *
694
695 It requires not only a working C preprocessor but also a working
696 F<sed>.  If not on UNIX, you are probably out of luck on this.
697
698 =item *
699
700 Script line numbers are not preserved.
701
702 =item *
703
704 The C<-x> does not work with C<-P>.
705
706 =back
707
708 =item B<-s>
709
710 enables rudimentary switch parsing for switches on the command
711 line after the program name but before any filename arguments (or before
712 an argument of B<-->).  This means you can have switches with two leading
713 dashes (B<--help>).  Any switch found there is removed from @ARGV and sets the
714 corresponding variable in the Perl program.  The following program
715 prints "1" if the program is invoked with a B<-xyz> switch, and "abc"
716 if it is invoked with B<-xyz=abc>.
717
718     #!/usr/bin/perl -s
719     if ($xyz) { print "$xyz\n" }
720
721 Do note that B<--help> creates the variable ${-help}, which is not compliant
722 with C<strict refs>.
723
724 =item B<-S>
725
726 makes Perl use the PATH environment variable to search for the
727 program (unless the name of the program contains directory separators).
728
729 On some platforms, this also makes Perl append suffixes to the
730 filename while searching for it.  For example, on Win32 platforms,
731 the ".bat" and ".cmd" suffixes are appended if a lookup for the
732 original name fails, and if the name does not already end in one
733 of those suffixes.  If your Perl was compiled with DEBUGGING turned
734 on, using the -Dp switch to Perl shows how the search progresses.
735
736 Typically this is used to emulate #! startup on platforms that
737 don't support #!.  This example works on many platforms that
738 have a shell compatible with Bourne shell:
739
740     #!/usr/bin/perl
741     eval 'exec /usr/bin/perl -wS $0 ${1+"$@"}'
742             if $running_under_some_shell;
743
744 The system ignores the first line and feeds the program to F</bin/sh>,
745 which proceeds to try to execute the Perl program as a shell script.
746 The shell executes the second line as a normal shell command, and thus
747 starts up the Perl interpreter.  On some systems $0 doesn't always
748 contain the full pathname, so the B<-S> tells Perl to search for the
749 program if necessary.  After Perl locates the program, it parses the
750 lines and ignores them because the variable $running_under_some_shell
751 is never true.  If the program will be interpreted by csh, you will need
752 to replace C<${1+"$@"}> with C<$*>, even though that doesn't understand
753 embedded spaces (and such) in the argument list.  To start up sh rather
754 than csh, some systems may have to replace the #! line with a line
755 containing just a colon, which will be politely ignored by Perl.  Other
756 systems can't control that, and need a totally devious construct that
757 will work under any of B<csh>, B<sh>, or Perl, such as the following:
758
759         eval '(exit $?0)' && eval 'exec perl -wS $0 ${1+"$@"}'
760         & eval 'exec /usr/bin/perl -wS $0 $argv:q'
761                 if $running_under_some_shell;
762
763 If the filename supplied contains directory separators (i.e., is an
764 absolute or relative pathname), and if that file is not found,
765 platforms that append file extensions will do so and try to look
766 for the file with those extensions added, one by one.
767
768 On DOS-like platforms, if the program does not contain directory
769 separators, it will first be searched for in the current directory
770 before being searched for on the PATH.  On Unix platforms, the
771 program will be searched for strictly on the PATH.
772
773 =item B<-t>
774
775 Like B<-T>, but taint checks will issue warnings rather than fatal
776 errors.  These warnings can be controlled normally with C<no warnings
777 qw(taint)>.
778
779 B<NOTE: this is not a substitute for -T.> This is meant only to be
780 used as a temporary development aid while securing legacy code:
781 for real production code and for new secure code written from scratch
782 always use the real B<-T>.
783
784 =item B<-T>
785
786 forces "taint" checks to be turned on so you can test them.  Ordinarily
787 these checks are done only when running setuid or setgid.  It's a
788 good idea to turn them on explicitly for programs that run on behalf
789 of someone else whom you might not necessarily trust, such as CGI
790 programs or any internet servers you might write in Perl.  See
791 L<perlsec> for details.  For security reasons, this option must be
792 seen by Perl quite early; usually this means it must appear early
793 on the command line or in the #! line for systems which support
794 that construct.
795
796 =item B<-u>
797
798 This obsolete switch causes Perl to dump core after compiling your
799 program.  You can then in theory take this core dump and turn it
800 into an executable file by using the B<undump> program (not supplied).
801 This speeds startup at the expense of some disk space (which you
802 can minimize by stripping the executable).  (Still, a "hello world"
803 executable comes out to about 200K on my machine.)  If you want to
804 execute a portion of your program before dumping, use the dump()
805 operator instead.  Note: availability of B<undump> is platform
806 specific and may not be available for a specific port of Perl.
807
808 This switch has been superseded in favor of the new Perl code
809 generator backends to the compiler.  See L<B> and L<B::Bytecode>
810 for details.
811
812 =item B<-U>
813
814 allows Perl to do unsafe operations.  Currently the only "unsafe"
815 operations are the unlinking of directories while running as superuser,
816 and running setuid programs with fatal taint checks turned into
817 warnings.  Note that the B<-w> switch (or the C<$^W> variable) must
818 be used along with this option to actually I<generate> the
819 taint-check warnings.
820
821 =item B<-v>
822
823 prints the version and patchlevel of your perl executable.
824
825 =item B<-V>
826
827 prints summary of the major perl configuration values and the current
828 values of @INC.
829
830 =item B<-V:>I<name>
831
832 Prints to STDOUT the value of the named configuration variable(s),
833 with multiples when your query looks like a regex.
834 For example,
835
836     $ perl -V:lib.
837         libs='-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc';
838         libc='/lib/libc-2.2.4.so';
839     $ perl -V:lib.*
840         libpth='/usr/local/lib /lib /usr/lib';
841         libs='-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc';
842         lib_ext='.a';
843         libc='/lib/libc-2.2.4.so';
844         libperl='libperl.a';
845         ....
846
847 Additionally, extra colons can be used to control formatting.  A
848 trailing colon suppresses the linefeed and terminator ';', allowing
849 you to embed queries into shell commands.  (mnemonic: PATH separator
850 ':'.)
851
852     $ echo "compression-vars: " `perl -V:z.*: ` " are here !"
853     compression-vars:  zcat='' zip='zip'  are here !
854
855 A leading colon removes the 'name=' part of the response, this allows
856 you to map to the name you need.
857
858     $ echo "goodvfork="`./perl -Ilib -V::usevfork`
859     goodvfork=false;
860
861 Leading and trailing colons can be used together if you need
862 positional parameter values without the names.  Note that in the case
863 below, the PERL_API params are returned in alphabetical order.
864
865     $ echo building_on `perl -V::osname: -V::PERL_API_.*:` now
866     building_on 'linux' '5' '1' '9' now
867
868 =item B<-w>
869
870 prints warnings about dubious constructs, such as variable names
871 that are mentioned only once and scalar variables that are used
872 before being set, redefined subroutines, references to undefined
873 filehandles or filehandles opened read-only that you are attempting
874 to write on, values used as a number that doesn't look like numbers,
875 using an array as though it were a scalar, if your subroutines
876 recurse more than 100 deep, and innumerable other things.
877
878 This switch really just enables the internal C<$^W> variable.  You
879 can disable or promote into fatal errors specific warnings using
880 C<__WARN__> hooks, as described in L<perlvar> and L<perlfunc/warn>.
881 See also L<perldiag> and L<perltrap>.  A new, fine-grained warning
882 facility is also available if you want to manipulate entire classes
883 of warnings; see L<warnings> or L<perllexwarn>.
884
885 =item B<-W>
886
887 Enables all warnings regardless of C<no warnings> or C<$^W>.
888 See L<perllexwarn>.
889
890 =item B<-X>
891
892 Disables all warnings regardless of C<use warnings> or C<$^W>.
893 See L<perllexwarn>.
894
895 =item B<-x> I<directory>
896
897 tells Perl that the program is embedded in a larger chunk of unrelated
898 ASCII text, such as in a mail message.  Leading garbage will be
899 discarded until the first line that starts with #! and contains the
900 string "perl".  Any meaningful switches on that line will be applied.
901 If a directory name is specified, Perl will switch to that directory
902 before running the program.  The B<-x> switch controls only the
903 disposal of leading garbage.  The program must be terminated with
904 C<__END__> if there is trailing garbage to be ignored (the program
905 can process any or all of the trailing garbage via the DATA filehandle
906 if desired).
907
908 =back
909
910 =head1 ENVIRONMENT
911
912 =over 12
913
914 =item HOME
915
916 Used if chdir has no argument.
917
918 =item LOGDIR
919
920 Used if chdir has no argument and HOME is not set.
921
922 =item PATH
923
924 Used in executing subprocesses, and in finding the program if B<-S> is
925 used.
926
927 =item PERL5LIB
928
929 A list of directories in which to look for Perl library
930 files before looking in the standard library and the current
931 directory.  Any architecture-specific directories under the specified
932 locations are automatically included if they exist.  If PERL5LIB is not
933 defined, PERLLIB is used.  Directories are separated (like in PATH) by
934 a colon on unixish platforms and by a semicolon on Windows (the proper
935 path separator being given by the command C<perl -V:path_sep>).
936
937 When running taint checks (either because the program was running setuid
938 or setgid, or the B<-T> switch was used), neither variable is used.
939 The program should instead say:
940
941     use lib "/my/directory";
942
943 =item PERL5OPT
944
945 Command-line options (switches).  Switches in this variable are taken
946 as if they were on every Perl command line.  Only the B<-[DIMUdmtw]>
947 switches are allowed.  When running taint checks (because the program
948 was running setuid or setgid, or the B<-T> switch was used), this
949 variable is ignored.  If PERL5OPT begins with B<-T>, tainting will be
950 enabled, and any subsequent options ignored.
951
952 =item PERLIO
953
954 A space (or colon) separated list of PerlIO layers. If perl is built
955 to use PerlIO system for IO (the default) these layers effect perl's IO.
956
957 It is conventional to start layer names with a colon e.g. C<:perlio> to
958 emphasise their similarity to variable "attributes". But the code that parses
959 layer specification strings (which is also used to decode the PERLIO
960 environment variable) treats the colon as a separator.
961
962 An unset or empty PERLIO is equivalent to C<:stdio>.
963
964 The list becomes the default for I<all> perl's IO. Consequently only built-in
965 layers can appear in this list, as external layers (such as :encoding()) need
966 IO in  order to load them!. See L<"open pragma"|open> for how to add external
967 encodings as defaults.
968
969 The layers that it makes sense to include in the PERLIO environment
970 variable are briefly summarised below. For more details see L<PerlIO>.
971
972 =over 8
973
974 =item :bytes
975
976 A pseudolayer that turns I<off> the C<:utf8> flag for the layer below.
977 Unlikely to be useful on its own in the global PERLIO environment variable.
978 You perhaps were thinking of C<:crlf:bytes> or C<:perlio:bytes>.
979
980 =item :crlf
981
982 A layer which does CRLF to "\n" translation distinguishing "text" and
983 "binary" files in the manner of MS-DOS and similar operating systems.
984 (It currently does I<not> mimic MS-DOS as far as treating of Control-Z
985 as being an end-of-file marker.)
986
987 =item :mmap
988
989 A layer which implements "reading" of files by using C<mmap()> to
990 make (whole) file appear in the process's address space, and then
991 using that as PerlIO's "buffer".
992
993 =item :perlio
994
995 This is a re-implementation of "stdio-like" buffering written as a
996 PerlIO "layer".  As such it will call whatever layer is below it for
997 its operations (typically C<:unix>).
998
999 =item :pop
1000
1001 An experimental pseudolayer that removes the topmost layer.
1002 Use with the same care as is reserved for nitroglycerin.
1003
1004 =item :raw
1005
1006 A pseudolayer that manipulates other layers.  Applying the <:raw>
1007 layer is equivalent to calling C<binmode($fh)>.  It makes the stream
1008 pass each byte as-is without any translation.  In particular CRLF
1009 translation, and/or :utf8 intuited from locale are disabled.
1010
1011 Unlike in the earlier versions of Perl C<:raw> is I<not>
1012 just the inverse of C<:crlf> - other layers which would affect the
1013 binary nature of the stream are also removed or disabled.
1014
1015 =item :stdio
1016
1017 This layer provides PerlIO interface by wrapping system's ANSI C "stdio"
1018 library calls. The layer provides both buffering and IO.
1019 Note that C<:stdio> layer does I<not> do CRLF translation even if that
1020 is platforms normal behaviour. You will need a C<:crlf> layer above it
1021 to do that.
1022
1023 =item :unix
1024
1025 Low level layer which calls C<read>, C<write> and C<lseek> etc.
1026
1027 =item :utf8
1028
1029 A pseudolayer that turns on a flag on the layer below to tell perl
1030 that output should be in utf8 and that input should be regarded as
1031 already in utf8 form.  May be useful in PERLIO environment
1032 variable to make UTF-8 the default. (To turn off that behaviour
1033 use C<:bytes> layer.)
1034
1035 =item :win32
1036
1037 On Win32 platforms this I<experimental> layer uses native "handle" IO
1038 rather than unix-like numeric file descriptor layer. Known to be
1039 buggy in this release.
1040
1041 =back
1042
1043 On all platforms the default set of layers should give acceptable results.
1044
1045 For UNIX platforms that will equivalent of "unix perlio" or "stdio".
1046 Configure is setup to prefer "stdio" implementation if system's library
1047 provides for fast access to the buffer, otherwise it uses the "unix perlio"
1048 implementation.
1049
1050 On Win32 the default in this release is "unix crlf". Win32's "stdio"
1051 has a number of bugs/mis-features for perl IO which are somewhat
1052 C compiler vendor/version dependent. Using our own C<crlf> layer as
1053 the buffer avoids those issues and makes things more uniform.
1054 The C<crlf> layer provides CRLF to/from "\n" conversion as well as
1055 buffering.
1056
1057 This release uses C<unix> as the bottom layer on Win32 and so still uses C
1058 compiler's numeric file descriptor routines. There is an experimental native
1059 C<win32> layer which is expected to be enhanced and should eventually be
1060 the default under Win32.
1061
1062 =item PERLIO_DEBUG
1063
1064 If set to the name of a file or device then certain operations of PerlIO
1065 sub-system will be logged to that file (opened as append). Typical uses
1066 are UNIX:
1067
1068    PERLIO_DEBUG=/dev/tty perl script ...
1069
1070 and Win32 approximate equivalent:
1071
1072    set PERLIO_DEBUG=CON
1073    perl script ...
1074
1075
1076 =item PERLLIB
1077
1078 A list of directories in which to look for Perl library
1079 files before looking in the standard library and the current directory.
1080 If PERL5LIB is defined, PERLLIB is not used.
1081
1082 =item PERL5DB
1083
1084 The command used to load the debugger code.  The default is:
1085
1086         BEGIN { require 'perl5db.pl' }
1087
1088 =item PERL5SHELL (specific to the Win32 port)
1089
1090 May be set to an alternative shell that perl must use internally for
1091 executing "backtick" commands or system().  Default is C<cmd.exe /x/d/c>
1092 on WindowsNT and C<command.com /c> on Windows95.  The value is considered
1093 to be space-separated.  Precede any character that needs to be protected
1094 (like a space or backslash) with a backslash.
1095
1096 Note that Perl doesn't use COMSPEC for this purpose because
1097 COMSPEC has a high degree of variability among users, leading to
1098 portability concerns.  Besides, perl can use a shell that may not be
1099 fit for interactive use, and setting COMSPEC to such a shell may
1100 interfere with the proper functioning of other programs (which usually
1101 look in COMSPEC to find a shell fit for interactive use).
1102
1103 =item PERL_DEBUG_MSTATS
1104
1105 Relevant only if perl is compiled with the malloc included with the perl
1106 distribution (that is, if C<perl -V:d_mymalloc> is 'define').
1107 If set, this causes memory statistics to be dumped after execution.  If set
1108 to an integer greater than one, also causes memory statistics to be dumped
1109 after compilation.
1110
1111 =item PERL_DESTRUCT_LEVEL
1112
1113 Relevant only if your perl executable was built with B<-DDEBUGGING>,
1114 this controls the behavior of global destruction of objects and other
1115 references.  See L<perlhack/PERL_DESTRUCT_LEVEL> for more information.
1116
1117 =item PERL_DL_NONLAZY
1118
1119 Set to one to have perl resolve B<all> undefined symbols when it loads
1120 a dynamic library.  The default behaviour is to resolve symbols when
1121 they are used.  Setting this variable is useful during testing of
1122 extensions as it ensures that you get an error on misspelled function
1123 names even if the test suite doesn't call it.
1124
1125 =item PERL_ENCODING
1126
1127 If using the C<encoding> pragma without an explicit encoding name, the
1128 PERL_ENCODING environment variable is consulted for an encoding name.
1129
1130 =item PERL_HASH_SEED
1131
1132 (Since Perl 5.8.1.)  Used to randomise Perl's internal hash function.
1133 To emulate the pre-5.8.1 behaviour, set to an integer (zero means
1134 exactly the same order as 5.8.0).  "Pre-5.8.1" means, among other
1135 things, that hash keys will be ordered the same between different runs
1136 of Perl.
1137
1138 The default behaviour is to randomise unless the PERL_HASH_SEED is set.
1139 If Perl has been compiled with C<-DUSE_HASH_SEED_EXPLICIT>, the default
1140 behaviour is B<not> to randomise unless the PERL_HASH_SEED is set.
1141
1142 If PERL_HASH_SEED is unset or set to a non-numeric string, Perl uses
1143 the pseudorandom seed supplied by the operating system and libraries.
1144 This means that each different run of Perl will have a different
1145 ordering of the results of keys(), values(), and each().
1146
1147 B<Please note that the hash seed is sensitive information>. Hashes are
1148 randomized to protect against local and remote attacks against Perl
1149 code. By manually setting a seed this protection may be partially or
1150 completely lost.
1151
1152 See L<perlsec/"Algorithmic Complexity Attacks"> and
1153 L</PERL_HASH_SEED_DEBUG> for more information.
1154
1155 =item PERL_HASH_SEED_DEBUG
1156
1157 (Since Perl 5.8.1.)  Set to one to display (to STDERR) the value of
1158 the hash seed at the beginning of execution.  This, combined with
1159 L</PERL_HASH_SEED> is intended to aid in debugging nondeterministic
1160 behavior caused by hash randomization.
1161
1162 B<Note that the hash seed is sensitive information>: by knowing it one
1163 can craft a denial-of-service attack against Perl code, even remotely,
1164 see L<perlsec/"Algorithmic Complexity Attacks"> for more information.
1165 B<Do not disclose the hash seed> to people who don't need to know it.
1166 See also hash_seed() of L<Hash::Util>.
1167
1168 =item PERL_ROOT (specific to the VMS port)
1169
1170 A translation concealed rooted logical name that contains perl and the
1171 logical device for the @INC path on VMS only.  Other logical names that
1172 affect perl on VMS include PERLSHR, PERL_ENV_TABLES, and
1173 SYS$TIMEZONE_DIFFERENTIAL but are optional and discussed further in
1174 L<perlvms> and in F<README.vms> in the Perl source distribution.
1175
1176 =item PERL_SIGNALS
1177
1178 In Perls 5.8.1 and later.  If set to C<unsafe> the pre-Perl-5.8.0
1179 signals behaviour (immediate but unsafe) is restored.  If set to
1180 C<safe> the safe (or deferred) signals are used.
1181 See L<perlipc/"Deferred Signals (Safe signals)">.
1182
1183 =item PERL_UNICODE
1184
1185 Equivalent to the B<-C> command-line switch.  Note that this is not
1186 a boolean variable-- setting this to C<"1"> is not the right way to
1187 "enable Unicode" (whatever that would mean).  You can use C<"0"> to
1188 "disable Unicode", though (or alternatively unset PERL_UNICODE in
1189 your shell before starting Perl).  See the description of the C<-C>
1190 switch for more information.
1191
1192 =item SYS$LOGIN (specific to the VMS port)
1193
1194 Used if chdir has no argument and HOME and LOGDIR are not set.
1195
1196 =back
1197
1198 Perl also has environment variables that control how Perl handles data
1199 specific to particular natural languages.  See L<perllocale>.
1200
1201 Apart from these, Perl uses no other environment variables, except
1202 to make them available to the program being executed, and to child
1203 processes.  However, programs running setuid would do well to execute
1204 the following lines before doing anything else, just to keep people
1205 honest:
1206
1207     $ENV{PATH}  = '/bin:/usr/bin';    # or whatever you need
1208     $ENV{SHELL} = '/bin/sh' if exists $ENV{SHELL};
1209     delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};