pod/perl.pod

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