be defensive about setting {host,group,pass}cat (from Andy Dougherty)
[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 For ease of access, the Perl manual has been split up into several
16 sections:
17
18     perl                Perl overview (this section)
19     perldelta           Perl changes since previous version
20     perl5005delta       Perl changes in version 5.005
21     perl5004delta       Perl changes in version 5.004
22     perlfaq             Perl frequently asked questions
23     perltoc             Perl documentation table of contents
24
25     perldata            Perl data structures
26     perlsyn             Perl syntax
27     perlop              Perl operators and precedence
28     perlre              Perl regular expressions
29     perlrun             Perl execution and options
30     perlfunc            Perl builtin functions
31     perlopentut         Perl open() tutorial
32     perlvar             Perl predefined variables
33     perlsub             Perl subroutines
34     perlmod             Perl modules: how they work
35     perlmodlib          Perl modules: how to write and use
36     perlmodinstall      Perl modules: how to install from CPAN
37     perlform            Perl formats
38     perllocale          Perl locale support
39
40     perlreftut          Perl references short introduction
41     perlref             Perl references, the rest of the story
42     perldsc             Perl data structures intro
43     perllol             Perl data structures: arrays of arrays
44     perltoot            Perl OO tutorial, part 1
45     perltootc           Perl OO tutorial, part 2
46     perlobj             Perl objects
47     perltie             Perl objects hidden behind simple variables
48     perlbot             Perl OO tricks and examples
49     perlipc             Perl interprocess communication
50     perlfork            Perl fork() information
51     perlthrtut          Perl threads tutorial
52     perldbmfilter       Perl DBM Filters
53
54     perlcompile         Perl compiler suite intro
55     perldebug           Perl debugging
56     perldiag            Perl diagnostic messages
57     perlsec             Perl security
58     perltrap            Perl traps for the unwary
59     perlport            Perl portability guide
60     perlstyle           Perl style guide
61
62     perlpod             Perl plain old documentation
63     perlbook            Perl book information
64
65     perlembed           Perl ways to embed perl in your C or C++ application
66     perlapio            Perl internal IO abstraction interface
67     perlxs              Perl XS application programming interface
68     perlxstut           Perl XS tutorial
69     perlguts            Perl internal functions for those doing extensions
70     perlcall            Perl calling conventions from C
71
72     perltodo            Perl things to do
73     perlhack            Perl hackers guide
74     perlhist            Perl history records
75
76 (If you're intending to read these straight through for the first time,
77 the suggested order will tend to reduce the number of forward references.)
78
79 By default, the manpages listed above are installed in the 
80 F</usr/local/man/> directory.  
81
82 Extensive additional documentation for Perl modules is available.  The
83 default configuration for perl will place this additional documentation
84 in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
85 subdirectory of the Perl library directory).  Some of this additional
86 documentation is distributed standard with Perl, but you'll also find
87 documentation for third-party modules there.
88
89 You should be able to view Perl's documentation with your man(1)
90 program by including the proper directories in the appropriate start-up
91 files, or in the MANPATH environment variable.  To find out where the
92 configuration has installed the manpages, type:
93
94     perl -V:man.dir
95
96 If the directories have a common stem, such as F</usr/local/man/man1>
97 and F</usr/local/man/man3>, you need only to add that stem
98 (F</usr/local/man>) to your man(1) configuration files or your MANPATH
99 environment variable.  If they do not share a stem, you'll have to add
100 both stems.
101
102 If that doesn't work for some reason, you can still use the
103 supplied F<perldoc> script to view module information.  You might
104 also look into getting a replacement man program.
105
106 If something strange has gone wrong with your program and you're not
107 sure where you should look for help, try the B<-w> switch first.  It
108 will often point out exactly where the trouble is.
109
110 =head1 DESCRIPTION
111
112 Perl is a language optimized for scanning arbitrary
113 text files, extracting information from those text files, and printing
114 reports based on that information.  It's also a good language for many
115 system management tasks.  The language is intended to be practical
116 (easy to use, efficient, complete) rather than beautiful (tiny,
117 elegant, minimal).
118
119 Perl combines (in the author's opinion, anyway) some of the best
120 features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
121 those languages should have little difficulty with it.  (Language
122 historians will also note some vestiges of B<csh>, Pascal, and even
123 BASIC-PLUS.)  Expression syntax corresponds closely to C
124 expression syntax.  Unlike most Unix utilities, Perl does not
125 arbitrarily limit the size of your data--if you've got the memory,
126 Perl can slurp in your whole file as a single string.  Recursion is of
127 unlimited depth.  And the tables used by hashes (sometimes called
128 "associative arrays") grow as necessary to prevent degraded
129 performance.  Perl can use sophisticated pattern matching techniques to
130 scan large amounts of data quickly.  Although optimized for
131 scanning text, Perl can also deal with binary data, and can make dbm
132 files look like hashes.  Setuid Perl scripts are safer than C programs
133 through a dataflow tracing mechanism that prevents many stupid
134 security holes.
135
136 If you have a problem that would ordinarily use B<sed> or B<awk> or
137 B<sh>, but it exceeds their capabilities or must run a little faster,
138 and you don't want to write the silly thing in C, then Perl may be for
139 you.  There are also translators to turn your B<sed> and B<awk>
140 scripts into Perl scripts.
141
142 But wait, there's more...
143
144 Begun in 1993 (see L<perlhist>), Perl version 5 is nearly a complete
145 rewrite that provides the following additional benefits:
146
147 =over
148
149 =item * modularity and reusability using innumerable modules 
150
151 Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
152
153 =item * embeddable and extensible 
154
155 Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
156 L<perlguts>, and L<xsubpp>.
157
158 =item * roll-your-own magic variables (including multiple simultaneous DBM implementations)
159
160 Described in L<perltie> and L<AnyDBM_File>.
161
162 =item * subroutines can now be overridden, autoloaded, and prototyped
163
164 Described in L<perlsub>.
165
166 =item * arbitrarily nested data structures and anonymous functions
167
168 Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
169
170 =item * object-oriented programming
171
172 Described in L<perlobj>, L<perltoot>, and L<perlbot>.
173
174 =item * compilability into C code or Perl bytecode
175
176 Described in L<B> and L<B::Bytecode>.
177
178 =item * support for light-weight processes (threads)
179
180 Described in L<perlthrtut> and L<Thread>.
181
182 =item * support for internationalization, localization, and Unicode 
183
184 Described in L<perllocale> and L<utf8>.
185
186 =item * lexical scoping
187
188 Described in L<perlsub>.
189
190 =item * regular expression enhancements
191
192 Described in L<perlre>, with additional examples in L<perlop>.
193
194 =item * enhanced debugger and interactive Perl environment, with integrated editor support
195
196 Described in L<perldebug>.
197
198 =item * POSIX 1003.1 compliant library
199
200 Described in L<POSIX>.
201
202 =back
203
204 Okay, that's I<definitely> enough hype.
205
206 =head1 AVAILABILITY
207
208 Perl is available for most operating systems, including virtually
209 all Unix-like platforms.
210
211 As of May 1999, the following platforms are able to build Perl
212 from the standard source code distribution available at
213 http://www.perl.com/CPAN/src/index.html
214
215         AIX             Linux           SCO ODT/OSR
216         A/UX            MachTen         Solaris
217         BeOS            MPE/iX          SunOS
218         BSD/OS          NetBSD          SVR4
219         DG/UX           NextSTEP        Tru64 UNIX      3)
220         DomainOS        OpenBSD         Ultrix                  
221         DOS DJGPP 1)    OpenSTEP        UNICOS                  
222         DYNIX/ptx       OS/2            VMS                     
223         FreeBSD         OS390     2)    VOS 
224         HP-UX           PowerMAX        Windows 3.1     1)      
225         Hurd            QNX             Windows 95      1) 4)   
226         IRIX                            Windows 98      1) 4)   
227                                         Windows NT      1) 4)
228
229         1) in DOS mode either the DOS or OS/2 ports can be used
230         2) formerly known as MVS
231         3) formerly known as Digital UNIX and before that DEC OSF/1     
232         4) compilers: Borland, Cygwin, Mingw32 EGCS/GCC, VC++
233                                         
234 The following platforms have been known to build Perl from source,
235 but we haven't been able to verify their status for the current release,
236 either because the hardware/software platforms are rare or
237 because we don't have an active champion on these platforms--or both.
238                                         
239         3b1             FPS             Plan 9
240         AmigaOS         GENIX           PowerUX
241         ConvexOS        Greenhills      RISC/os         
242         CX/UX           ISC             Stellar         
243         DC/OSx          MachTen 68k     SVR2            
244         DDE SMES        MiNT            TI1500          
245         DOS EMX         MPC             TitanOS         
246         Dynix           NEWS-OS         UNICOS/mk       
247         EP/IX           Opus            Unisys Dynix    
248         ESIX                            Unixware        
249
250 Support for the following platforms is planned for the next major
251 Perl release.
252
253         BS2000
254         Netware
255         Rhapsody
256         VM/ESA
257
258 The following platforms have their own source code distributions and
259 binaries available via http://www.perl.com/CPAN/ports/index.html.
260
261                                 Perl release
262
263         AS/400                  5.003
264         MacOS                   5.004
265         Netware                 5.003_07
266         Tandem Guardian         5.004
267
268 The following platforms have only binaries available via
269 http://www.perl.com/CPAN/ports/index.html.
270
271                                 Perl release
272
273         Acorn RISCOS            5.005_02
274         AOS                     5.002
275         LynxOS                  5.004_02
276
277 =head1 ENVIRONMENT
278
279 See L<perlrun>.
280
281 =head1 AUTHOR
282
283 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
284
285 If your Perl success stories and testimonials may be of help to others 
286 who wish to advocate the use of Perl in their applications, 
287 or if you wish to simply express your gratitude to Larry and the 
288 Perl developers, please write to perl-thanks@perl.org .
289
290 =head1 FILES
291
292  "@INC"                 locations of perl libraries
293
294 =head1 SEE ALSO
295
296  a2p    awk to perl translator
297  s2p    sed to perl translator
298
299  http://www.perl.com/       the Perl Home Page
300  http://www.perl.com/CPAN   the Comphrehensive Perl Archive
301
302 =head1 DIAGNOSTICS
303
304 The B<-w> switch produces some lovely diagnostics.
305
306 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
307 diagnostics> pragma automatically turns Perl's normally terse warnings
308 and errors into these longer forms.
309
310 Compilation errors will tell you the line number of the error, with an
311 indication of the next token or token type that was to be examined.
312 (In a script passed to Perl via B<-e> switches, each
313 B<-e> is counted as one line.)
314
315 Setuid scripts have additional constraints that can produce error
316 messages such as "Insecure dependency".  See L<perlsec>.
317
318 Did we mention that you should definitely consider using the B<-w>
319 switch?
320
321 =head1 BUGS
322
323 The B<-w> switch is not mandatory.
324
325 Perl is at the mercy of your machine's definitions of various
326 operations such as type casting, atof(), and floating-point
327 output with sprintf().
328
329 If your stdio requires a seek or eof between reads and writes on a
330 particular stream, so does Perl.  (This doesn't apply to sysread()
331 and syswrite().)
332
333 While none of the built-in data types have any arbitrary size limits
334 (apart from memory size), there are still a few arbitrary limits:  a
335 given variable name may not be longer than 251 characters.  Line numbers
336 displayed by diagnostics are internally stored as short integers,
337 so they are limited to a maximum of 65535 (higher numbers usually being
338 affected by wraparound).
339
340 You may mail your bug reports (be sure to include full configuration
341 information as output by the myconfig program in the perl source
342 tree, or by C<perl -V>) to perlbug@perl.com .  If you've succeeded
343 in compiling perl, the perlbug script in the utils/ subdirectory
344 can be used to help mail in a bug report.
345
346 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
347 don't tell anyone I said that.
348
349 =head1 NOTES
350
351 The Perl motto is "There's more than one way to do it."  Divining
352 how many more is left as an exercise to the reader.
353
354 The three principal virtues of a programmer are Laziness,
355 Impatience, and Hubris.  See the Camel Book for why.
356