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