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