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