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 =head1 GETTING HELP
  19
  20 The F<perldoc> program gives you access to all the documentation that comes
  21 with Perl.  You can get more documentation, tutorials and community support
  22 online at L<http://www.perl.org/>.
  23
  24 If you're new to Perl, you should start by running C<perldoc perlintro>,
  25 which is a general intro for beginners and provides some background to help
  26 you navigate the rest of Perl's extensive documentation.  Run C<perldoc
  27 perldoc> to learn more things you can do with F<perldoc>.
  28
  29 For ease of access, the Perl manual has been split up into several sections.
  30
  31 =begin buildtoc
  32
  33 # This section is parsed by Porting/pod_lib.pl for use by pod/buildtoc etc
  34
  35 flag =g  perluniprops perlmodlib perlapi perlintern
  36 flag =go perltoc
  37 flag =ro perlcn perljp perlko perltw
  38 flag =   perlvms
  39
  40 path perlfaq.*               cpan/perlfaq/lib/
  41 path perlglossary            cpan/perlfaq/lib/
  42 path perlxs(?:tut|typemap)?  dist/ExtUtils-ParseXS/lib/
  43 path perldoc                 cpan/Pod-Perldoc/lib/
  44
  45 aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
  46
  47 =end buildtoc
  48
  49 =head2 Overview
  50
  51     perl                Perl overview (this section)
  52     perlintro           Perl introduction for beginners
  53     perltoc             Perl documentation table of contents
  54
  55 =head2 Tutorials
  56
  57     perlreftut          Perl references short introduction
  58     perldsc             Perl data structures intro
  59     perllol             Perl data structures: arrays of arrays
  60
  61     perlrequick         Perl regular expressions quick start
  62     perlretut           Perl regular expressions tutorial
  63
  64     perlootut           Perl OO tutorial for beginners
  65
  66     perlperf            Perl Performance and Optimization Techniques
  67
  68     perlstyle           Perl style guide
  69
  70     perlcheat           Perl cheat sheet
  71     perltrap            Perl traps for the unwary
  72     perldebtut          Perl debugging tutorial
  73
  74     perlfaq             Perl frequently asked questions
  75       perlfaq1          General Questions About Perl
  76       perlfaq2          Obtaining and Learning about Perl
  77       perlfaq3          Programming Tools
  78       perlfaq4          Data Manipulation
  79       perlfaq5          Files and Formats
  80       perlfaq6          Regexes
  81       perlfaq7          Perl Language Issues
  82       perlfaq8          System Interaction
  83       perlfaq9          Networking
  84
  85 =head2 Reference Manual
  86
  87     perlsyn             Perl syntax
  88     perldata            Perl data structures
  89     perlop              Perl operators and precedence
  90     perlsub             Perl subroutines
  91     perlfunc            Perl built-in functions
  92       perlopentut       Perl open() tutorial
  93       perlpacktut       Perl pack() and unpack() tutorial
  94     perlpod             Perl plain old documentation
  95     perlpodspec         Perl plain old documentation format specification
  96     perlpodstyle        Perl POD style guide
  97     perlrun             Perl execution and options
  98     perldiag            Perl diagnostic messages
  99     perllexwarn         Perl warnings and their control
 100     perldebug           Perl debugging
 101     perlvar             Perl predefined variables
 102     perlre              Perl regular expressions, the rest of the story
 103     perlrebackslash     Perl regular expression backslash sequences
 104     perlrecharclass     Perl regular expression character classes
 105     perlreref           Perl regular expressions quick reference
 106     perlref             Perl references, the rest of the story
 107     perlform            Perl formats
 108     perlobj             Perl objects
 109     perltie             Perl objects hidden behind simple variables
 110       perldbmfilter     Perl DBM filters
 111
 112     perlipc             Perl interprocess communication
 113     perlfork            Perl fork() information
 114     perlnumber          Perl number semantics
 115
 116     perlthrtut          Perl threads tutorial
 117
 118     perlport            Perl portability guide
 119     perllocale          Perl locale support
 120     perluniintro        Perl Unicode introduction
 121     perlunicode         Perl Unicode support
 122     perlunifaq          Perl Unicode FAQ
 123     perluniprops        Index of Unicode Version 6.0.0 properties in Perl
 124     perlunitut          Perl Unicode tutorial
 125     perlebcdic          Considerations for running Perl on EBCDIC platforms
 126
 127     perlsec             Perl security
 128
 129     perlmod             Perl modules: how they work
 130     perlmodlib          Perl modules: how to write and use
 131     perlmodstyle        Perl modules: how to write modules with style
 132     perlmodinstall      Perl modules: how to install from CPAN
 133     perlnewmod          Perl modules: preparing a new module for distribution
 134     perlpragma          Perl modules: writing a user pragma
 135
 136     perlutil            utilities packaged with the Perl distribution
 137
 138     perlfilter          Perl source filters
 139
 140     perldtrace          Perl's support for DTrace
 141
 142     perlglossary        Perl Glossary
 143
 144 =head2 Internals and C Language Interface
 145
 146     perlembed           Perl ways to embed perl in your C or C++ application
 147     perldebguts         Perl debugging guts and tips
 148     perlxstut           Perl XS tutorial
 149     perlxs              Perl XS application programming interface
 150     perlxstypemap       Perl XS C/Perl type conversion tools
 151     perlclib            Internal replacements for standard C library functions
 152     perlguts            Perl internal functions for those doing extensions
 153     perlcall            Perl calling conventions from C
 154     perlmroapi          Perl method resolution plugin interface
 155     perlreapi           Perl regular expression plugin interface
 156     perlreguts          Perl regular expression engine internals
 157
 158     perlapi             Perl API listing (autogenerated)
 159     perlintern          Perl internal functions (autogenerated)
 160     perliol             C API for Perl's implementation of IO in Layers
 161     perlapio            Perl internal IO abstraction interface
 162
 163     perlhack            Perl hackers guide
 164     perlsource          Guide to the Perl source tree
 165     perlinterp          Overview of the Perl interpreter source and how it works
 166     perlhacktut         Walk through the creation of a simple C code patch
 167     perlhacktips        Tips for Perl core C code hacking
 168     perlpolicy          Perl development policies
 169     perlgit             Using git with the Perl repository
 170
 171 =head2 Miscellaneous
 172
 173     perlbook            Perl book information
 174     perlcommunity       Perl community information
 175
 176     perldoc             Look up Perl documentation in Pod format
 177
 178     perlhist            Perl history records
 179     perldelta           Perl changes since previous version
 180     perl5159delta       Perl changes in version 5.15.9
 181     perl5158delta       Perl changes in version 5.15.8
 182     perl5157delta       Perl changes in version 5.15.7
 183     perl5156delta       Perl changes in version 5.15.6
 184     perl5155delta       Perl changes in version 5.15.5
 185     perl5154delta       Perl changes in version 5.15.4
 186     perl5153delta       Perl changes in version 5.15.3
 187     perl5152delta       Perl changes in version 5.15.2
 188     perl5151delta       Perl changes in version 5.15.1
 189     perl5150delta       Perl changes in version 5.15.0
 190     perl5142delta       Perl changes in version 5.14.2
 191     perl5141delta       Perl changes in version 5.14.1
 192     perl5140delta       Perl changes in version 5.14.0
 193     perl5124delta       Perl changes in version 5.12.4
 194     perl5123delta       Perl changes in version 5.12.3
 195     perl5122delta       Perl changes in version 5.12.2
 196     perl5121delta       Perl changes in version 5.12.1
 197     perl5120delta       Perl changes in version 5.12.0
 198     perl5101delta       Perl changes in version 5.10.1
 199     perl5100delta       Perl changes in version 5.10.0
 200     perl589delta        Perl changes in version 5.8.9
 201     perl588delta        Perl changes in version 5.8.8
 202     perl587delta        Perl changes in version 5.8.7
 203     perl586delta        Perl changes in version 5.8.6
 204     perl585delta        Perl changes in version 5.8.5
 205     perl584delta        Perl changes in version 5.8.4
 206     perl583delta        Perl changes in version 5.8.3
 207     perl582delta        Perl changes in version 5.8.2
 208     perl581delta        Perl changes in version 5.8.1
 209     perl58delta         Perl changes in version 5.8.0
 210     perl561delta        Perl changes in version 5.6.1
 211     perl56delta         Perl changes in version 5.6
 212     perl5005delta       Perl changes in version 5.005
 213     perl5004delta       Perl changes in version 5.004
 214
 215     perlexperiment      A listing of experimental features in Perl
 216
 217     perlartistic        Perl Artistic License
 218     perlgpl             GNU General Public License
 219
 220 =head2 Language-Specific
 221
 222 =for buildtoc flag +r
 223
 224     perlcn              Perl for Simplified Chinese (in EUC-CN)
 225     perljp              Perl for Japanese (in EUC-JP)
 226     perlko              Perl for Korean (in EUC-KR)
 227     perltw              Perl for Traditional Chinese (in Big5)
 228
 229 =head2 Platform-Specific
 230
 231     perlaix             Perl notes for AIX
 232     perlamiga           Perl notes for AmigaOS
 233     perlbeos            Perl notes for BeOS
 234     perlbs2000          Perl notes for POSIX-BC BS2000
 235     perlce              Perl notes for WinCE
 236     perlcygwin          Perl notes for Cygwin
 237     perldgux            Perl notes for DG/UX
 238     perldos             Perl notes for DOS
 239     perlepoc            Perl notes for EPOC
 240     perlfreebsd         Perl notes for FreeBSD
 241     perlhaiku           Perl notes for Haiku
 242     perlhpux            Perl notes for HP-UX
 243     perlhurd            Perl notes for Hurd
 244     perlirix            Perl notes for Irix
 245     perllinux           Perl notes for Linux
 246     perlmacos           Perl notes for Mac OS (Classic)
 247     perlmacosx          Perl notes for Mac OS X
 248     perlmpeix           Perl notes for MPE/iX
 249     perlnetware         Perl notes for NetWare
 250     perlopenbsd         Perl notes for OpenBSD
 251     perlos2             Perl notes for OS/2
 252     perlos390           Perl notes for OS/390
 253     perlos400           Perl notes for OS/400
 254     perlplan9           Perl notes for Plan 9
 255     perlqnx             Perl notes for QNX
 256     perlriscos          Perl notes for RISC OS
 257     perlsolaris         Perl notes for Solaris
 258     perlsymbian         Perl notes for Symbian
 259     perltru64           Perl notes for Tru64
 260     perluts             Perl notes for UTS
 261     perlvmesa           Perl notes for VM/ESA
 262     perlvms             Perl notes for VMS
 263     perlvos             Perl notes for Stratus VOS
 264     perlwin32           Perl notes for Windows
 265
 266 =for buildtoc flag -r
 267
 268 =head2 Stubs for Deleted Documents
 269
 270     perlboot
 271     perlbot
 272     perltodo
 273     perltooc
 274     perltoot
 275
 276 =for buildtoc __END__
 277
 278 On a Unix-like system, these documentation files will usually also be
 279 available as manpages for use with the F<man> program.
 280
 281 In general, if something strange has gone wrong with your program and you're
 282 not sure where you should look for help, try the B<-w> switch first.  It will
 283 often point out exactly 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 The C<use warnings> pragma (and the B<-w> switch) produces some
 434 lovely diagnostics.
 435
 436 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 437 diagnostics> pragma automatically turns Perl's normally terse warnings
 438 and errors into these longer forms.
 439
 440 Compilation errors will tell you the line number of the error, with an
 441 indication of the next token or token type that was to be examined.
 442 (In a script passed to Perl via B<-e> switches, each
 443 B<-e> is counted as one line.)
 444
 445 Setuid scripts have additional constraints that can produce error
 446 messages such as "Insecure dependency".  See L<perlsec>.
 447
 448 Did we mention that you should definitely consider using the B<-w>
 449 switch?
 450
 451 =head1 BUGS
 452
 453 The B<-w> switch is not mandatory.
 454
 455 Perl is at the mercy of your machine's definitions of various
 456 operations such as type casting, atof(), and floating-point
 457 output with sprintf().
 458
 459 If your stdio requires a seek or eof between reads and writes on a
 460 particular stream, so does Perl.  (This doesn't apply to sysread()
 461 and syswrite().)
 462
 463 While none of the built-in data types have any arbitrary size limits
 464 (apart from memory size), there are still a few arbitrary limits:  a
 465 given variable name may not be longer than 251 characters.  Line numbers
 466 displayed by diagnostics are internally stored as short integers,
 467 so they are limited to a maximum of 65535 (higher numbers usually being
 468 affected by wraparound).
 469
 470 You may mail your bug reports (be sure to include full configuration
 471 information as output by the myconfig program in the perl source
 472 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
 473 in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
 474 can be used to help mail in a bug report.
 475
 476 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 477 don't tell anyone I said that.
 478
 479 =head1 NOTES
 480
 481 The Perl motto is "There's more than one way to do it."  Divining
 482 how many more is left as an exercise to the reader.
 483
 484 The three principal virtues of a programmer are Laziness,
 485 Impatience, and Hubris.  See the Camel Book for why.
 486