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
  16 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 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 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 that 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 integrated 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 most operating systems, including virtually
 206 all Unix-like platforms.
 207
 208 As of May 1999, the following platforms are able to build Perl
 209 from the standard source code distribution available at
 210 http://www.perl.com/CPAN/src/index.html
 211
 212         AIX             Linux           SCO ODT/OSR
 213         A/UX            MachTen         Solaris
 214         BeOS            MPE/iX          SunOS
 215         BSD/OS          NetBSD          SVR4
 216         DG/UX           NextSTEP        Tru64 UNIX      3)
 217         DomainOS        OpenBSD         Ultrix
 218         DOS DJGPP 1)    OpenSTEP        UNICOS
 219         DYNIX/ptx       OS/2            VMS
 220         FreeBSD         OS390     2)    VOS
 221         HP-UX           PowerMAX        Windows 3.1     1)
 222         Hurd            QNX             Windows 95      1) 4)
 223         IRIX                            Windows 98      1) 4)
 224                                         Windows NT      1) 4)
 225
 226         1) in DOS mode either the DOS or OS/2 ports can be used
 227         2) formerly known as MVS
 228         3) formerly known as Digital UNIX and before that DEC OSF/1
 229         4) compilers: Borland, Cygwin, Mingw32 EGCS/GCC, VC++
 230
 231 The following platforms have been known to build Perl from source,
 232 but we haven't been able to verify their status for the current release,
 233 either because the hardware/software platforms are rare or
 234 because we don't have an active champion on these platforms--or both.
 235
 236         3b1             FPS             Plan 9
 237         AmigaOS         GENIX           PowerUX
 238         ConvexOS        Greenhills      RISC/os
 239         CX/UX           ISC             Stellar
 240         DC/OSx          MachTen 68k     SVR2
 241         DDE SMES        MiNT            TI1500
 242         DOS EMX         MPC             TitanOS
 243         Dynix           NEWS-OS         UNICOS/mk
 244         EP/IX           Opus            Unisys Dynix
 245         ESIX                            Unixware
 246
 247 Support for the following platforms is planned for the next major
 248 Perl release.
 249
 250         BS2000
 251         Netware
 252         Rhapsody
 253         VM/ESA
 254
 255 The following platforms have their own source code distributions and
 256 binaries available via http://www.perl.com/CPAN/ports/index.html.
 257
 258                                 Perl release
 259
 260         AS/400                  5.003
 261         MacOS                   5.004
 262         Netware                 5.003_07
 263         Tandem Guardian         5.004
 264
 265 The following platforms have only binaries available via
 266 http://www.perl.com/CPAN/ports/index.html.
 267
 268                                 Perl release
 269
 270         Acorn RISCOS            5.005_02
 271         AOS                     5.002
 272         LynxOS                  5.004_02
 273
 274 =head1 ENVIRONMENT
 275
 276 See L<perlrun>.
 277
 278 =head1 AUTHOR
 279
 280 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 281
 282 If your Perl success stories and testimonials may be of help to others
 283 who wish to advocate the use of Perl in their applications,
 284 or if you wish to simply express your gratitude to Larry and the
 285 Perl developers, please write to perl-thanks@perl.org .
 286
 287 =head1 FILES
 288
 289  "@INC"                 locations of perl libraries
 290
 291 =head1 SEE ALSO
 292
 293  a2p    awk to perl translator
 294  s2p    sed to perl translator
 295
 296  http://www.perl.com/       the Perl Home Page
 297  http://www.perl.com/CPAN   the Comphrehensive Perl Archive
 298
 299 =head1 DIAGNOSTICS
 300
 301 The B<-w> switch produces some lovely diagnostics.
 302
 303 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 304 diagnostics> pragma automatically turns Perl's normally terse warnings
 305 and errors into these longer forms.
 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 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 floating-point
 324 output with sprintf().
 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 251 characters.  Line numbers
 333 displayed by diagnostics are internally stored as short integers,
 334 so they are limited to a maximum of 65535 (higher numbers usually being
 335 affected by wraparound).
 336
 337 You may mail your bug reports (be sure to include full configuration
 338 information as output by the myconfig program in the perl source
 339 tree, or by C<perl -V>) to perlbug@perl.com .  If you've succeeded
 340 in compiling perl, the perlbug script in the utils/ subdirectory
 341 can be used to help mail in a bug report.
 342
 343 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 344 don't tell anyone I said that.
 345
 346 =head1 NOTES
 347
 348 The Perl motto is "There's more than one way to do it."  Divining
 349 how many more is left as an exercise to the reader.
 350
 351 The three principal virtues of a programmer are Laziness,
 352 Impatience, and Hubris.  See the Camel Book for why.
 353