home *** CD-ROM | disk | FTP | other *** search
/ PC Plus SuperCD (UK) 2000 May / PCP163A.iso / full / activeperl / APi522e.exe / data.z / perl.pod < prev    next >
Encoding:
Text File  |  1999-11-01  |  15.0 KB  |  397 lines

  1. =head1 NAME
  2.  
  3. perl - Practical Extraction and Report Language
  4.  
  5. =head1 SYNOPSIS
  6.  
  7. B<perl>    S<[ B<-sTuU> ]>
  8.     S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
  9.     S<[ B<-cw> ] [ B<-d>[:I<debugger>] ] [ B<-D>[I<number/list>] ]>
  10.     S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal>] ]>
  11.     S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ]>
  12.     S<[ B<-P> ]>
  13.     S<[ B<-S> ]>
  14.     S<[ B<-x>[I<dir>] ]>
  15.     S<[ B<-i>[I<extension>] ]>
  16.     S<[ B<-e> I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
  17.  
  18. For ease of access, the Perl manual has been split up into a number
  19. of sections:
  20.  
  21.     perl        Perl overview (this section)
  22.     perldelta        Perl changes since previous version
  23.     perl5004delta    Perl changes in version 5.004
  24.     perlfaq        Perl frequently asked questions
  25.     perltoc        Perl documentation table of contents
  26.  
  27.     perldata        Perl data structures
  28.     perlsyn        Perl syntax
  29.     perlop        Perl operators and precedence
  30.     perlre        Perl regular expressions
  31.     perlrun        Perl execution and options
  32.     perlfunc        Perl builtin functions
  33.     perlopentut        Perl open() tutorial
  34.     perlvar        Perl predefined variables
  35.     perlsub        Perl subroutines
  36.     perlmod        Perl modules: how they work
  37.     perlmodlib        Perl modules: how to write and use
  38.     perlmodinstall    Perl modules: how to install from CPAN
  39.     perlform        Perl formats
  40.     perllocale        Perl locale support
  41.  
  42.     perlref        Perl references
  43.     perlreftut        Perl references short introduction
  44.     perldsc        Perl data structures intro
  45.     perllol        Perl data structures: lists of lists
  46.     perltoot        Perl OO tutorial
  47.     perlobj        Perl objects
  48.     perltie        Perl objects hidden behind simple variables
  49.     perlbot        Perl OO tricks and examples
  50.     perlipc        Perl interprocess communication
  51.     perlthrtut        Perl threads tutorial
  52.  
  53.     perldebug        Perl debugging
  54.     perldiag        Perl diagnostic messages
  55.     perlsec        Perl security
  56.     perltrap        Perl traps for the unwary
  57.     perlport        Perl portability guide
  58.     perlstyle        Perl style guide
  59.  
  60.     perlpod        Perl plain old documentation
  61.     perlbook        Perl book information
  62.  
  63.     perlembed        Perl ways to embed perl in your C or C++ application
  64.     perlapio        Perl internal IO abstraction interface
  65.     perlxs        Perl XS application programming interface
  66.     perlxstut        Perl XS tutorial
  67.     perlguts        Perl internal functions for those doing extensions
  68.     perlcall        Perl calling conventions from C
  69.  
  70.     perlhist        Perl history records
  71.  
  72. (If you're intending to read these straight through for the first time,
  73. the suggested order will tend to reduce the number of forward references.)
  74.  
  75. By default, all of the above manpages are installed in the
  76. F</usr/local/man/> directory.
  77.  
  78. Extensive additional documentation for Perl modules is available.  The
  79. default configuration for perl will place this additional documentation
  80. in the F</usr/local/lib/perl5/man> directory (or else in the F<man>
  81. subdirectory of the Perl library directory).  Some of this additional
  82. documentation is distributed standard with Perl, but you'll also find
  83. documentation for third-party modules there.
  84.  
  85. You should be able to view Perl's documentation with your man(1)
  86. program by including the proper directories in the appropriate start-up
  87. files, or in the MANPATH environment variable.  To find out where the
  88. configuration has installed the manpages, type:
  89.  
  90.     perl -V:man.dir
  91.  
  92. If the directories have a common stem, such as F</usr/local/man/man1>
  93. and F</usr/local/man/man3>, you need only to add that stem
  94. (F</usr/local/man>) to your man(1) configuration files or your MANPATH
  95. environment variable.  If they do not share a stem, you'll have to add
  96. both stems.
  97.  
  98. If that doesn't work for some reason, you can still use the
  99. supplied F<perldoc> script to view module information.  You might
  100. also look into getting a replacement man program.
  101.  
  102. If something strange has gone wrong with your program and you're not
  103. sure where you should look for help, try the B<-w> switch first.  It
  104. will often point out exactly where the trouble is.
  105.  
  106. =head1 DESCRIPTION
  107.  
  108. Perl is a language optimized for scanning arbitrary
  109. text files, extracting information from those text files, and printing
  110. reports based on that information.  It's also a good language for many
  111. system management tasks.  The language is intended to be practical
  112. (easy to use, efficient, complete) rather than beautiful (tiny,
  113. elegant, minimal).
  114.  
  115. Perl combines (in the author's opinion, anyway) some of the best
  116. features of C, B<sed>, B<awk>, and B<sh>, so people familiar with
  117. those languages should have little difficulty with it.  (Language
  118. historians will also note some vestiges of B<csh>, Pascal, and even
  119. BASIC-PLUS.)  Expression syntax corresponds quite closely to C
  120. expression syntax.  Unlike most Unix utilities, Perl does not
  121. arbitrarily limit the size of your data--if you've got the memory,
  122. Perl can slurp in your whole file as a single string.  Recursion is of
  123. unlimited depth.  And the tables used by hashes (sometimes called
  124. "associative arrays") grow as necessary to prevent degraded
  125. performance.  Perl can use sophisticated pattern matching techniques to
  126. scan large amounts of data very quickly.  Although optimized for
  127. scanning text, Perl can also deal with binary data, and can make dbm
  128. files look like hashes.  Setuid Perl scripts are safer than C programs
  129. through a dataflow tracing mechanism which prevents many stupid
  130. security holes.
  131.  
  132. If you have a problem that would ordinarily use B<sed> or B<awk> or
  133. B<sh>, but it exceeds their capabilities or must run a little faster,
  134. and you don't want to write the silly thing in C, then Perl may be for
  135. you.  There are also translators to turn your B<sed> and B<awk>
  136. scripts into Perl scripts.
  137.  
  138. But wait, there's more...
  139.  
  140. Perl version 5 is nearly a complete rewrite, and provides
  141. the following additional benefits:
  142.  
  143. =over 5
  144.  
  145. =item * Many usability enhancements
  146.  
  147. It is now possible to write much more readable Perl code (even within
  148. regular expressions).  Formerly cryptic variable names can be replaced
  149. by mnemonic identifiers.  Error messages are more informative, and the
  150. optional warnings will catch many of the mistakes a novice might make.
  151. This cannot be stressed enough.  Whenever you get mysterious behavior,
  152. try the B<-w> switch!!!  Whenever you don't get mysterious behavior,
  153. try using B<-w> anyway.
  154.  
  155. =item * Simplified grammar
  156.  
  157. The new yacc grammar is one half the size of the old one.  Many of the
  158. arbitrary grammar rules have been regularized.  The number of reserved
  159. words has been cut by 2/3.  Despite this, nearly all old Perl scripts
  160. will continue to work unchanged.
  161.  
  162. =item * Lexical scoping
  163.  
  164. Perl variables may now be declared within a lexical scope, like "auto"
  165. variables in C.  Not only is this more efficient, but it contributes
  166. to better privacy for "programming in the large".  Anonymous
  167. subroutines exhibit deep binding of lexical variables (closures).
  168.  
  169. =item * Arbitrarily nested data structures
  170.  
  171. Any scalar value, including any array element, may now contain a
  172. reference to any other variable or subroutine.  You can easily create
  173. anonymous variables and subroutines.  Perl manages your reference
  174. counts for you.
  175.  
  176. =item * Modularity and reusability
  177.  
  178. The Perl library is now defined in terms of modules which can be easily
  179. shared among various packages.  A package may choose to import all or a
  180. portion of a module's published interface.  Pragmas (that is, compiler
  181. directives) are defined and used by the same mechanism.
  182.  
  183. =item * Object-oriented programming
  184.  
  185. A package can function as a class.  Dynamic multiple inheritance and
  186. virtual methods are supported in a straightforward manner and with very
  187. little new syntax.  Filehandles may now be treated as objects.
  188.  
  189. =item * Embeddable and Extensible
  190.  
  191. Perl may now be embedded easily in your C or C++ application, and can
  192. either call or be called by your routines through a documented
  193. interface.  The XS preprocessor is provided to make it easy to glue
  194. your C or C++ routines into Perl.  Dynamic loading of modules is
  195. supported, and Perl itself can be made into a dynamic library.
  196.  
  197. =item * POSIX compliant
  198.  
  199. A major new module is the POSIX module, which provides access to all
  200. available POSIX routines and definitions, via object classes where
  201. appropriate.
  202.  
  203. =item * Package constructors and destructors
  204.  
  205. The new BEGIN and END blocks provide means to capture control as
  206. a package is being compiled, and after the program exits.  As a
  207. degenerate case they work just like awk's BEGIN and END when you
  208. use the B<-p> or B<-n> switches.
  209.  
  210. =item * Multiple simultaneous DBM implementations
  211.  
  212. A Perl program may now access DBM, NDBM, SDBM, GDBM, and Berkeley DB
  213. files from the same script simultaneously.  In fact, the old dbmopen
  214. interface has been generalized to allow any variable to be tied
  215. to an object class which defines its access methods.
  216.  
  217. =item * Subroutine definitions may now be autoloaded
  218.  
  219. In fact, the AUTOLOAD mechanism also allows you to define any arbitrary
  220. semantics for undefined subroutine calls.  It's not for just autoloading.
  221.  
  222. =item * Regular expression enhancements
  223.  
  224. You can now specify nongreedy quantifiers.  You can now do grouping
  225. without creating a backreference.  You can now write regular expressions
  226. with embedded whitespace and comments for readability.  A consistent
  227. extensibility mechanism has been added that is upwardly compatible with
  228. all old regular expressions.
  229.  
  230. =item * Innumerable Unbundled Modules
  231.  
  232. The Comprehensive Perl Archive Network described in L<perlmodlib>
  233. contains hundreds of plug-and-play modules full of reusable code.
  234. See F<http://www.perl.com/CPAN> for a site near you.
  235.  
  236. =item * Compilability
  237.  
  238. While not yet in full production mode, a working perl-to-C compiler
  239. does exist.  It can generate portable byte code, simple C, or
  240. optimized C code.
  241.  
  242. =back
  243.  
  244. Okay, that's I<definitely> enough hype.
  245.  
  246. =head1 AVAILABILITY
  247.  
  248. Perl is available for the vast majority of operating system platforms,
  249. including most Unix-like platforms. The following situation is as of
  250. February 1999 and Perl 5.005_03.
  251.  
  252. The following platforms are able to build Perl from the standard
  253. source code distribution available at
  254. F<http://www.perl.com/CPAN/src/index.html>
  255.  
  256.         AIX             Linux           SCO ODT/OSR
  257.         A/UX            MachTen         Solaris
  258.         BeOS            MPE/iX          SunOS
  259.         BSD/OS          NetBSD          SVR4
  260.         DG/UX           NextSTEP        Tru64 UNIX      3)
  261.         DomainOS        OpenBSD         Ultrix
  262.         DOS DJGPP 1)    OpenSTEP        UNICOS
  263.         DYNIX/ptx       OS/2            VMS
  264.         FreeBSD         OS390     2)    VOS
  265.         HP-UX           PowerMAX        Windows 3.1     1)
  266.         Hurd            QNX             Windows 95      1) 4)
  267.         IRIX                            Windows 98      1) 4)
  268.                                         Windows NT      1) 4)
  269.  
  270.         1) in DOS mode either the DOS or OS/2 ports can be used
  271.         2) formerly known as MVS
  272.         3) formerly known as Digital UNIX and before that DEC OSF/1
  273.         4) compilers: Borland, Cygwin32, Mingw32 EGCS/GCC, VC++
  274.  
  275. The following platforms have been known to build Perl from the source
  276. but for the Perl release 5.005_03 we haven't been able to verify them,
  277. either because the hardware/software platforms are rather rare or
  278. because we don't have an active champion on these platforms, or both.
  279.                     
  280.         3b1             FPS             Plan 9
  281.         AmigaOS         GENIX           PowerUX
  282.         ConvexOS        Greenhills      RISC/os
  283.         CX/UX           ISC             Stellar
  284.         DC/OSx          MachTen 68k     SVR2
  285.         DDE SMES        MiNT            TI1500
  286.         DOS EMX         MPC             TitanOS
  287.         Dynix           NEWS-OS         UNICOS/mk
  288.         EP/IX           Opus            Unisys Dynix
  289.         ESIX                Unixware
  290.  
  291. The following platforms are planned to be supported in the standard
  292. source code distribution of the Perl release 5.006 but are not
  293. supported in the Perl release 5.005_03:
  294.  
  295.         BS2000
  296.     Netware
  297.     Rhapsody
  298.         VM/ESA
  299.  
  300. The following platforms have their own source code distributions and
  301. binaries available via F<http://www.perl.com/CPAN/ports/index.html>.
  302.  
  303.                 Perl release
  304.  
  305.     AS/400            5.003
  306.     MacOS            5.004
  307.     Netware            5.003_07
  308.     Tandem Guardian        5.004
  309.  
  310. The following platforms have only binaries available via
  311. F<http://www.perl.com/CPAN/ports/index.html>.
  312.  
  313.                 Perl release
  314.  
  315.     Acorn RISCOS        5.005_02
  316.     AOS            5.002
  317.     LynxOS            5.004_02
  318.  
  319. =head1 ENVIRONMENT
  320.  
  321. See L<perlrun>.
  322.  
  323. =head1 AUTHOR
  324.  
  325. Larry Wall <F<larry@wall.org>>, with the help of oodles of other folks.
  326.  
  327. If your Perl success stories and testimonials may be of help to others
  328. who wish to advocate the use of Perl in their applications,
  329. or if you wish to simply express your gratitude to Larry and the
  330. Perl developers, please write to <F<perl-thanks@perl.org>>.
  331.  
  332. =head1 FILES
  333.  
  334.  "@INC"            locations of perl libraries
  335.  
  336. =head1 SEE ALSO
  337.  
  338.  a2p    awk to perl translator
  339.  
  340.  s2p    sed to perl translator
  341.  
  342. =head1 DIAGNOSTICS
  343.  
  344. The B<-w> switch produces some lovely diagnostics.
  345.  
  346. See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
  347. diagnostics> pragma automatically turns Perl's normally terse warnings
  348. and errors into these longer forms.
  349.  
  350. Compilation errors will tell you the line number of the error, with an
  351. indication of the next token or token type that was to be examined.
  352. (In the case of a script passed to Perl via B<-e> switches, each
  353. B<-e> is counted as one line.)
  354.  
  355. Setuid scripts have additional constraints that can produce error
  356. messages such as "Insecure dependency".  See L<perlsec>.
  357.  
  358. Did we mention that you should definitely consider using the B<-w>
  359. switch?
  360.  
  361. =head1 BUGS
  362.  
  363. The B<-w> switch is not mandatory.
  364.  
  365. Perl is at the mercy of your machine's definitions of various
  366. operations such as type casting, atof(), and floating-point
  367. output with sprintf().
  368.  
  369. If your stdio requires a seek or eof between reads and writes on a
  370. particular stream, so does Perl.  (This doesn't apply to sysread()
  371. and syswrite().)
  372.  
  373. While none of the built-in data types have any arbitrary size limits
  374. (apart from memory size), there are still a few arbitrary limits:  a
  375. given variable name may not be longer than 251 characters.  Line numbers
  376. displayed by diagnostics are internally stored as short integers,
  377. so they are limited to a maximum of 65535 (higher numbers usually being
  378. affected by wraparound).
  379.  
  380. You may mail your bug reports (be sure to include full configuration
  381. information as output by the myconfig program in the perl source tree,
  382. or by C<perl -V>) to <F<perlbug@perl.com>>.
  383. If you've succeeded in compiling perl, the perlbug script in the utils/
  384. subdirectory can be used to help mail in a bug report.
  385.  
  386. Perl actually stands for Pathologically Eclectic Rubbish Lister, but
  387. don't tell anyone I said that.
  388.  
  389. =head1 NOTES
  390.  
  391. The Perl motto is "There's more than one way to do it."  Divining
  392. how many more is left as an exercise to the reader.
  393.  
  394. The three principal virtues of a programmer are Laziness,
  395. Impatience, and Hubris.  See the Camel Book for why.
  396.  
  397.