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