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