Create perldelta for 5.14.3
[perl.git] / pod / perl.pod
1 =head1 NAME
2
3 perl - The Perl 5 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     perlpodstyle        Perl POD style guide
82     perlrun             Perl execution and options
83     perldiag            Perl diagnostic messages
84     perllexwarn         Perl warnings and their control
85     perldebug           Perl debugging
86     perlvar             Perl predefined variables
87     perlre              Perl regular expressions, the rest of the story
88     perlrebackslash     Perl regular expression backslash sequences
89     perlrecharclass     Perl regular expression character classes
90     perlreref           Perl regular expressions quick reference
91     perlref             Perl references, the rest of the story
92     perlform            Perl formats
93     perlobj             Perl objects
94     perltie             Perl objects hidden behind simple variables
95       perldbmfilter     Perl DBM filters
96
97     perlipc             Perl interprocess communication
98     perlfork            Perl fork() information
99     perlnumber          Perl number semantics
100
101     perlthrtut          Perl threads tutorial
102
103     perlport            Perl portability guide
104     perllocale          Perl locale support
105     perluniintro        Perl Unicode introduction
106     perlunicode         Perl Unicode support
107     perlunifaq          Perl Unicode FAQ
108     perluniprops        Index of Unicode Version 6.0.0 properties in Perl
109     perlunitut          Perl Unicode tutorial
110     perlebcdic          Considerations for running Perl on EBCDIC platforms
111
112     perlsec             Perl security
113
114     perlmod             Perl modules: how they work
115     perlmodlib          Perl modules: how to write and use
116     perlmodstyle        Perl modules: how to write modules with style
117     perlmodinstall      Perl modules: how to install from CPAN
118     perlnewmod          Perl modules: preparing a new module for distribution
119     perlpragma          Perl modules: writing a user pragma
120
121     perlutil            utilities packaged with the Perl distribution
122
123     perlcompile         Perl compiler suite intro
124
125     perlfilter          Perl source filters
126
127     perlglossary        Perl Glossary
128
129 =head2 Internals and C Language Interface
130
131     perlembed           Perl ways to embed perl in your C or C++ application
132     perldebguts         Perl debugging guts and tips
133     perlxstut           Perl XS tutorial
134     perlxs              Perl XS application programming interface
135     perlclib            Internal replacements for standard C library functions
136     perlguts            Perl internal functions for those doing extensions
137     perlcall            Perl calling conventions from C
138     perlmroapi          Perl method resolution plugin interface
139     perlreapi           Perl regular expression plugin interface
140     perlreguts          Perl regular expression engine internals
141
142     perlapi             Perl API listing (autogenerated)
143     perlintern          Perl internal functions (autogenerated)
144     perliol             C API for Perl's implementation of IO in Layers
145     perlapio            Perl internal IO abstraction interface
146
147     perlhack            Perl hackers guide
148     perlsource          Guide to the Perl source tree
149     perlinterp          Overview of the Perl intepreter source and how it works
150     perlhacktut         Walk through the creation of a simple C code patch
151     perlhacktips        Tips for Perl core C code hacking
152     perlpolicy          Perl development policies
153     perlgit             Using git with the Perl repository
154
155 =head2 Miscellaneous
156
157     perlbook            Perl book information
158     perlcommunity       Perl community information
159     perltodo            Perl things to do
160
161     perldoc             Look up Perl documentation in Pod format
162
163     perlhist            Perl history records
164     perldelta           Perl changes since previous version
165     perl5142delta       Perl changes in version 5.14.2
166     perl5141delta       Perl changes in version 5.14.1
167     perl5140delta       Perl changes in version 5.14.0
168     perl51311delta      Perl changes in version 5.13.11
169     perl51310delta      Perl changes in version 5.13.10
170     perl5139delta       Perl changes in version 5.13.9
171     perl5138delta       Perl changes in version 5.13.8
172     perl5137delta       Perl changes in version 5.13.7
173     perl5136delta       Perl changes in version 5.13.6
174     perl5135delta       Perl changes in version 5.13.5
175     perl5134delta       Perl changes in version 5.13.4
176     perl5133delta       Perl changes in version 5.13.3
177     perl5132delta       Perl changes in version 5.13.2
178     perl5131delta       Perl changes in version 5.13.1
179     perl5130delta       Perl changes in version 5.13.0
180     perl5123delta       Perl changes in version 5.12.3
181     perl5122delta       Perl changes in version 5.12.2
182     perl5121delta       Perl changes in version 5.12.1
183     perl5120delta       Perl changes in version 5.12.0
184     perl5115delta       Perl changes in version 5.11.5
185     perl5114delta       Perl changes in version 5.11.4
186     perl5113delta       Perl changes in version 5.11.3
187     perl5112delta       Perl changes in version 5.11.2
188     perl5111delta       Perl changes in version 5.11.1
189     perl5110delta       Perl changes in version 5.11.0
190     perl5101delta       Perl changes in version 5.10.1
191     perl5100delta       Perl changes in version 5.10.0
192     perl595delta        Perl changes in version 5.9.5
193     perl594delta        Perl changes in version 5.9.4
194     perl593delta        Perl changes in version 5.9.3
195     perl592delta        Perl changes in version 5.9.2
196     perl591delta        Perl changes in version 5.9.1
197     perl590delta        Perl changes in version 5.9.0
198     perl589delta        Perl changes in version 5.8.9
199     perl588delta        Perl changes in version 5.8.8
200     perl587delta        Perl changes in version 5.8.7
201     perl586delta        Perl changes in version 5.8.6
202     perl585delta        Perl changes in version 5.8.5
203     perl584delta        Perl changes in version 5.8.4
204     perl583delta        Perl changes in version 5.8.3
205     perl582delta        Perl changes in version 5.8.2
206     perl581delta        Perl changes in version 5.8.1
207     perl58delta         Perl changes in version 5.8.0
208     perl573delta        Perl changes in version 5.7.3
209     perl572delta        Perl changes in version 5.7.2
210     perl571delta        Perl changes in version 5.7.1
211     perl570delta        Perl changes in version 5.7.0
212     perl561delta        Perl changes in version 5.6.1
213     perl56delta         Perl changes in version 5.6
214     perl5005delta       Perl changes in version 5.005
215     perl5004delta       Perl changes in version 5.004
216
217     perlartistic        Perl Artistic License
218     perlgpl             GNU General Public License
219
220 =head2 Language-Specific
221
222     perlcn              Perl for Simplified Chinese (in EUC-CN)
223     perljp              Perl for Japanese (in EUC-JP)
224     perlko              Perl for Korean (in EUC-KR)
225     perltw              Perl for Traditional Chinese (in Big5)
226
227 =head2 Platform-Specific
228
229     perlaix             Perl notes for AIX
230     perlamiga           Perl notes for AmigaOS
231     perlbeos            Perl notes for BeOS
232     perlbs2000          Perl notes for POSIX-BC BS2000
233     perlce              Perl notes for WinCE
234     perlcygwin          Perl notes for Cygwin
235     perldgux            Perl notes for DG/UX
236     perldos             Perl notes for DOS
237     perlepoc            Perl notes for EPOC
238     perlfreebsd         Perl notes for FreeBSD
239     perlhaiku           Perl notes for Haiku
240     perlhpux            Perl notes for HP-UX
241     perlhurd            Perl notes for Hurd
242     perlirix            Perl notes for Irix
243     perllinux           Perl notes for Linux
244     perlmacos           Perl notes for Mac OS (Classic)
245     perlmacosx          Perl notes for Mac OS X
246     perlmpeix           Perl notes for MPE/iX
247     perlnetware         Perl notes for NetWare
248     perlopenbsd         Perl notes for OpenBSD
249     perlos2             Perl notes for OS/2
250     perlos390           Perl notes for OS/390
251     perlos400           Perl notes for OS/400
252     perlplan9           Perl notes for Plan 9
253     perlqnx             Perl notes for QNX
254     perlriscos          Perl notes for RISC OS
255     perlsolaris         Perl notes for Solaris
256     perlsymbian         Perl notes for Symbian
257     perltru64           Perl notes for Tru64
258     perluts             Perl notes for UTS
259     perlvmesa           Perl notes for VM/ESA
260     perlvms             Perl notes for VMS
261     perlvos             Perl notes for Stratus VOS
262     perlwin32           Perl notes for Windows
263
264
265 On a Unix-like system, these documentation files will usually also be
266 available as manpages for use with the F<man> program.
267
268 In general, if something strange has gone wrong with your program and you're
269 not sure where you should look for help, try the B<-w> switch first.  It will
270 often point out exactly where the trouble is.
271
272 =head1 DESCRIPTION
273
274 Perl officially stands for Practical Extraction and Report Language,
275 except when it doesn't.
276
277 Perl was originally a language optimized for scanning arbitrary
278 text files, extracting information from those text files, and printing
279 reports based on that information.  It quickly became a good language
280 for many system management tasks. Over the years, Perl has grown into
281 a general-purpose programming language. It's widely used for everything
282 from quick "one-liners" to full-scale application development.
283
284 The language is intended to be practical (easy to use, efficient,
285 complete) rather than beautiful (tiny, elegant, minimal).
286
287 Perl combines (in the author's opinion, anyway) some of the best
288 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
289 those languages should have little difficulty with it.  (Language
290 historians will also note some vestiges of B<csh>, Pascal, and even
291 BASIC-PLUS.)  Expression syntax corresponds closely to C
292 expression syntax.  Unlike most Unix utilities, Perl does not
293 arbitrarily limit the size of your data--if you've got the memory,
294 Perl can slurp in your whole file as a single string.  Recursion is of
295 unlimited depth.  And the tables used by hashes (sometimes called
296 "associative arrays") grow as necessary to prevent degraded
297 performance.  Perl can use sophisticated pattern matching techniques to
298 scan large amounts of data quickly.  Although optimized for
299 scanning text, Perl also has many excellent tools for slicing
300 and dicing binary data.
301
302 But wait, there's more...
303
304 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
305 rewrite that provides the following additional benefits:
306
307 =over 4
308
309 =item *
310
311 modularity and reusability using innumerable modules 
312
313 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
314
315 =item *
316
317 embeddable and extensible 
318
319 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
320 L<perlguts>, and L<xsubpp>.
321
322 =item *
323
324 roll-your-own magic variables (including multiple simultaneous DBM
325 implementations)
326
327 Described in L<perltie> and L<AnyDBM_File>.
328
329 =item *
330
331 subroutines can now be overridden, autoloaded, and prototyped
332
333 Described in L<perlsub>.
334
335 =item *
336
337 arbitrarily nested data structures and anonymous functions
338
339 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
340
341 =item *
342
343 object-oriented programming
344
345 Described in L<perlobj>, L<perlboot>, L<perltoot>, L<perltooc>,
346 and L<perlbot>.
347
348 =item *
349
350 support for light-weight processes (threads)
351
352 Described in L<perlthrtut> and L<threads>.
353
354 =item *
355
356 support for Unicode, internationalization, and localization
357
358 Described in L<perluniintro>, L<perllocale> and L<Locale::Maketext>.
359
360 =item *
361
362 lexical scoping
363
364 Described in L<perlsub>.
365
366 =item *
367
368 regular expression enhancements
369
370 Described in L<perlre>, with additional examples in L<perlop>.
371
372 =item *
373
374 enhanced debugger and interactive Perl environment,
375 with integrated editor support
376
377 Described in L<perldebtut>, L<perldebug> and L<perldebguts>.
378
379 =item *
380
381 POSIX 1003.1 compliant library
382
383 Described in L<POSIX>.
384
385 =back
386
387 Okay, that's I<definitely> enough hype.
388
389 =head1 AVAILABILITY
390
391 Perl is available for most operating systems, including virtually
392 all Unix-like platforms.  See L<perlport/"Supported Platforms">
393 for a listing.
394
395 =head1 ENVIRONMENT
396
397 See L<perlrun>.
398
399 =head1 AUTHOR
400
401 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
402
403 If your Perl success stories and testimonials may be of help to others 
404 who wish to advocate the use of Perl in their applications, 
405 or if you wish to simply express your gratitude to Larry and the 
406 Perl developers, please write to perl-thanks@perl.org .
407
408 =head1 FILES
409
410  "@INC"                 locations of perl libraries
411
412 =head1 SEE ALSO
413
414  http://www.perl.org/       the Perl homepage
415  http://www.perl.com/       Perl articles (O'Reilly)
416  http://www.cpan.org/       the Comprehensive Perl Archive
417  http://www.pm.org/         the Perl Mongers
418
419 =head1 DIAGNOSTICS
420
421 The C<use warnings> pragma (and the B<-w> switch) produces some 
422 lovely diagnostics.
423
424 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
425 diagnostics> pragma automatically turns Perl's normally terse warnings
426 and errors into these longer forms.
427
428 Compilation errors will tell you the line number of the error, with an
429 indication of the next token or token type that was to be examined.
430 (In a script passed to Perl via B<-e> switches, each
431 B<-e> is counted as one line.)
432
433 Setuid scripts have additional constraints that can produce error
434 messages such as "Insecure dependency".  See L<perlsec>.
435
436 Did we mention that you should definitely consider using the B<-w>
437 switch?
438
439 =head1 BUGS
440
441 The B<-w> switch is not mandatory.
442
443 Perl is at the mercy of your machine's definitions of various
444 operations such as type casting, atof(), and floating-point
445 output with sprintf().
446
447 If your stdio requires a seek or eof between reads and writes on a
448 particular stream, so does Perl.  (This doesn't apply to sysread()
449 and syswrite().)
450
451 While none of the built-in data types have any arbitrary size limits
452 (apart from memory size), there are still a few arbitrary limits:  a
453 given variable name may not be longer than 251 characters.  Line numbers
454 displayed by diagnostics are internally stored as short integers,
455 so they are limited to a maximum of 65535 (higher numbers usually being
456 affected by wraparound).
457
458 You may mail your bug reports (be sure to include full configuration
459 information as output by the myconfig program in the perl source
460 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
461 in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
462 can be used to help mail in a bug report.
463
464 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
465 don't tell anyone I said that.
466
467 =head1 NOTES
468
469 The Perl motto is "There's more than one way to do it."  Divining
470 how many more is left as an exercise to the reader.
471
472 The three principal virtues of a programmer are Laziness,
473 Impatience, and Hubris.  See the Camel Book for why.
474