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