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