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> ]>
   8         S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
   9         S<[ B<-cw> ] [ B<-d>[:I<debugger>] ] [ B<-D>[I<number/list>] ]>
  10         S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal>] ]>
  11         S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ]>
  12         S<[ B<-P> ]>
  13         S<[ B<-S> ]>
  14         S<[ B<-x>[I<dir>] ]>
  15         S<[ B<-i>[I<extension>] ]>
  16         S<[ B<-e> I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
  17
  18 For ease of access, the Perl manual has been split up into a number
  19 of sections:
  20
  21     perl        Perl overview (this section)
  22     perldelta   Perl changes since previous version
  23
  24     perldata    Perl data structures
  25     perlsyn     Perl syntax
  26     perlop      Perl operators and precedence
  27     perlre      Perl regular expressions
  28     perlrun     Perl execution and options
  29     perlfunc    Perl builtin functions
  30     perlvar     Perl predefined variables
  31     perlsub     Perl subroutines
  32     perlmod     Perl modules
  33     perlform    Perl formats
  34     perllocale  Perl locale support
  35
  36     perlref     Perl references
  37     perldsc     Perl data structures intro
  38     perllol     Perl data structures: lists of lists
  39     perltoot    Perl OO tutorial
  40     perlobj     Perl objects
  41     perltie     Perl objects hidden behind simple variables
  42     perlbot     Perl OO tricks and examples
  43     perlipc     Perl interprocess communication
  44
  45     perlbug     Perl bug reports howto
  46     perldebug   Perl debugging
  47     perldiag    Perl diagnostic messages
  48     perlsec     Perl security
  49     perltrap    Perl traps for the unwary
  50     perlstyle   Perl style guide
  51
  52     perlpod     Perl plain old documentation
  53     perlbook    Perl book information
  54
  55     perlembed   Perl how to embed perl in your C or C++ app
  56     perlapio    Perl internal IO abstraction interface
  57     perlxs      Perl XS application programming interface
  58     perlxstut   Perl XS tutorial
  59     perlguts    Perl internal functions for those doing extensions
  60     perlcall    Perl calling conventions from C
  61
  62 (If you're intending to read these straight through for the first time,
  63 the suggested order will tend to reduce the number of forward references.)
  64
  65 Additional documentation for Perl modules is available in the
  66 F</usr/local/man/> directory.  Some of this is distributed standard with
  67 Perl, but you'll also find third-party modules there.  You should be able
  68 to view this with your man(1) program by including the proper directories
  69 in the appropriate start-up files.  To find out where these are, type:
  70
  71     perl -V:man.dir
  72
  73 If the directories were F</usr/local/man/man1> and F</usr/local/man/man3>,
  74 you would need to add only F</usr/local/man> to your MANPATH.  If
  75 they are different, you'll have to add both stems.
  76
  77 If that doesn't work for some reason, you can still use the
  78 supplied F<perldoc> script to view module information.  You might
  79 also look into getting a replacement man program.
  80
  81 If something strange has gone wrong with your program and you're not
  82 sure where you should look for help, try the B<-w> switch first.  It
  83 will often point out exactly where the trouble is.
  84
  85 =head1 DESCRIPTION
  86
  87 Perl is a language optimized for scanning arbitrary
  88 text files, extracting information from those text files, and printing
  89 reports based on that information.  It's also a good language for many
  90 system management tasks.  The language is intended to be practical
  91 (easy to use, efficient, complete) rather than beautiful (tiny,
  92 elegant, minimal).
  93
  94 Perl combines (in the author's opinion, anyway) some of the best
  95 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
  96 those languages should have little difficulty with it.  (Language
  97 historians will also note some vestiges of B<csh>, Pascal, and even
  98 BASIC-PLUS.)  Expression syntax corresponds quite closely to C
  99 expression syntax.  Unlike most Unix utilities, Perl does not
 100 arbitrarily limit the size of your data--if you've got the memory,
 101 Perl can slurp in your whole file as a single string.  Recursion is of
 102 unlimited depth.  And the tables used by hashes (previously called
 103 "associative arrays") grow as necessary to prevent degraded
 104 performance.  Perl uses sophisticated pattern matching techniques to
 105 scan large amounts of data very quickly.  Although optimized for
 106 scanning text, Perl can also deal with binary data, and can make dbm
 107 files look like hashes.  Setuid Perl scripts are safer than C programs
 108 through a dataflow tracing mechanism which prevents many stupid
 109 security holes.
 110
 111 If you have a problem that would ordinarily use B<sed> or B<awk> or
 112 B<sh>, but it exceeds their capabilities or must run a little faster,
 113 and you don't want to write the silly thing in C, then Perl may be for
 114 you.  There are also translators to turn your B<sed> and B<awk>
 115 scripts into Perl scripts.
 116
 117 But wait, there's more...
 118
 119 Perl version 5 is nearly a complete rewrite, and provides
 120 the following additional benefits:
 121
 122 =over 5
 123
 124 =item * Many usability enhancements
 125
 126 It is now possible to write much more readable Perl code (even within
 127 regular expressions).  Formerly cryptic variable names can be replaced
 128 by mnemonic identifiers.  Error messages are more informative, and the
 129 optional warnings will catch many of the mistakes a novice might make.
 130 This cannot be stressed enough.  Whenever you get mysterious behavior,
 131 try the B<-w> switch!!!  Whenever you don't get mysterious behavior,
 132 try using B<-w> anyway.
 133
 134 =item * Simplified grammar
 135
 136 The new yacc grammar is one half the size of the old one.  Many of the
 137 arbitrary grammar rules have been regularized.  The number of reserved
 138 words has been cut by 2/3.  Despite this, nearly all old Perl scripts
 139 will continue to work unchanged.
 140
 141 =item * Lexical scoping
 142
 143 Perl variables may now be declared within a lexical scope, like "auto"
 144 variables in C.  Not only is this more efficient, but it contributes
 145 to better privacy for "programming in the large".  Anonymous
 146 subroutines exhibit deep binding of lexical variables (closures).
 147
 148 =item * Arbitrarily nested data structures
 149
 150 Any scalar value, including any array element, may now contain a
 151 reference to any other variable or subroutine.  You can easily create
 152 anonymous variables and subroutines.  Perl manages your reference
 153 counts for you.
 154
 155 =item * Modularity and reusability
 156
 157 The Perl library is now defined in terms of modules which can be easily
 158 shared among various packages.  A package may choose to import all or a
 159 portion of a module's published interface.  Pragmas (that is, compiler
 160 directives) are defined and used by the same mechanism.
 161
 162 =item * Object-oriented programming
 163
 164 A package can function as a class.  Dynamic multiple inheritance and
 165 virtual methods are supported in a straightforward manner and with very
 166 little new syntax.  Filehandles may now be treated as objects.
 167
 168 =item * Embeddable and Extensible
 169
 170 Perl may now be embedded easily in your C or C++ application, and can
 171 either call or be called by your routines through a documented
 172 interface.  The XS preprocessor is provided to make it easy to glue
 173 your C or C++ routines into Perl.  Dynamic loading of modules is
 174 supported, and Perl itself can be made into a dynamic library.
 175
 176 =item * POSIX compliant
 177
 178 A major new module is the POSIX module, which provides access to all
 179 available POSIX routines and definitions, via object classes where
 180 appropriate.
 181
 182 =item * Package constructors and destructors
 183
 184 The new BEGIN and END blocks provide means to capture control as
 185 a package is being compiled, and after the program exits.  As a
 186 degenerate case they work just like awk's BEGIN and END when you
 187 use the B<-p> or B<-n> switches.
 188
 189 =item * Multiple simultaneous DBM implementations
 190
 191 A Perl program may now access DBM, NDBM, SDBM, GDBM, and Berkeley DB
 192 files from the same script simultaneously.  In fact, the old dbmopen
 193 interface has been generalized to allow any variable to be tied
 194 to an object class which defines its access methods.
 195
 196 =item * Subroutine definitions may now be autoloaded
 197
 198 In fact, the AUTOLOAD mechanism also allows you to define any arbitrary
 199 semantics for undefined subroutine calls.  It's not for just autoloading.
 200
 201 =item * Regular expression enhancements
 202
 203 You can now specify non-greedy quantifiers.  You can now do grouping
 204 without creating a backreference.  You can now write regular expressions
 205 with embedded whitespace and comments for readability.  A consistent
 206 extensibility mechanism has been added that is upwardly compatible with
 207 all old regular expressions.
 208
 209 =item * Innumerable Unbundled Modules
 210
 211 The Comprehensive Perl Archive Network described in L<perlmod>
 212 contains hundreds of plug-and-play modules full of reusable
 213 code.  See F<http://www.perl.com/CPAN> for a site near you.
 214
 215 =item * Compilability
 216
 217 While not yet in full production mode, a working perl-to-C compiler
 218 does exist.  It can generate portable bytecode, simple C, or
 219 optimized C code.
 220
 221 =back
 222
 223 Ok, that's I<definitely> enough hype.
 224
 225 =head1 ENVIRONMENT
 226
 227 =over 12
 228
 229 =item HOME
 230
 231 Used if chdir has no argument.
 232
 233 =item LOGDIR
 234
 235 Used if chdir has no argument and HOME is not set.
 236
 237 =item PATH
 238
 239 Used in executing subprocesses, and in finding the script if B<-S> is
 240 used.
 241
 242 =item PERL5LIB
 243
 244 A colon-separated list of directories in which to look for Perl library
 245 files before looking in the standard library and the current
 246 directory.  If PERL5LIB is not defined, PERLLIB is used.  When running
 247 taint checks (because the script was running setuid or setgid, or the
 248 B<-T> switch was used), neither variable is used.  The script should
 249 instead say
 250
 251     use lib "/my/directory";
 252
 253 =item PERL5DB
 254
 255 The command used to get the debugger code.  If unset, uses
 256
 257         BEGIN { require 'perl5db.pl' }
 258
 259 =item PERL_DESTRUCT_LEVEL
 260
 261 Relevant only if your perl executable was built with B<-DDEBUGGING>,
 262 this controls the behavior of global destruction of objects and other
 263 references.
 264
 265 =item PERLLIB
 266
 267 A colon-separated list of directories in which to look for Perl library
 268 files before looking in the standard library and the current
 269 directory.  If PERL5LIB is defined, PERLLIB is not used.
 270
 271 =back
 272
 273 Perl also has environment variables that control how Perl handles data
 274 specific to particular natural languages.  See L<perllocale>.
 275
 276 Apart from these, Perl uses no other environment variables, except
 277 to make them available to the script being executed, and to child
 278 processes.  However, scripts running setuid would do well to execute
 279 the following lines before doing anything else, just to keep people
 280 honest:
 281
 282     $ENV{'PATH'} = '/bin:/usr/bin';    # or whatever you need
 283     $ENV{'SHELL'} = '/bin/sh' if defined $ENV{'SHELL'};
 284     $ENV{'IFS'} = ''          if defined $ENV{'IFS'};
 285
 286 =head1 AUTHOR
 287
 288 Larry Wall E<lt>F<larry@wall.org>E<gt>, with the help of oodles of other folks.
 289
 290 =head1 FILES
 291
 292  "/tmp/perl-e$$"        temporary file for -e commands
 293  "@INC"                 locations of perl libraries
 294
 295 =head1 SEE ALSO
 296
 297  a2p    awk to perl translator
 298
 299  s2p    sed to perl translator
 300
 301 =head1 DIAGNOSTICS
 302
 303 The B<-w> switch produces some lovely diagnostics.
 304
 305 See L<perldiag> for explanations of all Perl's diagnostics.
 306
 307 Compilation errors will tell you the line number of the error, with an
 308 indication of the next token or token type that was to be examined.
 309 (In the case of a script passed to Perl via B<-e> switches, each
 310 B<-e> is counted as one line.)
 311
 312 Setuid scripts have additional constraints that can produce error
 313 messages such as "Insecure dependency".  See L<perlsec>.
 314
 315 Did we mention that you should definitely consider using the B<-w>
 316 switch?
 317
 318 =head1 BUGS
 319
 320 The B<-w> switch is not mandatory.
 321
 322 Perl is at the mercy of your machine's definitions of various
 323 operations such as type casting, atof(), and sprintf().  The latter
 324 can even trigger a core dump when passed ludicrous input values.
 325
 326 If your stdio requires a seek or eof between reads and writes on a
 327 particular stream, so does Perl.  (This doesn't apply to sysread()
 328 and syswrite().)
 329
 330 While none of the built-in data types have any arbitrary size limits
 331 (apart from memory size), there are still a few arbitrary limits:  a
 332 given variable name may not be longer than 255 characters, and no
 333 component of your PATH may be longer than 255 if you use B<-S>.  A regular
 334 expression may not compile to more than 32767 bytes internally.
 335
 336 You may mail your bug reports (be sure to include full configuration
 337 information as output by the myconfig program in the perl source tree,
 338 or by C<perl -V>) to F<perlbug@perl.com>.
 339 If you've succeeded in compiling perl, the perlbug script in the utils/
 340 subdirectory can be used to help mail in a bug report.
 341
 342 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 343 don't tell anyone I said that.
 344
 345 =head1 NOTES
 346
 347 The Perl motto is "There's more than one way to do it."  Divining
 348 how many more is left as an exercise to the reader.
 349
 350 The three principal virtues of a programmer are Laziness,
 351 Impatience, and Hubris.  See the Camel Book for why.
 352