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