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 a number
  16 of sections:
  17
  18     perl                Perl overview (this section)
  19     perldelta           Perl changes since previous version
  20     perl5005delta       Perl changes in version 5.005
  21     perl5004delta       Perl changes in version 5.004
  22     perlfaq             Perl frequently asked questions
  23     perltoc             Perl documentation table of contents
  24
  25     perldata            Perl data structures
  26     perlsyn             Perl syntax
  27     perlop              Perl operators and precedence
  28     perlre              Perl regular expressions
  29     perlrun             Perl execution and options
  30     perlfunc            Perl builtin functions
  31     perlopentut         Perl open() tutorial
  32     perlvar             Perl predefined variables
  33     perlsub             Perl subroutines
  34     perlmod             Perl modules: how they work
  35     perlmodlib          Perl modules: how to write and use
  36     perlmodinstall      Perl modules: how to install from CPAN
  37     perlform            Perl formats
  38     perllocale          Perl locale support
  39
  40     perlreftut          Perl references short introduction
  41     perlref             Perl references, the rest of the story
  42     perldsc             Perl data structures intro
  43     perllol             Perl data structures: arrays of arrays
  44     perltoot            Perl OO tutorial, part 1
  45     perltootc           Perl OO tutorial, part 2
  46     perlobj             Perl objects
  47     perltie             Perl objects hidden behind simple variables
  48     perlbot             Perl OO tricks and examples
  49     perlipc             Perl interprocess communication
  50     perlthrtut          Perl threads tutorial
  51     perldbmfilter       Perl DBM Filters
  52
  53     perldebug           Perl debugging
  54     perldiag            Perl diagnostic messages
  55     perlsec             Perl security
  56     perltrap            Perl traps for the unwary
  57     perlport            Perl portability guide
  58     perlstyle           Perl style guide
  59
  60     perlpod             Perl plain old documentation
  61     perlbook            Perl book information
  62
  63     perlembed           Perl ways to embed perl in your C or C++ application
  64     perlapio            Perl internal IO abstraction interface
  65     perlxs              Perl XS application programming interface
  66     perlxstut           Perl XS tutorial
  67     perlguts            Perl internal functions for those doing extensions
  68     perlcall            Perl calling conventions from C
  69
  70     perltodo            Perl things to do
  71     perlhist            Perl history records
  72
  73 (If you're intending to read these straight through for the first time,
  74 the suggested order will tend to reduce the number of forward references.)
  75
  76 By default, the manpages listed above are installed in the
  77 F</usr/local/man/> directory.
  78
  79 Extensive additional documentation for Perl modules is available.  The
  80 default configuration for perl will place this additional documentation
  81 in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
  82 subdirectory of the Perl library directory).  Some of this additional
  83 documentation is distributed standard with Perl, but you'll also find
  84 documentation for third-party modules there.
  85
  86 You should be able to view Perl's documentation with your man(1)
  87 program by including the proper directories in the appropriate start-up
  88 files, or in the MANPATH environment variable.  To find out where the
  89 configuration has installed the manpages, type:
  90
  91     perl -V:man.dir
  92
  93 If the directories have a common stem, such as F</usr/local/man/man1>
  94 and F</usr/local/man/man3>, you need only to add that stem
  95 (F</usr/local/man>) to your man(1) configuration files or your MANPATH
  96 environment variable.  If they do not share a stem, you'll have to add
  97 both stems.
  98
  99 If that doesn't work for some reason, you can still use the
 100 supplied F<perldoc> script to view module information.  You might
 101 also look into getting a replacement man program.
 102
 103 If something strange has gone wrong with your program and you're not
 104 sure where you should look for help, try the B<-w> switch first.  It
 105 will often point out exactly where the trouble is.
 106
 107 =head1 DESCRIPTION
 108
 109 Perl is a language optimized for scanning arbitrary
 110 text files, extracting information from those text files, and printing
 111 reports based on that information.  It's also a good language for many
 112 system management tasks.  The language is intended to be practical
 113 (easy to use, efficient, complete) rather than beautiful (tiny,
 114 elegant, minimal).
 115
 116 Perl combines (in the author's opinion, anyway) some of the best
 117 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
 118 those languages should have little difficulty with it.  (Language
 119 historians will also note some vestiges of B<csh>, Pascal, and even
 120 BASIC-PLUS.)  Expression syntax corresponds quite closely to C
 121 expression syntax.  Unlike most Unix utilities, Perl does not
 122 arbitrarily limit the size of your data--if you've got the memory,
 123 Perl can slurp in your whole file as a single string.  Recursion is of
 124 unlimited depth.  And the tables used by hashes (sometimes called
 125 "associative arrays") grow as necessary to prevent degraded
 126 performance.  Perl can use sophisticated pattern matching techniques to
 127 scan large amounts of data very quickly.  Although optimized for
 128 scanning text, Perl can also deal with binary data, and can make dbm
 129 files look like hashes.  Setuid Perl scripts are safer than C programs
 130 through a dataflow tracing mechanism which prevents many stupid
 131 security holes.
 132
 133 If you have a problem that would ordinarily use B<sed> or B<awk> or
 134 B<sh>, but it exceeds their capabilities or must run a little faster,
 135 and you don't want to write the silly thing in C, then Perl may be for
 136 you.  There are also translators to turn your B<sed> and B<awk>
 137 scripts into Perl scripts.
 138
 139 But wait, there's more...
 140
 141 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
 142 rewrite that provides the following additional benefits:
 143
 144 =over
 145
 146 =item * modularity and reusability using innumerable modules
 147
 148 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
 149
 150 =item * embeddable and extensible
 151
 152 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
 153 L<perlguts>, and L<xsubpp>.
 154
 155 =item * roll-your-own magic variables (including multiple simultaneous DBM implementations)
 156
 157 Described in L<perltie> and L<AnyDBM_File>.
 158
 159 =item * subroutines can now be overridden, autoloaded, and prototyped
 160
 161 Described in L<perlsub>.
 162
 163 =item * arbitrarily nested data structures and anonymous functions
 164
 165 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
 166
 167 =item * object-oriented programming
 168
 169 Described in L<perlobj>, L<perltoot>, and L<perlbot>.
 170
 171 =item * compilability into C code or Perl bytecode
 172
 173 Described in L<B> and L<B::Bytecode>.
 174
 175 =item * support for light-weight processes (threads)
 176
 177 Described in L<perlthrtut> and L<Thread>.
 178
 179 =item * support for internationalization, localization, and Unicode
 180
 181 Described in L<perllocale> and L<utf8>.
 182
 183 =item * lexical scoping
 184
 185 Described in L<perlsub>.
 186
 187 =item * regular expression enhancements
 188
 189 Described in L<perlre>, with additional examples in L<perlop>.
 190
 191 =item * enhanced debugger and interactive Perl environment, with intregrated editor support
 192
 193 Described in L<perldebug>.
 194
 195 =item * POSIX 1003.1 compliant library
 196
 197 Described in L<POSIX>.
 198
 199 =back
 200
 201 Okay, that's I<definitely> enough hype.
 202
 203 =head1 AVAILABILITY
 204
 205 Perl is available for the vast majority of operating system platforms,
 206 including most Unix-like platforms. The following situation is as of
 207 February 1999 and Perl 5.005_03.
 208
 209 The following platforms are able to build Perl from the standard
 210 source code distribution available at
 211 http://www.perl.com/CPAN/src/index.html
 212
 213         AIX             Linux           SCO ODT/OSR
 214         A/UX            MachTen         Solaris
 215         BeOS            MPE/iX          SunOS
 216         BSD/OS          NetBSD          SVR4
 217         DG/UX           NextSTEP        Tru64 UNIX      3)
 218         DomainOS        OpenBSD         Ultrix
 219         DOS DJGPP 1)    OpenSTEP        UNICOS
 220         DYNIX/ptx       OS/2            VMS
 221         FreeBSD         OS390     2)    VOS
 222         HP-UX           PowerMAX        Windows 3.1     1)
 223         Hurd            QNX             Windows 95      1) 4)
 224         IRIX                            Windows 98      1) 4)
 225                                         Windows NT      1) 4)
 226
 227         1) in DOS mode either the DOS or OS/2 ports can be used
 228         2) formerly known as MVS
 229         3) formerly known as Digital UNIX and before that DEC OSF/1
 230         4) compilers: Borland, Cygwin32, Mingw32 EGCS/GCC, VC++
 231
 232 The following platforms have been known to build Perl from the source
 233 but for the Perl release 5.005_03 we haven't been able to verify them,
 234 either because the hardware/software platforms are rather rare or
 235 because we don't have an active champion on these platforms--or both.
 236
 237         3b1             FPS             Plan 9
 238         AmigaOS         GENIX           PowerUX
 239         ConvexOS        Greenhills      RISC/os
 240         CX/UX           ISC             Stellar
 241         DC/OSx          MachTen 68k     SVR2
 242         DDE SMES        MiNT            TI1500
 243         DOS EMX         MPC             TitanOS
 244         Dynix           NEWS-OS         UNICOS/mk
 245         EP/IX           Opus            Unisys Dynix
 246         ESIX                            Unixware
 247
 248 The following platforms are planned to be supported in the standard
 249 source code distribution of the Perl release 5.006 but are not
 250 supported in the Perl release 5.005_03:
 251
 252         BS2000
 253         Netware
 254         Rhapsody
 255         VM/ESA
 256
 257 The following platforms have their own source code distributions and
 258 binaries available via http://www.perl.com/CPAN/ports/index.html.
 259
 260                                 Perl release
 261
 262         AS/400                  5.003
 263         MacOS                   5.004
 264         Netware                 5.003_07
 265         Tandem Guardian         5.004
 266
 267 The following platforms have only binaries available via
 268 http://www.perl.com/CPAN/ports/index.html.
 269
 270                                 Perl release
 271
 272         Acorn RISCOS            5.005_02
 273         AOS                     5.002
 274         LynxOS                  5.004_02
 275
 276 =head1 ENVIRONMENT
 277
 278 See L<perlrun>.
 279
 280 =head1 AUTHOR
 281
 282 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 283
 284 If your Perl success stories and testimonials may be of help to others
 285 who wish to advocate the use of Perl in their applications,
 286 or if you wish to simply express your gratitude to Larry and the
 287 Perl developers, please write to perl-thanks@perl.org .
 288
 289 =head1 FILES
 290
 291  "@INC"                 locations of perl libraries
 292
 293 =head1 SEE ALSO
 294
 295  a2p    awk to perl translator
 296  s2p    sed to perl translator
 297
 298  http://www.perl.com/       the Perl Home Page
 299  http://www.perl.com/CPAN   the Comphrehensive Perl Archive
 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.  The C<use
 306 diagnostics> pragma automatically turns Perl's normally terse warnings
 307 and errors into these longer forms.
 308
 309 Compilation errors will tell you the line number of the error, with an
 310 indication of the next token or token type that was to be examined.
 311 (In the case of a script passed to Perl via B<-e> switches, each
 312 B<-e> is counted as one line.)
 313
 314 Setuid scripts have additional constraints that can produce error
 315 messages such as "Insecure dependency".  See L<perlsec>.
 316
 317 Did we mention that you should definitely consider using the B<-w>
 318 switch?
 319
 320 =head1 BUGS
 321
 322 The B<-w> switch is not mandatory.
 323
 324 Perl is at the mercy of your machine's definitions of various
 325 operations such as type casting, atof(), and floating-point
 326 output with sprintf().
 327
 328 If your stdio requires a seek or eof between reads and writes on a
 329 particular stream, so does Perl.  (This doesn't apply to sysread()
 330 and syswrite().)
 331
 332 While none of the built-in data types have any arbitrary size limits
 333 (apart from memory size), there are still a few arbitrary limits:  a
 334 given variable name may not be longer than 251 characters.  Line numbers
 335 displayed by diagnostics are internally stored as short integers,
 336 so they are limited to a maximum of 65535 (higher numbers usually being
 337 affected by wraparound).
 338
 339 You may mail your bug reports (be sure to include full configuration
 340 information as output by the myconfig program in the perl source
 341 tree, or by C<perl -V>) to perlbug@perl.com .  If you've succeeded
 342 in compiling perl, the perlbug script in the utils/ subdirectory
 343 can be used to help mail in a bug report.
 344
 345 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 346 don't tell anyone I said that.
 347
 348 =head1 NOTES
 349
 350 The Perl motto is "There's more than one way to do it."  Divining
 351 how many more is left as an exercise to the reader.
 352
 353 The three principal virtues of a programmer are Laziness,
 354 Impatience, and Hubris.  See the Camel Book for why.
 355