This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move more URLs from http:// to https://
[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
71c89d21 24online at L<https://www.perl.org/>.
6b43eec4
DG
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/
cb1974ba 45path perldoc cpan/Pod-Perldoc/
0aef0fe5 46
2560602c 47aux h2ph h2xs perlbug pl2pm pod2html pod2man splain xsubpp
0aef0fe5
NC
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
9021a1cf 101 perldeprecation Perl deprecations
41630250 102 perllexwarn Perl warnings and their control
4755096e 103 perldebug Perl debugging
fb9cefb4 104 perlvar Perl predefined variables
4755096e 105 perlre Perl regular expressions, the rest of the story
8a118206
RGS
106 perlrebackslash Perl regular expression backslash sequences
107 perlrecharclass Perl regular expression character classes
30487ceb 108 perlreref Perl regular expressions quick reference
d396a558 109 perlref Perl references, the rest of the story
fb9cefb4 110 perlform Perl formats
d396a558 111 perlobj Perl objects
d396a558 112 perltie Perl objects hidden behind simple variables
fd7b6849 113 perldbmfilter Perl DBM filters
760ac839 114
c2e66d9e
GS
115 perlipc Perl interprocess communication
116 perlfork Perl fork() information
117 perlnumber Perl number semantics
53d7eaa8 118
c2e66d9e
GS
119 perlthrtut Perl threads tutorial
120
121 perlport Perl portability guide
d396a558 122 perllocale Perl locale support
07fcf8ff 123 perluniintro Perl Unicode introduction
41630250 124 perlunicode Perl Unicode support
5dd47fd4 125 perlunicook Perl Unicode cookbook
3426ea3d 126 perlunifaq Perl Unicode FAQ
0cb5a9a8 127 perluniprops Index of Unicode properties in Perl
aadaa455 128 perlunitut Perl Unicode tutorial
d396a558 129 perlebcdic Considerations for running Perl on EBCDIC platforms
c2e66d9e 130
d396a558 131 perlsec Perl security
4755096e 132
c2e66d9e 133 perlmod Perl modules: how they work
35bf961c
JH
134 perlmodlib Perl modules: how to write and use
135 perlmodstyle Perl modules: how to write modules with style
fd7b6849 136 perlmodinstall Perl modules: how to install from CPAN
c2e66d9e 137 perlnewmod Perl modules: preparing a new module for distribution
a550ee30 138 perlpragma Perl modules: writing a user pragma
760ac839 139
fd7b6849 140 perlutil utilities packaged with the Perl distribution
760ac839 141
fd7b6849
MJD
142 perlfilter Perl source filters
143
4000c4db
FC
144 perldtrace Perl's support for DTrace
145
97a1d740
YST
146 perlglossary Perl Glossary
147
fd7b6849
MJD
148=head2 Internals and C Language Interface
149
fb9cefb4 150 perlembed Perl ways to embed perl in your C or C++ application
41630250 151 perldebguts Perl debugging guts and tips
fb9cefb4 152 perlxstut Perl XS tutorial
4755096e 153 perlxs Perl XS application programming interface
0eb29def 154 perlxstypemap Perl XS C/Perl type conversion tools
f40a6c71 155 perlclib Internal replacements for standard C library functions
fb9cefb4
GS
156 perlguts Perl internal functions for those doing extensions
157 perlcall Perl calling conventions from C
15932acc 158 perlmroapi Perl method resolution plugin interface
108003db 159 perlreapi Perl regular expression plugin interface
b23a565d 160 perlreguts Perl regular expression engine internals
fd7b6849 161
954c1994
GS
162 perlapi Perl API listing (autogenerated)
163 perlintern Perl internal functions (autogenerated)
dc5c060f 164 perliol C API for Perl's implementation of IO in Layers
4755096e 165 perlapio Perl internal IO abstraction interface
fd7b6849 166
e8cd7eae 167 perlhack Perl hackers guide
04c692a8 168 perlsource Guide to the Perl source tree
1c2e8cca 169 perlinterp Overview of the Perl interpreter source and how it works
04c692a8
DR
170 perlhacktut Walk through the creation of a simple C code patch
171 perlhacktips Tips for Perl core C code hacking
cb8a010e 172 perlpolicy Perl development policies
04c692a8 173 perlgit Using git with the Perl repository
4755096e 174
fd7b6849
MJD
175=head2 Miscellaneous
176
177 perlbook Perl book information
cbd87e7e 178 perlcommunity Perl community information
fd7b6849 179
2a551100
JH
180 perldoc Look up Perl documentation in Pod format
181
fb9cefb4 182 perlhist Perl history records
bdfb6cc8 183 perldelta Perl changes since previous version
74c14c97 184 perl5314delta Perl changes in version 5.31.4
fcbec156 185 perl5313delta Perl changes in version 5.31.3
9064626f 186 perl5312delta Perl changes in version 5.31.2
dad02c36 187 perl5311delta Perl changes in version 5.31.1
8424e368 188 perl5310delta Perl changes in version 5.31.0
5560f8d2 189 perl5300delta Perl changes in version 5.30.0
bea9954d 190 perl5282delta Perl changes in version 5.28.2
43323ad1 191 perl5281delta Perl changes in version 5.28.1
b0394755 192 perl5280delta Perl changes in version 5.28.0
43323ad1 193 perl5263delta Perl changes in version 5.26.3
fb51aa58 194 perl5262delta Perl changes in version 5.26.2
c592f515 195 perl5261delta Perl changes in version 5.26.1
b5cbfe35 196 perl5260delta Perl changes in version 5.26.0
fb51aa58 197 perl5244delta Perl changes in version 5.24.4
c592f515 198 perl5243delta Perl changes in version 5.24.3
50d330d7 199 perl5242delta Perl changes in version 5.24.2
f4a48a9e 200 perl5241delta Perl changes in version 5.24.1
4b8803f0 201 perl5240delta Perl changes in version 5.24.0
50d330d7 202 perl5224delta Perl changes in version 5.22.4
f4a48a9e 203 perl5223delta Perl changes in version 5.22.3
2f7cab8b 204 perl5222delta Perl changes in version 5.22.2
fd5868f3 205 perl5221delta Perl changes in version 5.22.1
2cfe9b50 206 perl5220delta Perl changes in version 5.22.0
9fd420ca 207 perl5203delta Perl changes in version 5.20.3
2b85b119 208 perl5202delta Perl changes in version 5.20.2
0c54b9fe 209 perl5201delta Perl changes in version 5.20.1
d1148309 210 perl5200delta Perl changes in version 5.20.0
e990b849 211 perl5184delta Perl changes in version 5.18.4
7b97958f 212 perl5182delta Perl changes in version 5.18.2
f4e35152 213 perl5181delta Perl changes in version 5.18.1
f13a3008 214 perl5180delta Perl changes in version 5.18.0
eaf7bcbf 215 perl5163delta Perl changes in version 5.16.3
d1148309
AP
216 perl5162delta Perl changes in version 5.16.2
217 perl5161delta Perl changes in version 5.16.1
05c8f9ed 218 perl5160delta Perl changes in version 5.16.0
1e5cc764 219 perl5144delta Perl changes in version 5.14.4
70ce046e 220 perl5143delta Perl changes in version 5.14.3
77efd0f7 221 perl5142delta Perl changes in version 5.14.2
10288c7a 222 perl5141delta Perl changes in version 5.14.1
066dc4d9 223 perl5140delta Perl changes in version 5.14.0
a5caed3e 224 perl5125delta Perl changes in version 5.12.5
0b67f426 225 perl5124delta Perl changes in version 5.12.4
6c5f5efa 226 perl5123delta Perl changes in version 5.12.3
e71d1a7d 227 perl5122delta Perl changes in version 5.12.2
bdfb6cc8 228 perl5121delta Perl changes in version 5.12.1
20d57231 229 perl5120delta Perl changes in version 5.12.0
7cdf958d 230 perl5101delta Perl changes in version 5.10.1
7120b314 231 perl5100delta Perl changes in version 5.10.0
fc5be808 232 perl589delta Perl changes in version 5.8.9
c11a53c6 233 perl588delta Perl changes in version 5.8.8
315ba985 234 perl587delta Perl changes in version 5.8.7
e4bb216d 235 perl586delta Perl changes in version 5.8.6
07e9b5fe 236 perl585delta Perl changes in version 5.8.5
5f15c94e 237 perl584delta Perl changes in version 5.8.4
2e038148
NC
238 perl583delta Perl changes in version 5.8.3
239 perl582delta Perl changes in version 5.8.2
b6235c4f 240 perl581delta Perl changes in version 5.8.1
2e038148 241 perl58delta Perl changes in version 5.8.0
493a87da 242 perl561delta Perl changes in version 5.6.1
41630250 243 perl56delta Perl changes in version 5.6
4755096e
GS
244 perl5005delta Perl changes in version 5.005
245 perl5004delta Perl changes in version 5.004
d516a115 246
42e73e1c 247 perlexperiment A listing of experimental features in Perl
248
2a551100
JH
249 perlartistic Perl Artistic License
250 perlgpl GNU General Public License
251
d8416318
JH
252=head2 Language-Specific
253
0aef0fe5
NC
254=for buildtoc flag +r
255
d8416318
JH
256 perlcn Perl for Simplified Chinese (in EUC-CN)
257 perljp Perl for Japanese (in EUC-JP)
258 perlko Perl for Korean (in EUC-KR)
259 perltw Perl for Traditional Chinese (in Big5)
260
fd7b6849
MJD
261=head2 Platform-Specific
262
37d4d706 263 perlaix Perl notes for AIX
a83b6f46 264 perlamiga Perl notes for AmigaOS
6001596e 265 perlandroid Perl notes for Android
dc5c060f 266 perlbs2000 Perl notes for POSIX-BC BS2000
49877630
GS
267 perlcygwin Perl notes for Cygwin
268 perldos Perl notes for DOS
41630250 269 perlfreebsd Perl notes for FreeBSD
f6706af3 270 perlhaiku Perl notes for Haiku
49877630 271 perlhpux Perl notes for HP-UX
a83b6f46 272 perlhurd Perl notes for Hurd
469e7be4 273 perlirix Perl notes for Irix
991e8403 274 perllinux Perl notes for Linux
26d9b02f 275 perlmacos Perl notes for Mac OS (Classic)
0d53b15f 276 perlmacosx Perl notes for Mac OS X
41630250 277 perlnetware Perl notes for NetWare
b0846812 278 perlopenbsd Perl notes for OpenBSD
49877630
GS
279 perlos2 Perl notes for OS/2
280 perlos390 Perl notes for OS/390
522b859a 281 perlos400 Perl notes for OS/400
a83b6f46
JH
282 perlplan9 Perl notes for Plan 9
283 perlqnx Perl notes for QNX
2f08ed66 284 perlriscos Perl notes for RISC OS
d420ca49 285 perlsolaris Perl notes for Solaris
27da23d5 286 perlsymbian Perl notes for Symbian
58534900 287 perlsynology Perl notes for Synology
772ff3b9 288 perltru64 Perl notes for Tru64
49877630 289 perlvms Perl notes for VMS
9a997319 290 perlvos Perl notes for Stratus VOS
49877630
GS
291 perlwin32 Perl notes for Windows
292
0aef0fe5
NC
293=for buildtoc flag -r
294
e653ab25
DR
295=head2 Stubs for Deleted Documents
296
297 perlboot
298 perlbot
9ab63835 299 perlrepository
5d0b49e8 300 perltodo
e653ab25
DR
301 perltooc
302 perltoot
303
0aef0fe5 304=for buildtoc __END__
35dec5db 305
6b43eec4
DG
306On a Unix-like system, these documentation files will usually also be
307available as manpages for use with the F<man> program.
a0d0e21e 308
f747cd2a
MB
309Some documentation is not available as man pages, so if a
310cross-reference is not found by man, try it with L<perldoc>. Perldoc can
311also take you directly to documentation for functions (with the B<-f>
312switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>)
313for other helpful options L<perldoc> has to offer.
314
6b43eec4 315In general, if something strange has gone wrong with your program and you're
71b5b092
SF
316not sure where you should look for help, try making your code comply with
317B<use strict> and B<use warnings>. These will often point out exactly
318where the trouble is.
a0d0e21e
LW
319
320=head1 DESCRIPTION
321
d27f2b2f
DG
322Perl officially stands for Practical Extraction and Report Language,
323except when it doesn't.
324
72033c14 325Perl was originally a language optimized for scanning arbitrary
a0d0e21e 326text files, extracting information from those text files, and printing
72033c14
JV
327reports based on that information. It quickly became a good language
328for many system management tasks. Over the years, Perl has grown into
b6538e4f 329a general-purpose programming language. It's widely used for everything
72033c14
JV
330from quick "one-liners" to full-scale application development.
331
332The language is intended to be practical (easy to use, efficient,
c1264fa8
RS
333complete) rather than beautiful (tiny, elegant, minimal). It combines
334(in the author's opinion, anyway) some of the best features of B<sed>,
0e7bd06d 335B<awk>, and B<sh>, making it familiar and easy to use for Unix users to
c1264fa8
RS
336whip up quick solutions to annoying problems. Its general-purpose
337programming facilities support procedural, functional, and
338object-oriented programming paradigms, making Perl a comfortable
339language for the long haul on major projects, whatever your bent.
340
341Perl's roots in text processing haven't been forgotten over the years.
342It still boasts some of the most powerful regular expressions to be
343found anywhere, and its support for Unicode text is world-class. It
344handles all kinds of structured text, too, through an extensive
345collection of extensions. Those libraries, collected in the CPAN,
346provide ready-made solutions to an astounding array of problems. When
347they haven't set the standard themselves, they steal from the best
348-- just like Perl itself.
a0d0e21e 349
8e465e4e
JH
350=head1 AVAILABILITY
351
14218588 352Perl is available for most operating systems, including virtually
055fd3a9
GS
353all Unix-like platforms. See L<perlport/"Supported Platforms">
354for a listing.
8bc4a6bb 355
a0d0e21e
LW
356=head1 ENVIRONMENT
357
1e422769 358See L<perlrun>.
a0d0e21e
LW
359
360=head1 AUTHOR
361
19799a22 362Larry Wall <larry@wall.org>, with the help of oodles of other folks.
a0d0e21e 363
a99b1639
TP
364If your Perl success stories and testimonials may be of help to others
365who wish to advocate the use of Perl in their applications,
366or if you wish to simply express your gratitude to Larry and the
19799a22 367Perl developers, please write to perl-thanks@perl.org .
a99b1639 368
a0d0e21e
LW
369=head1 FILES
370
5f05dabc 371 "@INC" locations of perl libraries
a0d0e21e 372
5290b67b
DH
373"@INC" above is a reference to the built-in variable of the same name;
374see L<perlvar> for more information.
375
a0d0e21e
LW
376=head1 SEE ALSO
377
e6fbcce1
KL
378 https://www.perl.org/ the Perl homepage
379 https://www.perl.com/ Perl articles
380 https://www.cpan.org/ the Comprehensive Perl Archive
381 https://www.pm.org/ the Perl Mongers
19799a22 382
a0d0e21e
LW
383=head1 DIAGNOSTICS
384
71b5b092
SF
385Using the C<use strict> pragma ensures that all variables are properly
386declared and prevents other misuses of legacy Perl features.
387
6753a9e9
SF
388The C<use warnings> pragma produces some lovely diagnostics. One can
389also use the B<-w> flag, but its use is normally discouraged, because
390it gets applied to all executed Perl code, including that not under
391your control.
a0d0e21e 392
5a964f20
TC
393See L<perldiag> for explanations of all Perl's diagnostics. The C<use
394diagnostics> pragma automatically turns Perl's normally terse warnings
395and errors into these longer forms.
a0d0e21e
LW
396
397Compilation errors will tell you the line number of the error, with an
398indication of the next token or token type that was to be examined.
14218588 399(In a script passed to Perl via B<-e> switches, each
a0d0e21e
LW
400B<-e> is counted as one line.)
401
402Setuid scripts have additional constraints that can produce error
403messages such as "Insecure dependency". See L<perlsec>.
404
71b5b092
SF
405Did we mention that you should definitely consider using the B<use warnings>
406pragma?
a0d0e21e
LW
407
408=head1 BUGS
409
71b5b092 410The behavior implied by the B<use warnings> pragma is not mandatory.
a0d0e21e
LW
411
412Perl is at the mercy of your machine's definitions of various
1b3f7d21
CS
413operations such as type casting, atof(), and floating-point
414output with sprintf().
a0d0e21e 415
748a9306 416If your stdio requires a seek or eof between reads and writes on a
a0d0e21e
LW
417particular stream, so does Perl. (This doesn't apply to sysread()
418and syswrite().)
419
420While none of the built-in data types have any arbitrary size limits
421(apart from memory size), there are still a few arbitrary limits: a
a30ac152
GS
422given variable name may not be longer than 251 characters. Line numbers
423displayed by diagnostics are internally stored as short integers,
424so they are limited to a maximum of 65535 (higher numbers usually being
425affected by wraparound).
a0d0e21e 426
b0607b7a 427You may mail your bug reports (be sure to include full configuration
19799a22 428information as output by the myconfig program in the perl source
7f2de2d2 429tree, or by C<perl -V>) to perlbug@perl.org . If you've succeeded
7f89f796 430in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
19799a22 431can be used to help mail in a bug report.
4633a7c4 432
a0d0e21e
LW
433Perl actually stands for Pathologically Eclectic Rubbish Lister, but
434don't tell anyone I said that.
435
436=head1 NOTES
437
438The Perl motto is "There's more than one way to do it." Divining
439how many more is left as an exercise to the reader.
440
4633a7c4 441The three principal virtues of a programmer are Laziness,
a0d0e21e 442Impatience, and Hubris. See the Camel Book for why.
16d20bd9 443