This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pmruntime(): change '=' to '==' in an assertion
[perl5.git] / pod / perl.pod
CommitLineData
a0d0e21e
LW
1=head1 NAME
2
095a5c3e 3perl - The Perl 5 language interpreter
a0d0e21e
LW
4
5=head1 SYNOPSIS
6
df451b2a
RGS
7B<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> ]>
df451b2a 12 S<[ B<-C [I<number/list>] >]>
df451b2a
RGS
13 S<[ B<-S> ]>
14 S<[ B<-x>[I<dir>] ]>
15 S<[ B<-i>[I<extension>] ]>
eb1dd64e 16 S<[ [B<-e>|B<-E>] I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
c07a80fd 17
b28fe7ca
JL
18For more information on these options, you can run C<perldoc perlrun>.
19
6b43eec4
DG
20=head1 GETTING HELP
21
22The F<perldoc> program gives you access to all the documentation that comes
23with Perl. You can get more documentation, tutorials and community support
24online at L<http://www.perl.org/>.
25
26If you're new to Perl, you should start by running C<perldoc perlintro>,
27which is a general intro for beginners and provides some background to help
28you navigate the rest of Perl's extensive documentation. Run C<perldoc
29perldoc> to learn more things you can do with F<perldoc>.
10151d09
JH
30
31For ease of access, the Perl manual has been split up into several sections.
a0d0e21e 32
0aef0fe5
NC
33=begin buildtoc
34
35# This section is parsed by Porting/pod_lib.pl for use by pod/buildtoc etc
36
37flag =g perluniprops perlmodlib perlapi perlintern
38flag =go perltoc
39flag =ro perlcn perljp perlko perltw
40flag = perlvms
41
0eb29def
SM
42path perlfaq.* cpan/perlfaq/lib/
43path perlglossary cpan/perlfaq/lib/
44path perlxs(?:tut|typemap)? dist/ExtUtils-ParseXS/lib/
45path perldoc cpan/Pod-Perldoc/lib/
0aef0fe5
NC
46
47aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
48
49=end buildtoc
50
fd7b6849
MJD
51=head2 Overview
52
fb9cefb4 53 perl Perl overview (this section)
10151d09 54 perlintro Perl introduction for beginners
b28fe7ca 55 perlrun Perl execution and options
fb9cefb4 56 perltoc Perl documentation table of contents
760ac839 57
fd7b6849
MJD
58=head2 Tutorials
59
7a2320f0
AMS
60 perlreftut Perl references short introduction
61 perldsc Perl data structures intro
62 perllol Perl data structures: arrays of arrays
7a2320f0 63
41630250 64 perlrequick Perl regular expressions quick start
7a2320f0
AMS
65 perlretut Perl regular expressions tutorial
66
82e1c0d9 67 perlootut Perl OO tutorial for beginners
7a2320f0 68
da096611
RGS
69 perlperf Perl Performance and Optimization Techniques
70
7a2320f0
AMS
71 perlstyle Perl style guide
72
41630250 73 perlcheat Perl cheat sheet
7a2320f0
AMS
74 perltrap Perl traps for the unwary
75 perldebtut Perl debugging tutorial
76
fd7b6849
MJD
77 perlfaq Perl frequently asked questions
78 perlfaq1 General Questions About Perl
79 perlfaq2 Obtaining and Learning about Perl
80 perlfaq3 Programming Tools
81 perlfaq4 Data Manipulation
82 perlfaq5 Files and Formats
83 perlfaq6 Regexes
84 perlfaq7 Perl Language Issues
85 perlfaq8 System Interaction
86 perlfaq9 Networking
0f542199 87
fd7b6849 88=head2 Reference Manual
413510b3 89
fb9cefb4 90 perlsyn Perl syntax
4755096e 91 perldata Perl data structures
fb9cefb4 92 perlop Perl operators and precedence
c2e66d9e 93 perlsub Perl subroutines
fd7b6849 94 perlfunc Perl built-in functions
413510b3 95 perlopentut Perl open() tutorial
41630250 96 perlpacktut Perl pack() and unpack() tutorial
c2e66d9e 97 perlpod Perl plain old documentation
41630250 98 perlpodspec Perl plain old documentation format specification
f4d47668 99 perlpodstyle Perl POD style guide
c2e66d9e 100 perldiag Perl diagnostic messages
41630250 101 perllexwarn Perl warnings and their control
4755096e 102 perldebug Perl debugging
fb9cefb4 103 perlvar Perl predefined variables
4755096e 104 perlre Perl regular expressions, the rest of the story
8a118206
RGS
105 perlrebackslash Perl regular expression backslash sequences
106 perlrecharclass Perl regular expression character classes
30487ceb 107 perlreref Perl regular expressions quick reference
d396a558 108 perlref Perl references, the rest of the story
fb9cefb4 109 perlform Perl formats
d396a558 110 perlobj Perl objects
d396a558 111 perltie Perl objects hidden behind simple variables
fd7b6849 112 perldbmfilter Perl DBM filters
760ac839 113
c2e66d9e
GS
114 perlipc Perl interprocess communication
115 perlfork Perl fork() information
116 perlnumber Perl number semantics
53d7eaa8 117
c2e66d9e
GS
118 perlthrtut Perl threads tutorial
119
120 perlport Perl portability guide
d396a558 121 perllocale Perl locale support
07fcf8ff 122 perluniintro Perl Unicode introduction
41630250 123 perlunicode Perl Unicode support
3426ea3d 124 perlunifaq Perl Unicode FAQ
0cb5a9a8 125 perluniprops Index of Unicode properties in Perl
aadaa455 126 perlunitut Perl Unicode tutorial
d396a558 127 perlebcdic Considerations for running Perl on EBCDIC platforms
c2e66d9e 128
d396a558 129 perlsec Perl security
4755096e 130
c2e66d9e 131 perlmod Perl modules: how they work
35bf961c
JH
132 perlmodlib Perl modules: how to write and use
133 perlmodstyle Perl modules: how to write modules with style
fd7b6849 134 perlmodinstall Perl modules: how to install from CPAN
c2e66d9e 135 perlnewmod Perl modules: preparing a new module for distribution
a550ee30 136 perlpragma Perl modules: writing a user pragma
760ac839 137
fd7b6849 138 perlutil utilities packaged with the Perl distribution
760ac839 139
fd7b6849
MJD
140 perlfilter Perl source filters
141
4000c4db
FC
142 perldtrace Perl's support for DTrace
143
97a1d740
YST
144 perlglossary Perl Glossary
145
fd7b6849
MJD
146=head2 Internals and C Language Interface
147
fb9cefb4 148 perlembed Perl ways to embed perl in your C or C++ application
41630250 149 perldebguts Perl debugging guts and tips
fb9cefb4 150 perlxstut Perl XS tutorial
4755096e 151 perlxs Perl XS application programming interface
0eb29def 152 perlxstypemap Perl XS C/Perl type conversion tools
f40a6c71 153 perlclib Internal replacements for standard C library functions
fb9cefb4
GS
154 perlguts Perl internal functions for those doing extensions
155 perlcall Perl calling conventions from C
15932acc 156 perlmroapi Perl method resolution plugin interface
108003db 157 perlreapi Perl regular expression plugin interface
b23a565d 158 perlreguts Perl regular expression engine internals
fd7b6849 159
954c1994
GS
160 perlapi Perl API listing (autogenerated)
161 perlintern Perl internal functions (autogenerated)
dc5c060f 162 perliol C API for Perl's implementation of IO in Layers
4755096e 163 perlapio Perl internal IO abstraction interface
fd7b6849 164
e8cd7eae 165 perlhack Perl hackers guide
04c692a8 166 perlsource Guide to the Perl source tree
1c2e8cca 167 perlinterp Overview of the Perl interpreter source and how it works
04c692a8
DR
168 perlhacktut Walk through the creation of a simple C code patch
169 perlhacktips Tips for Perl core C code hacking
cb8a010e 170 perlpolicy Perl development policies
04c692a8 171 perlgit Using git with the Perl repository
4755096e 172
fd7b6849
MJD
173=head2 Miscellaneous
174
175 perlbook Perl book information
cbd87e7e 176 perlcommunity Perl community information
fd7b6849 177
2a551100
JH
178 perldoc Look up Perl documentation in Pod format
179
fb9cefb4 180 perlhist Perl history records
bdfb6cc8 181 perldelta Perl changes since previous version
19718730 182 perl5178delta Perl changes in version 5.17.8
6253ee75 183 perl5177delta Perl changes in version 5.17.7
e14ac59b 184 perl5176delta Perl changes in version 5.17.6
7e7cfa2d 185 perl5175delta Perl changes in version 5.17.5
5d8c8c8a 186 perl5174delta Perl changes in version 5.17.4
916c45d9 187 perl5173delta Perl changes in version 5.17.3
4eabcf70 188 perl5172delta Perl changes in version 5.17.2
e96e0834 189 perl5171delta Perl changes in version 5.17.1
61174fb5 190 perl5170delta Perl changes in version 5.17.0
69cb649c 191 perl5161delta Perl changes in version 5.16.1
50f27400 192 perl5162delta Perl changes in version 5.16.2
05c8f9ed 193 perl5160delta Perl changes in version 5.16.0
70ce046e 194 perl5143delta Perl changes in version 5.14.3
77efd0f7 195 perl5142delta Perl changes in version 5.14.2
10288c7a 196 perl5141delta Perl changes in version 5.14.1
066dc4d9 197 perl5140delta Perl changes in version 5.14.0
a5caed3e 198 perl5125delta Perl changes in version 5.12.5
0b67f426 199 perl5124delta Perl changes in version 5.12.4
6c5f5efa 200 perl5123delta Perl changes in version 5.12.3
e71d1a7d 201 perl5122delta Perl changes in version 5.12.2
bdfb6cc8 202 perl5121delta Perl changes in version 5.12.1
20d57231 203 perl5120delta Perl changes in version 5.12.0
7cdf958d 204 perl5101delta Perl changes in version 5.10.1
7120b314 205 perl5100delta Perl changes in version 5.10.0
fc5be808 206 perl589delta Perl changes in version 5.8.9
c11a53c6 207 perl588delta Perl changes in version 5.8.8
315ba985 208 perl587delta Perl changes in version 5.8.7
e4bb216d 209 perl586delta Perl changes in version 5.8.6
07e9b5fe 210 perl585delta Perl changes in version 5.8.5
5f15c94e 211 perl584delta Perl changes in version 5.8.4
2e038148
NC
212 perl583delta Perl changes in version 5.8.3
213 perl582delta Perl changes in version 5.8.2
b6235c4f 214 perl581delta Perl changes in version 5.8.1
2e038148 215 perl58delta Perl changes in version 5.8.0
493a87da 216 perl561delta Perl changes in version 5.6.1
41630250 217 perl56delta Perl changes in version 5.6
4755096e
GS
218 perl5005delta Perl changes in version 5.005
219 perl5004delta Perl changes in version 5.004
d516a115 220
42e73e1c 221 perlexperiment A listing of experimental features in Perl
222
2a551100
JH
223 perlartistic Perl Artistic License
224 perlgpl GNU General Public License
225
d8416318
JH
226=head2 Language-Specific
227
0aef0fe5
NC
228=for buildtoc flag +r
229
d8416318
JH
230 perlcn Perl for Simplified Chinese (in EUC-CN)
231 perljp Perl for Japanese (in EUC-JP)
232 perlko Perl for Korean (in EUC-KR)
233 perltw Perl for Traditional Chinese (in Big5)
234
fd7b6849
MJD
235=head2 Platform-Specific
236
37d4d706 237 perlaix Perl notes for AIX
a83b6f46 238 perlamiga Perl notes for AmigaOS
dc5c060f 239 perlbs2000 Perl notes for POSIX-BC BS2000
a1f19229 240 perlce Perl notes for WinCE
49877630 241 perlcygwin Perl notes for Cygwin
245d750e 242 perldgux Perl notes for DG/UX
49877630 243 perldos Perl notes for DOS
41630250 244 perlfreebsd Perl notes for FreeBSD
f6706af3 245 perlhaiku Perl notes for Haiku
49877630 246 perlhpux Perl notes for HP-UX
a83b6f46 247 perlhurd Perl notes for Hurd
469e7be4 248 perlirix Perl notes for Irix
991e8403 249 perllinux Perl notes for Linux
26d9b02f 250 perlmacos Perl notes for Mac OS (Classic)
0d53b15f 251 perlmacosx Perl notes for Mac OS X
41630250 252 perlnetware Perl notes for NetWare
b0846812 253 perlopenbsd Perl notes for OpenBSD
49877630
GS
254 perlos2 Perl notes for OS/2
255 perlos390 Perl notes for OS/390
522b859a 256 perlos400 Perl notes for OS/400
a83b6f46
JH
257 perlplan9 Perl notes for Plan 9
258 perlqnx Perl notes for QNX
2f08ed66 259 perlriscos Perl notes for RISC OS
d420ca49 260 perlsolaris Perl notes for Solaris
27da23d5 261 perlsymbian Perl notes for Symbian
772ff3b9 262 perltru64 Perl notes for Tru64
49877630 263 perlvms Perl notes for VMS
9a997319 264 perlvos Perl notes for Stratus VOS
49877630
GS
265 perlwin32 Perl notes for Windows
266
0aef0fe5
NC
267=for buildtoc flag -r
268
e653ab25
DR
269=head2 Stubs for Deleted Documents
270
271 perlboot
272 perlbot
5d0b49e8 273 perltodo
e653ab25
DR
274 perltooc
275 perltoot
276
0aef0fe5 277=for buildtoc __END__
35dec5db 278
6b43eec4
DG
279On a Unix-like system, these documentation files will usually also be
280available as manpages for use with the F<man> program.
a0d0e21e 281
6b43eec4 282In general, if something strange has gone wrong with your program and you're
71b5b092
SF
283not sure where you should look for help, try making your code comply with
284B<use strict> and B<use warnings>. These will often point out exactly
285where the trouble is.
a0d0e21e
LW
286
287=head1 DESCRIPTION
288
d27f2b2f
DG
289Perl officially stands for Practical Extraction and Report Language,
290except when it doesn't.
291
72033c14 292Perl was originally a language optimized for scanning arbitrary
a0d0e21e 293text files, extracting information from those text files, and printing
72033c14
JV
294reports based on that information. It quickly became a good language
295for many system management tasks. Over the years, Perl has grown into
b6538e4f 296a general-purpose programming language. It's widely used for everything
72033c14
JV
297from quick "one-liners" to full-scale application development.
298
299The language is intended to be practical (easy to use, efficient,
300complete) rather than beautiful (tiny, elegant, minimal).
94d58c47 301
aa689395
PP
302Perl combines (in the author's opinion, anyway) some of the best
303features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
304those languages should have little difficulty with it. (Language
305historians will also note some vestiges of B<csh>, Pascal, and even
14218588 306BASIC-PLUS.) Expression syntax corresponds closely to C
a0d0e21e
LW
307expression syntax. Unlike most Unix utilities, Perl does not
308arbitrarily limit the size of your data--if you've got the memory,
aa689395 309Perl can slurp in your whole file as a single string. Recursion is of
0f31cffe 310unlimited depth. And the tables used by hashes (sometimes called
aa689395 311"associative arrays") grow as necessary to prevent degraded
0f31cffe 312performance. Perl can use sophisticated pattern matching techniques to
14218588 313scan large amounts of data quickly. Although optimized for
a8ebcfe9
JV
314scanning text, Perl also has many excellent tools for slicing
315and dicing binary data.
aa689395 316
a0d0e21e
LW
317But wait, there's more...
318
19799a22
GS
319Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
320rewrite that provides the following additional benefits:
a0d0e21e 321
13a2d996 322=over 4
a0d0e21e 323
551e1d92
RB
324=item *
325
326modularity and reusability using innumerable modules
a0d0e21e 327
19799a22 328Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
a0d0e21e 329
551e1d92
RB
330=item *
331
332embeddable and extensible
a0d0e21e 333
0eb29def
SM
334Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlxstypemap>,
335L<perlcall>, L<perlguts>, and L<xsubpp>.
a0d0e21e 336
551e1d92
RB
337=item *
338
63de3cb2
JH
339roll-your-own magic variables (including multiple simultaneous DBM
340implementations)
a0d0e21e 341
19799a22 342Described in L<perltie> and L<AnyDBM_File>.
a0d0e21e 343
551e1d92
RB
344=item *
345
346subroutines can now be overridden, autoloaded, and prototyped
a0d0e21e 347
19799a22 348Described in L<perlsub>.
a0d0e21e 349
551e1d92
RB
350=item *
351
352arbitrarily nested data structures and anonymous functions
a0d0e21e 353
19799a22 354Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
a0d0e21e 355
551e1d92
RB
356=item *
357
358object-oriented programming
a0d0e21e 359
82e1c0d9 360Described in L<perlobj> and L<perlootut>.
a0d0e21e 361
551e1d92
RB
362=item *
363
551e1d92 364support for light-weight processes (threads)
a0d0e21e 365
63de3cb2 366Described in L<perlthrtut> and L<threads>.
a0d0e21e 367
551e1d92
RB
368=item *
369
63de3cb2 370support for Unicode, internationalization, and localization
a0d0e21e 371
63de3cb2 372Described in L<perluniintro>, L<perllocale> and L<Locale::Maketext>.
a0d0e21e 373
551e1d92
RB
374=item *
375
376lexical scoping
a0d0e21e 377
19799a22 378Described in L<perlsub>.
a0d0e21e 379
551e1d92
RB
380=item *
381
382regular expression enhancements
a0d0e21e 383
19799a22 384Described in L<perlre>, with additional examples in L<perlop>.
a0d0e21e 385
551e1d92
RB
386=item *
387
388enhanced debugger and interactive Perl environment,
389with integrated editor support
a0d0e21e 390
f6b3c421 391Described in L<perldebtut>, L<perldebug> and L<perldebguts>.
a0d0e21e 392
551e1d92
RB
393=item *
394
395POSIX 1003.1 compliant library
5f05dabc 396
19799a22 397Described in L<POSIX>.
5f05dabc 398
a0d0e21e
LW
399=back
400
68dc0745 401Okay, that's I<definitely> enough hype.
a0d0e21e 402
8e465e4e
JH
403=head1 AVAILABILITY
404
14218588 405Perl is available for most operating systems, including virtually
055fd3a9
GS
406all Unix-like platforms. See L<perlport/"Supported Platforms">
407for a listing.
8bc4a6bb 408
a0d0e21e
LW
409=head1 ENVIRONMENT
410
1e422769 411See L<perlrun>.
a0d0e21e
LW
412
413=head1 AUTHOR
414
19799a22 415Larry Wall <larry@wall.org>, with the help of oodles of other folks.
a0d0e21e 416
a99b1639
TP
417If your Perl success stories and testimonials may be of help to others
418who wish to advocate the use of Perl in their applications,
419or if you wish to simply express your gratitude to Larry and the
19799a22 420Perl developers, please write to perl-thanks@perl.org .
a99b1639 421
a0d0e21e
LW
422=head1 FILES
423
5f05dabc 424 "@INC" locations of perl libraries
a0d0e21e
LW
425
426=head1 SEE ALSO
427
c5f69108 428 http://www.perl.org/ the Perl homepage
da9e6348 429 http://www.perl.com/ Perl articles (O'Reilly)
f6b3c421 430 http://www.cpan.org/ the Comprehensive Perl Archive
c5f69108 431 http://www.pm.org/ the Perl Mongers
19799a22 432
a0d0e21e
LW
433=head1 DIAGNOSTICS
434
71b5b092
SF
435Using the C<use strict> pragma ensures that all variables are properly
436declared and prevents other misuses of legacy Perl features.
437
6753a9e9
SF
438The C<use warnings> pragma produces some lovely diagnostics. One can
439also use the B<-w> flag, but its use is normally discouraged, because
440it gets applied to all executed Perl code, including that not under
441your control.
a0d0e21e 442
5a964f20
TC
443See L<perldiag> for explanations of all Perl's diagnostics. The C<use
444diagnostics> pragma automatically turns Perl's normally terse warnings
445and errors into these longer forms.
a0d0e21e
LW
446
447Compilation errors will tell you the line number of the error, with an
448indication of the next token or token type that was to be examined.
14218588 449(In a script passed to Perl via B<-e> switches, each
a0d0e21e
LW
450B<-e> is counted as one line.)
451
452Setuid scripts have additional constraints that can produce error
453messages such as "Insecure dependency". See L<perlsec>.
454
71b5b092
SF
455Did we mention that you should definitely consider using the B<use warnings>
456pragma?
a0d0e21e
LW
457
458=head1 BUGS
459
71b5b092 460The behavior implied by the B<use warnings> pragma is not mandatory.
a0d0e21e
LW
461
462Perl is at the mercy of your machine's definitions of various
1b3f7d21
CS
463operations such as type casting, atof(), and floating-point
464output with sprintf().
a0d0e21e 465
748a9306 466If your stdio requires a seek or eof between reads and writes on a
a0d0e21e
LW
467particular stream, so does Perl. (This doesn't apply to sysread()
468and syswrite().)
469
470While none of the built-in data types have any arbitrary size limits
471(apart from memory size), there are still a few arbitrary limits: a
a30ac152
GS
472given variable name may not be longer than 251 characters. Line numbers
473displayed by diagnostics are internally stored as short integers,
474so they are limited to a maximum of 65535 (higher numbers usually being
475affected by wraparound).
a0d0e21e 476
b0607b7a 477You may mail your bug reports (be sure to include full configuration
19799a22 478information as output by the myconfig program in the perl source
7f2de2d2 479tree, or by C<perl -V>) to perlbug@perl.org . If you've succeeded
7f89f796 480in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
19799a22 481can be used to help mail in a bug report.
4633a7c4 482
a0d0e21e
LW
483Perl actually stands for Pathologically Eclectic Rubbish Lister, but
484don't tell anyone I said that.
485
486=head1 NOTES
487
488The Perl motto is "There's more than one way to do it." Divining
489how many more is left as an exercise to the reader.
490
4633a7c4 491The three principal virtues of a programmer are Laziness,
a0d0e21e 492Impatience, and Hubris. See the Camel Book for why.
16d20bd9 493