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