This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
update TOC and perldelta references
[perl5.git] / pod / perl.pod
1 =head1 NAME
2
3 perl - The Perl language interpreter
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 =head1 GETTING HELP
19
20 The F<perldoc> program gives you access to all the documentation that comes
21 with Perl.  You can get more documentation, tutorials and community support
22 online at L<http://www.perl.org/>.
23
24 If you're new to Perl, you should start by running C<perldoc perlintro>,
25 which is a general intro for beginners and provides some background to help
26 you navigate the rest of Perl's extensive documentation.  Run C<perldoc
27 perldoc> to learn more things you can do with F<perldoc>.
28
29 For ease of access, the Perl manual has been split up into several sections.
30
31 =head2 Overview
32
33     perl                Perl overview (this section)
34     perlintro           Perl introduction for beginners
35     perltoc             Perl documentation table of contents
36
37 =head2 Tutorials
38
39     perlreftut          Perl references short introduction
40     perldsc             Perl data structures intro
41     perllol             Perl data structures: arrays of arrays
42
43     perlrequick         Perl regular expressions quick start
44     perlretut           Perl regular expressions tutorial
45
46     perlboot            Perl OO tutorial for beginners
47     perltoot            Perl OO tutorial, part 1
48     perltooc            Perl OO tutorial, part 2
49     perlbot             Perl OO tricks and examples
50
51     perlperf            Perl Performance and Optimization Techniques
52
53     perlstyle           Perl style guide
54
55     perlcheat           Perl cheat sheet
56     perltrap            Perl traps for the unwary
57     perldebtut          Perl debugging tutorial
58
59     perlfaq             Perl frequently asked questions
60       perlfaq1          General Questions About Perl
61       perlfaq2          Obtaining and Learning about Perl
62       perlfaq3          Programming Tools
63       perlfaq4          Data Manipulation
64       perlfaq5          Files and Formats
65       perlfaq6          Regexes
66       perlfaq7          Perl Language Issues
67       perlfaq8          System Interaction
68       perlfaq9          Networking
69
70 =head2 Reference Manual
71
72     perlsyn             Perl syntax
73     perldata            Perl data structures
74     perlop              Perl operators and precedence
75     perlsub             Perl subroutines
76     perlfunc            Perl built-in functions
77       perlopentut       Perl open() tutorial
78       perlpacktut       Perl pack() and unpack() tutorial
79     perlpod             Perl plain old documentation
80     perlpodspec         Perl plain old documentation format specification
81     perlrun             Perl execution and options
82     perldiag            Perl diagnostic messages
83     perllexwarn         Perl warnings and their control
84     perldebug           Perl debugging
85     perlvar             Perl predefined variables
86     perlre              Perl regular expressions, the rest of the story
87     perlrebackslash     Perl regular expression backslash sequences
88     perlrecharclass     Perl regular expression character classes
89     perlreref           Perl regular expressions quick reference
90     perlref             Perl references, the rest of the story
91     perlform            Perl formats
92     perlobj             Perl objects
93     perltie             Perl objects hidden behind simple variables
94       perldbmfilter     Perl DBM filters
95
96     perlipc             Perl interprocess communication
97     perlfork            Perl fork() information
98     perlnumber          Perl number semantics
99
100     perlthrtut          Perl threads tutorial
101
102     perlport            Perl portability guide
103     perllocale          Perl locale support
104     perluniintro        Perl Unicode introduction
105     perlunicode         Perl Unicode support
106     perlunifaq          Perl Unicode FAQ
107     perluniprops        Index of Unicode Version 5.2.0 properties in Perl
108     perlunitut          Perl Unicode tutorial
109     perlebcdic          Considerations for running Perl on EBCDIC platforms
110
111     perlsec             Perl security
112
113     perlmod             Perl modules: how they work
114     perlmodlib          Perl modules: how to write and use
115     perlmodstyle        Perl modules: how to write modules with style
116     perlmodinstall      Perl modules: how to install from CPAN
117     perlnewmod          Perl modules: preparing a new module for distribution
118     perlpragma          Perl modules: writing a user pragma
119
120     perlutil            utilities packaged with the Perl distribution
121
122     perlcompile         Perl compiler suite intro
123
124     perlfilter          Perl source filters
125
126     perlglossary        Perl Glossary
127
128 =head2 Internals and C Language Interface
129
130     perlembed           Perl ways to embed perl in your C or C++ application
131     perldebguts         Perl debugging guts and tips
132     perlxstut           Perl XS tutorial
133     perlxs              Perl XS application programming interface
134     perlclib            Internal replacements for standard C library functions
135     perlguts            Perl internal functions for those doing extensions
136     perlcall            Perl calling conventions from C
137     perlmroapi          Perl method resolution plugin interface
138     perlreapi           Perl regular expression plugin interface
139     perlreguts          Perl regular expression engine internals
140
141     perlapi             Perl API listing (autogenerated)
142     perlintern          Perl internal functions (autogenerated)
143     perliol             C API for Perl's implementation of IO in Layers
144     perlapio            Perl internal IO abstraction interface
145
146     perlhack            Perl hackers guide
147     perlpolicy          Perl development policies
148     perlrepository      Perl source repository
149
150 =head2 Miscellaneous
151
152     perlbook            Perl book information
153     perlcommunity       Perl community information
154     perltodo            Perl things to do
155
156     perldoc             Look up Perl documentation in Pod format
157
158     perlhist            Perl history records
159     perldelta           Perl changes since previous version
160     perl5134delta       Perl changes in version 5.13.4
161     perl5133delta       Perl changes in version 5.13.3
162     perl5132delta       Perl changes in version 5.13.2
163     perl5131delta       Perl changes in version 5.13.1
164     perl5130delta       Perl changes in version 5.13.0
165     perl5121delta       Perl changes in version 5.12.1
166     perl5120delta       Perl changes in version 5.12.0
167     perl5115delta       Perl changes in version 5.11.5
168     perl5114delta       Perl changes in version 5.11.4
169     perl5113delta       Perl changes in version 5.11.3
170     perl5112delta       Perl changes in version 5.11.2
171     perl5111delta       Perl changes in version 5.11.1
172     perl5110delta       Perl changes in version 5.11.0
173     perl5101delta       Perl changes in version 5.10.1
174     perl5100delta       Perl changes in version 5.10.0
175     perl595delta        Perl changes in version 5.9.5
176     perl594delta        Perl changes in version 5.9.4
177     perl593delta        Perl changes in version 5.9.3
178     perl592delta        Perl changes in version 5.9.2
179     perl591delta        Perl changes in version 5.9.1
180     perl590delta        Perl changes in version 5.9.0
181     perl589delta        Perl changes in version 5.8.9
182     perl588delta        Perl changes in version 5.8.8
183     perl587delta        Perl changes in version 5.8.7
184     perl586delta        Perl changes in version 5.8.6
185     perl585delta        Perl changes in version 5.8.5
186     perl584delta        Perl changes in version 5.8.4
187     perl583delta        Perl changes in version 5.8.3
188     perl582delta        Perl changes in version 5.8.2
189     perl581delta        Perl changes in version 5.8.1
190     perl58delta         Perl changes in version 5.8.0
191     perl573delta        Perl changes in version 5.7.3
192     perl572delta        Perl changes in version 5.7.2
193     perl571delta        Perl changes in version 5.7.1
194     perl570delta        Perl changes in version 5.7.0
195     perl561delta        Perl changes in version 5.6.1
196     perl56delta         Perl changes in version 5.6
197     perl5005delta       Perl changes in version 5.005
198     perl5004delta       Perl changes in version 5.004
199
200     perlartistic        Perl Artistic License
201     perlgpl             GNU General Public License
202
203 =head2 Language-Specific
204
205     perlcn              Perl for Simplified Chinese (in EUC-CN)
206     perljp              Perl for Japanese (in EUC-JP)
207     perlko              Perl for Korean (in EUC-KR)
208     perltw              Perl for Traditional Chinese (in Big5)
209
210 =head2 Platform-Specific
211
212     perlaix             Perl notes for AIX
213     perlamiga           Perl notes for AmigaOS
214     perlapollo          Perl notes for Apollo DomainOS
215     perlbeos            Perl notes for BeOS
216     perlbs2000          Perl notes for POSIX-BC BS2000
217     perlce              Perl notes for WinCE
218     perlcygwin          Perl notes for Cygwin
219     perldgux            Perl notes for DG/UX
220     perldos             Perl notes for DOS
221     perlepoc            Perl notes for EPOC
222     perlfreebsd         Perl notes for FreeBSD
223     perlhaiku           Perl notes for Haiku
224     perlhpux            Perl notes for HP-UX
225     perlhurd            Perl notes for Hurd
226     perlirix            Perl notes for Irix
227     perllinux           Perl notes for Linux
228     perlmacos           Perl notes for Mac OS (Classic)
229     perlmacosx          Perl notes for Mac OS X
230     perlmpeix           Perl notes for MPE/iX
231     perlnetware         Perl notes for NetWare
232     perlopenbsd         Perl notes for OpenBSD
233     perlos2             Perl notes for OS/2
234     perlos390           Perl notes for OS/390
235     perlos400           Perl notes for OS/400
236     perlplan9           Perl notes for Plan 9
237     perlqnx             Perl notes for QNX
238     perlriscos          Perl notes for RISC OS
239     perlsolaris         Perl notes for Solaris
240     perlsymbian         Perl notes for Symbian
241     perltru64           Perl notes for Tru64
242     perluts             Perl notes for UTS
243     perlvmesa           Perl notes for VM/ESA
244     perlvms             Perl notes for VMS
245     perlvos             Perl notes for Stratus VOS
246     perlwin32           Perl notes for Windows
247
248
249 On a Unix-like system, these documentation files will usually also be
250 available as manpages for use with the F<man> program.
251
252 In general, if something strange has gone wrong with your program and you're
253 not sure where you should look for help, try the B<-w> switch first.  It will
254 often point out exactly where the trouble is.
255
256 =head1 DESCRIPTION
257
258 Perl officially stands for Practical Extraction and Report Language,
259 except when it doesn't.
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