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 open() 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 Platform-Specific
 140
 141     perlaix             Perl notes for AIX
 142     perlamiga           Perl notes for AmigaOS
 143     perlapollo          Perl notes for Apollo DomainOS
 144     perlbeos            Perl notes for BeOS
 145     perlbs2000          Perl notes for POSIX-BC BS2000
 146     perlce              Perl notes for WinCE
 147     perlcygwin          Perl notes for Cygwin
 148     perldgux            Perl notes for DG/UX
 149     perldos             Perl notes for DOS
 150     perlepoc            Perl notes for EPOC
 151     perlhpux            Perl notes for HP-UX
 152     perlhurd            Perl notes for Hurd
 153     perlmachten         Perl notes for Power MachTen
 154     perlmacos           Perl notes for Mac OS (Classic)
 155     perlmint            Perl notes for MiNT
 156     perlmpeix           Perl notes for MPE/iX
 157     perlnetware         Perl notes for NetWare
 158     perlos2             Perl notes for OS/2
 159     perlos390           Perl notes for OS/390
 160     perlplan9           Perl notes for Plan 9
 161     perlqnx             Perl notes for QNX
 162     perlsolaris         Perl notes for Solaris
 163     perltru64           Perl notes for Tru64
 164     perluts             Perl notes for UTS
 165     perlvmesa           Perl notes for VM/ESA
 166     perlvms             Perl notes for VMS
 167     perlvos             Perl notes for Stratus VOS
 168     perlwin32           Perl notes for Windows
 169
 170
 171 By default, the manpages listed above are installed in the
 172 F</usr/local/man/> directory.
 173
 174 Extensive additional documentation for Perl modules is available.  The
 175 default configuration for perl will place this additional documentation
 176 in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
 177 subdirectory of the Perl library directory).  Some of this additional
 178 documentation is distributed standard with Perl, but you'll also find
 179 documentation for third-party modules there.
 180
 181 You should be able to view Perl's documentation with your man(1)
 182 program by including the proper directories in the appropriate start-up
 183 files, or in the MANPATH environment variable.  To find out where the
 184 configuration has installed the manpages, type:
 185
 186     perl -V:man.dir
 187
 188 If the directories have a common stem, such as F</usr/local/man/man1>
 189 and F</usr/local/man/man3>, you need only to add that stem
 190 (F</usr/local/man>) to your man(1) configuration files or your MANPATH
 191 environment variable.  If they do not share a stem, you'll have to add
 192 both stems.
 193
 194 If that doesn't work for some reason, you can still use the
 195 supplied F<perldoc> script to view module information.  You might
 196 also look into getting a replacement man program.
 197
 198 If something strange has gone wrong with your program and you're not
 199 sure where you should look for help, try the B<-w> switch first.  It
 200 will often point out exactly where the trouble is.
 201
 202 =head1 DESCRIPTION
 203
 204 Perl is a language optimized for scanning arbitrary
 205 text files, extracting information from those text files, and printing
 206 reports based on that information.  It's also a good language for many
 207 system management tasks.  The language is intended to be practical
 208 (easy to use, efficient, complete) rather than beautiful (tiny,
 209 elegant, minimal).
 210
 211 Perl combines (in the author's opinion, anyway) some of the best
 212 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
 213 those languages should have little difficulty with it.  (Language
 214 historians will also note some vestiges of B<csh>, Pascal, and even
 215 BASIC-PLUS.)  Expression syntax corresponds closely to C
 216 expression syntax.  Unlike most Unix utilities, Perl does not
 217 arbitrarily limit the size of your data--if you've got the memory,
 218 Perl can slurp in your whole file as a single string.  Recursion is of
 219 unlimited depth.  And the tables used by hashes (sometimes called
 220 "associative arrays") grow as necessary to prevent degraded
 221 performance.  Perl can use sophisticated pattern matching techniques to
 222 scan large amounts of data quickly.  Although optimized for
 223 scanning text, Perl can also deal with binary data, and can make dbm
 224 files look like hashes.  Setuid Perl scripts are safer than C programs
 225 through a dataflow tracing mechanism that prevents many stupid
 226 security holes.
 227
 228 If you have a problem that would ordinarily use B<sed> or B<awk> or
 229 B<sh>, but it exceeds their capabilities or must run a little faster,
 230 and you don't want to write the silly thing in C, then Perl may be for
 231 you.  There are also translators to turn your B<sed> and B<awk>
 232 scripts into Perl scripts.
 233
 234 But wait, there's more...
 235
 236 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
 237 rewrite that provides the following additional benefits:
 238
 239 =over 4
 240
 241 =item *
 242
 243 modularity and reusability using innumerable modules
 244
 245 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
 246
 247 =item *
 248
 249 embeddable and extensible
 250
 251 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
 252 L<perlguts>, and L<xsubpp>.
 253
 254 =item *
 255
 256 roll-your-own magic variables (including multiple simultaneous DBM implementations)
 257
 258 Described in L<perltie> and L<AnyDBM_File>.
 259
 260 =item *
 261
 262 subroutines can now be overridden, autoloaded, and prototyped
 263
 264 Described in L<perlsub>.
 265
 266 =item *
 267
 268 arbitrarily nested data structures and anonymous functions
 269
 270 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
 271
 272 =item *
 273
 274 object-oriented programming
 275
 276 Described in L<perlobj>, L<perlboot>, L<perltoot>, L<perltooc>,
 277 and L<perlbot>.
 278
 279 =item *
 280
 281 compilability into C code or Perl bytecode
 282
 283 Described in L<B> and L<B::Bytecode>.
 284
 285 =item *
 286
 287 support for light-weight processes (threads)
 288
 289 Described in L<perlthrtut> and L<Thread>.
 290
 291 =item *
 292
 293 support for internationalization, localization, and Unicode
 294
 295 Described in L<perllocale> and L<utf8>.
 296
 297 =item *
 298
 299 lexical scoping
 300
 301 Described in L<perlsub>.
 302
 303 =item *
 304
 305 regular expression enhancements
 306
 307 Described in L<perlre>, with additional examples in L<perlop>.
 308
 309 =item *
 310
 311 enhanced debugger and interactive Perl environment,
 312 with integrated editor support
 313
 314 Described in L<perldebtut>, L<perldebug> and L<perldebguts>.
 315
 316 =item *
 317
 318 POSIX 1003.1 compliant library
 319
 320 Described in L<POSIX>.
 321
 322 =back
 323
 324 Okay, that's I<definitely> enough hype.
 325
 326 =head1 AVAILABILITY
 327
 328 Perl is available for most operating systems, including virtually
 329 all Unix-like platforms.  See L<perlport/"Supported Platforms">
 330 for a listing.
 331
 332 =head1 ENVIRONMENT
 333
 334 See L<perlrun>.
 335
 336 =head1 AUTHOR
 337
 338 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 339
 340 If your Perl success stories and testimonials may be of help to others
 341 who wish to advocate the use of Perl in their applications,
 342 or if you wish to simply express your gratitude to Larry and the
 343 Perl developers, please write to perl-thanks@perl.org .
 344
 345 =head1 FILES
 346
 347  "@INC"                 locations of perl libraries
 348
 349 =head1 SEE ALSO
 350
 351  a2p    awk to perl translator
 352  s2p    sed to perl translator
 353
 354  http://www.perl.com/       the Perl Home Page
 355  http://www.cpan.org/       the Comprehensive Perl Archive
 356  http://www.perl.org/       Perl Mongers (Perl user groups)
 357
 358 =head1 DIAGNOSTICS
 359
 360 The C<use warnings> pragma (and the B<-w> switch) produces some
 361 lovely diagnostics.
 362
 363 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 364 diagnostics> pragma automatically turns Perl's normally terse warnings
 365 and errors into these longer forms.
 366
 367 Compilation errors will tell you the line number of the error, with an
 368 indication of the next token or token type that was to be examined.
 369 (In a script passed to Perl via B<-e> switches, each
 370 B<-e> is counted as one line.)
 371
 372 Setuid scripts have additional constraints that can produce error
 373 messages such as "Insecure dependency".  See L<perlsec>.
 374
 375 Did we mention that you should definitely consider using the B<-w>
 376 switch?
 377
 378 =head1 BUGS
 379
 380 The B<-w> switch is not mandatory.
 381
 382 Perl is at the mercy of your machine's definitions of various
 383 operations such as type casting, atof(), and floating-point
 384 output with sprintf().
 385
 386 If your stdio requires a seek or eof between reads and writes on a
 387 particular stream, so does Perl.  (This doesn't apply to sysread()
 388 and syswrite().)
 389
 390 While none of the built-in data types have any arbitrary size limits
 391 (apart from memory size), there are still a few arbitrary limits:  a
 392 given variable name may not be longer than 251 characters.  Line numbers
 393 displayed by diagnostics are internally stored as short integers,
 394 so they are limited to a maximum of 65535 (higher numbers usually being
 395 affected by wraparound).
 396
 397 You may mail your bug reports (be sure to include full configuration
 398 information as output by the myconfig program in the perl source
 399 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
 400 in compiling perl, the B<perlbug> script in the F<utils/> subdirectory
 401 can be used to help mail in a bug report.
 402
 403 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 404 don't tell anyone I said that.
 405
 406 =head1 NOTES
 407
 408 The Perl motto is "There's more than one way to do it."  Divining
 409 how many more is left as an exercise to the reader.
 410
 411 The three principal virtues of a programmer are Laziness,
 412 Impatience, and Hubris.  See the Camel Book for why.
 413