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