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