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