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