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 =head2 Overview
  32
  33     perl                Perl overview (this section)
  34     perlintro           Perl introduction for beginners
  35     perltoc             Perl documentation table of contents
  36
  37 =head2 Tutorials
  38
  39     perlreftut          Perl references short introduction
  40     perldsc             Perl data structures intro
  41     perllol             Perl data structures: arrays of arrays
  42
  43     perlrequick         Perl regular expressions quick start
  44     perlretut           Perl regular expressions tutorial
  45
  46     perlboot            Perl OO tutorial for beginners
  47     perltoot            Perl OO tutorial, part 1
  48     perltooc            Perl OO tutorial, part 2
  49     perlbot             Perl OO tricks and examples
  50
  51     perlperf            Perl Performance and Optimization Techniques
  52
  53     perlstyle           Perl style guide
  54
  55     perlcheat           Perl cheat sheet
  56     perltrap            Perl traps for the unwary
  57     perldebtut          Perl debugging tutorial
  58
  59     perlfaq             Perl frequently asked questions
  60       perlfaq1          General Questions About Perl
  61       perlfaq2          Obtaining and Learning about Perl
  62       perlfaq3          Programming Tools
  63       perlfaq4          Data Manipulation
  64       perlfaq5          Files and Formats
  65       perlfaq6          Regexes
  66       perlfaq7          Perl Language Issues
  67       perlfaq8          System Interaction
  68       perlfaq9          Networking
  69
  70 =head2 Reference Manual
  71
  72     perlsyn             Perl syntax
  73     perldata            Perl data structures
  74     perlop              Perl operators and precedence
  75     perlsub             Perl subroutines
  76     perlfunc            Perl built-in functions
  77       perlopentut       Perl open() tutorial
  78       perlpacktut       Perl pack() and unpack() tutorial
  79     perlpod             Perl plain old documentation
  80     perlpodspec         Perl plain old documentation format specification
  81     perlpodstyle        Perl POD style guide
  82     perlrun             Perl execution and options
  83     perldiag            Perl diagnostic messages
  84     perllexwarn         Perl warnings and their control
  85     perldebug           Perl debugging
  86     perlvar             Perl predefined variables
  87     perlre              Perl regular expressions, the rest of the story
  88     perlrebackslash     Perl regular expression backslash sequences
  89     perlrecharclass     Perl regular expression character classes
  90     perlreref           Perl regular expressions quick reference
  91     perlref             Perl references, the rest of the story
  92     perlform            Perl formats
  93     perlobj             Perl objects
  94     perltie             Perl objects hidden behind simple variables
  95       perldbmfilter     Perl DBM filters
  96
  97     perlipc             Perl interprocess communication
  98     perlfork            Perl fork() information
  99     perlnumber          Perl number semantics
 100
 101     perlthrtut          Perl threads tutorial
 102
 103     perlport            Perl portability guide
 104     perllocale          Perl locale support
 105     perluniintro        Perl Unicode introduction
 106     perlunicode         Perl Unicode support
 107     perlunifaq          Perl Unicode FAQ
 108     perluniprops        Index of Unicode Version 6.0.0 properties in Perl
 109     perlunitut          Perl Unicode tutorial
 110     perlebcdic          Considerations for running Perl on EBCDIC platforms
 111
 112     perlsec             Perl security
 113
 114     perlmod             Perl modules: how they work
 115     perlmodlib          Perl modules: how to write and use
 116     perlmodstyle        Perl modules: how to write modules with style
 117     perlmodinstall      Perl modules: how to install from CPAN
 118     perlnewmod          Perl modules: preparing a new module for distribution
 119     perlpragma          Perl modules: writing a user pragma
 120
 121     perlutil            utilities packaged with the Perl distribution
 122
 123     perlcompile         Perl compiler suite intro
 124
 125     perlfilter          Perl source filters
 126
 127     perlglossary        Perl Glossary
 128
 129 =head2 Internals and C Language Interface
 130
 131     perlembed           Perl ways to embed perl in your C or C++ application
 132     perldebguts         Perl debugging guts and tips
 133     perlxstut           Perl XS tutorial
 134     perlxs              Perl XS application programming interface
 135     perlclib            Internal replacements for standard C library functions
 136     perlguts            Perl internal functions for those doing extensions
 137     perlcall            Perl calling conventions from C
 138     perlmroapi          Perl method resolution plugin interface
 139     perlreapi           Perl regular expression plugin interface
 140     perlreguts          Perl regular expression engine internals
 141
 142     perlapi             Perl API listing (autogenerated)
 143     perlintern          Perl internal functions (autogenerated)
 144     perliol             C API for Perl's implementation of IO in Layers
 145     perlapio            Perl internal IO abstraction interface
 146
 147     perlhack            Perl hackers guide
 148     perlpolicy          Perl development policies
 149     perlrepository      Perl source repository
 150
 151 =head2 Miscellaneous
 152
 153     perlbook            Perl book information
 154     perlcommunity       Perl community information
 155     perltodo            Perl things to do
 156
 157     perldoc             Look up Perl documentation in Pod format
 158
 159     perlhist            Perl history records
 160     perldelta           Perl changes since previous version
 161     perl5137delta       Perl changes in version 5.13.7
 162     perl5136delta       Perl changes in version 5.13.6
 163     perl5135delta       Perl changes in version 5.13.5
 164     perl5134delta       Perl changes in version 5.13.4
 165     perl5133delta       Perl changes in version 5.13.3
 166     perl5132delta       Perl changes in version 5.13.2
 167     perl5131delta       Perl changes in version 5.13.1
 168     perl5130delta       Perl changes in version 5.13.0
 169     perl5122delta       Perl changes in version 5.12.2
 170     perl5121delta       Perl changes in version 5.12.1
 171     perl5120delta       Perl changes in version 5.12.0
 172     perl5115delta       Perl changes in version 5.11.5
 173     perl5114delta       Perl changes in version 5.11.4
 174     perl5113delta       Perl changes in version 5.11.3
 175     perl5112delta       Perl changes in version 5.11.2
 176     perl5111delta       Perl changes in version 5.11.1
 177     perl5110delta       Perl changes in version 5.11.0
 178     perl5101delta       Perl changes in version 5.10.1
 179     perl5100delta       Perl changes in version 5.10.0
 180     perl595delta        Perl changes in version 5.9.5
 181     perl594delta        Perl changes in version 5.9.4
 182     perl593delta        Perl changes in version 5.9.3
 183     perl592delta        Perl changes in version 5.9.2
 184     perl591delta        Perl changes in version 5.9.1
 185     perl590delta        Perl changes in version 5.9.0
 186     perl589delta        Perl changes in version 5.8.9
 187     perl588delta        Perl changes in version 5.8.8
 188     perl587delta        Perl changes in version 5.8.7
 189     perl586delta        Perl changes in version 5.8.6
 190     perl585delta        Perl changes in version 5.8.5
 191     perl584delta        Perl changes in version 5.8.4
 192     perl583delta        Perl changes in version 5.8.3
 193     perl582delta        Perl changes in version 5.8.2
 194     perl581delta        Perl changes in version 5.8.1
 195     perl58delta         Perl changes in version 5.8.0
 196     perl573delta        Perl changes in version 5.7.3
 197     perl572delta        Perl changes in version 5.7.2
 198     perl571delta        Perl changes in version 5.7.1
 199     perl570delta        Perl changes in version 5.7.0
 200     perl561delta        Perl changes in version 5.6.1
 201     perl56delta         Perl changes in version 5.6
 202     perl5005delta       Perl changes in version 5.005
 203     perl5004delta       Perl changes in version 5.004
 204
 205     perlartistic        Perl Artistic License
 206     perlgpl             GNU General Public License
 207
 208 =head2 Language-Specific
 209
 210     perlcn              Perl for Simplified Chinese (in EUC-CN)
 211     perljp              Perl for Japanese (in EUC-JP)
 212     perlko              Perl for Korean (in EUC-KR)
 213     perltw              Perl for Traditional Chinese (in Big5)
 214
 215 =head2 Platform-Specific
 216
 217     perlaix             Perl notes for AIX
 218     perlamiga           Perl notes for AmigaOS
 219     perlapollo          Perl notes for Apollo DomainOS
 220     perlbeos            Perl notes for BeOS
 221     perlbs2000          Perl notes for POSIX-BC BS2000
 222     perlce              Perl notes for WinCE
 223     perlcygwin          Perl notes for Cygwin
 224     perldgux            Perl notes for DG/UX
 225     perldos             Perl notes for DOS
 226     perlepoc            Perl notes for EPOC
 227     perlfreebsd         Perl notes for FreeBSD
 228     perlhaiku           Perl notes for Haiku
 229     perlhpux            Perl notes for HP-UX
 230     perlhurd            Perl notes for Hurd
 231     perlirix            Perl notes for Irix
 232     perllinux           Perl notes for Linux
 233     perlmacos           Perl notes for Mac OS (Classic)
 234     perlmacosx          Perl notes for Mac OS X
 235     perlmpeix           Perl notes for MPE/iX
 236     perlnetware         Perl notes for NetWare
 237     perlopenbsd         Perl notes for OpenBSD
 238     perlos2             Perl notes for OS/2
 239     perlos390           Perl notes for OS/390
 240     perlos400           Perl notes for OS/400
 241     perlplan9           Perl notes for Plan 9
 242     perlqnx             Perl notes for QNX
 243     perlriscos          Perl notes for RISC OS
 244     perlsolaris         Perl notes for Solaris
 245     perlsymbian         Perl notes for Symbian
 246     perltru64           Perl notes for Tru64
 247     perluts             Perl notes for UTS
 248     perlvmesa           Perl notes for VM/ESA
 249     perlvms             Perl notes for VMS
 250     perlvos             Perl notes for Stratus VOS
 251     perlwin32           Perl notes for Windows
 252
 253
 254 On a Unix-like system, these documentation files will usually also be
 255 available as manpages for use with the F<man> program.
 256
 257 In general, if something strange has gone wrong with your program and you're
 258 not sure where you should look for help, try the B<-w> switch first.  It will
 259 often point out exactly where the trouble is.
 260
 261 =head1 DESCRIPTION
 262
 263 Perl officially stands for Practical Extraction and Report Language,
 264 except when it doesn't.
 265
 266 Perl is a language optimized for scanning arbitrary
 267 text files, extracting information from those text files, and printing
 268 reports based on that information.  It's also a good language for many
 269 system management tasks.  The language is intended to be practical
 270 (easy to use, efficient, complete) rather than beautiful (tiny,
 271 elegant, minimal).
 272
 273 Perl combines (in the author's opinion, anyway) some of the best
 274 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
 275 those languages should have little difficulty with it.  (Language
 276 historians will also note some vestiges of B<csh>, Pascal, and even
 277 BASIC-PLUS.)  Expression syntax corresponds closely to C
 278 expression syntax.  Unlike most Unix utilities, Perl does not
 279 arbitrarily limit the size of your data--if you've got the memory,
 280 Perl can slurp in your whole file as a single string.  Recursion is of
 281 unlimited depth.  And the tables used by hashes (sometimes called
 282 "associative arrays") grow as necessary to prevent degraded
 283 performance.  Perl can use sophisticated pattern matching techniques to
 284 scan large amounts of data quickly.  Although optimized for
 285 scanning text, Perl can also deal with binary data, and can make dbm
 286 files look like hashes.
 287
 288 But wait, there's more...
 289
 290 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
 291 rewrite that provides the following additional benefits:
 292
 293 =over 4
 294
 295 =item *
 296
 297 modularity and reusability using innumerable modules
 298
 299 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
 300
 301 =item *
 302
 303 embeddable and extensible
 304
 305 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
 306 L<perlguts>, and L<xsubpp>.
 307
 308 =item *
 309
 310 roll-your-own magic variables (including multiple simultaneous DBM
 311 implementations)
 312
 313 Described in L<perltie> and L<AnyDBM_File>.
 314
 315 =item *
 316
 317 subroutines can now be overridden, autoloaded, and prototyped
 318
 319 Described in L<perlsub>.
 320
 321 =item *
 322
 323 arbitrarily nested data structures and anonymous functions
 324
 325 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
 326
 327 =item *
 328
 329 object-oriented programming
 330
 331 Described in L<perlobj>, L<perlboot>, L<perltoot>, L<perltooc>,
 332 and L<perlbot>.
 333
 334 =item *
 335
 336 support for light-weight processes (threads)
 337
 338 Described in L<perlthrtut> and L<threads>.
 339
 340 =item *
 341
 342 support for Unicode, internationalization, and localization
 343
 344 Described in L<perluniintro>, L<perllocale> and L<Locale::Maketext>.
 345
 346 =item *
 347
 348 lexical scoping
 349
 350 Described in L<perlsub>.
 351
 352 =item *
 353
 354 regular expression enhancements
 355
 356 Described in L<perlre>, with additional examples in L<perlop>.
 357
 358 =item *
 359
 360 enhanced debugger and interactive Perl environment,
 361 with integrated editor support
 362
 363 Described in L<perldebtut>, L<perldebug> and L<perldebguts>.
 364
 365 =item *
 366
 367 POSIX 1003.1 compliant library
 368
 369 Described in L<POSIX>.
 370
 371 =back
 372
 373 Okay, that's I<definitely> enough hype.
 374
 375 =head1 AVAILABILITY
 376
 377 Perl is available for most operating systems, including virtually
 378 all Unix-like platforms.  See L<perlport/"Supported Platforms">
 379 for a listing.
 380
 381 =head1 ENVIRONMENT
 382
 383 See L<perlrun>.
 384
 385 =head1 AUTHOR
 386
 387 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 388
 389 If your Perl success stories and testimonials may be of help to others
 390 who wish to advocate the use of Perl in their applications,
 391 or if you wish to simply express your gratitude to Larry and the
 392 Perl developers, please write to perl-thanks@perl.org .
 393
 394 =head1 FILES
 395
 396  "@INC"                 locations of perl libraries
 397
 398 =head1 SEE ALSO
 399
 400  a2p    awk to perl translator
 401  s2p    sed to perl translator
 402
 403  http://www.perl.org/       the Perl homepage
 404  http://www.perl.com/       Perl articles (O'Reilly)
 405  http://www.cpan.org/       the Comprehensive Perl Archive
 406  http://www.pm.org/         the Perl Mongers
 407
 408 =head1 DIAGNOSTICS
 409
 410 The C<use warnings> pragma (and the B<-w> switch) produces some
 411 lovely diagnostics.
 412
 413 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 414 diagnostics> pragma automatically turns Perl's normally terse warnings
 415 and errors into these longer forms.
 416
 417 Compilation errors will tell you the line number of the error, with an
 418 indication of the next token or token type that was to be examined.
 419 (In a script passed to Perl via B<-e> switches, each
 420 B<-e> is counted as one line.)
 421
 422 Setuid scripts have additional constraints that can produce error
 423 messages such as "Insecure dependency".  See L<perlsec>.
 424
 425 Did we mention that you should definitely consider using the B<-w>
 426 switch?
 427
 428 =head1 BUGS
 429
 430 The B<-w> switch is not mandatory.
 431
 432 Perl is at the mercy of your machine's definitions of various
 433 operations such as type casting, atof(), and floating-point
 434 output with sprintf().
 435
 436 If your stdio requires a seek or eof between reads and writes on a
 437 particular stream, so does Perl.  (This doesn't apply to sysread()
 438 and syswrite().)
 439
 440 While none of the built-in data types have any arbitrary size limits
 441 (apart from memory size), there are still a few arbitrary limits:  a
 442 given variable name may not be longer than 251 characters.  Line numbers
 443 displayed by diagnostics are internally stored as short integers,
 444 so they are limited to a maximum of 65535 (higher numbers usually being
 445 affected by wraparound).
 446
 447 You may mail your bug reports (be sure to include full configuration
 448 information as output by the myconfig program in the perl source
 449 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
 450 in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
 451 can be used to help mail in a bug report.
 452
 453 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 454 don't tell anyone I said that.
 455
 456 =head1 NOTES
 457
 458 The Perl motto is "There's more than one way to do it."  Divining
 459 how many more is left as an exercise to the reader.
 460
 461 The three principal virtues of a programmer are Laziness,
 462 Impatience, and Hubris.  See the Camel Book for why.
 463