This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add Synology instructions
[perl5.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 For more information on these options, you can run C<perldoc perlrun>.
19
20 =head1 GETTING HELP
21
22 The F<perldoc> program gives you access to all the documentation that comes
23 with Perl.  You can get more documentation, tutorials and community support
24 online at L<http://www.perl.org/>.
25
26 If you're new to Perl, you should start by running C<perldoc perlintro>,
27 which is a general intro for beginners and provides some background to help
28 you navigate the rest of Perl's extensive documentation.  Run C<perldoc
29 perldoc> to learn more things you can do with F<perldoc>.
30
31 For ease of access, the Perl manual has been split up into several sections.
32
33 =begin buildtoc
34
35 # This section is parsed by Porting/pod_lib.pl for use by pod/buildtoc etc
36
37 flag =g  perluniprops perlmodlib perlapi perlintern
38 flag =go perltoc
39 flag =ro perlcn perljp perlko perltw
40 flag =   perlvms
41
42 path perlfaq.*               cpan/perlfaq/lib/
43 path perlglossary            cpan/perlfaq/lib/
44 path perlxs(?:tut|typemap)?  dist/ExtUtils-ParseXS/lib/
45 path perldoc                 cpan/Pod-Perldoc/
46
47 aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
48
49 =end buildtoc
50
51 =head2 Overview
52
53     perl                Perl overview (this section)
54     perlintro           Perl introduction for beginners
55     perlrun             Perl execution and options
56     perltoc             Perl documentation table of contents
57
58 =head2 Tutorials
59
60     perlreftut          Perl references short introduction
61     perldsc             Perl data structures intro
62     perllol             Perl data structures: arrays of arrays
63
64     perlrequick         Perl regular expressions quick start
65     perlretut           Perl regular expressions tutorial
66
67     perlootut           Perl OO tutorial for beginners
68
69     perlperf            Perl Performance and Optimization Techniques
70
71     perlstyle           Perl style guide
72
73     perlcheat           Perl cheat sheet
74     perltrap            Perl traps for the unwary
75     perldebtut          Perl debugging tutorial
76
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
87
88 =head2 Reference Manual
89
90     perlsyn             Perl syntax
91     perldata            Perl data structures
92     perlop              Perl operators and precedence
93     perlsub             Perl subroutines
94     perlfunc            Perl built-in functions
95       perlopentut       Perl open() tutorial
96       perlpacktut       Perl pack() and unpack() tutorial
97     perlpod             Perl plain old documentation
98     perlpodspec         Perl plain old documentation format specification
99     perlpodstyle        Perl POD style guide
100     perldiag            Perl diagnostic messages
101     perllexwarn         Perl warnings and their control
102     perldebug           Perl debugging
103     perlvar             Perl predefined variables
104     perlre              Perl regular expressions, the rest of the story
105     perlrebackslash     Perl regular expression backslash sequences
106     perlrecharclass     Perl regular expression character classes
107     perlreref           Perl regular expressions quick reference
108     perlref             Perl references, the rest of the story
109     perlform            Perl formats
110     perlobj             Perl objects
111     perltie             Perl objects hidden behind simple variables
112       perldbmfilter     Perl DBM filters
113
114     perlipc             Perl interprocess communication
115     perlfork            Perl fork() information
116     perlnumber          Perl number semantics
117
118     perlthrtut          Perl threads tutorial
119
120     perlport            Perl portability guide
121     perllocale          Perl locale support
122     perluniintro        Perl Unicode introduction
123     perlunicode         Perl Unicode support
124     perlunifaq          Perl Unicode FAQ
125     perluniprops        Index of Unicode properties in Perl
126     perlunitut          Perl Unicode tutorial
127     perlebcdic          Considerations for running Perl on EBCDIC platforms
128
129     perlsec             Perl security
130
131     perlmod             Perl modules: how they work
132     perlmodlib          Perl modules: how to write and use
133     perlmodstyle        Perl modules: how to write modules with style
134     perlmodinstall      Perl modules: how to install from CPAN
135     perlnewmod          Perl modules: preparing a new module for distribution
136     perlpragma          Perl modules: writing a user pragma
137
138     perlutil            utilities packaged with the Perl distribution
139
140     perlfilter          Perl source filters
141
142     perldtrace          Perl's support for DTrace
143
144     perlglossary        Perl Glossary
145
146 =head2 Internals and C Language Interface
147
148     perlembed           Perl ways to embed perl in your C or C++ application
149     perldebguts         Perl debugging guts and tips
150     perlxstut           Perl XS tutorial
151     perlxs              Perl XS application programming interface
152     perlxstypemap       Perl XS C/Perl type conversion tools
153     perlclib            Internal replacements for standard C library functions
154     perlguts            Perl internal functions for those doing extensions
155     perlcall            Perl calling conventions from C
156     perlmroapi          Perl method resolution plugin interface
157     perlreapi           Perl regular expression plugin interface
158     perlreguts          Perl regular expression engine internals
159
160     perlapi             Perl API listing (autogenerated)
161     perlintern          Perl internal functions (autogenerated)
162     perliol             C API for Perl's implementation of IO in Layers
163     perlapio            Perl internal IO abstraction interface
164
165     perlhack            Perl hackers guide
166     perlsource          Guide to the Perl source tree
167     perlinterp          Overview of the Perl interpreter source and how it works
168     perlhacktut         Walk through the creation of a simple C code patch
169     perlhacktips        Tips for Perl core C code hacking
170     perlpolicy          Perl development policies
171     perlgit             Using git with the Perl repository
172
173 =head2 Miscellaneous
174
175     perlbook            Perl book information
176     perlcommunity       Perl community information
177
178     perldoc             Look up Perl documentation in Pod format
179
180     perlhist            Perl history records
181     perldelta           Perl changes since previous version
182     perl5195delta       Perl changes in version 5.19.5
183     perl5194delta       Perl changes in version 5.19.4
184     perl5193delta       Perl changes in version 5.19.3
185     perl5192delta       Perl changes in version 5.19.2
186     perl5191delta       Perl changes in version 5.19.1
187     perl5190delta       Perl changes in version 5.19.0
188     perl5181delta       Perl changes in version 5.18.1
189     perl5180delta       Perl changes in version 5.18.0
190     perl5161delta       Perl changes in version 5.16.1
191     perl5162delta       Perl changes in version 5.16.2
192     perl5163delta       Perl changes in version 5.16.3
193     perl5160delta       Perl changes in version 5.16.0
194     perl5144delta       Perl changes in version 5.14.4
195     perl5143delta       Perl changes in version 5.14.3
196     perl5142delta       Perl changes in version 5.14.2
197     perl5141delta       Perl changes in version 5.14.1
198     perl5140delta       Perl changes in version 5.14.0
199     perl5125delta       Perl changes in version 5.12.5
200     perl5124delta       Perl changes in version 5.12.4
201     perl5123delta       Perl changes in version 5.12.3
202     perl5122delta       Perl changes in version 5.12.2
203     perl5121delta       Perl changes in version 5.12.1
204     perl5120delta       Perl changes in version 5.12.0
205     perl5101delta       Perl changes in version 5.10.1
206     perl5100delta       Perl changes in version 5.10.0
207     perl589delta        Perl changes in version 5.8.9
208     perl588delta        Perl changes in version 5.8.8
209     perl587delta        Perl changes in version 5.8.7
210     perl586delta        Perl changes in version 5.8.6
211     perl585delta        Perl changes in version 5.8.5
212     perl584delta        Perl changes in version 5.8.4
213     perl583delta        Perl changes in version 5.8.3
214     perl582delta        Perl changes in version 5.8.2
215     perl581delta        Perl changes in version 5.8.1
216     perl58delta         Perl changes in version 5.8.0
217     perl561delta        Perl changes in version 5.6.1
218     perl56delta         Perl changes in version 5.6
219     perl5005delta       Perl changes in version 5.005
220     perl5004delta       Perl changes in version 5.004
221
222     perlexperiment      A listing of experimental features in Perl
223
224     perlartistic        Perl Artistic License
225     perlgpl             GNU General Public License
226
227 =head2 Language-Specific
228
229 =for buildtoc flag +r
230
231     perlcn              Perl for Simplified Chinese (in EUC-CN)
232     perljp              Perl for Japanese (in EUC-JP)
233     perlko              Perl for Korean (in EUC-KR)
234     perltw              Perl for Traditional Chinese (in Big5)
235
236 =head2 Platform-Specific
237
238     perlaix             Perl notes for AIX
239     perlamiga           Perl notes for AmigaOS
240     perlbs2000          Perl notes for POSIX-BC BS2000
241     perlce              Perl notes for WinCE
242     perlcygwin          Perl notes for Cygwin
243     perldos             Perl notes for DOS
244     perlfreebsd         Perl notes for FreeBSD
245     perlhaiku           Perl notes for Haiku
246     perlhpux            Perl notes for HP-UX
247     perlhurd            Perl notes for Hurd
248     perlirix            Perl notes for Irix
249     perllinux           Perl notes for Linux
250     perlmacos           Perl notes for Mac OS (Classic)
251     perlmacosx          Perl notes for Mac OS X
252     perlnetware         Perl notes for NetWare
253     perlopenbsd         Perl notes for OpenBSD
254     perlos2             Perl notes for OS/2
255     perlos390           Perl notes for OS/390
256     perlos400           Perl notes for OS/400
257     perlplan9           Perl notes for Plan 9
258     perlqnx             Perl notes for QNX
259     perlriscos          Perl notes for RISC OS
260     perlsolaris         Perl notes for Solaris
261     perlsymbian         Perl notes for Symbian
262     perlsynology        Perl notes for Synology
263     perltru64           Perl notes for Tru64
264     perlvms             Perl notes for VMS
265     perlvos             Perl notes for Stratus VOS
266     perlwin32           Perl notes for Windows
267
268 =for buildtoc flag -r
269
270 =head2 Stubs for Deleted Documents
271
272     perlboot            
273     perlbot             
274     perlrepository
275     perltodo
276     perltooc            
277     perltoot            
278
279 =for buildtoc __END__
280
281 On a Unix-like system, these documentation files will usually also be
282 available as manpages for use with the F<man> program.
283
284 Some documentation is not available as man pages, so if a
285 cross-reference is not found by man, try it with L<perldoc>.  Perldoc can
286 also take you directly to documentation for functions (with the B<-f>
287 switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>)
288 for other helpful options L<perldoc> has to offer.
289
290 In general, if something strange has gone wrong with your program and you're
291 not sure where you should look for help, try making your code comply with
292 B<use strict> and B<use warnings>.  These will often point out exactly
293 where the trouble is.
294
295 =head1 DESCRIPTION
296
297 Perl officially stands for Practical Extraction and Report Language,
298 except when it doesn't.
299
300 Perl was originally a language optimized for scanning arbitrary
301 text files, extracting information from those text files, and printing
302 reports based on that information.  It quickly became a good language
303 for many system management tasks. Over the years, Perl has grown into
304 a general-purpose programming language. It's widely used for everything
305 from quick "one-liners" to full-scale application development.
306
307 The language is intended to be practical (easy to use, efficient,
308 complete) rather than beautiful (tiny, elegant, minimal).  It combines
309 (in the author's opinion, anyway) some of the best features of B<sed>,
310 B<awk>, and B<sh>, making it familiar and easy to use for Unix users to
311 whip up quick solutions to annoying problems.  Its general-purpose
312 programming facilities support procedural, functional, and
313 object-oriented programming paradigms, making Perl a comfortable
314 language for the long haul on major projects, whatever your bent.
315
316 Perl's roots in text processing haven't been forgotten over the years.
317 It still boasts some of the most powerful regular expressions to be
318 found anywhere, and its support for Unicode text is world-class.  It
319 handles all kinds of structured text, too, through an extensive
320 collection of extensions.  Those libraries, collected in the CPAN,
321 provide ready-made solutions to an astounding array of problems.  When
322 they haven't set the standard themselves, they steal from the best
323 -- just like Perl itself.
324
325 =head1 AVAILABILITY
326
327 Perl is available for most operating systems, including virtually
328 all Unix-like platforms.  See L<perlport/"Supported Platforms">
329 for a listing.
330
331 =head1 ENVIRONMENT
332
333 See L<perlrun>.
334
335 =head1 AUTHOR
336
337 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
338
339 If your Perl success stories and testimonials may be of help to others 
340 who wish to advocate the use of Perl in their applications, 
341 or if you wish to simply express your gratitude to Larry and the 
342 Perl developers, please write to perl-thanks@perl.org .
343
344 =head1 FILES
345
346  "@INC"                 locations of perl libraries
347
348 =head1 SEE ALSO
349
350  http://www.perl.org/       the Perl homepage
351  http://www.perl.com/       Perl articles (O'Reilly)
352  http://www.cpan.org/       the Comprehensive Perl Archive
353  http://www.pm.org/         the Perl Mongers
354
355 =head1 DIAGNOSTICS
356
357 Using the C<use strict> pragma ensures that all variables are properly
358 declared and prevents other misuses of legacy Perl features.
359
360 The C<use warnings> pragma produces some lovely diagnostics. One can
361 also use the B<-w> flag, but its use is normally discouraged, because
362 it gets applied to all executed Perl code, including that not under
363 your control.
364
365 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
366 diagnostics> pragma automatically turns Perl's normally terse warnings
367 and errors into these longer forms.
368
369 Compilation errors will tell you the line number of the error, with an
370 indication of the next token or token type that was to be examined.
371 (In a script passed to Perl via B<-e> switches, each
372 B<-e> is counted as one line.)
373
374 Setuid scripts have additional constraints that can produce error
375 messages such as "Insecure dependency".  See L<perlsec>.
376
377 Did we mention that you should definitely consider using the B<use warnings>
378 pragma?
379
380 =head1 BUGS
381
382 The behavior implied by the B<use warnings> pragma is not mandatory.
383
384 Perl is at the mercy of your machine's definitions of various
385 operations such as type casting, atof(), and floating-point
386 output with sprintf().
387
388 If your stdio requires a seek or eof between reads and writes on a
389 particular stream, so does Perl.  (This doesn't apply to sysread()
390 and syswrite().)
391
392 While none of the built-in data types have any arbitrary size limits
393 (apart from memory size), there are still a few arbitrary limits:  a
394 given variable name may not be longer than 251 characters.  Line numbers
395 displayed by diagnostics are internally stored as short integers,
396 so they are limited to a maximum of 65535 (higher numbers usually being
397 affected by wraparound).
398
399 You may mail your bug reports (be sure to include full configuration
400 information as output by the myconfig program in the perl source
401 tree, or by C<perl -V>) to perlbug@perl.org .  If you've succeeded
402 in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
403 can be used to help mail in a bug report.
404
405 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
406 don't tell anyone I said that.
407
408 =head1 NOTES
409
410 The Perl motto is "There's more than one way to do it."  Divining
411 how many more is left as an exercise to the reader.
412
413 The three principal virtues of a programmer are Laziness,
414 Impatience, and Hubris.  See the Camel Book for why.
415