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