This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
cleanup AVAILABILITY and mention binaries
[perl5.git] / 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     perlunicode         Perl unicode support
39     perllocale          Perl locale support
40
41     perlreftut          Perl references short introduction
42     perlref             Perl references, the rest of the story
43     perldsc             Perl data structures intro
44     perllol             Perl data structures: arrays of arrays
45     perlboot            Perl OO tutorial for beginners
46     perltoot            Perl OO tutorial, part 1
47     perltootc           Perl OO tutorial, part 2
48     perlobj             Perl objects
49     perltie             Perl objects hidden behind simple variables
50     perlbot             Perl OO tricks and examples
51     perlipc             Perl interprocess communication
52     perlfork            Perl fork() information
53     perlthrtut          Perl threads tutorial
54     perllexwarn         Perl warnings and their control
55     perlfilter          Perl source filters
56     perldbmfilter       Perl DBM filters
57
58     perlcompile         Perl compiler suite intro
59     perldebug           Perl debugging
60     perldiag            Perl diagnostic messages
61     perlnumber          Perl number semantics
62     perlsec             Perl security
63     perltrap            Perl traps for the unwary
64     perlport            Perl portability guide
65     perlstyle           Perl style guide
66
67     perlpod             Perl plain old documentation
68     perlbook            Perl book information
69
70     perlembed           Perl ways to embed perl in your C or C++ application
71     perlapio            Perl internal IO abstraction interface
72     perlxs              Perl XS application programming interface
73     perlxstut           Perl XS tutorial
74     perlguts            Perl internal functions for those doing extensions
75     perlcall            Perl calling conventions from C
76     perlapi             Perl API listing (autogenerated)
77     perlintern          Perl internal functions (autogenerated)
78
79     perltodo            Perl things to do
80     perlhack            Perl hackers guide
81     perlhist            Perl history records
82
83     perlamiga           Perl notes for Amiga
84     perlcygwin          Perl notes for Cygwin
85     perldos             Perl notes for DOS
86     perlhpux            Perl notes for HP-UX
87     perlos2             Perl notes for OS/2
88     perlos390           Perl notes for OS/390
89     perlvms             Perl notes for VMS
90     perlwin32           Perl notes for Windows
91
92 (If you're intending to read these straight through for the first time,
93 the suggested order will tend to reduce the number of forward references.)
94
95 By default, the manpages listed above are installed in the 
96 F</usr/local/man/> directory.  
97
98 Extensive additional documentation for Perl modules is available.  The
99 default configuration for perl will place this additional documentation
100 in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
101 subdirectory of the Perl library directory).  Some of this additional
102 documentation is distributed standard with Perl, but you'll also find
103 documentation for third-party modules there.
104
105 You should be able to view Perl's documentation with your man(1)
106 program by including the proper directories in the appropriate start-up
107 files, or in the MANPATH environment variable.  To find out where the
108 configuration has installed the manpages, type:
109
110     perl -V:man.dir
111
112 If the directories have a common stem, such as F</usr/local/man/man1>
113 and F</usr/local/man/man3>, you need only to add that stem
114 (F</usr/local/man>) to your man(1) configuration files or your MANPATH
115 environment variable.  If they do not share a stem, you'll have to add
116 both stems.
117
118 If that doesn't work for some reason, you can still use the
119 supplied F<perldoc> script to view module information.  You might
120 also look into getting a replacement man program.
121
122 If something strange has gone wrong with your program and you're not
123 sure where you should look for help, try the B<-w> switch first.  It
124 will often point out exactly where the trouble is.
125
126 =head1 DESCRIPTION
127
128 Perl is a language optimized for scanning arbitrary
129 text files, extracting information from those text files, and printing
130 reports based on that information.  It's also a good language for many
131 system management tasks.  The language is intended to be practical
132 (easy to use, efficient, complete) rather than beautiful (tiny,
133 elegant, minimal).
134
135 Perl combines (in the author's opinion, anyway) some of the best
136 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
137 those languages should have little difficulty with it.  (Language
138 historians will also note some vestiges of B<csh>, Pascal, and even
139 BASIC-PLUS.)  Expression syntax corresponds closely to C
140 expression syntax.  Unlike most Unix utilities, Perl does not
141 arbitrarily limit the size of your data--if you've got the memory,
142 Perl can slurp in your whole file as a single string.  Recursion is of
143 unlimited depth.  And the tables used by hashes (sometimes called
144 "associative arrays") grow as necessary to prevent degraded
145 performance.  Perl can use sophisticated pattern matching techniques to
146 scan large amounts of data quickly.  Although optimized for
147 scanning text, Perl can also deal with binary data, and can make dbm
148 files look like hashes.  Setuid Perl scripts are safer than C programs
149 through a dataflow tracing mechanism that prevents many stupid
150 security holes.
151
152 If you have a problem that would ordinarily use B<sed> or B<awk> or
153 B<sh>, but it exceeds their capabilities or must run a little faster,
154 and you don't want to write the silly thing in C, then Perl may be for
155 you.  There are also translators to turn your B<sed> and B<awk>
156 scripts into Perl scripts.
157
158 But wait, there's more...
159
160 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
161 rewrite that provides the following additional benefits:
162
163 =over
164
165 =item * modularity and reusability using innumerable modules 
166
167 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
168
169 =item * embeddable and extensible 
170
171 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
172 L<perlguts>, and L<xsubpp>.
173
174 =item * roll-your-own magic variables (including multiple simultaneous DBM implementations)
175
176 Described in L<perltie> and L<AnyDBM_File>.
177
178 =item * subroutines can now be overridden, autoloaded, and prototyped
179
180 Described in L<perlsub>.
181
182 =item * arbitrarily nested data structures and anonymous functions
183
184 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
185
186 =item * object-oriented programming
187
188 Described in L<perlobj>, L<perltoot>, and L<perlbot>.
189
190 =item * compilability into C code or Perl bytecode
191
192 Described in L<B> and L<B::Bytecode>.
193
194 =item * support for light-weight processes (threads)
195
196 Described in L<perlthrtut> and L<Thread>.
197
198 =item * support for internationalization, localization, and Unicode 
199
200 Described in L<perllocale> and L<utf8>.
201
202 =item * lexical scoping
203
204 Described in L<perlsub>.
205
206 =item * regular expression enhancements
207
208 Described in L<perlre>, with additional examples in L<perlop>.
209
210 =item * enhanced debugger and interactive Perl environment, with integrated editor support
211
212 Described in L<perldebug>.
213
214 =item * POSIX 1003.1 compliant library
215
216 Described in L<POSIX>.
217
218 =back
219
220 Okay, that's I<definitely> enough hype.
221
222 =head1 AVAILABILITY
223
224 Perl is available for most operating systems, including virtually
225 all Unix-like platforms.
226
227 As of early March 2000 (the Perl release 5.6.0), the following
228 platforms are able to build Perl from the standard source code
229 distribution available at http://www.perl.com/CPAN/src/index.html
230
231         AIX
232         DOS DJGPP       1)
233         FreeBSD
234         HP-UX
235         IRIX
236         Linux
237         MachTen
238         MPE/iX
239         NetBSD
240         OpenBSD
241         OS/2
242         Rhapsody/Darwin 2)
243         Solaris
244         Tru64 UNIX      3)
245         UNICOS
246         UNICOS/mk
247         VMS
248         VOS
249         Windows 3.1     1)
250         Windows 95      1) 4)
251         Windows 98      1) 4)
252         Windows NT      1) 4)
253
254         1) in DOS mode either the DOS or OS/2 ports can be used
255         2) new in 5.6.0: the BSD/NeXT-based UNIX of Mac OS X
256         3) formerly known as Digital UNIX and before that DEC OSF/1
257         4) compilers: Borland, Cygwin, Mingw32 EGCS/GCC, VC++
258
259 The following platforms worked for the previous major release
260 (5.005_04 being the latest maintenance release of that, as of early
261 March 2000), but be did not manage to test these in time for the 5.6.0
262 release of Perl.  There is a very good chance that these will work
263 just fine with 5.6.0.
264
265         A/UX
266         BeOS
267         BSD/OS
268         DG/UX
269         DYNIX/ptx
270         DomainOS
271         Hurd
272         NextSTEP
273         OpenSTEP
274         PowerMAX
275         QNX
276         SCO ODT/OSR     
277         SunOS
278         SVR4
279         Ultrix
280
281 The following platform worked for the previous major release (5.005_04
282 being the latest maintenance release of that, as of early March 2000).
283 However, standardization on UTF-8 as the internal string representation
284 in 5.6.0 has introduced incompatibilities in this EBCDIC platform.
285 Support for this platform may be enabled in a future release:
286
287         OS390   1)
288
289         1) Previously known as MVS, or OpenEdition MVS.
290
291 Strongly related to the OS390 platform by also being EBCDIC-based
292 mainframe platforms are the following platforms:
293
294         BS2000
295         VM/ESA
296
297 These are also not expected to work under 5.6.0 for the same reasons
298 as OS390.  Contact the mailing list perl-mvs@perl.org for more details.
299
300 MacOS (Classic, pre-X) is almost 5.6.0-ready; building from the source
301 does work with 5.6.0, but additional MacOS specific source code is needed
302 for a complete port.  Contact the mailing list macperl-porters@macperl.org
303 for more more information.
304
305 The following platforms have been known to build Perl from source in
306 the past, but we haven't been able to verify their status for the
307 current release, either because the hardware/software platforms are
308 rare or because we don't have an active champion on these
309 platforms--or both:
310
311         3b1
312         AmigaOS
313         ConvexOS
314         CX/UX
315         DC/OSx
316         DDE SMES
317         DOS EMX
318         Dynix
319         EP/IX
320         ESIX
321         FPS
322         GENIX
323         Greenhills
324         ISC
325         MachTen 68k
326         MiNT
327         MPC
328         NEWS-OS
329         Opus
330         Plan 9
331         PowerUX
332         RISC/os
333         Stellar
334         SVR2
335         TI1500
336         TitanOS
337         Unisys Dynix
338         Unixware
339
340 Support for the following platform is planned for a future Perl release:
341
342         Netware
343
344 The following platforms have their own source code distributions and
345 binaries available via http://www.perl.com/CPAN/ports/index.html:
346
347                                 Perl release
348
349         AS/400                  5.003
350         Netware                 5.003_07
351         Tandem Guardian         5.004
352
353 The following platforms have only binaries available via
354 http://www.perl.com/CPAN/ports/index.html:
355
356                                 Perl release
357
358         Acorn RISCOS            5.005_02
359         AOS                     5.002
360         LynxOS                  5.004_02
361
362 Although we do suggest that you always build your own Perl from the
363 source code, both for maximal configurability and for security,
364 in case you are in a hurry you can check the URL
365 http://www.perl.com/CPAN/ports/index.html for binary releases.
366
367 =head1 ENVIRONMENT
368
369 See L<perlrun>.
370
371 =head1 AUTHOR
372
373 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
374
375 If your Perl success stories and testimonials may be of help to others 
376 who wish to advocate the use of Perl in their applications, 
377 or if you wish to simply express your gratitude to Larry and the 
378 Perl developers, please write to perl-thanks@perl.org .
379
380 =head1 FILES
381
382  "@INC"                 locations of perl libraries
383
384 =head1 SEE ALSO
385
386  a2p    awk to perl translator
387  s2p    sed to perl translator
388
389  http://www.perl.com/       the Perl Home Page
390  http://www.perl.com/CPAN   the Comprehensive Perl Archive
391
392 =head1 DIAGNOSTICS
393
394 The B<-w> switch produces some 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.com .  If you've succeeded
433 in compiling perl, the perlbug script in the 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