pod/perl.pod

   1 =head1 NAME
   2
   3 perl - Practical Extraction and Report Language
   4
   5 =head1 SYNOPSIS
   6
   7 B<perl> S<[ B<-sTuU> ]> 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> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal>] ]>
  10     S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ]>
  11     S<[ B<-P> ]> S<[ B<-S> ]> S<[ B<-x>[I<dir>] ]>
  12     S<[ B<-i>[I<extension>] ]> S<[ B<-e> I<'command'> ]
  13     [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
  14
  15 For ease of access, the Perl manual has been split up into several
  16 sections:
  17
  18     perl                Perl overview (this section)
  19     perldelta           Perl changes since previous version
  20     perl5005delta       Perl changes in version 5.005
  21     perl5004delta       Perl changes in version 5.004
  22     perlfaq             Perl frequently asked questions
  23     perltoc             Perl documentation table of contents
  24
  25     perldata            Perl data structures
  26     perlsyn             Perl syntax
  27     perlop              Perl operators and precedence
  28     perlre              Perl regular expressions
  29     perlrun             Perl execution and options
  30     perlfunc            Perl builtin functions
  31     perlopentut         Perl open() tutorial
  32     perlvar             Perl predefined variables
  33     perlsub             Perl subroutines
  34     perlmod             Perl modules: how they work
  35     perlmodlib          Perl modules: how to write and use
  36     perlmodinstall      Perl modules: how to install from CPAN
  37     perlform            Perl formats
  38     perlunicode         Perl unicode support
  39     perllocale          Perl locale support
  40
  41     perlreftut          Perl references short introduction
  42     perlref             Perl references, the rest of the story
  43     perldsc             Perl data structures intro
  44     perllol             Perl data structures: arrays of arrays
  45     perlboot            Perl OO tutorial for beginners
  46     perltoot            Perl OO tutorial, part 1
  47     perltootc           Perl OO tutorial, part 2
  48     perlobj             Perl objects
  49     perltie             Perl objects hidden behind simple variables
  50     perlbot             Perl OO tricks and examples
  51     perlipc             Perl interprocess communication
  52     perlfork            Perl fork() information
  53     perlthrtut          Perl threads tutorial
  54     perllexwarn         Perl warnings and their control
  55     perlfilter          Perl source filters
  56     perldbmfilter       Perl DBM filters
  57
  58     perlcompile         Perl compiler suite intro
  59     perldebug           Perl debugging
  60     perldiag            Perl diagnostic messages
  61     perlnumber          Perl number semantics
  62     perlsec             Perl security
  63     perltrap            Perl traps for the unwary
  64     perlport            Perl portability guide
  65     perlstyle           Perl style guide
  66
  67     perlpod             Perl plain old documentation
  68     perlbook            Perl book information
  69
  70     perlembed           Perl ways to embed perl in your C or C++ application
  71     perlapio            Perl internal IO abstraction interface
  72     perlxs              Perl XS application programming interface
  73     perlxstut           Perl XS tutorial
  74     perlguts            Perl internal functions for those doing extensions
  75     perlcall            Perl calling conventions from C
  76     perlapi             Perl API listing (autogenerated)
  77     perlintern          Perl internal functions (autogenerated)
  78
  79     perltodo            Perl things to do
  80     perlhack            Perl hackers guide
  81     perlhist            Perl history records
  82
  83     perlamiga           Perl notes for Amiga
  84     perlcygwin          Perl notes for Cygwin
  85     perldos             Perl notes for DOS
  86     perlhpux            Perl notes for HP-UX
  87     perlos2             Perl notes for OS/2
  88     perlos390           Perl notes for OS/390
  89     perlvms             Perl notes for VMS
  90     perlwin32           Perl notes for Windows
  91
  92 (If you're intending to read these straight through for the first time,
  93 the suggested order will tend to reduce the number of forward references.)
  94
  95 By default, the manpages listed above are installed in the
  96 F</usr/local/man/> directory.
  97
  98 Extensive additional documentation for Perl modules is available.  The
  99 default configuration for perl will place this additional documentation
 100 in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
 101 subdirectory of the Perl library directory).  Some of this additional
 102 documentation is distributed standard with Perl, but you'll also find
 103 documentation for third-party modules there.
 104
 105 You should be able to view Perl's documentation with your man(1)
 106 program by including the proper directories in the appropriate start-up
 107 files, or in the MANPATH environment variable.  To find out where the
 108 configuration has installed the manpages, type:
 109
 110     perl -V:man.dir
 111
 112 If the directories have a common stem, such as F</usr/local/man/man1>
 113 and F</usr/local/man/man3>, you need only to add that stem
 114 (F</usr/local/man>) to your man(1) configuration files or your MANPATH
 115 environment variable.  If they do not share a stem, you'll have to add
 116 both stems.
 117
 118 If that doesn't work for some reason, you can still use the
 119 supplied F<perldoc> script to view module information.  You might
 120 also look into getting a replacement man program.
 121
 122 If something strange has gone wrong with your program and you're not
 123 sure where you should look for help, try the B<-w> switch first.  It
 124 will often point out exactly where the trouble is.
 125
 126 =head1 DESCRIPTION
 127
 128 Perl is a language optimized for scanning arbitrary
 129 text files, extracting information from those text files, and printing
 130 reports based on that information.  It's also a good language for many
 131 system management tasks.  The language is intended to be practical
 132 (easy to use, efficient, complete) rather than beautiful (tiny,
 133 elegant, minimal).
 134
 135 Perl combines (in the author's opinion, anyway) some of the best
 136 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
 137 those languages should have little difficulty with it.  (Language
 138 historians will also note some vestiges of B<csh>, Pascal, and even
 139 BASIC-PLUS.)  Expression syntax corresponds closely to C
 140 expression syntax.  Unlike most Unix utilities, Perl does not
 141 arbitrarily limit the size of your data--if you've got the memory,
 142 Perl can slurp in your whole file as a single string.  Recursion is of
 143 unlimited depth.  And the tables used by hashes (sometimes called
 144 "associative arrays") grow as necessary to prevent degraded
 145 performance.  Perl can use sophisticated pattern matching techniques to
 146 scan large amounts of data quickly.  Although optimized for
 147 scanning text, Perl can also deal with binary data, and can make dbm
 148 files look like hashes.  Setuid Perl scripts are safer than C programs
 149 through a dataflow tracing mechanism that prevents many stupid
 150 security holes.
 151
 152 If you have a problem that would ordinarily use B<sed> or B<awk> or
 153 B<sh>, but it exceeds their capabilities or must run a little faster,
 154 and you don't want to write the silly thing in C, then Perl may be for
 155 you.  There are also translators to turn your B<sed> and B<awk>
 156 scripts into Perl scripts.
 157
 158 But wait, there's more...
 159
 160 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
 161 rewrite that provides the following additional benefits:
 162
 163 =over
 164
 165 =item * modularity and reusability using innumerable modules
 166
 167 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
 168
 169 =item * embeddable and extensible
 170
 171 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
 172 L<perlguts>, and L<xsubpp>.
 173
 174 =item * roll-your-own magic variables (including multiple simultaneous DBM implementations)
 175
 176 Described in L<perltie> and L<AnyDBM_File>.
 177
 178 =item * subroutines can now be overridden, autoloaded, and prototyped
 179
 180 Described in L<perlsub>.
 181
 182 =item * arbitrarily nested data structures and anonymous functions
 183
 184 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
 185
 186 =item * object-oriented programming
 187
 188 Described in L<perlobj>, L<perltoot>, and L<perlbot>.
 189
 190 =item * compilability into C code or Perl bytecode
 191
 192 Described in L<B> and L<B::Bytecode>.
 193
 194 =item * support for light-weight processes (threads)
 195
 196 Described in L<perlthrtut> and L<Thread>.
 197
 198 =item * support for internationalization, localization, and Unicode
 199
 200 Described in L<perllocale> and L<utf8>.
 201
 202 =item * lexical scoping
 203
 204 Described in L<perlsub>.
 205
 206 =item * regular expression enhancements
 207
 208 Described in L<perlre>, with additional examples in L<perlop>.
 209
 210 =item * enhanced debugger and interactive Perl environment, with integrated editor support
 211
 212 Described in L<perldebug>.
 213
 214 =item * POSIX 1003.1 compliant library
 215
 216 Described in L<POSIX>.
 217
 218 =back
 219
 220 Okay, that's I<definitely> enough hype.
 221
 222 =head1 AVAILABILITY
 223
 224 Perl is available for most operating systems, including virtually
 225 all Unix-like platforms.
 226
 227 As of early March 2000 (the Perl release 5.6.0), the following
 228 platforms are able to build Perl from the standard source code
 229 distribution available at http://www.perl.com/CPAN/src/index.html
 230
 231         AIX
 232         DOS DJGPP 1)
 233         FreeBSD
 234         HP-UX
 235         IRIX
 236         Linux
 237         MachTen
 238         MPE/iX
 239         NetBSD
 240         OpenBSD
 241         OS/2
 242         Rhapsody/Darwin 2)
 243         Solaris
 244         Tru64 UNIX      3)
 245         UNICOS
 246         UNICOS/mk
 247         VMS
 248         VOS
 249         Windows 3.1     1)
 250         Windows 95      1) 4)
 251         Windows 98      1) 4)
 252         Windows NT      1) 4)
 253
 254         1) in DOS mode either the DOS or OS/2 ports can be used
 255         2) NEW in 5.6.0: the BSD/NeXT-based UNIX of Mac OS X
 256         3) formerly known as Digital UNIX and before that DEC OSF/1
 257         4) compilers: Borland, Cygwin, Mingw32 EGCS/GCC, VC++
 258
 259 The following platforms worked for the previous major release,
 260 5.005_04 being the latest (as of March 2000) maintenance release, but
 261 we didn't manage to test these in time for the 5.6.0 release of Perl.
 262 There is a very good chance that these will work just fine with 5.6.0.
 263
 264         A/UX
 265         BeOS
 266         BSD/OS
 267         DG/UX
 268         DYNIX/ptx
 269         DomainOS
 270         Hurd
 271         NextSTEP
 272         OpenSTEP
 273         PowerMAX
 274         QNX
 275         SCO ODT/OSR
 276         SunOS
 277         SVR4
 278         Ultrix
 279
 280 The following platform worked for the previous major release, 5.005_04
 281 being the latest (as of early March 2000) maintenance release of that,
 282 but unfortunately the Unicode changes in 5.6.0 broke the port.  This
 283 will be fixed in a future Perl release.
 284
 285         OS390   1)
 286
 287         1) Previously known as MVS, or OpenEdition MVS.
 288
 289 Strongly related to the OS390 platform by also being EBCDIC-based
 290 mainframe platforms are the
 291
 292         BS2000
 293         VM/ESA
 294
 295 platforms.  They are related by not working in 5.6.0, unfortunately.
 296 Contact the mailing list perl-mvs@perl.org for more details.
 297
 298 MacOS (Classic, pre-X) is kind of 5.6.0-ready: building from the
 299 source does work with the 5.6.0, but you need more than just the Perl
 300 5.6 source code.  Contact the mailing list macperl-porters@macperl.org
 301 for more more information.
 302
 303 The following platforms have been known to build Perl from source in
 304 the past, but we haven't been able to verify their status for the
 305 current release, either because the hardware/software platforms are
 306 rare or because we don't have an active champion on these
 307 platforms--or both.
 308
 309         3b1
 310         AmigaOS
 311         ConvexOS
 312         CX/UX
 313         DC/OSx
 314         DDE SMES
 315         DOS EMX
 316         Dynix
 317         EP/IX
 318         ESIX
 319         FPS
 320         GENIX
 321         Greenhills
 322         ISC
 323         MachTen 68k
 324         MiNT
 325         MPC
 326         NEWS-OS
 327         Opus
 328         Plan 9
 329         PowerUX
 330         RISC/os
 331         Stellar
 332         SVR2
 333         TI1500
 334         TitanOS
 335         Unisys Dynix
 336         Unixware
 337
 338 Support for the following platform is planned for a future Perl release.
 339
 340         Netware
 341
 342 The following platforms have their own source code distributions and
 343 binaries available via http://www.perl.com/CPAN/ports/index.html.
 344
 345                                 Perl release
 346
 347         AS/400                  5.003
 348         Netware                 5.003_07
 349         Tandem Guardian         5.004
 350
 351 The following platforms have only binaries available via
 352 http://www.perl.com/CPAN/ports/index.html.
 353
 354                                 Perl release
 355
 356         Acorn RISCOS            5.005_02
 357         AOS                     5.002
 358         LynxOS                  5.004_02
 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.com/       the Perl Home Page
 383  http://www.perl.com/CPAN   the Comprehensive Perl Archive
 384
 385 =head1 DIAGNOSTICS
 386
 387 The B<-w> switch produces some lovely diagnostics.
 388
 389 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 390 diagnostics> pragma automatically turns Perl's normally terse warnings
 391 and errors into these longer forms.
 392
 393 Compilation errors will tell you the line number of the error, with an
 394 indication of the next token or token type that was to be examined.
 395 (In a script passed to Perl via B<-e> switches, each
 396 B<-e> is counted as one line.)
 397
 398 Setuid scripts have additional constraints that can produce error
 399 messages such as "Insecure dependency".  See L<perlsec>.
 400
 401 Did we mention that you should definitely consider using the B<-w>
 402 switch?
 403
 404 =head1 BUGS
 405
 406 The B<-w> switch is not mandatory.
 407
 408 Perl is at the mercy of your machine's definitions of various
 409 operations such as type casting, atof(), and floating-point
 410 output with sprintf().
 411
 412 If your stdio requires a seek or eof between reads and writes on a
 413 particular stream, so does Perl.  (This doesn't apply to sysread()
 414 and syswrite().)
 415
 416 While none of the built-in data types have any arbitrary size limits
 417 (apart from memory size), there are still a few arbitrary limits:  a
 418 given variable name may not be longer than 251 characters.  Line numbers
 419 displayed by diagnostics are internally stored as short integers,
 420 so they are limited to a maximum of 65535 (higher numbers usually being
 421 affected by wraparound).
 422
 423 You may mail your bug reports (be sure to include full configuration
 424 information as output by the myconfig program in the perl source
 425 tree, or by C<perl -V>) to perlbug@perl.com .  If you've succeeded
 426 in compiling perl, the perlbug script in the utils/ subdirectory
 427 can be used to help mail in a bug report.
 428
 429 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 430 don't tell anyone I said that.
 431
 432 =head1 NOTES
 433
 434 The Perl motto is "There's more than one way to do it."  Divining
 435 how many more is left as an exercise to the reader.
 436
 437 The three principal virtues of a programmer are Laziness,
 438 Impatience, and Hubris.  See the Camel Book for why.
 439