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