Avoid using the warnings pragma in proto.t - use may not work yet.
[perl.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<-sTtuUWX> ]>
8         S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
9         S<[ B<-cw> ] [ B<-d>[B<t>][:I<debugger>] ] [ B<-D>[I<number/list>] ]>
10         S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal/hexadecimal>] ]>
11         S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ] [ B<-f> ]>
12         S<[ B<-C [I<number/list>] >]>
13         S<[ B<-S> ]>
14         S<[ B<-x>[I<dir>] ]>
15         S<[ B<-i>[I<extension>] ]>
16         S<[ [B<-e>|B<-E>] I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
17
18 If you're new to Perl, you should start with L<perlintro>, which is a 
19 general intro for beginners and provides some background to help you
20 navigate the rest of Perl's extensive documentation.
21
22 For ease of access, the Perl manual has been split up into several sections.
23
24 =head2 Overview
25
26     perl                Perl overview (this section)
27     perlintro           Perl introduction for beginners
28     perltoc             Perl documentation table of contents
29
30 =head2 Tutorials
31
32     perlreftut          Perl references short introduction
33     perldsc             Perl data structures intro
34     perllol             Perl data structures: arrays of arrays
35
36     perlrequick         Perl regular expressions quick start
37     perlretut           Perl regular expressions tutorial
38
39     perlboot            Perl OO tutorial for beginners
40     perltoot            Perl OO tutorial, part 1
41     perltooc            Perl OO tutorial, part 2
42     perlbot             Perl OO tricks and examples
43
44     perlperf            Perl Performance and Optimization Techniques
45
46     perlstyle           Perl style guide
47
48     perlcheat           Perl cheat sheet
49     perltrap            Perl traps for the unwary
50     perldebtut          Perl debugging tutorial
51
52     perlfaq             Perl frequently asked questions
53       perlfaq1          General Questions About Perl
54       perlfaq2          Obtaining and Learning about Perl
55       perlfaq3          Programming Tools
56       perlfaq4          Data Manipulation
57       perlfaq5          Files and Formats
58       perlfaq6          Regexes
59       perlfaq7          Perl Language Issues
60       perlfaq8          System Interaction
61       perlfaq9          Networking
62
63 =head2 Reference Manual
64
65     perlsyn             Perl syntax
66     perldata            Perl data structures
67     perlop              Perl operators and precedence
68     perlsub             Perl subroutines
69     perlfunc            Perl built-in functions
70       perlopentut       Perl open() tutorial
71       perlpacktut       Perl pack() and unpack() tutorial
72     perlpod             Perl plain old documentation
73     perlpodspec         Perl plain old documentation format specification
74     perlrun             Perl execution and options
75     perldiag            Perl diagnostic messages
76     perllexwarn         Perl warnings and their control
77     perldebug           Perl debugging
78     perlvar             Perl predefined variables
79     perlre              Perl regular expressions, the rest of the story
80     perlrebackslash     Perl regular expression backslash sequences
81     perlrecharclass     Perl regular expression character classes
82     perlreref           Perl regular expressions quick reference
83     perlref             Perl references, the rest of the story
84     perlform            Perl formats
85     perlobj             Perl objects
86     perltie             Perl objects hidden behind simple variables
87       perldbmfilter     Perl DBM filters
88
89     perlipc             Perl interprocess communication
90     perlfork            Perl fork() information
91     perlnumber          Perl number semantics
92
93     perlthrtut          Perl threads tutorial
94
95     perlport            Perl portability guide
96     perllocale          Perl locale support
97     perluniintro        Perl Unicode introduction
98     perlunicode         Perl Unicode support
99     perlunifaq          Perl Unicode FAQ
100     perlunitut          Perl Unicode tutorial
101     perlebcdic          Considerations for running Perl on EBCDIC platforms
102
103     perlsec             Perl security
104
105     perlmod             Perl modules: how they work
106     perlmodlib          Perl modules: how to write and use
107     perlmodstyle        Perl modules: how to write modules with style
108     perlmodinstall      Perl modules: how to install from CPAN
109     perlnewmod          Perl modules: preparing a new module for distribution
110     perlpragma          Perl modules: writing a user pragma
111
112     perlutil            utilities packaged with the Perl distribution
113
114     perlcompile         Perl compiler suite intro
115
116     perlfilter          Perl source filters
117
118     perlglossary        Perl Glossary
119
120 =head2 Internals and C Language Interface
121
122     perlembed           Perl ways to embed perl in your C or C++ application
123     perldebguts         Perl debugging guts and tips
124     perlxstut           Perl XS tutorial
125     perlxs              Perl XS application programming interface
126     perlclib            Internal replacements for standard C library functions
127     perlguts            Perl internal functions for those doing extensions
128     perlcall            Perl calling conventions from C
129     perlmroapi          Perl method resolution plugin interface
130     perlreapi           Perl regular expression plugin interface
131     perlreguts          Perl regular expression engine internals
132
133     perlapi             Perl API listing (autogenerated)
134     perlintern          Perl internal functions (autogenerated)
135     perliol             C API for Perl's implementation of IO in Layers
136     perlapio            Perl internal IO abstraction interface
137
138     perlhack            Perl hackers guide
139     perlrepository      Perl source repository
140
141 =head2 Miscellaneous
142
143     perlbook            Perl book information
144     perlcommunity       Perl community information
145     perltodo            Perl things to do
146
147     perldoc             Look up Perl documentation in Pod format
148
149     perlhist            Perl history records
150     perldelta           Perl changes since previous version
151     perl5110delta       Perl changes in version 5.11.0
152     perl5101delta       Perl changes in version 5.10.1
153     perl5100delta       Perl changes in version 5.10.0
154     perl595delta        Perl changes in version 5.9.5
155     perl594delta        Perl changes in version 5.9.4
156     perl593delta        Perl changes in version 5.9.3
157     perl592delta        Perl changes in version 5.9.2
158     perl591delta        Perl changes in version 5.9.1
159     perl590delta        Perl changes in version 5.9.0
160     perl589delta        Perl changes in version 5.8.9
161     perl588delta        Perl changes in version 5.8.8
162     perl587delta        Perl changes in version 5.8.7
163     perl586delta        Perl changes in version 5.8.6
164     perl585delta        Perl changes in version 5.8.5
165     perl584delta        Perl changes in version 5.8.4
166     perl583delta        Perl changes in version 5.8.3
167     perl582delta        Perl changes in version 5.8.2
168     perl581delta        Perl changes in version 5.8.1
169     perl58delta         Perl changes in version 5.8.0
170     perl573delta        Perl changes in version 5.7.3
171     perl572delta        Perl changes in version 5.7.2
172     perl571delta        Perl changes in version 5.7.1
173     perl570delta        Perl changes in version 5.7.0
174     perl561delta        Perl changes in version 5.6.1
175     perl56delta         Perl changes in version 5.6
176     perl5005delta       Perl changes in version 5.005
177     perl5004delta       Perl changes in version 5.004
178
179     perlartistic        Perl Artistic License
180     perlgpl             GNU General Public License
181
182 =head2 Language-Specific
183
184     perlcn              Perl for Simplified Chinese (in EUC-CN)
185     perljp              Perl for Japanese (in EUC-JP)
186     perlko              Perl for Korean (in EUC-KR)
187     perltw              Perl for Traditional Chinese (in Big5)
188
189 =head2 Platform-Specific
190
191     perlaix             Perl notes for AIX
192     perlamiga           Perl notes for AmigaOS
193     perlapollo          Perl notes for Apollo DomainOS
194     perlbeos            Perl notes for BeOS
195     perlbs2000          Perl notes for POSIX-BC BS2000
196     perlce              Perl notes for WinCE
197     perlcygwin          Perl notes for Cygwin
198     perldgux            Perl notes for DG/UX
199     perldos             Perl notes for DOS
200     perlepoc            Perl notes for EPOC
201     perlfreebsd         Perl notes for FreeBSD
202     perlhaiku           Perl notes for Haiku
203     perlhpux            Perl notes for HP-UX
204     perlhurd            Perl notes for Hurd
205     perlirix            Perl notes for Irix
206     perllinux           Perl notes for Linux
207     perlmacos           Perl notes for Mac OS (Classic)
208     perlmacosx          Perl notes for Mac OS X
209     perlmpeix           Perl notes for MPE/iX
210     perlnetware         Perl notes for NetWare
211     perlopenbsd         Perl notes for OpenBSD
212     perlos2             Perl notes for OS/2
213     perlos390           Perl notes for OS/390
214     perlos400           Perl notes for OS/400
215     perlplan9           Perl notes for Plan 9
216     perlqnx             Perl notes for QNX
217     perlriscos          Perl notes for RISC OS
218     perlsolaris         Perl notes for Solaris
219     perlsymbian         Perl notes for Symbian
220     perltru64           Perl notes for Tru64
221     perluts             Perl notes for UTS
222     perlvmesa           Perl notes for VM/ESA
223     perlvms             Perl notes for VMS
224     perlvos             Perl notes for Stratus VOS
225     perlwin32           Perl notes for Windows
226
227
228 By default, the manpages listed above are installed in the 
229 F</usr/local/man/> directory.  
230
231 Extensive additional documentation for Perl modules is available.  The
232 default configuration for perl will place this additional documentation
233 in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
234 subdirectory of the Perl library directory).  Some of this additional
235 documentation is distributed standard with Perl, but you'll also find
236 documentation for third-party modules there.
237
238 You should be able to view Perl's documentation with your man(1)
239 program by including the proper directories in the appropriate start-up
240 files, or in the MANPATH environment variable.  To find out where the
241 configuration has installed the manpages, type:
242
243     perl -V:man.dir
244
245 If the directories have a common stem, such as F</usr/local/man/man1>
246 and F</usr/local/man/man3>, you need only to add that stem
247 (F</usr/local/man>) to your man(1) configuration files or your MANPATH
248 environment variable.  If they do not share a stem, you'll have to add
249 both stems.
250
251 If that doesn't work for some reason, you can still use the
252 supplied F<perldoc> script to view module information.  You might
253 also look into getting a replacement man program.
254
255 If something strange has gone wrong with your program and you're not
256 sure where you should look for help, try the B<-w> switch first.  It
257 will often point out exactly where the trouble is.
258
259 =head1 DESCRIPTION
260
261 Perl is a language optimized for scanning arbitrary
262 text files, extracting information from those text files, and printing
263 reports based on that information.  It's also a good language for many
264 system management tasks.  The language is intended to be practical
265 (easy to use, efficient, complete) rather than beautiful (tiny,
266 elegant, minimal).
267
268 Perl combines (in the author's opinion, anyway) some of the best
269 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
270 those languages should have little difficulty with it.  (Language
271 historians will also note some vestiges of B<csh>, Pascal, and even
272 BASIC-PLUS.)  Expression syntax corresponds closely to C
273 expression syntax.  Unlike most Unix utilities, Perl does not
274 arbitrarily limit the size of your data--if you've got the memory,
275 Perl can slurp in your whole file as a single string.  Recursion is of
276 unlimited depth.  And the tables used by hashes (sometimes called
277 "associative arrays") grow as necessary to prevent degraded
278 performance.  Perl can use sophisticated pattern matching techniques to
279 scan large amounts of data quickly.  Although optimized for
280 scanning text, Perl can also deal with binary data, and can make dbm
281 files look like hashes.  Setuid Perl scripts are safer than C programs
282 through a dataflow tracing mechanism that prevents many stupid
283 security holes.
284
285 If you have a problem that would ordinarily use B<sed> or B<awk> or
286 B<sh>, but it exceeds their capabilities or must run a little faster,
287 and you don't want to write the silly thing in C, then Perl may be for
288 you.  There are also translators to turn your B<sed> and B<awk>
289 scripts into Perl scripts.
290
291 But wait, there's more...
292
293 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
294 rewrite that provides the following additional benefits:
295
296 =over 4
297
298 =item *
299
300 modularity and reusability using innumerable modules 
301
302 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
303
304 =item *
305
306 embeddable and extensible 
307
308 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
309 L<perlguts>, and L<xsubpp>.
310
311 =item *
312
313 roll-your-own magic variables (including multiple simultaneous DBM
314 implementations)
315
316 Described in L<perltie> and L<AnyDBM_File>.
317
318 =item *
319
320 subroutines can now be overridden, autoloaded, and prototyped
321
322 Described in L<perlsub>.
323
324 =item *
325
326 arbitrarily nested data structures and anonymous functions
327
328 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
329
330 =item *
331
332 object-oriented programming
333
334 Described in L<perlobj>, L<perlboot>, L<perltoot>, L<perltooc>,
335 and L<perlbot>.
336
337 =item *
338
339 support for light-weight processes (threads)
340
341 Described in L<perlthrtut> and L<threads>.
342
343 =item *
344
345 support for Unicode, internationalization, and localization
346
347 Described in L<perluniintro>, L<perllocale> and L<Locale::Maketext>.
348
349 =item *
350
351 lexical scoping
352
353 Described in L<perlsub>.
354
355 =item *
356
357 regular expression enhancements
358
359 Described in L<perlre>, with additional examples in L<perlop>.
360
361 =item *
362
363 enhanced debugger and interactive Perl environment,
364 with integrated editor support
365
366 Described in L<perldebtut>, L<perldebug> and L<perldebguts>.
367
368 =item *
369
370 POSIX 1003.1 compliant library
371
372 Described in L<POSIX>.
373
374 =back
375
376 Okay, that's I<definitely> enough hype.
377
378 =head1 AVAILABILITY
379
380 Perl is available for most operating systems, including virtually
381 all Unix-like platforms.  See L<perlport/"Supported Platforms">
382 for a listing.
383
384 =head1 ENVIRONMENT
385
386 See L<perlrun>.
387
388 =head1 AUTHOR
389
390 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
391
392 If your Perl success stories and testimonials may be of help to others 
393 who wish to advocate the use of Perl in their applications, 
394 or if you wish to simply express your gratitude to Larry and the 
395 Perl developers, please write to perl-thanks@perl.org .
396
397 =head1 FILES
398
399  "@INC"                 locations of perl libraries
400
401 =head1 SEE ALSO
402
403  a2p    awk to perl translator
404  s2p    sed to perl translator
405
406  http://www.perl.org/       the Perl homepage
407  http://www.perl.com/       Perl articles (O'Reilly)
408  http://www.cpan.org/       the Comprehensive Perl Archive
409  http://www.pm.org/         the Perl Mongers
410
411 =head1 DIAGNOSTICS
412
413 The C<use warnings> pragma (and the B<-w> switch) produces some 
414 lovely diagnostics.
415
416 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
417 diagnostics> pragma automatically turns Perl's normally terse warnings
418 and errors into these longer forms.
419
420 Compilation errors will tell you the line number of the error, with an
421 indication of the next token or token type that was to be examined.
422 (In a script passed to Perl via B<-e> switches, each
423 B<-e> is counted as one line.)
424
425 Setuid scripts have additional constraints that can produce error
426 messages such as "Insecure dependency".  See L<perlsec>.
427
428 Did we mention that you should definitely consider using the B<-w>
429 switch?
430
431 =head1 BUGS
432
433 The B<-w> switch is not mandatory.
434
435 Perl is at the mercy of your machine's definitions of various
436 operations such as type casting, atof(), and floating-point
437 output with sprintf().
438
439 If your stdio requires a seek or eof between reads and writes on a
440 particular stream, so does Perl.  (This doesn't apply to sysread()
441 and syswrite().)
442
443 While none of the built-in data types have any arbitrary size limits
444 (apart from memory size), there are still a few arbitrary limits:  a
445 given variable name may not be longer than 251 characters.  Line numbers
446 displayed by diagnostics are internally stored as short integers,
447 so they are limited to a maximum of 65535 (higher numbers usually being
448 affected by wraparound).
449
450 You may mail your bug reports (be sure to include full configuration
451 information as output by the myconfig program in the perl source
452 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
453 in compiling perl, the B<perlbug> script in the F<utils/> subdirectory
454 can be used to help mail in a bug report.
455
456 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
457 don't tell anyone I said that.
458
459 =head1 NOTES
460
461 The Perl motto is "There's more than one way to do it."  Divining
462 how many more is left as an exercise to the reader.
463
464 The three principal virtues of a programmer are Laziness,
465 Impatience, and Hubris.  See the Camel Book for why.
466