pod/perl.pod

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