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<http://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/lib/
  46
  47 aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p 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     perlpodstyle        Perl POD style guide
 100     perldiag            Perl diagnostic messages
 101     perllexwarn         Perl warnings and their control
 102     perldebug           Perl debugging
 103     perlvar             Perl predefined variables
 104     perlre              Perl regular expressions, the rest of the story
 105     perlrebackslash     Perl regular expression backslash sequences
 106     perlrecharclass     Perl regular expression character classes
 107     perlreref           Perl regular expressions quick reference
 108     perlref             Perl references, the rest of the story
 109     perlform            Perl formats
 110     perlobj             Perl objects
 111     perltie             Perl objects hidden behind simple variables
 112       perldbmfilter     Perl DBM filters
 113
 114     perlipc             Perl interprocess communication
 115     perlfork            Perl fork() information
 116     perlnumber          Perl number semantics
 117
 118     perlthrtut          Perl threads tutorial
 119
 120     perlport            Perl portability guide
 121     perllocale          Perl locale support
 122     perluniintro        Perl Unicode introduction
 123     perlunicode         Perl Unicode support
 124     perlunifaq          Perl Unicode FAQ
 125     perluniprops        Index of Unicode properties in Perl
 126     perlunitut          Perl Unicode tutorial
 127     perlebcdic          Considerations for running Perl on EBCDIC platforms
 128
 129     perlsec             Perl security
 130
 131     perlmod             Perl modules: how they work
 132     perlmodlib          Perl modules: how to write and use
 133     perlmodstyle        Perl modules: how to write modules with style
 134     perlmodinstall      Perl modules: how to install from CPAN
 135     perlnewmod          Perl modules: preparing a new module for distribution
 136     perlpragma          Perl modules: writing a user pragma
 137
 138     perlutil            utilities packaged with the Perl distribution
 139
 140     perlfilter          Perl source filters
 141
 142     perldtrace          Perl's support for DTrace
 143
 144     perlglossary        Perl Glossary
 145
 146 =head2 Internals and C Language Interface
 147
 148     perlembed           Perl ways to embed perl in your C or C++ application
 149     perldebguts         Perl debugging guts and tips
 150     perlxstut           Perl XS tutorial
 151     perlxs              Perl XS application programming interface
 152     perlxstypemap       Perl XS C/Perl type conversion tools
 153     perlclib            Internal replacements for standard C library functions
 154     perlguts            Perl internal functions for those doing extensions
 155     perlcall            Perl calling conventions from C
 156     perlmroapi          Perl method resolution plugin interface
 157     perlreapi           Perl regular expression plugin interface
 158     perlreguts          Perl regular expression engine internals
 159
 160     perlapi             Perl API listing (autogenerated)
 161     perlintern          Perl internal functions (autogenerated)
 162     perliol             C API for Perl's implementation of IO in Layers
 163     perlapio            Perl internal IO abstraction interface
 164
 165     perlhack            Perl hackers guide
 166     perlsource          Guide to the Perl source tree
 167     perlinterp          Overview of the Perl interpreter source and how it works
 168     perlhacktut         Walk through the creation of a simple C code patch
 169     perlhacktips        Tips for Perl core C code hacking
 170     perlpolicy          Perl development policies
 171     perlgit             Using git with the Perl repository
 172
 173 =head2 Miscellaneous
 174
 175     perlbook            Perl book information
 176     perlcommunity       Perl community information
 177
 178     perldoc             Look up Perl documentation in Pod format
 179
 180     perlhist            Perl history records
 181     perldelta           Perl changes since previous version
 182     perl5175delta       Perl changes in version 5.17.5
 183     perl5174delta       Perl changes in version 5.17.4
 184     perl5173delta       Perl changes in version 5.17.3
 185     perl5172delta       Perl changes in version 5.17.2
 186     perl5171delta       Perl changes in version 5.17.1
 187     perl5170delta       Perl changes in version 5.17.0
 188     perl5161delta       Perl changes in version 5.16.1
 189     perl5162delta       Perl changes in version 5.16.2
 190     perl5160delta       Perl changes in version 5.16.0
 191     perl5143delta       Perl changes in version 5.14.3
 192     perl5142delta       Perl changes in version 5.14.2
 193     perl5141delta       Perl changes in version 5.14.1
 194     perl5140delta       Perl changes in version 5.14.0
 195     perl5124delta       Perl changes in version 5.12.4
 196     perl5123delta       Perl changes in version 5.12.3
 197     perl5122delta       Perl changes in version 5.12.2
 198     perl5121delta       Perl changes in version 5.12.1
 199     perl5120delta       Perl changes in version 5.12.0
 200     perl5101delta       Perl changes in version 5.10.1
 201     perl5100delta       Perl changes in version 5.10.0
 202     perl589delta        Perl changes in version 5.8.9
 203     perl588delta        Perl changes in version 5.8.8
 204     perl587delta        Perl changes in version 5.8.7
 205     perl586delta        Perl changes in version 5.8.6
 206     perl585delta        Perl changes in version 5.8.5
 207     perl584delta        Perl changes in version 5.8.4
 208     perl583delta        Perl changes in version 5.8.3
 209     perl582delta        Perl changes in version 5.8.2
 210     perl581delta        Perl changes in version 5.8.1
 211     perl58delta         Perl changes in version 5.8.0
 212     perl561delta        Perl changes in version 5.6.1
 213     perl56delta         Perl changes in version 5.6
 214     perl5005delta       Perl changes in version 5.005
 215     perl5004delta       Perl changes in version 5.004
 216
 217     perlexperiment      A listing of experimental features in Perl
 218
 219     perlartistic        Perl Artistic License
 220     perlgpl             GNU General Public License
 221
 222 =head2 Language-Specific
 223
 224 =for buildtoc flag +r
 225
 226     perlcn              Perl for Simplified Chinese (in EUC-CN)
 227     perljp              Perl for Japanese (in EUC-JP)
 228     perlko              Perl for Korean (in EUC-KR)
 229     perltw              Perl for Traditional Chinese (in Big5)
 230
 231 =head2 Platform-Specific
 232
 233     perlaix             Perl notes for AIX
 234     perlamiga           Perl notes for AmigaOS
 235     perlbeos            Perl notes for BeOS
 236     perlbs2000          Perl notes for POSIX-BC BS2000
 237     perlce              Perl notes for WinCE
 238     perlcygwin          Perl notes for Cygwin
 239     perldgux            Perl notes for DG/UX
 240     perldos             Perl notes for DOS
 241     perlepoc            Perl notes for EPOC
 242     perlfreebsd         Perl notes for FreeBSD
 243     perlhaiku           Perl notes for Haiku
 244     perlhpux            Perl notes for HP-UX
 245     perlhurd            Perl notes for Hurd
 246     perlirix            Perl notes for Irix
 247     perllinux           Perl notes for Linux
 248     perlmacos           Perl notes for Mac OS (Classic)
 249     perlmacosx          Perl notes for Mac OS X
 250     perlnetware         Perl notes for NetWare
 251     perlopenbsd         Perl notes for OpenBSD
 252     perlos2             Perl notes for OS/2
 253     perlos390           Perl notes for OS/390
 254     perlos400           Perl notes for OS/400
 255     perlplan9           Perl notes for Plan 9
 256     perlqnx             Perl notes for QNX
 257     perlriscos          Perl notes for RISC OS
 258     perlsolaris         Perl notes for Solaris
 259     perlsymbian         Perl notes for Symbian
 260     perltru64           Perl notes for Tru64
 261     perlvms             Perl notes for VMS
 262     perlvos             Perl notes for Stratus VOS
 263     perlwin32           Perl notes for Windows
 264
 265 =for buildtoc flag -r
 266
 267 =head2 Stubs for Deleted Documents
 268
 269     perlboot
 270     perlbot
 271     perltodo
 272     perltooc
 273     perltoot
 274
 275 =for buildtoc __END__
 276
 277 On a Unix-like system, these documentation files will usually also be
 278 available as manpages for use with the F<man> program.
 279
 280 In general, if something strange has gone wrong with your program and you're
 281 not sure where you should look for help, try making your code comply with
 282 B<use strict> and B<use warnings>.  These will often point out exactly
 283 where the trouble is.
 284
 285 =head1 DESCRIPTION
 286
 287 Perl officially stands for Practical Extraction and Report Language,
 288 except when it doesn't.
 289
 290 Perl was originally a language optimized for scanning arbitrary
 291 text files, extracting information from those text files, and printing
 292 reports based on that information.  It quickly became a good language
 293 for many system management tasks. Over the years, Perl has grown into
 294 a general-purpose programming language. It's widely used for everything
 295 from quick "one-liners" to full-scale application development.
 296
 297 The language is intended to be practical (easy to use, efficient,
 298 complete) rather than beautiful (tiny, elegant, minimal).
 299
 300 Perl combines (in the author's opinion, anyway) some of the best
 301 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
 302 those languages should have little difficulty with it.  (Language
 303 historians will also note some vestiges of B<csh>, Pascal, and even
 304 BASIC-PLUS.)  Expression syntax corresponds closely to C
 305 expression syntax.  Unlike most Unix utilities, Perl does not
 306 arbitrarily limit the size of your data--if you've got the memory,
 307 Perl can slurp in your whole file as a single string.  Recursion is of
 308 unlimited depth.  And the tables used by hashes (sometimes called
 309 "associative arrays") grow as necessary to prevent degraded
 310 performance.  Perl can use sophisticated pattern matching techniques to
 311 scan large amounts of data quickly.  Although optimized for
 312 scanning text, Perl also has many excellent tools for slicing
 313 and dicing binary data.
 314
 315 But wait, there's more...
 316
 317 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
 318 rewrite that provides the following additional benefits:
 319
 320 =over 4
 321
 322 =item *
 323
 324 modularity and reusability using innumerable modules
 325
 326 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
 327
 328 =item *
 329
 330 embeddable and extensible
 331
 332 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlxstypemap>,
 333 L<perlcall>, L<perlguts>, and L<xsubpp>.
 334
 335 =item *
 336
 337 roll-your-own magic variables (including multiple simultaneous DBM
 338 implementations)
 339
 340 Described in L<perltie> and L<AnyDBM_File>.
 341
 342 =item *
 343
 344 subroutines can now be overridden, autoloaded, and prototyped
 345
 346 Described in L<perlsub>.
 347
 348 =item *
 349
 350 arbitrarily nested data structures and anonymous functions
 351
 352 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
 353
 354 =item *
 355
 356 object-oriented programming
 357
 358 Described in L<perlobj> and L<perlootut>.
 359
 360 =item *
 361
 362 support for light-weight processes (threads)
 363
 364 Described in L<perlthrtut> and L<threads>.
 365
 366 =item *
 367
 368 support for Unicode, internationalization, and localization
 369
 370 Described in L<perluniintro>, L<perllocale> and L<Locale::Maketext>.
 371
 372 =item *
 373
 374 lexical scoping
 375
 376 Described in L<perlsub>.
 377
 378 =item *
 379
 380 regular expression enhancements
 381
 382 Described in L<perlre>, with additional examples in L<perlop>.
 383
 384 =item *
 385
 386 enhanced debugger and interactive Perl environment,
 387 with integrated editor support
 388
 389 Described in L<perldebtut>, L<perldebug> and L<perldebguts>.
 390
 391 =item *
 392
 393 POSIX 1003.1 compliant library
 394
 395 Described in L<POSIX>.
 396
 397 =back
 398
 399 Okay, that's I<definitely> enough hype.
 400
 401 =head1 AVAILABILITY
 402
 403 Perl is available for most operating systems, including virtually
 404 all Unix-like platforms.  See L<perlport/"Supported Platforms">
 405 for a listing.
 406
 407 =head1 ENVIRONMENT
 408
 409 See L<perlrun>.
 410
 411 =head1 AUTHOR
 412
 413 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 414
 415 If your Perl success stories and testimonials may be of help to others
 416 who wish to advocate the use of Perl in their applications,
 417 or if you wish to simply express your gratitude to Larry and the
 418 Perl developers, please write to perl-thanks@perl.org .
 419
 420 =head1 FILES
 421
 422  "@INC"                 locations of perl libraries
 423
 424 =head1 SEE ALSO
 425
 426  http://www.perl.org/       the Perl homepage
 427  http://www.perl.com/       Perl articles (O'Reilly)
 428  http://www.cpan.org/       the Comprehensive Perl Archive
 429  http://www.pm.org/         the Perl Mongers
 430
 431 =head1 DIAGNOSTICS
 432
 433 Using the C<use strict> pragma ensures that all variables are properly
 434 declared and prevents other misuses of legacy Perl features.
 435
 436 The C<use warnings> pragma (and the globally applied and deprecated B<-w>
 437 switch) produce some lovely diagnostics.
 438
 439 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 440 diagnostics> pragma automatically turns Perl's normally terse warnings
 441 and errors into these longer forms.
 442
 443 Compilation errors will tell you the line number of the error, with an
 444 indication of the next token or token type that was to be examined.
 445 (In a script passed to Perl via B<-e> switches, each
 446 B<-e> is counted as one line.)
 447
 448 Setuid scripts have additional constraints that can produce error
 449 messages such as "Insecure dependency".  See L<perlsec>.
 450
 451 Did we mention that you should definitely consider using the B<use warnings>
 452 pragma?
 453
 454 =head1 BUGS
 455
 456 The behavior implied by the B<use warnings> pragma is not mandatory.
 457
 458 Perl is at the mercy of your machine's definitions of various
 459 operations such as type casting, atof(), and floating-point
 460 output with sprintf().
 461
 462 If your stdio requires a seek or eof between reads and writes on a
 463 particular stream, so does Perl.  (This doesn't apply to sysread()
 464 and syswrite().)
 465
 466 While none of the built-in data types have any arbitrary size limits
 467 (apart from memory size), there are still a few arbitrary limits:  a
 468 given variable name may not be longer than 251 characters.  Line numbers
 469 displayed by diagnostics are internally stored as short integers,
 470 so they are limited to a maximum of 65535 (higher numbers usually being
 471 affected by wraparound).
 472
 473 You may mail your bug reports (be sure to include full configuration
 474 information as output by the myconfig program in the perl source
 475 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
 476 in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
 477 can be used to help mail in a bug report.
 478
 479 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 480 don't tell anyone I said that.
 481
 482 =head1 NOTES
 483
 484 The Perl motto is "There's more than one way to do it."  Divining
 485 how many more is left as an exercise to the reader.
 486
 487 The three principal virtues of a programmer are Laziness,
 488 Impatience, and Hubris.  See the Camel Book for why.
 489