pod/perl.pod

   1 =head1 NAME
   2
   3 perl - The Perl 5 language interpreter
   4
   5 =head1 SYNOPSIS
   6
   7 B<perl> S<[ B<-sTtuUWX> ]>
   8         S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
   9         S<[ B<-cw> ] [ B<-d>[B<t>][:I<debugger>] ] [ B<-D>[I<number/list>] ]>
  10         S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal/hexadecimal>] ]>
  11         S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ] [ 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 For more information on these options, you can run C<perldoc perlrun>.
  19
  20 =head1 GETTING HELP
  21
  22 The F<perldoc> program gives you access to all the documentation that comes
  23 with Perl.  You can get more documentation, tutorials and community support
  24 online at L<https://www.perl.org/>.
  25
  26 If you're new to Perl, you should start by running C<perldoc perlintro>,
  27 which is a general intro for beginners and provides some background to help
  28 you navigate the rest of Perl's extensive documentation.  Run C<perldoc
  29 perldoc> to learn more things you can do with F<perldoc>.
  30
  31 For ease of access, the Perl manual has been split up into several sections.
  32
  33 =begin buildtoc
  34
  35 # This section is parsed by Porting/pod_lib.pl for use by pod/buildtoc etc
  36
  37 flag =g  perluniprops perlmodlib perlapi perlintern
  38 flag =go perltoc
  39 flag =ro perlcn perljp perlko perltw
  40 flag =   perlvms
  41
  42 path perlfaq.*               cpan/perlfaq/lib/
  43 path perlglossary            cpan/perlfaq/lib/
  44 path perlxs(?:tut|typemap)?  dist/ExtUtils-ParseXS/lib/
  45 path perldoc                 cpan/Pod-Perldoc/
  46
  47 aux h2ph h2xs perlbug pl2pm pod2html pod2man splain xsubpp
  48
  49 =end buildtoc
  50
  51 =head2 Overview
  52
  53     perl                Perl overview (this section)
  54     perlintro           Perl introduction for beginners
  55     perlrun             Perl execution and options
  56     perltoc             Perl documentation table of contents
  57
  58 =head2 Tutorials
  59
  60     perlreftut          Perl references short introduction
  61     perldsc             Perl data structures intro
  62     perllol             Perl data structures: arrays of arrays
  63
  64     perlrequick         Perl regular expressions quick start
  65     perlretut           Perl regular expressions tutorial
  66
  67     perlootut           Perl OO tutorial for beginners
  68
  69     perlperf            Perl Performance and Optimization Techniques
  70
  71     perlstyle           Perl style guide
  72
  73     perlcheat           Perl cheat sheet
  74     perltrap            Perl traps for the unwary
  75     perldebtut          Perl debugging tutorial
  76
  77     perlfaq             Perl frequently asked questions
  78       perlfaq1          General Questions About Perl
  79       perlfaq2          Obtaining and Learning about Perl
  80       perlfaq3          Programming Tools
  81       perlfaq4          Data Manipulation
  82       perlfaq5          Files and Formats
  83       perlfaq6          Regexes
  84       perlfaq7          Perl Language Issues
  85       perlfaq8          System Interaction
  86       perlfaq9          Networking
  87
  88 =head2 Reference Manual
  89
  90     perlsyn             Perl syntax
  91     perldata            Perl data structures
  92     perlop              Perl operators and precedence
  93     perlsub             Perl subroutines
  94     perlfunc            Perl built-in functions
  95       perlopentut       Perl open() tutorial
  96       perlpacktut       Perl pack() and unpack() tutorial
  97     perlpod             Perl plain old documentation
  98     perlpodspec         Perl plain old documentation format specification
  99     perldocstyle        Perl style guide for core docs
 100     perlpodstyle        Perl POD style guide
 101     perldiag            Perl diagnostic messages
 102     perldeprecation     Perl deprecations
 103     perllexwarn         Perl warnings and their control
 104     perldebug           Perl debugging
 105     perlvar             Perl predefined variables
 106     perlre              Perl regular expressions, the rest of the story
 107     perlrebackslash     Perl regular expression backslash sequences
 108     perlrecharclass     Perl regular expression character classes
 109     perlreref           Perl regular expressions quick reference
 110     perlref             Perl references, the rest of the story
 111     perlform            Perl formats
 112     perlobj             Perl objects
 113     perltie             Perl objects hidden behind simple variables
 114       perldbmfilter     Perl DBM filters
 115
 116     perlipc             Perl interprocess communication
 117     perlfork            Perl fork() information
 118     perlnumber          Perl number semantics
 119
 120     perlthrtut          Perl threads tutorial
 121
 122     perlport            Perl portability guide
 123     perllocale          Perl locale support
 124     perluniintro        Perl Unicode introduction
 125     perlunicode         Perl Unicode support
 126     perlunicook         Perl Unicode cookbook
 127     perlunifaq          Perl Unicode FAQ
 128     perluniprops        Index of Unicode properties in Perl
 129     perlunitut          Perl Unicode tutorial
 130     perlebcdic          Considerations for running Perl on EBCDIC platforms
 131
 132     perlsec             Perl security
 133     perlsecpolicy       Perl security report handling policy
 134
 135     perlmod             Perl modules: how they work
 136     perlmodlib          Perl modules: how to write and use
 137     perlmodstyle        Perl modules: how to write modules with style
 138     perlmodinstall      Perl modules: how to install from CPAN
 139     perlnewmod          Perl modules: preparing a new module for distribution
 140     perlpragma          Perl modules: writing a user pragma
 141
 142     perlutil            utilities packaged with the Perl distribution
 143
 144     perlfilter          Perl source filters
 145
 146     perldtrace          Perl's support for DTrace
 147
 148     perlglossary        Perl Glossary
 149
 150 =head2 Internals and C Language Interface
 151
 152     perlembed           Perl ways to embed perl in your C or C++ application
 153     perldebguts         Perl debugging guts and tips
 154     perlxstut           Perl XS tutorial
 155     perlxs              Perl XS application programming interface
 156     perlxstypemap       Perl XS C/Perl type conversion tools
 157     perlclib            Internal replacements for standard C library functions
 158     perlguts            Perl internal functions for those doing extensions
 159     perlcall            Perl calling conventions from C
 160     perlmroapi          Perl method resolution plugin interface
 161     perlreapi           Perl regular expression plugin interface
 162     perlreguts          Perl regular expression engine internals
 163
 164     perlapi             Perl API listing (autogenerated)
 165     perlintern          Perl internal functions (autogenerated)
 166     perliol             C API for Perl's implementation of IO in Layers
 167     perlapio            Perl internal IO abstraction interface
 168
 169     perlhack            Perl hackers guide
 170     perlsource          Guide to the Perl source tree
 171     perlinterp          Overview of the Perl interpreter source and how it works
 172     perlhacktut         Walk through the creation of a simple C code patch
 173     perlhacktips        Tips for Perl core C code hacking
 174     perlpolicy          Perl development policies
 175     perlgov             Perl Rules of Governance
 176     perlgit             Using git with the Perl repository
 177
 178 =head2 History
 179
 180     perlhist            Perl history records
 181     perldelta           Perl changes since previous version
 182     perl5357delta       Perl changes in version 5.35.7
 183     perl5356delta       Perl changes in version 5.35.6
 184     perl5355delta       Perl changes in version 5.35.5
 185     perl5354delta       Perl changes in version 5.35.4
 186     perl5353delta       Perl changes in version 5.35.3
 187     perl5352delta       Perl changes in version 5.35.2
 188     perl5351delta       Perl changes in version 5.35.1
 189     perl5350delta       Perl changes in version 5.35.0
 190     perl5340delta       Perl changes in version 5.34.0
 191     perl5321delta       Perl changes in version 5.32.1
 192     perl5320delta       Perl changes in version 5.32.0
 193     perl5303delta       Perl changes in version 5.30.3
 194     perl5302delta       Perl changes in version 5.30.2
 195     perl5301delta       Perl changes in version 5.30.1
 196     perl5300delta       Perl changes in version 5.30.0
 197     perl5283delta       Perl changes in version 5.28.3
 198     perl5282delta       Perl changes in version 5.28.2
 199     perl5281delta       Perl changes in version 5.28.1
 200     perl5280delta       Perl changes in version 5.28.0
 201     perl5263delta       Perl changes in version 5.26.3
 202     perl5262delta       Perl changes in version 5.26.2
 203     perl5261delta       Perl changes in version 5.26.1
 204     perl5260delta       Perl changes in version 5.26.0
 205     perl5244delta       Perl changes in version 5.24.4
 206     perl5243delta       Perl changes in version 5.24.3
 207     perl5242delta       Perl changes in version 5.24.2
 208     perl5241delta       Perl changes in version 5.24.1
 209     perl5240delta       Perl changes in version 5.24.0
 210     perl5224delta       Perl changes in version 5.22.4
 211     perl5223delta       Perl changes in version 5.22.3
 212     perl5222delta       Perl changes in version 5.22.2
 213     perl5221delta       Perl changes in version 5.22.1
 214     perl5220delta       Perl changes in version 5.22.0
 215     perl5203delta       Perl changes in version 5.20.3
 216     perl5202delta       Perl changes in version 5.20.2
 217     perl5201delta       Perl changes in version 5.20.1
 218     perl5200delta       Perl changes in version 5.20.0
 219     perl5184delta       Perl changes in version 5.18.4
 220     perl5182delta       Perl changes in version 5.18.2
 221     perl5181delta       Perl changes in version 5.18.1
 222     perl5180delta       Perl changes in version 5.18.0
 223     perl5163delta       Perl changes in version 5.16.3
 224     perl5162delta       Perl changes in version 5.16.2
 225     perl5161delta       Perl changes in version 5.16.1
 226     perl5160delta       Perl changes in version 5.16.0
 227     perl5144delta       Perl changes in version 5.14.4
 228     perl5143delta       Perl changes in version 5.14.3
 229     perl5142delta       Perl changes in version 5.14.2
 230     perl5141delta       Perl changes in version 5.14.1
 231     perl5140delta       Perl changes in version 5.14.0
 232     perl5125delta       Perl changes in version 5.12.5
 233     perl5124delta       Perl changes in version 5.12.4
 234     perl5123delta       Perl changes in version 5.12.3
 235     perl5122delta       Perl changes in version 5.12.2
 236     perl5121delta       Perl changes in version 5.12.1
 237     perl5120delta       Perl changes in version 5.12.0
 238     perl5101delta       Perl changes in version 5.10.1
 239     perl5100delta       Perl changes in version 5.10.0
 240     perl589delta        Perl changes in version 5.8.9
 241     perl588delta        Perl changes in version 5.8.8
 242     perl587delta        Perl changes in version 5.8.7
 243     perl586delta        Perl changes in version 5.8.6
 244     perl585delta        Perl changes in version 5.8.5
 245     perl584delta        Perl changes in version 5.8.4
 246     perl583delta        Perl changes in version 5.8.3
 247     perl582delta        Perl changes in version 5.8.2
 248     perl581delta        Perl changes in version 5.8.1
 249     perl58delta         Perl changes in version 5.8.0
 250     perl561delta        Perl changes in version 5.6.1
 251     perl56delta         Perl changes in version 5.6
 252     perl5005delta       Perl changes in version 5.005
 253     perl5004delta       Perl changes in version 5.004
 254
 255 =head2 Miscellaneous
 256
 257     perlbook            Perl book information
 258     perlcommunity       Perl community information
 259
 260     perldoc             Look up Perl documentation in Pod format
 261
 262     perlexperiment      A listing of experimental features in Perl
 263
 264     perlartistic        Perl Artistic License
 265     perlgpl             GNU General Public License
 266
 267 =head2 Language-Specific
 268
 269 =for buildtoc flag +r
 270
 271     perlcn              Perl for Simplified Chinese (in UTF-8)
 272     perljp              Perl for Japanese (in EUC-JP)
 273     perlko              Perl for Korean (in EUC-KR)
 274     perltw              Perl for Traditional Chinese (in Big5)
 275
 276 =head2 Platform-Specific
 277
 278     perlaix             Perl notes for AIX
 279     perlamiga           Perl notes for AmigaOS
 280     perlandroid         Perl notes for Android
 281     perlbs2000          Perl notes for POSIX-BC BS2000
 282     perlcygwin          Perl notes for Cygwin
 283     perlfreebsd         Perl notes for FreeBSD
 284     perlhaiku           Perl notes for Haiku
 285     perlhpux            Perl notes for HP-UX
 286     perlhurd            Perl notes for Hurd
 287     perlirix            Perl notes for Irix
 288     perllinux           Perl notes for Linux
 289     perlmacos           Perl notes for Mac OS (Classic)
 290     perlmacosx          Perl notes for Mac OS X
 291     perlopenbsd         Perl notes for OpenBSD
 292     perlos2             Perl notes for OS/2
 293     perlos390           Perl notes for OS/390
 294     perlos400           Perl notes for OS/400
 295     perlplan9           Perl notes for Plan 9
 296     perlqnx             Perl notes for QNX
 297     perlriscos          Perl notes for RISC OS
 298     perlsolaris         Perl notes for Solaris
 299     perlsynology        Perl notes for Synology
 300     perltru64           Perl notes for Tru64
 301     perlvms             Perl notes for VMS
 302     perlvos             Perl notes for Stratus VOS
 303     perlwin32           Perl notes for Windows
 304
 305 =for buildtoc flag -r
 306
 307 =head2 Stubs for Deleted Documents
 308
 309     perlboot
 310     perlbot
 311     perlrepository
 312     perltodo
 313     perltooc
 314     perltoot
 315
 316 =for buildtoc __END__
 317
 318 On a Unix-like system, these documentation files will usually also be
 319 available as manpages for use with the F<man> program.
 320
 321 Some documentation is not available as man pages, so if a
 322 cross-reference is not found by man, try it with L<perldoc>.  Perldoc can
 323 also take you directly to documentation for functions (with the B<-f>
 324 switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>)
 325 for other helpful options L<perldoc> has to offer.
 326
 327 In general, if something strange has gone wrong with your program and you're
 328 not sure where you should look for help, try making your code comply with
 329 B<use strict> and B<use warnings>.  These will often point out exactly
 330 where the trouble is.
 331
 332 =head1 DESCRIPTION
 333
 334 Perl officially stands for Practical Extraction and Report Language,
 335 except when it doesn't.
 336
 337 Perl was originally a language optimized for scanning arbitrary
 338 text files, extracting information from those text files, and printing
 339 reports based on that information.  It quickly became a good language
 340 for many system management tasks. Over the years, Perl has grown into
 341 a general-purpose programming language. It's widely used for everything
 342 from quick "one-liners" to full-scale application development.
 343
 344 The language is intended to be practical (easy to use, efficient,
 345 complete) rather than beautiful (tiny, elegant, minimal).  It combines
 346 (in the author's opinion, anyway) some of the best features of B<sed>,
 347 B<awk>, and B<sh>, making it familiar and easy to use for Unix users to
 348 whip up quick solutions to annoying problems.  Its general-purpose
 349 programming facilities support procedural, functional, and
 350 object-oriented programming paradigms, making Perl a comfortable
 351 language for the long haul on major projects, whatever your bent.
 352
 353 Perl's roots in text processing haven't been forgotten over the years.
 354 It still boasts some of the most powerful regular expressions to be
 355 found anywhere, and its support for Unicode text is world-class.  It
 356 handles all kinds of structured text, too, through an extensive
 357 collection of extensions.  Those libraries, collected in the CPAN,
 358 provide ready-made solutions to an astounding array of problems.  When
 359 they haven't set the standard themselves, they steal from the best
 360 -- just like Perl itself.
 361
 362 =head1 AVAILABILITY
 363
 364 Perl is available for most operating systems, including virtually
 365 all Unix-like platforms.  See L<perlport/"Supported Platforms">
 366 for a listing.
 367
 368 =head1 ENVIRONMENT
 369
 370 See L<perlrun/ENVIRONMENT>.
 371
 372 =head1 AUTHOR
 373
 374 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 375
 376 If your Perl success stories and testimonials may be of help to others
 377 who wish to advocate the use of Perl in their applications,
 378 or if you wish to simply express your gratitude to Larry and the
 379 Perl developers, please write to perl-thanks@perl.org .
 380
 381 =head1 FILES
 382
 383  "@INC"                 locations of perl libraries
 384
 385 "@INC" above is a reference to the built-in variable of the same name;
 386 see L<perlvar> for more information.
 387
 388 =head1 SEE ALSO
 389
 390  https://www.perl.org/       the Perl homepage
 391  https://www.perl.com/       Perl articles
 392  https://www.cpan.org/       the Comprehensive Perl Archive
 393  https://www.pm.org/         the Perl Mongers
 394
 395 =head1 DIAGNOSTICS
 396
 397 Using the C<use strict> pragma ensures that all variables are properly
 398 declared and prevents other misuses of legacy Perl features.
 399 These are enabled by default within the scope of
 400 C<L<use v5.12|perlfunc/use VERSION>> (or higher).
 401
 402 The C<use warnings> pragma produces some lovely diagnostics.
 403 It is enabled by default when you say C<use v5.35> (or higher).
 404 One can also use the B<-w> flag, but its use is normally discouraged,
 405 because it gets applied to all executed Perl code, including that not under
 406 your control.
 407
 408 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 409 diagnostics> pragma automatically turns Perl's normally terse warnings
 410 and errors into these longer forms.
 411
 412 Compilation errors will tell you the line number of the error, with an
 413 indication of the next token or token type that was to be examined.
 414 (In a script passed to Perl via B<-e> switches, each
 415 B<-e> is counted as one line.)
 416
 417 Setuid scripts have additional constraints that can produce error
 418 messages such as "Insecure dependency".  See L<perlsec>.
 419
 420 Did we mention that you should definitely consider using the B<use warnings>
 421 pragma?
 422
 423 =head1 BUGS
 424
 425 The behavior implied by the B<use warnings> pragma is not mandatory.
 426
 427 Perl is at the mercy of your machine's definitions of various
 428 operations such as type casting, atof(), and floating-point
 429 output with sprintf().
 430
 431 If your stdio requires a seek or eof between reads and writes on a
 432 particular stream, so does Perl.  (This doesn't apply to sysread()
 433 and syswrite().)
 434
 435 While none of the built-in data types have any arbitrary size limits
 436 (apart from memory size), there are still a few arbitrary limits:  a
 437 given variable name may not be longer than 251 characters.  Line numbers
 438 displayed by diagnostics are internally stored as short integers,
 439 so they are limited to a maximum of 65535 (higher numbers usually being
 440 affected by wraparound).
 441
 442 You may submit your bug reports (be sure to include full configuration
 443 information as output by the myconfig program in the perl source
 444 tree, or by C<perl -V>) to L<https://github.com/Perl/perl5/issues>.
 445
 446 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 447 don't tell anyone I said that.
 448
 449 =head1 NOTES
 450
 451 The Perl motto is "There's more than one way to do it."  Divining
 452 how many more is left as an exercise to the reader.
 453
 454 The three principal virtues of a programmer are Laziness,
 455 Impatience, and Hubris.  See the Camel Book for why.
 456