Commit | Line | Data |
a0d0e21e |
1 | =head1 NAME |
2 | |
3 | perl - Practical Extraction and Report Language |
4 | |
5 | =head1 SYNOPSIS |
6 | |
df451b2a |
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<-A>[I<module>][=I<assertions>] ]> |
13 | S<[ B<-C [I<number/list>] >]> |
14 | S<[ B<-P> ]> |
15 | S<[ B<-S> ]> |
16 | S<[ B<-x>[I<dir>] ]> |
17 | S<[ B<-i>[I<extension>] ]> |
18 | S<[ B<-e> I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...> |
c07a80fd |
19 | |
10151d09 |
20 | If you're new to Perl, you should start with L<perlintro>, which is a |
21 | general intro for beginners and provides some background to help you |
22 | navigate the rest of Perl's extensive documentation. |
23 | |
24 | For ease of access, the Perl manual has been split up into several sections. |
a0d0e21e |
25 | |
fd7b6849 |
26 | =head2 Overview |
27 | |
fb9cefb4 |
28 | perl Perl overview (this section) |
10151d09 |
29 | perlintro Perl introduction for beginners |
fb9cefb4 |
30 | perltoc Perl documentation table of contents |
760ac839 |
31 | |
fd7b6849 |
32 | =head2 Tutorials |
33 | |
7a2320f0 |
34 | perlreftut Perl references short introduction |
35 | perldsc Perl data structures intro |
36 | perllol Perl data structures: arrays of arrays |
7a2320f0 |
37 | |
41630250 |
38 | perlrequick Perl regular expressions quick start |
7a2320f0 |
39 | perlretut Perl regular expressions tutorial |
40 | |
41 | perlboot Perl OO tutorial for beginners |
42 | perltoot Perl OO tutorial, part 1 |
43 | perltooc Perl OO tutorial, part 2 |
44 | perlbot Perl OO tricks and examples |
45 | |
46 | perlstyle Perl style guide |
47 | |
41630250 |
48 | perlcheat Perl cheat sheet |
7a2320f0 |
49 | perltrap Perl traps for the unwary |
50 | perldebtut Perl debugging tutorial |
51 | |
fd7b6849 |
52 | perlfaq Perl frequently asked questions |
53 | perlfaq1 General Questions About Perl |
54 | perlfaq2 Obtaining and Learning about Perl |
55 | perlfaq3 Programming Tools |
56 | perlfaq4 Data Manipulation |
57 | perlfaq5 Files and Formats |
58 | perlfaq6 Regexes |
59 | perlfaq7 Perl Language Issues |
60 | perlfaq8 System Interaction |
61 | perlfaq9 Networking |
0f542199 |
62 | |
fd7b6849 |
63 | =head2 Reference Manual |
413510b3 |
64 | |
fb9cefb4 |
65 | perlsyn Perl syntax |
4755096e |
66 | perldata Perl data structures |
fb9cefb4 |
67 | perlop Perl operators and precedence |
c2e66d9e |
68 | perlsub Perl subroutines |
fd7b6849 |
69 | perlfunc Perl built-in functions |
413510b3 |
70 | perlopentut Perl open() tutorial |
41630250 |
71 | perlpacktut Perl pack() and unpack() tutorial |
c2e66d9e |
72 | perlpod Perl plain old documentation |
41630250 |
73 | perlpodspec Perl plain old documentation format specification |
c2e66d9e |
74 | perlrun Perl execution and options |
75 | perldiag Perl diagnostic messages |
41630250 |
76 | perllexwarn Perl warnings and their control |
4755096e |
77 | perldebug Perl debugging |
fb9cefb4 |
78 | perlvar Perl predefined variables |
4755096e |
79 | perlre Perl regular expressions, the rest of the story |
30487ceb |
80 | perlreref Perl regular expressions quick reference |
d396a558 |
81 | perlref Perl references, the rest of the story |
fb9cefb4 |
82 | perlform Perl formats |
d396a558 |
83 | perlobj Perl objects |
d396a558 |
84 | perltie Perl objects hidden behind simple variables |
fd7b6849 |
85 | perldbmfilter Perl DBM filters |
760ac839 |
86 | |
c2e66d9e |
87 | perlipc Perl interprocess communication |
88 | perlfork Perl fork() information |
89 | perlnumber Perl number semantics |
53d7eaa8 |
90 | |
c2e66d9e |
91 | perlthrtut Perl threads tutorial |
41630250 |
92 | perlothrtut Old Perl threads tutorial |
c2e66d9e |
93 | |
94 | perlport Perl portability guide |
d396a558 |
95 | perllocale Perl locale support |
07fcf8ff |
96 | perluniintro Perl Unicode introduction |
41630250 |
97 | perlunicode Perl Unicode support |
d396a558 |
98 | perlebcdic Considerations for running Perl on EBCDIC platforms |
c2e66d9e |
99 | |
d396a558 |
100 | perlsec Perl security |
4755096e |
101 | |
c2e66d9e |
102 | perlmod Perl modules: how they work |
35bf961c |
103 | perlmodlib Perl modules: how to write and use |
104 | perlmodstyle Perl modules: how to write modules with style |
fd7b6849 |
105 | perlmodinstall Perl modules: how to install from CPAN |
c2e66d9e |
106 | perlnewmod Perl modules: preparing a new module for distribution |
760ac839 |
107 | |
fd7b6849 |
108 | perlutil utilities packaged with the Perl distribution |
760ac839 |
109 | |
41630250 |
110 | perlcompile Perl compiler suite intro |
760ac839 |
111 | |
fd7b6849 |
112 | perlfilter Perl source filters |
113 | |
97a1d740 |
114 | perlglossary Perl Glossary |
115 | |
fd7b6849 |
116 | =head2 Internals and C Language Interface |
117 | |
fb9cefb4 |
118 | perlembed Perl ways to embed perl in your C or C++ application |
41630250 |
119 | perldebguts Perl debugging guts and tips |
fb9cefb4 |
120 | perlxstut Perl XS tutorial |
4755096e |
121 | perlxs Perl XS application programming interface |
f40a6c71 |
122 | perlclib Internal replacements for standard C library functions |
fb9cefb4 |
123 | perlguts Perl internal functions for those doing extensions |
124 | perlcall Perl calling conventions from C |
fd7b6849 |
125 | |
954c1994 |
126 | perlapi Perl API listing (autogenerated) |
127 | perlintern Perl internal functions (autogenerated) |
dc5c060f |
128 | perliol C API for Perl's implementation of IO in Layers |
4755096e |
129 | perlapio Perl internal IO abstraction interface |
fd7b6849 |
130 | |
e8cd7eae |
131 | perlhack Perl hackers guide |
4755096e |
132 | |
fd7b6849 |
133 | =head2 Miscellaneous |
134 | |
135 | perlbook Perl book information |
fd7b6849 |
136 | perltodo Perl things to do |
137 | |
2a551100 |
138 | perldoc Look up Perl documentation in Pod format |
139 | |
fb9cefb4 |
140 | perlhist Perl history records |
4755096e |
141 | perldelta Perl changes since previous version |
496c75d0 |
142 | perl592delta Perl changes in version 5.9.2 |
e0eb806d |
143 | perl591delta Perl changes in version 5.9.1 |
1400179b |
144 | perl590delta Perl changes in version 5.9.0 |
315ba985 |
145 | perl587delta Perl changes in version 5.8.7 |
e4bb216d |
146 | perl586delta Perl changes in version 5.8.6 |
07e9b5fe |
147 | perl585delta Perl changes in version 5.8.5 |
5f15c94e |
148 | perl584delta Perl changes in version 5.8.4 |
2e038148 |
149 | perl583delta Perl changes in version 5.8.3 |
150 | perl582delta Perl changes in version 5.8.2 |
b6235c4f |
151 | perl581delta Perl changes in version 5.8.1 |
2e038148 |
152 | perl58delta Perl changes in version 5.8.0 |
77b096b5 |
153 | perl573delta Perl changes in version 5.7.3 |
245d750e |
154 | perl572delta Perl changes in version 5.7.2 |
1db9e106 |
155 | perl571delta Perl changes in version 5.7.1 |
156 | perl570delta Perl changes in version 5.7.0 |
493a87da |
157 | perl561delta Perl changes in version 5.6.1 |
41630250 |
158 | perl56delta Perl changes in version 5.6 |
4755096e |
159 | perl5005delta Perl changes in version 5.005 |
160 | perl5004delta Perl changes in version 5.004 |
d516a115 |
161 | |
2a551100 |
162 | perlartistic Perl Artistic License |
163 | perlgpl GNU General Public License |
164 | |
d8416318 |
165 | =head2 Language-Specific |
166 | |
167 | perlcn Perl for Simplified Chinese (in EUC-CN) |
168 | perljp Perl for Japanese (in EUC-JP) |
169 | perlko Perl for Korean (in EUC-KR) |
170 | perltw Perl for Traditional Chinese (in Big5) |
171 | |
fd7b6849 |
172 | =head2 Platform-Specific |
173 | |
37d4d706 |
174 | perlaix Perl notes for AIX |
a83b6f46 |
175 | perlamiga Perl notes for AmigaOS |
176 | perlapollo Perl notes for Apollo DomainOS |
177 | perlbeos Perl notes for BeOS |
dc5c060f |
178 | perlbs2000 Perl notes for POSIX-BC BS2000 |
a1f19229 |
179 | perlce Perl notes for WinCE |
49877630 |
180 | perlcygwin Perl notes for Cygwin |
245d750e |
181 | perldgux Perl notes for DG/UX |
49877630 |
182 | perldos Perl notes for DOS |
9a997319 |
183 | perlepoc Perl notes for EPOC |
41630250 |
184 | perlfreebsd Perl notes for FreeBSD |
49877630 |
185 | perlhpux Perl notes for HP-UX |
a83b6f46 |
186 | perlhurd Perl notes for Hurd |
469e7be4 |
187 | perlirix Perl notes for Irix |
991e8403 |
188 | perllinux Perl notes for Linux |
41630250 |
189 | perlmachten Perl notes for Power MachTen |
26d9b02f |
190 | perlmacos Perl notes for Mac OS (Classic) |
0d53b15f |
191 | perlmacosx Perl notes for Mac OS X |
a83b6f46 |
192 | perlmint Perl notes for MiNT |
ab648d5e |
193 | perlmpeix Perl notes for MPE/iX |
41630250 |
194 | perlnetware Perl notes for NetWare |
b0846812 |
195 | perlopenbsd Perl notes for OpenBSD |
49877630 |
196 | perlos2 Perl notes for OS/2 |
197 | perlos390 Perl notes for OS/390 |
522b859a |
198 | perlos400 Perl notes for OS/400 |
a83b6f46 |
199 | perlplan9 Perl notes for Plan 9 |
200 | perlqnx Perl notes for QNX |
d420ca49 |
201 | perlsolaris Perl notes for Solaris |
27da23d5 |
202 | perlsymbian Perl notes for Symbian |
772ff3b9 |
203 | perltru64 Perl notes for Tru64 |
41630250 |
204 | perluts Perl notes for UTS |
cbe1151c |
205 | perlvmesa Perl notes for VM/ESA |
49877630 |
206 | perlvms Perl notes for VMS |
9a997319 |
207 | perlvos Perl notes for Stratus VOS |
49877630 |
208 | perlwin32 Perl notes for Windows |
209 | |
a0d0e21e |
210 | |
19799a22 |
211 | By default, the manpages listed above are installed in the |
fc952dec |
212 | F</usr/local/man/> directory. |
213 | |
214 | Extensive additional documentation for Perl modules is available. The |
215 | default configuration for perl will place this additional documentation |
216 | in the F</usr/local/lib/perl5/man> directory (or else in the F<man> |
217 | subdirectory of the Perl library directory). Some of this additional |
218 | documentation is distributed standard with Perl, but you'll also find |
219 | documentation for third-party modules there. |
220 | |
221 | You should be able to view Perl's documentation with your man(1) |
222 | program by including the proper directories in the appropriate start-up |
223 | files, or in the MANPATH environment variable. To find out where the |
224 | configuration has installed the manpages, type: |
16d20bd9 |
225 | |
760ac839 |
226 | perl -V:man.dir |
16d20bd9 |
227 | |
fc952dec |
228 | If the directories have a common stem, such as F</usr/local/man/man1> |
229 | and F</usr/local/man/man3>, you need only to add that stem |
230 | (F</usr/local/man>) to your man(1) configuration files or your MANPATH |
231 | environment variable. If they do not share a stem, you'll have to add |
232 | both stems. |
16d20bd9 |
233 | |
234 | If that doesn't work for some reason, you can still use the |
4633a7c4 |
235 | supplied F<perldoc> script to view module information. You might |
236 | also look into getting a replacement man program. |
16d20bd9 |
237 | |
a0d0e21e |
238 | If something strange has gone wrong with your program and you're not |
239 | sure where you should look for help, try the B<-w> switch first. It |
240 | will often point out exactly where the trouble is. |
241 | |
242 | =head1 DESCRIPTION |
243 | |
5f05dabc |
244 | Perl is a language optimized for scanning arbitrary |
a0d0e21e |
245 | text files, extracting information from those text files, and printing |
246 | reports based on that information. It's also a good language for many |
247 | system management tasks. The language is intended to be practical |
248 | (easy to use, efficient, complete) rather than beautiful (tiny, |
94d58c47 |
249 | elegant, minimal). |
250 | |
aa689395 |
251 | Perl combines (in the author's opinion, anyway) some of the best |
252 | features of C, B<sed>, B<awk>, and B<sh>, so people familiar with |
253 | those languages should have little difficulty with it. (Language |
254 | historians will also note some vestiges of B<csh>, Pascal, and even |
14218588 |
255 | BASIC-PLUS.) Expression syntax corresponds closely to C |
a0d0e21e |
256 | expression syntax. Unlike most Unix utilities, Perl does not |
257 | arbitrarily limit the size of your data--if you've got the memory, |
aa689395 |
258 | Perl can slurp in your whole file as a single string. Recursion is of |
0f31cffe |
259 | unlimited depth. And the tables used by hashes (sometimes called |
aa689395 |
260 | "associative arrays") grow as necessary to prevent degraded |
0f31cffe |
261 | performance. Perl can use sophisticated pattern matching techniques to |
14218588 |
262 | scan large amounts of data quickly. Although optimized for |
aa689395 |
263 | scanning text, Perl can also deal with binary data, and can make dbm |
264 | files look like hashes. Setuid Perl scripts are safer than C programs |
14218588 |
265 | through a dataflow tracing mechanism that prevents many stupid |
aa689395 |
266 | security holes. |
267 | |
268 | If you have a problem that would ordinarily use B<sed> or B<awk> or |
269 | B<sh>, but it exceeds their capabilities or must run a little faster, |
270 | and you don't want to write the silly thing in C, then Perl may be for |
271 | you. There are also translators to turn your B<sed> and B<awk> |
272 | scripts into Perl scripts. |
a0d0e21e |
273 | |
274 | But wait, there's more... |
275 | |
19799a22 |
276 | Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete |
277 | rewrite that provides the following additional benefits: |
a0d0e21e |
278 | |
13a2d996 |
279 | =over 4 |
a0d0e21e |
280 | |
551e1d92 |
281 | =item * |
282 | |
283 | modularity and reusability using innumerable modules |
a0d0e21e |
284 | |
19799a22 |
285 | Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>. |
a0d0e21e |
286 | |
551e1d92 |
287 | =item * |
288 | |
289 | embeddable and extensible |
a0d0e21e |
290 | |
19799a22 |
291 | Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>, |
292 | L<perlguts>, and L<xsubpp>. |
a0d0e21e |
293 | |
551e1d92 |
294 | =item * |
295 | |
63de3cb2 |
296 | roll-your-own magic variables (including multiple simultaneous DBM |
297 | implementations) |
a0d0e21e |
298 | |
19799a22 |
299 | Described in L<perltie> and L<AnyDBM_File>. |
a0d0e21e |
300 | |
551e1d92 |
301 | =item * |
302 | |
303 | subroutines can now be overridden, autoloaded, and prototyped |
a0d0e21e |
304 | |
19799a22 |
305 | Described in L<perlsub>. |
a0d0e21e |
306 | |
551e1d92 |
307 | =item * |
308 | |
309 | arbitrarily nested data structures and anonymous functions |
a0d0e21e |
310 | |
19799a22 |
311 | Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>. |
a0d0e21e |
312 | |
551e1d92 |
313 | =item * |
314 | |
315 | object-oriented programming |
a0d0e21e |
316 | |
f6b3c421 |
317 | Described in L<perlobj>, L<perlboot>, L<perltoot>, L<perltooc>, |
318 | and L<perlbot>. |
a0d0e21e |
319 | |
551e1d92 |
320 | =item * |
321 | |
551e1d92 |
322 | support for light-weight processes (threads) |
a0d0e21e |
323 | |
63de3cb2 |
324 | Described in L<perlthrtut> and L<threads>. |
a0d0e21e |
325 | |
551e1d92 |
326 | =item * |
327 | |
63de3cb2 |
328 | support for Unicode, internationalization, and localization |
a0d0e21e |
329 | |
63de3cb2 |
330 | Described in L<perluniintro>, L<perllocale> and L<Locale::Maketext>. |
a0d0e21e |
331 | |
551e1d92 |
332 | =item * |
333 | |
334 | lexical scoping |
a0d0e21e |
335 | |
19799a22 |
336 | Described in L<perlsub>. |
a0d0e21e |
337 | |
551e1d92 |
338 | =item * |
339 | |
340 | regular expression enhancements |
a0d0e21e |
341 | |
19799a22 |
342 | Described in L<perlre>, with additional examples in L<perlop>. |
a0d0e21e |
343 | |
551e1d92 |
344 | =item * |
345 | |
346 | enhanced debugger and interactive Perl environment, |
347 | with integrated editor support |
a0d0e21e |
348 | |
f6b3c421 |
349 | Described in L<perldebtut>, L<perldebug> and L<perldebguts>. |
a0d0e21e |
350 | |
551e1d92 |
351 | =item * |
352 | |
353 | POSIX 1003.1 compliant library |
5f05dabc |
354 | |
19799a22 |
355 | Described in L<POSIX>. |
5f05dabc |
356 | |
a0d0e21e |
357 | =back |
358 | |
68dc0745 |
359 | Okay, that's I<definitely> enough hype. |
a0d0e21e |
360 | |
8e465e4e |
361 | =head1 AVAILABILITY |
362 | |
14218588 |
363 | Perl is available for most operating systems, including virtually |
055fd3a9 |
364 | all Unix-like platforms. See L<perlport/"Supported Platforms"> |
365 | for a listing. |
8bc4a6bb |
366 | |
a0d0e21e |
367 | =head1 ENVIRONMENT |
368 | |
1e422769 |
369 | See L<perlrun>. |
a0d0e21e |
370 | |
371 | =head1 AUTHOR |
372 | |
19799a22 |
373 | Larry Wall <larry@wall.org>, with the help of oodles of other folks. |
a0d0e21e |
374 | |
a99b1639 |
375 | If your Perl success stories and testimonials may be of help to others |
376 | who wish to advocate the use of Perl in their applications, |
377 | or if you wish to simply express your gratitude to Larry and the |
19799a22 |
378 | Perl developers, please write to perl-thanks@perl.org . |
a99b1639 |
379 | |
a0d0e21e |
380 | =head1 FILES |
381 | |
5f05dabc |
382 | "@INC" locations of perl libraries |
a0d0e21e |
383 | |
384 | =head1 SEE ALSO |
385 | |
386 | a2p awk to perl translator |
387 | s2p sed to perl translator |
388 | |
c5f69108 |
389 | http://www.perl.org/ the Perl homepage |
da9e6348 |
390 | http://www.perl.com/ Perl articles (O'Reilly) |
f6b3c421 |
391 | http://www.cpan.org/ the Comprehensive Perl Archive |
c5f69108 |
392 | http://www.pm.org/ the Perl Mongers |
19799a22 |
393 | |
a0d0e21e |
394 | =head1 DIAGNOSTICS |
395 | |
9f1b1f2d |
396 | The C<use warnings> pragma (and the B<-w> switch) produces some |
397 | lovely diagnostics. |
a0d0e21e |
398 | |
5a964f20 |
399 | See L<perldiag> for explanations of all Perl's diagnostics. The C<use |
400 | diagnostics> pragma automatically turns Perl's normally terse warnings |
401 | and errors into these longer forms. |
a0d0e21e |
402 | |
403 | Compilation errors will tell you the line number of the error, with an |
404 | indication of the next token or token type that was to be examined. |
14218588 |
405 | (In a script passed to Perl via B<-e> switches, each |
a0d0e21e |
406 | B<-e> is counted as one line.) |
407 | |
408 | Setuid scripts have additional constraints that can produce error |
409 | messages such as "Insecure dependency". See L<perlsec>. |
410 | |
411 | Did we mention that you should definitely consider using the B<-w> |
412 | switch? |
413 | |
414 | =head1 BUGS |
415 | |
416 | The B<-w> switch is not mandatory. |
417 | |
418 | Perl is at the mercy of your machine's definitions of various |
1b3f7d21 |
419 | operations such as type casting, atof(), and floating-point |
420 | output with sprintf(). |
a0d0e21e |
421 | |
748a9306 |
422 | If your stdio requires a seek or eof between reads and writes on a |
a0d0e21e |
423 | particular stream, so does Perl. (This doesn't apply to sysread() |
424 | and syswrite().) |
425 | |
426 | While none of the built-in data types have any arbitrary size limits |
427 | (apart from memory size), there are still a few arbitrary limits: a |
a30ac152 |
428 | given variable name may not be longer than 251 characters. Line numbers |
429 | displayed by diagnostics are internally stored as short integers, |
430 | so they are limited to a maximum of 65535 (higher numbers usually being |
431 | affected by wraparound). |
a0d0e21e |
432 | |
b0607b7a |
433 | You may mail your bug reports (be sure to include full configuration |
19799a22 |
434 | information as output by the myconfig program in the perl source |
7f2de2d2 |
435 | tree, or by C<perl -V>) to perlbug@perl.org . If you've succeeded |
055fd3a9 |
436 | in compiling perl, the B<perlbug> script in the F<utils/> subdirectory |
19799a22 |
437 | can be used to help mail in a bug report. |
4633a7c4 |
438 | |
a0d0e21e |
439 | Perl actually stands for Pathologically Eclectic Rubbish Lister, but |
440 | don't tell anyone I said that. |
441 | |
442 | =head1 NOTES |
443 | |
444 | The Perl motto is "There's more than one way to do it." Divining |
445 | how many more is left as an exercise to the reader. |
446 | |
4633a7c4 |
447 | The three principal virtues of a programmer are Laziness, |
a0d0e21e |
448 | Impatience, and Hubris. See the Camel Book for why. |
16d20bd9 |
449 | |