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