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