4 perltoc - perl documentation table of contents
8 This page provides a brief table of contents for the rest of the Perl
9 documentation set. It is meant to be scanned quickly or grepped
10 through to locate the proper section you're looking for.
12 =head1 BASIC DOCUMENTATION
14 =head2 perl - Practical Extraction and Report Language
20 Many usability enhancements, Simplified grammar, Lexical scoping,
21 Arbitrarily nested data structures, Modularity and reusability,
22 Object-oriented programming, Embeddable and Extensible, POSIX compliant,
23 Package constructors and destructors, Multiple simultaneous DBM
24 implementations, Subroutine definitions may now be autoloaded, Regular
25 expression enhancements, Innumerable Unbundled Modules, Compilability
29 HOME, LOGDIR, PATH, PERL5LIB, PERL5DB, PERL_DESTRUCT_LEVEL, PERLLIB
43 =head2 perldelta - what's new for perl5.004
47 =item Supported Environments
53 =item Compilation Option: Binary Compatibility With 5.003
55 =item New Opcode Module and Revised Safe Module
57 =item Internal Change: FileHandle Deprecated
59 =item Internal Change: PerlIO internal IO abstraction interface
61 =item New and Changed Built-in Variables
65 =item New and Changed Built-in Functions
67 delete on slices, flock, printf and sprintf, keys as an lvalue, my() in
68 Control Structures, unpack() and pack(), use VERSION, use Module VERSION
69 LIST, prototype(FUNCTION), $_ as Default, C<m//g> does not trigger a pos()
70 reset on failure, nested C<sub{}> closures work now, formats work right on
73 =item New Built-in Methods
75 isa(CLASS), can(METHOD), VERSION( [NEED] ), class(), is_instance()
77 =item TIEHANDLE Now Supported
79 TIEHANDLE classname, LIST, PRINT this, LIST, READLINE this, DESTROY this,
80 Efficiency Enhancements
86 use blib, use blib 'dir', use locale, use ops
92 =item Installation Directories
96 =item Module Information Summary
106 =item Overridden Built-ins
110 =item Utility Changes
116 C<void> XSUBs now default to returning nothing
120 =item C Language API Changes
122 C<gv_fetchmethod> and C<perl_call_sv>
124 =item Documentation Changes
126 L<perldelta>, L<perllocale>, L<perltoot>, L<perlapio>, L<perldebug>,
129 =item New Diagnostics
131 "my" variable %s masks earlier declaration in same scope, %s argument is
132 not a HASH element or slice, Allocation too large: %lx, Allocation too
133 large, Attempt to free non-existent shared string, Attempt to use reference
134 as lvalue in substr, Unsupported function fork, Ill-formed logical name
135 |%s| in prime_env_iter, Can't use bareword ("%s") as %s ref while "strict
136 refs" in use, Constant subroutine %s redefined, Died, Integer overflow in
137 hex number, Integer overflow in octal number, Name "%s::%s" used only once:
138 possible typo, Null picture in formline, Offset outside string, Stub found
139 while resolving method `%s' overloading `%s' in package `%s', Cannot
140 resolve method `%s' overloading `%s' in package `s', Out of memory!, Out of
141 memory during request for %s, Possible attempt to put comments in qw()
142 list, Possible attempt to separate words with commas, Scalar value @%s{%s}
143 better written as $%s{%s}, untie attempted while %d inner references still
144 exist, Value of %s construct can be "0"; test with defined(), Variable "%s"
145 may be unavailable, Variable "%s" will not stay shared, Warning:
146 something's wrong, Got an error from DosAllocMem, Malformed PERLLIB_PREFIX,
147 PERL_SH_DIR too long, Process terminated by SIG%s
155 =head2 perldata - Perl data types
167 =item Scalar value constructors
169 =item List value constructors
171 =item Typeglobs and Filehandles
175 =head2 perlsyn - Perl syntax
183 =item Simple statements
185 =item Compound statements
193 =item Basic BLOCKs and Switch Statements
197 =item PODs: Embedded Documentation
199 =item Plain Old Comments (Not!)
203 =head2 perlop - Perl operators and precedence
211 =item Terms and List Operators (Leftward)
213 =item The Arrow Operator
215 =item Auto-increment and Auto-decrement
219 =item Symbolic Unary Operators
221 =item Binding Operators
223 =item Multiplicative Operators
225 =item Additive Operators
227 =item Shift Operators
229 =item Named Unary Operators
231 =item Relational Operators
233 =item Equality Operators
237 =item Bitwise Or and Exclusive Or
239 =item C-style Logical And
241 =item C-style Logical Or
245 =item Conditional Operator
247 =item Assignment Operators
251 =item List Operators (Rightward)
257 =item Logical or and Exclusive Or
259 =item C Operators Missing From Perl
261 unary &, unary *, (TYPE)
263 =item Quote and Quote-like Operators
265 =item Regexp Quote-Like Operators
267 ?PATTERN?, m/PATTERN/gimosx, /PATTERN/gimosx, q/STRING/, C<'STRING'>,
268 qq/STRING/, "STRING", qx/STRING/, `STRING`, qw/STRING/,
269 s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds,
270 y/SEARCHLIST/REPLACEMENTLIST/cds
274 =item Constant Folding
276 =item Integer Arithmetic
280 =head2 perlre - Perl regular expressions
288 =item Regular Expressions
290 (?#text), (?:regexp), (?=regexp), (?!regexp), (?imsx)
294 =item Version 8 Regular Expressions
296 =item WARNING on \1 vs $1
300 =head2 perlrun - how to execute the Perl interpreter
310 B<-0>[I<digits>], B<-a>, B<-c>, B<-d>, B<-d:>I<foo>, B<-D>I<number>,
311 B<-D>I<list>, B<-e> I<commandline>, B<-F>I<pattern>, B<-h>,
312 B<-i>[I<extension>], B<-I>I<directory>, B<-l>[I<octnum>],
313 B<-m>[B<->]I<module>, B<-M>[B<->]I<module>, B<-M>[B<->]I<'module ...'>,
314 B<-[mM]>[B<->]I<module=arg[,arg]...>, B<-n>, B<-p>, B<-P>, B<-s>, B<-S>,
315 B<-T>, B<-u>, B<-U>, B<-v>, B<-V>, B<-V:>I<name>, B<-w>, B<-x> I<directory>
319 =head2 perlfunc - Perl builtin functions
323 I<THERE IS NO GENERAL RULE FOR CONVERTING A LIST INTO A SCALAR!>
327 =item Perl Functions by Category
329 Functions for SCALARs or strings, Regular expressions and pattern matching,
330 Numeric functions, Functions for real @ARRAYs, Functions for list data,
331 Functions for real %HASHes, Input and output functions, Functions for fixed
332 length data or records, Functions for filehandles, files, or directories,
333 Keywords related to the control flow of your perl program, Keywords related
334 to scoping, Miscellaneous functions, Functions for processes and process
335 groups, Keywords related to perl modules, Keywords related to classes and
336 object-orientedness, Low-level socket functions, System V interprocess
337 communication functions, Fetching user and group info, Fetching network
338 info, Time-related functions, Functions new in perl5, Functions obsoleted
341 =item Alphabetical Listing of Perl Functions
343 -I<X> FILEHANDLE, -I<X> EXPR, -I<X>, abs VALUE, abs, accept
344 NEWSOCKET,GENERICSOCKET, alarm SECONDS, alarm, atan2 Y,X, bind SOCKET,NAME,
345 binmode FILEHANDLE, bless REF,CLASSNAME, bless REF, caller EXPR, caller,
346 chdir EXPR, chmod LIST, chomp VARIABLE, chomp LIST, chomp, chop VARIABLE,
347 chop LIST, chop, chown LIST, chr NUMBER, chr, chroot FILENAME, chroot,
348 close FILEHANDLE, closedir DIRHANDLE, connect SOCKET,NAME, continue BLOCK,
349 cos EXPR, crypt PLAINTEXT,SALT, dbmclose ASSOC_ARRAY, dbmopen
350 ASSOC,DBNAME,MODE, defined EXPR, defined, delete EXPR, die LIST, do BLOCK,
351 do SUBROUTINE(LIST), do EXPR, dump LABEL, each ASSOC_ARRAY, eof FILEHANDLE,
352 eof (), eof, eval EXPR, eval BLOCK, exec LIST, exists EXPR, exit EXPR, exp
353 EXPR, exp, fcntl FILEHANDLE,FUNCTION,SCALAR, fileno FILEHANDLE, flock
354 FILEHANDLE,OPERATION, fork, format, formline PICTURE, LIST, getc
355 FILEHANDLE, getc, getlogin, getpeername SOCKET, getpgrp PID, getppid,
356 getpriority WHICH,WHO, getpwnam NAME, getgrnam NAME, gethostbyname NAME,
357 getnetbyname NAME, getprotobyname NAME, getpwuid UID, getgrgid GID,
358 getservbyname NAME,PROTO, gethostbyaddr ADDR,ADDRTYPE, getnetbyaddr
359 ADDR,ADDRTYPE, getprotobynumber NUMBER, getservbyport PORT,PROTO, getpwent,
360 getgrent, gethostent, getnetent, getprotoent, getservent, setpwent,
361 setgrent, sethostent STAYOPEN, setnetent STAYOPEN, setprotoent STAYOPEN,
362 setservent STAYOPEN, endpwent, endgrent, endhostent, endnetent,
363 endprotoent, endservent, getsockname SOCKET, getsockopt
364 SOCKET,LEVEL,OPTNAME, glob EXPR, glob, gmtime EXPR, goto LABEL, goto EXPR,
365 goto &NAME, grep BLOCK LIST, grep EXPR,LIST, hex EXPR, hex, import, index
366 STR,SUBSTR,POSITION, index STR,SUBSTR, int EXPR, int, ioctl
367 FILEHANDLE,FUNCTION,SCALAR, join EXPR,LIST, keys ASSOC_ARRAY, kill LIST,
368 last LABEL, last, lc EXPR, lc, lcfirst EXPR, lcfirst, length EXPR, length,
369 link OLDFILE,NEWFILE, listen SOCKET,QUEUESIZE, local EXPR, localtime EXPR,
370 log EXPR, log, lstat FILEHANDLE, lstat EXPR, lstat, m//, map BLOCK LIST,
371 map EXPR,LIST, mkdir FILENAME,MODE, msgctl ID,CMD,ARG, msgget KEY,FLAGS,
372 msgsnd ID,MSG,FLAGS, msgrcv ID,VAR,SIZE,TYPE,FLAGS, my EXPR, next LABEL,
373 next, no Module LIST, oct EXPR, oct, open FILEHANDLE,EXPR, open FILEHANDLE,
374 opendir DIRHANDLE,EXPR, ord EXPR, ord, pack TEMPLATE,LIST, package
375 NAMESPACE, pipe READHANDLE,WRITEHANDLE, pop ARRAY, pop, pos SCALAR, pos,
376 print FILEHANDLE LIST, print LIST, print, printf FILEHANDLE FORMAT, LIST,
377 printf FORMAT, LIST, prototype FUNCTION, push ARRAY,LIST, q/STRING/,
378 qq/STRING/, qx/STRING/, qw/STRING/, quotemeta EXPR, quotemeta, rand EXPR,
379 rand, read FILEHANDLE,SCALAR,LENGTH,OFFSET, read FILEHANDLE,SCALAR,LENGTH,
380 readdir DIRHANDLE, readlink EXPR, readlink, recv SOCKET,SCALAR,LEN,FLAGS,
381 redo LABEL, redo, ref EXPR, ref, rename OLDNAME,NEWNAME, require EXPR,
382 require, reset EXPR, reset, return LIST, reverse LIST, rewinddir DIRHANDLE,
383 rindex STR,SUBSTR,POSITION, rindex STR,SUBSTR, rmdir FILENAME, rmdir, s///,
384 scalar EXPR, seek FILEHANDLE,POSITION,WHENCE, seekdir DIRHANDLE,POS, select
385 FILEHANDLE, select, select RBITS,WBITS,EBITS,TIMEOUT, semctl
386 ID,SEMNUM,CMD,ARG, semget KEY,NSEMS,FLAGS, semop KEY,OPSTRING, send
387 SOCKET,MSG,FLAGS,TO, send SOCKET,MSG,FLAGS, setpgrp PID,PGRP, setpriority
388 WHICH,WHO,PRIORITY, setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL, shift ARRAY,
389 shift, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS, shmread ID,VAR,POS,SIZE,
390 shmwrite ID,STRING,POS,SIZE, shutdown SOCKET,HOW, sin EXPR, sin, sleep
391 EXPR, sleep, socket SOCKET,DOMAIN,TYPE,PROTOCOL, socketpair
392 SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, sort SUBNAME LIST, sort BLOCK LIST,
393 sort LIST, splice ARRAY,OFFSET,LENGTH,LIST, splice ARRAY,OFFSET,LENGTH,
394 splice ARRAY,OFFSET, split /PATTERN/,EXPR,LIMIT, split /PATTERN/,EXPR,
395 split /PATTERN/, split, sprintf FORMAT, LIST, sqrt EXPR, sqrt, srand EXPR,
396 stat FILEHANDLE, stat EXPR, stat, study SCALAR, study, sub BLOCK, sub NAME,
397 sub NAME BLOCK, substr EXPR,OFFSET,LEN, substr EXPR,OFFSET, symlink
398 OLDFILE,NEWFILE, syscall LIST, sysopen FILEHANDLE,FILENAME,MODE, sysopen
399 FILEHANDLE,FILENAME,MODE,PERMS, sysread FILEHANDLE,SCALAR,LENGTH,OFFSET,
400 sysread FILEHANDLE,SCALAR,LENGTH, system LIST, syswrite
401 FILEHANDLE,SCALAR,LENGTH,OFFSET, syswrite FILEHANDLE,SCALAR,LENGTH, tell
402 FILEHANDLE, tell, telldir DIRHANDLE, tie VARIABLE,CLASSNAME,LIST, tied
403 VARIABLE, time, times, tr///, truncate FILEHANDLE,LENGTH, truncate
404 EXPR,LENGTH, uc EXPR, uc, ucfirst EXPR, ucfirst, umask EXPR, umask, undef
405 EXPR, undef, unlink LIST, unlink, unpack TEMPLATE,EXPR, untie VARIABLE,
406 unshift ARRAY,LIST, use Module LIST, use Module, use Module VERSION LIST,
407 use VERSION, utime LIST, values ASSOC_ARRAY, vec EXPR,OFFSET,BITS, wait,
408 waitpid PID,FLAGS, wantarray, warn LIST, write FILEHANDLE, write EXPR,
413 =head2 perlvar - Perl predefined variables
419 =item Predefined Names
421 $ARG, $_, $E<lt>I<digit>E<gt>, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $',
422 $LAST_PAREN_MATCH, $+, $MULTILINE_MATCHING, $*, input_line_number HANDLE
423 EXPR, $INPUT_LINE_NUMBER, $NR, $, input_record_separator HANDLE EXPR,
424 $INPUT_RECORD_SEPARATOR, $RS, $/, autoflush HANDLE EXPR, $OUTPUT_AUTOFLUSH,
425 $|, output_field_separator HANDLE EXPR, $OUTPUT_FIELD_SEPARATOR, $OFS, $,,
426 output_record_separator HANDLE EXPR, $OUTPUT_RECORD_SEPARATOR, $ORS, $\,
427 $LIST_SEPARATOR, $", $SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $OFMT, $#,
428 format_page_number HANDLE EXPR, $FORMAT_PAGE_NUMBER, $%,
429 format_lines_per_page HANDLE EXPR, $FORMAT_LINES_PER_PAGE, $=,
430 format_lines_left HANDLE EXPR, $FORMAT_LINES_LEFT, $-, format_name HANDLE
431 EXPR, $FORMAT_NAME, $~, format_top_name HANDLE EXPR, $FORMAT_TOP_NAME, $^,
432 format_line_break_characters HANDLE EXPR, $FORMAT_LINE_BREAK_CHARACTERS,
433 $:, format_formfeed HANDLE EXPR, $FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A,
434 $CHILD_ERROR, $?, $SYSTEM_CHILD_STATUS, $^S, $OS_ERROR, $ERRNO, $!,
435 $EXTENDED_OS_ERROR, $^E, $EVAL_ERROR, $@, $PROCESS_ID, $PID, $$,
436 $REAL_USER_ID, $UID, $<, $EFFECTIVE_USER_ID, $EUID, $>, $REAL_GROUP_ID,
437 $GID, $(, $EFFECTIVE_GROUP_ID, $EGID, $), $PROGRAM_NAME, $0, $[,
438 $PERL_VERSION, $], $DEBUGGING, $^D, $SYSTEM_FD_MAX, $^F, $^H,
439 $INPLACE_EDIT, $^I, $OSNAME, $^O, $PERLDB, $^P, $BASETIME, $^T, $WARNING,
440 $^W, $EXECUTABLE_NAME, $^X, $ARGV, @ARGV, @INC, %INC, $ENV{expr},
445 =head2 perlsub - Perl subroutines
453 =item Private Variables via my()
455 =item Temporary Values via local()
457 =item Passing Symbol Table Entries (typeglobs)
459 =item Pass by Reference
463 =item Constant Functions
465 =item Overriding Builtin Functions
473 =head2 perlmod - Perl modules (packages)
483 =item Package Constructors and Destructors
493 =item THE PERL MODULE LIBRARY
497 =item Pragmatic Modules
499 blib, diagnostics, integer, less, lib, locale, ops, overload, sigtrap,
502 =item Standard Modules
504 AnyDBM_File, AutoLoader, AutoSplit, Benchmark, CPAN, CPAN::FirstTime,
505 CPAN::Nox, Carp, Class::Template, Config, Cwd, DB_File, Devel::SelfStubber,
506 DirHandle, DynaLoader, English, Env, Exporter, ExtUtils::Embed,
507 ExtUtils::Install, ExtUtils::Liblist, ExtUtils::MM_OS2, ExtUtils::MM_Unix,
508 ExtUtils::MM_VMS, ExtUtils::MakeMaker, ExtUtils::Manifest,
509 ExtUtils::Mkbootstrap, ExtUtils::Mksymlists, ExtUtils::testlib, Fatal,
510 Fcntl, File::Basename, File::CheckTree, File::Compare, File::Copy,
511 File::Find, File::Path, File::stat, FileCache, FileHandle, FindBin,
512 GDBM_File, Getopt::Long, Getopt::Std, I18N::Collate, IO, IO::File,
513 IO::Handle, IO::Pipe, IO::Seekable, IO::Select, IO::Socket, IPC::Open2,
514 IPC::Open3, Math::BigFloat, Math::BigInt, Math::Complex, NDBM_File,
515 Net::Ping, Net::hostent, Net::netent, Net::protoent, Net::servent, Opcode,
516 Pod::Text, POSIX, SDBM_File, Safe, Search::Dict, SelectSaver, SelfLoader,
517 Shell, Socket, Symbol, Sys::Hostname, Sys::Syslog, Term::Cap,
518 Term::Complete, Term::ReadLine, Test::Harness, Text::Abbrev,
519 Text::ParseWords, Text::Soundex, Text::Tabs, Text::Wrap, Tie::Hash,
520 Tie::RefHash, Tie::Scalar, Tie::SubstrHash, Time::Local, Time::gmtime,
521 Time::localtime, Time::tm, UNIVERSAL, User::grent, User::pwent
523 =item Extension Modules
529 Language Extensions and Documentation Tools, Development Support, Operating
530 System Interfaces, Networking, Device Control (modems) and InterProcess
531 Communication, Data Types and Data Type Utilities, Database Interfaces,
532 User Interfaces, Interfaces to / Emulations of Other Programming Languages,
533 File Names, File Systems and File Locking (see also File Handles), String
534 Processing, Language Text Processing, Parsing, and Searching, Option,
535 Argument, Parameter, and Configuration File Processing,
536 Internationalization and Locale, Authentication, Security, and Encryption,
537 World Wide Web, HTML, HTTP, CGI, MIME, Server and Daemon Utilities,
538 Archiving and Compression, Images, Pixmap and Bitmap Manipulation, Drawing,
539 and Graphing, Mail and Usenet News, Control Flow Utilities (callbacks and
540 exceptions etc), File Handle and Input/Output Stream Utilities,
541 Miscellaneous Modules
543 =item Modules: Creation, Use, and Abuse
547 =item Guidelines for Module Creation
549 Do similar modules already exist in some form?, Try to design the new
550 module to be easy to extend and reuse, Some simple style guidelines, Select
551 what to export, Select a name for the module, Have you got it right?,
552 README and other Additional Files, A description of the
553 module/package/extension etc, A copyright notice - see below, Prerequisites
554 - what else you may need to have, How to build it - possible changes to
555 Makefile.PL etc, How to install it, Recent changes in this release,
556 especially incompatibilities, Changes / enhancements you plan to make in
557 the future, Adding a Copyright Notice, Give the module a
558 version/issue/release number, How to release and distribute a module, Take
559 care when changing a released module
561 =item Guidelines for Converting Perl 4 Library Scripts into Modules
563 There is no requirement to convert anything, Consider the implications,
564 Make the most of the opportunity, The pl2pm utility will get you started,
565 Adds the standard Module prologue lines, Converts package specifiers from '
566 to ::, Converts die(...) to croak(...), Several other minor changes
568 =item Guidelines for Reusing Application Code
570 Complete applications rarely belong in the Perl Module Library, Many
571 applications contain some perl code which could be reused, Break-out the
572 reusable code into one or more separate module files, Take the opportunity
573 to reconsider and redesign the interfaces, In some cases the 'application'
574 can then be reduced to a small
578 =head2 perlform - Perl formats
584 =item Format Variables
594 =item Accessing Formatting Internals
600 =head2 perllocale - Perl locale handling (internationalization and
605 =item PREPARING TO USE LOCALES
611 =item The use locale pragma
613 =item The setlocale function
615 =item The localeconv function
619 =item LOCALE CATEGORIES
623 =item Category LC_COLLATE: Collation
625 =item Category LC_CTYPE: Character Types
627 =item Category LC_NUMERIC: Numeric Formatting
629 =item Category LC_MONETARY: Formatting of monetary amounts
633 =item Other categories
639 B<Comparison operators> (C<lt>, C<le>, C<ge>, C<gt> and C<cmp>):,
640 B<Case-mapping interpolation> (with C<\l>, C<\L>, C<\u> or <\U>),
641 B<Matching operator> (C<m//>):, B<Substitution operator> (C<s///>):,
642 B<In-memory formatting function> (sprintf()):, B<Output formatting
643 functions> (printf() and write()):, B<Case-mapping functions> (lc(),
644 lcfirst(), uc(), ucfirst()):, B<POSIX locale-dependent functions>
645 (localeconv(), strcoll(),strftime(), strxfrm()):, B<POSIX character class
646 tests> (isalnum(), isalpha(), isdigit(),isgraph(), islower(), isprint(),
647 ispunct(), isspace(), isupper(),
652 PERL_BADLANG, LC_ALL, LC_CTYPE, LC_COLLATE, LC_MONETARY, LC_NUMERIC,
659 =item Backward compatibility
661 =item I18N:Collate obsolete
663 =item Sort speed and memory use impacts
665 =item write() and LC_NUMERIC
667 =item Freely available locale definitions
671 =item An imperfect standard
687 =head2 perlref - Perl references and nested data structures
693 =item Symbolic references
695 =item Not-so-symbolic references
703 =head2 perldsc - Perl Data Structures Cookbook
707 arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes,
708 more elaborate constructs
712 =item COMMON MISTAKES
714 =item CAVEAT ON PRECEDENCE
716 =item WHY YOU SHOULD ALWAYS C<use strict>
726 =item Declaration of a LIST OF LISTS
728 =item Generation of a LIST OF LISTS
730 =item Access and Printing of a LIST OF LISTS
734 =item HASHES OF LISTS
738 =item Declaration of a HASH OF LISTS
740 =item Generation of a HASH OF LISTS
742 =item Access and Printing of a HASH OF LISTS
746 =item LISTS OF HASHES
750 =item Declaration of a LIST OF HASHES
752 =item Generation of a LIST OF HASHES
754 =item Access and Printing of a LIST OF HASHES
758 =item HASHES OF HASHES
762 =item Declaration of a HASH OF HASHES
764 =item Generation of a HASH OF HASHES
766 =item Access and Printing of a HASH OF HASHES
770 =item MORE ELABORATE RECORDS
774 =item Declaration of MORE ELABORATE RECORDS
776 =item Declaration of a HASH OF COMPLEX RECORDS
778 =item Generation of a HASH OF COMPLEX RECORDS
788 =head2 perllol, perlLoL - Manipulating Lists of Lists in Perl
792 =item Declaration and Access of Lists of Lists
794 =item Growing Your Own
796 =item Access and Printing
804 =head2 perltoot - Tom's object-oriented tutorial for perl
808 =item Creating a Class
812 =item Object Representation
814 =item Class Interface
816 =item Constructors and Instance Methods
818 =item Planning for the Future: Better Constructors
822 =item Other Object Methods
830 =item Accessing Class Data
832 =item Debugging Methods
834 =item Class Destructors
836 =item Documenting the Interface
846 =item Overridden Methods
848 =item Multiple Inheritance
850 =item UNIVERSAL: The Root of All Objects
854 =item Alternate Object Representations
858 =item Arrays as Objects
860 =item Closures as Objects
864 =item AUTOLOAD: Proxy Methods
868 =item Autoloaded Data Methods
870 =item Inherited Autoloaded Data Methods
874 =item Metaclassical Tools
878 =item Class::Template
880 =item Data Members as Variables
884 =item Object Terminology
894 =item Acknowledgments
898 =head2 perlobj - Perl objects
904 =item An Object is Simply a Reference
906 =item A Class is Simply a Package
908 =item A Method is Simply a Subroutine
910 =item Method Invocation
912 =item Default UNIVERSAL methods
914 isa(CLASS), can(METHOD), VERSION( [NEED] ), class(), is_instance()
922 =item Two-Phased Garbage Collection
928 =head2 perltie - how to hide an object class in a simple variable
938 TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this
942 TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value,
947 USER, HOME, CLOBBER, LIST, TIEHASH classname, LIST, FETCH this, key, STORE
948 this, key, value, DELETE this, key, CLEAR this, EXISTS this, key, FIRSTKEY
949 this, NEXTKEY this, lastkey, DESTROY this
951 =item Tying FileHandles
953 TIEHANDLE classname, LIST, PRINT this, LIST, READLINE this, DESTROY this
955 =item The C<untie> Gotcha
965 =head2 perlbot - Bag'o Object Tricks (the BOT)
969 =item OO SCALING TIPS
971 =item INSTANCE VARIABLES
973 =item SCALAR INSTANCE VARIABLES
975 =item INSTANCE VARIABLE INHERITANCE
977 =item OBJECT RELATIONSHIPS
979 =item OVERRIDING SUPERCLASS METHODS
981 =item USING RELATIONSHIP WITH SDBM
983 =item THINKING OF CODE REUSE
985 =item CLASS CONTEXT AND THE OBJECT
987 =item INHERITING A CONSTRUCTOR
991 =head2 perlipc - Perl interprocess communication (signals, fifos, pipes,
992 safe subprocesses, sockets, and semaphores)
1000 =item Using open() for IPC
1004 =item Safe Pipe Opens
1006 =item Bidirectional Communication
1010 =item Sockets: Client/Server Communication
1014 =item Internet TCP Clients and Servers
1016 =item Unix-Domain TCP Clients and Servers
1018 =item UDP: Message Passing
1034 =head2 perldebug - Perl debugging
1038 =item The Perl Debugger
1042 =item Debugger Commands
1044 h [command], p expr, x expr, V [pkg [vars]], X [vars], T, s [expr], n
1045 [expr], E<lt>CRE<gt>, c [line|sub], l, l min+incr, l min-max, l line, l
1046 subname, -, w [line], f filename, /pattern/, ?pattern?, L, S [[!]pattern],
1047 t, t expr, b [line] [condition], b subname [condition], b postpone subname
1048 [condition], b load filename, b compile subname, d [line], D, a [line]
1049 command, A, O [opt[=val]] [opt"val"] [opt?].., C<recallCommand>,
1050 C<ShellBang>, C<pager>, C<tkRunning>, C<signalLevel>, C<warnLevel>,
1051 C<dieLevel>, C<AutoTrace>, C<LineInfo>, C<inhibit_exit>, C<PrintRet>,
1052 C<frame>, C<maxTraceLen>, C<arrayDepth>, C<hashDepth>, C<compactDump>,
1053 C<veryCompact>, C<globPrint>, C<DumpDBFiles>, C<DumpPackages>, C<quote>,
1054 C<HighBit>, C<undefPrint>, C<UsageOnly>, C<TTY>, C<noTTY>, C<ReadLine>,
1055 C<NonStop>, E<lt> [ command ], E<lt>E<lt> command, E<gt> command,
1056 E<gt>E<gt> command, { [ command ], {{ command, ! number, ! -number, !
1057 pattern, !! cmd, H -number, q or ^D, R, |dbcmd, ||dbcmd, = [alias value],
1058 command, m expr, m package
1060 =item Debugger input/output
1062 Prompt, Multi-line commands, Stack backtrace, Listing, Frame listing
1064 =item Debugging compile-time statements
1066 =item Debugger Customization
1068 =item Readline Support
1070 =item Editor Support for Debugging
1072 =item The Perl Profiler
1074 =item Debugger support in perl
1076 =item Debugger Internals
1078 =item Other resources
1084 =head2 perldiag - various Perl diagnostics
1088 =head2 perlsec - Perl security
1094 =item Laundering and Detecting Tainted Data
1096 =item Cleaning Up Your Path
1102 =head2 perltrap - Perl traps for the unwary
1118 =item Perl4 to Perl5 Traps
1120 Discontinuance, Deprecation, and BugFix traps, Parsing Traps, Numerical
1121 Traps, General data type traps, Context Traps - scalar, list contexts,
1122 Precedence Traps, General Regular Expression Traps using s///, etc,
1123 Subroutine, Signal, Sorting Traps, OS Traps, DBM Traps, Unclassified Traps
1125 =item Discontinuance, Deprecation, and BugFix traps
1127 Discontinuance, Deprecation, BugFix, Discontinuance, Discontinuance,
1128 Discontinuance, BugFix, Discontinuance, Discontinuance, BugFix,
1129 Discontinuance, Deprecation, Discontinuance
1133 Parsing, Parsing, Parsing
1135 =item Numerical Traps
1137 Numerical, Numerical, Numerical
1139 =item General data type traps
1141 (Arrays), (Arrays), (Hashes), (Globs), (Scalar String), (Constants),
1142 (Scalars), (Variable Suicide)
1144 =item Context Traps - scalar, list contexts
1146 (list context), (scalar context), (scalar context), (list, builtin)
1148 =item Precedence Traps
1150 Precedence, Precedence, Precedence, Precedence, Precedence, Precedence,
1153 =item General Regular Expression Traps using s///, etc.
1155 Regular Expression, Regular Expression, Regular Expression, Regular
1156 Expression, Regular Expression, Regular Expression, Regular Expression,
1159 =item Subroutine, Signal, Sorting Traps
1161 (Signals), (Sort Subroutine), warn() won't let you specify a filehandle
1167 =item Interpolation Traps
1169 Interpolation, Interpolation, Interpolation, Interpolation, Interpolation,
1170 Interpolation, Interpolation, Interpolation, Interpolation
1176 =item Unclassified Traps
1182 =head2 perlstyle - Perl style guide
1186 =head2 perlpod - plain old documentation
1190 =item Embedding Pods in Perl Modules
1192 =item Common Pod Pitfalls
1198 =head2 perlbook - Perl book information
1202 =head2 perlembed - how to embed perl in your C program
1210 B<Use C from Perl?>, B<Use a UNIX program from Perl?>, B<Use Perl from
1211 Perl?>, B<Use C from C?>, B<Use Perl from C?>
1215 =item Compiling your C program
1217 =item Adding a Perl interpreter to your C program
1219 =item Calling a Perl subroutine from your C program
1221 =item Evaluating a Perl statement from your C program
1223 =item Performing Perl pattern matches and substitutions from your C program
1225 =item Fiddling with the Perl stack from your C program
1227 =item Maintaining a persistent interpreter
1229 =item Maintaining multiple interpreter instances
1231 =item Using Perl modules, which themselves use C libraries, from your C
1242 =head2 perlapio - perl's IO abstraction interface.
1248 B<PerlIO *>, B<PerlIO_stdin()>, B<PerlIO_stdout()>, B<PerlIO_stderr()>,
1249 B<PerlIO_open(path, mode)>, B<PerlIO_fdopen(fd,mode)>,
1250 B<PerlIO_printf(f,fmt,...)>, B<PerlIO_vprintf(f,fmt,a)>,
1251 B<PerlIO_stdoutf(fmt,...)>, B<PerlIO_read(f,buf,count)>,
1252 B<PerlIO_write(f,buf,count)>, B<PerlIO_close(f)>, B<PerlIO_puts(s,f)>,
1253 B<PerlIO_putc(c,f)>, B<PerlIO_ungetc(c,f)>, B<PerlIO_getc(f)>,
1254 B<PerlIO_eof(f)>, B<PerlIO_error(f)>, B<PerlIO_fileno(f)>,
1255 B<PerlIO_clearerr(f)>, B<PerlIO_flush(f)>, B<PerlIO_tell(f)>,
1256 B<PerlIO_seek(f,o,w)>, B<PerlIO_getpos(f,p)>, B<PerlIO_setpos(f,p)>,
1257 B<PerlIO_rewind(f)>, B<PerlIO_tmpfile()>
1261 =item Co-existence with stdio
1263 B<PerlIO_importFILE(f,flags)>, B<PerlIO_exportFILE(f,flags)>,
1264 B<PerlIO_findFILE(f)>, B<PerlIO_releaseFILE(p,f)>, B<PerlIO_setlinebuf(f)>,
1265 B<PerlIO_has_cntptr(f)>, B<PerlIO_get_ptr(f)>, B<PerlIO_get_cnt(f)>,
1266 B<PerlIO_canset_cnt(f)>, B<PerlIO_fast_gets(f)>,
1267 B<PerlIO_set_ptrcnt(f,p,c)>, B<PerlIO_set_cnt(f,c)>, B<PerlIO_has_base(f)>,
1268 B<PerlIO_get_base(f)>, B<PerlIO_get_bufsiz(f)>
1272 =head2 perlxs - XS language reference manual
1282 =item The Anatomy of an XSUB
1284 =item The Argument Stack
1286 =item The RETVAL Variable
1288 =item The MODULE Keyword
1290 =item The PACKAGE Keyword
1292 =item The PREFIX Keyword
1294 =item The OUTPUT: Keyword
1296 =item The CODE: Keyword
1298 =item The INIT: Keyword
1300 =item The NO_INIT Keyword
1302 =item Initializing Function Parameters
1304 =item Default Parameter Values
1306 =item The PREINIT: Keyword
1308 =item The SCOPE: Keyword
1310 =item The INPUT: Keyword
1312 =item Variable-length Parameter Lists
1314 =item The PPCODE: Keyword
1316 =item Returning Undef And Empty Lists
1318 =item The REQUIRE: Keyword
1320 =item The CLEANUP: Keyword
1322 =item The BOOT: Keyword
1324 =item The VERSIONCHECK: Keyword
1326 =item The PROTOTYPES: Keyword
1328 =item The PROTOTYPE: Keyword
1330 =item The ALIAS: Keyword
1332 =item The INCLUDE: Keyword
1334 =item The CASE: Keyword
1336 =item The & Unary Operator
1338 =item Inserting Comments and C Preprocessor Directives
1340 =item Using XS With C++
1342 =item Interface Strategy
1344 =item Perl Objects And C Structures
1356 =head2 perlxstut, perlXStut - Tutorial for XSUBs
1362 =item VERSION CAVEAT
1364 =item DYNAMIC VERSUS STATIC
1370 =item WHAT HAS GONE ON?
1372 =item WRITING GOOD TEST SCRIPTS
1376 =item WHAT'S NEW HERE?
1378 =item INPUT AND OUTPUT PARAMETERS
1380 =item THE XSUBPP COMPILER
1382 =item THE TYPEMAP FILE
1388 =item WHAT HAS HAPPENED HERE?
1390 =item SPECIFYING ARGUMENTS TO XSUBPP
1392 =item THE ARGUMENT STACK
1394 =item EXTENDING YOUR EXTENSION
1396 =item DOCUMENTING YOUR EXTENSION
1398 =item INSTALLING YOUR EXTENSION
1408 =head2 perlguts - Perl's Internal Functions
1418 =item What is an "IV"?
1420 =item Working with SV's
1422 =item What's Really Stored in an SV?
1424 =item Working with AV's
1426 =item Working with HV's
1430 =item Blessed References and Class Objects
1432 =item Creating New Variables
1434 =item Reference Counts and Mortality
1436 =item Stashes and Globs
1438 =item Double-Typed SV's
1440 =item Magic Variables
1442 =item Assigning Magic
1444 =item Magic Virtual Tables
1454 =item XSUB's and the Argument Stack
1456 =item Calling Perl Routines from within C Programs
1458 =item Memory Allocation
1462 =item Putting a C value on Perl stack
1466 =item Scratchpads and recursions
1476 =item Examining the tree
1478 =item Compile pass 1: check routines
1480 =item Compile pass 1a: constant folding
1482 =item Compile pass 2: context propagation
1484 =item Compile pass 3: peephole optimization
1490 AvFILL, av_clear, av_extend, av_fetch, av_len, av_make, av_pop, av_push,
1491 av_shift, av_store, av_undef, av_unshift, CLASS, Copy, croak, CvSTASH,
1492 DBsingle, DBsub, DBtrace, dMARK, dORIGMARK, dowarn, dSP, dXSARGS, dXSI32,
1493 dXSI32, ENTER, EXTEND, FREETMPS, G_ARRAY, G_DISCARD, G_EVAL, GIMME,
1494 G_NOARGS, G_SCALAR, gv_fetchmeth, gv_fetchmethod, gv_stashpv, gv_stashsv,
1495 GvSV, he_delayfree, he_free, hv_clear, hv_delete, hv_exists, hv_fetch,
1496 hv_iterinit, hv_iterkey, hv_iternext, hv_iternextsv, hv_iterval, hv_magic,
1497 HvNAME, hv_store, hv_undef, isALNUM, isALPHA, isDIGIT, isLOWER, isSPACE,
1498 isUPPER, items, ix, LEAVE, MARK, mg_clear, mg_copy, mg_find, mg_free,
1499 mg_get, mg_len, mg_magical, mg_set, Move, na, New, Newc, Newz, newAV,
1500 newHV, newRV_inc, newRV_noinc, newSV, newSViv, newSVnv, newSVpv, newSVrv,
1501 newSVsv, newXS, newXSproto, Nullav, Nullch, Nullcv, Nullhv, Nullsv,
1502 ORIGMARK, perl_alloc, perl_call_argv, perl_call_method, perl_call_pv,
1503 perl_call_sv, perl_construct, perl_destruct, perl_eval_sv, perl_free,
1504 perl_get_av, perl_get_cv, perl_get_hv, perl_get_sv, perl_parse,
1505 perl_require_pv, perl_run, POPi, POPl, POPp, POPn, POPs, PUSHMARK, PUSHi,
1506 PUSHn, PUSHp, PUSHs, PUTBACK, Renew, Renewc, RETVAL, safefree, safemalloc,
1507 saferealloc, savepv, savepvn, SAVETMPS, SP, SPAGAIN, ST, strEQ, strGE,
1508 strGT, strLE, strLT, strNE, strnEQ, strnNE, sv_2mortal, sv_bless, sv_catpv,
1509 sv_catpvn, sv_catsv, sv_cmp, sv_cmp, SvCUR, SvCUR_set, sv_dec, sv_dec,
1510 SvEND, sv_eq, SvGROW, sv_grow, sv_inc, SvIOK, SvIOK_off, SvIOK_on,
1511 SvIOK_only, SvIOK_only, SvIOKp, sv_isa, SvIV, sv_isobject, SvIVX, SvLEN,
1512 sv_len, sv_len, sv_magic, sv_mortalcopy, SvOK, sv_newmortal, sv_no, SvNIOK,
1513 SvNIOK_off, SvNIOKp, SvNOK, SvNOK_off, SvNOK_on, SvNOK_only, SvNOK_only,
1514 SvNOKp, SvNV, SvNVX, SvPOK, SvPOK_off, SvPOK_on, SvPOK_only, SvPOK_only,
1515 SvPOKp, SvPV, SvPVX, SvREFCNT, SvREFCNT_dec, SvREFCNT_inc, SvROK,
1516 SvROK_off, SvROK_on, SvRV, sv_setiv, sv_setnv, sv_setpv, sv_setpvn,
1517 sv_setref_iv, sv_setref_nv, sv_setref_pv, sv_setref_pvn, sv_setsv, SvSTASH,
1518 SVt_IV, SVt_PV, SVt_PVAV, SVt_PVCV, SVt_PVHV, SVt_PVMG, SVt_NV, SvTRUE,
1519 SvTYPE, svtype, SvUPGRADE, sv_upgrade, sv_undef, sv_unref, sv_usepvn,
1520 sv_yes, THIS, toLOWER, toUPPER, warn, XPUSHi, XPUSHn, XPUSHp, XPUSHs, XS,
1521 XSRETURN, XSRETURN_EMPTY, XSRETURN_IV, XSRETURN_NO, XSRETURN_NV,
1522 XSRETURN_PV, XSRETURN_UNDEF, XSRETURN_YES, XST_mIV, XST_mNV, XST_mNO,
1523 XST_mPV, XST_mUNDEF, XST_mYES, XS_VERSION, XS_VERSION_BOOTCHECK, Zero
1529 =head2 perlcall - Perl calling conventions from C
1533 An Error Handler, An Event Driven Program
1535 =item THE PERL_CALL FUNCTIONS
1537 B<perl_call_sv>, B<perl_call_pv>, B<perl_call_method>, B<perl_call_argv>
1555 =item Determining the Context
1559 =item KNOWN PROBLEMS
1565 =item No Parameters, Nothing returned
1567 =item Passing Parameters
1569 =item Returning a Scalar
1571 =item Returning a list of values
1573 =item Returning a list in a scalar context
1575 =item Returning Data from Perl via the parameter list
1579 =item Using G_KEEPERR
1581 =item Using perl_call_sv
1583 =item Using perl_call_argv
1585 =item Using perl_call_method
1589 =item Using Perl to dispose of temporaries
1591 =item Strategies for storing Callback Context Information
1593 1. Ignore the problem - Allow only 1 callback, 2. Create a sequence of
1594 callbacks - hard wired limit, 3. Use a parameter to map to the Perl
1597 =item Alternate Stack Manipulation
1607 =head1 PRAGMA DOCUMENTATION
1609 =head2 blib - Use MakeMaker's uninstalled version of a package
1619 =head2 diagnostics - Perl compiler pragma to force verbose warning
1628 =item The C<diagnostics> Pragma
1630 =item The I<splain> Program
1642 =head2 integer - Perl pragma to compute arithmetic in integer instead of
1649 =head2 less - perl pragma to request less of something from the compiler
1655 =head2 lib - manipulate @INC at compile time
1663 =item ADDING DIRECTORIES TO @INC
1665 =item DELETING DIRECTORIES FROM @INC
1667 =item RESTORING ORIGINAL @INC
1675 =head2 locale - Perl pragma to use and avoid POSIX locales for built-in
1682 =head2 overload - Package for overloading perl operations
1686 =item CAVEAT SCRIPTOR
1692 =item Declaration of overloaded functions
1694 =item Calling Conventions for Binary Operations
1696 FALSE, TRUE, C<undef>
1698 =item Calling Conventions for Unary Operations
1700 =item Overloadable Operations
1702 I<Arithmetic operations>, I<Comparison operations>, I<Bit operations>,
1703 I<Increment and decrement>, I<Transcendental functions>, I<Boolean, string
1704 and numeric conversion>, I<Special>
1706 =item Inheritance and overloading
1708 Strings as values of C<use overload> directive, Overloading of an operation
1709 is inherited by derived classes
1713 =item SPECIAL SYMBOLS FOR C<use overload>
1721 C<undef>, TRUE, defined, but FALSE
1723 =item Copy Constructor
1729 =item MAGIC AUTOGENERATION
1731 I<Assignment forms of arithmetic operations>, I<Conversion operations>,
1732 I<Increment and decrement>, C<abs($a)>, I<Unary minus>, I<Negation>,
1733 I<Concatenation>, I<Comparison operations>, I<Copy operator>
1737 =item Run-time Overloading
1739 =item Public functions
1741 overload::StrVal(arg), overload::Overloaded(arg), overload::Method(obj,op)
1743 =item IMPLEMENTATION
1751 =head2 sigtrap - Perl pragma to enable simple signal handling
1761 =item SIGNAL HANDLERS
1763 B<stack-trace>, B<die>, B<handler> I<your-handler>
1767 B<normal-signals>, B<error-signals>, B<old-interface-signals>
1771 B<untrapped>, B<any>, I<signal>, I<number>
1777 =head2 strict - Perl pragma to restrict unsafe constructs
1783 C<strict refs>, C<strict vars>, C<strict subs>
1785 =head2 subs - Perl pragma to predeclare sub names
1791 =head2 vars - Perl pragma to predeclare global variable names
1797 =head1 MODULE DOCUMENTATION
1799 =head2 AnyDBM_File - provide framework for multiple DBMs
1807 =item DBM Comparisons
1815 =head2 AutoLoader - load functions only on demand
1827 =item Package Lexicals
1829 =item AutoLoader vs. SelfLoader
1835 =head2 AutoSplit - split a package for autoloading
1845 =head2 Benchmark - benchmark running times of code
1857 =item Standard Exports
1859 timeit(COUNT, CODE), timethis, timethese, timediff, timestr
1861 =item Optional Exports
1873 =item MODIFICATION HISTORY
1875 =head2 Bundle::CPAN - A bundle to play with all the other modules on CPAN
1885 =head2 CPAN - query, download and build perl modules from CPAN sites
1893 =item Interactive Mode
1895 Searching for authors, bundles, distribution files and modules, make, test,
1896 install, clean modules or distributions, readme, look module or
1905 =item ProgrammerE<39>s interface
1915 =item Floppy, Zip, and all that Jazz
1921 o conf E<lt>scalar optionE<gt>, o conf E<lt>scalar optionE<gt>
1922 E<lt>valueE<gt>, o conf E<lt>list optionE<gt>, o conf E<lt>list optionE<gt>
1923 [shift|pop], o conf E<lt>list optionE<gt> [unshift|push|splice]
1936 =head2 CPAN::FirstTime - Utility for CPAN::Config file Initialization
1942 =head2 CPANox, CPAN::Nox - Wrapper around CPAN.pm without using any XS
1951 =head2 Carp, carp - warn of errors (from perspective of caller)
1957 =head2 Class::Template - struct/member template builder
1965 Example 1, Example 2
1969 =head2 Config - access Perl configuration information
1975 myconfig(), config_sh(), config_vars(@names)
1983 =head2 Cwd, getcwd - get pathname of current working directory
1989 =head2 DB_File - Perl5 access to Berkeley DB
1995 B<DB_HASH>, B<DB_BTREE>, B<DB_RECNO>
1999 =item How does DB_File interface to Berkeley DB?
2001 =item Opening a Berkeley DB Database File
2003 =item Default Parameters
2005 =item In Memory Databases
2013 =item A Simple Example.
2021 =item Changing the BTREE sort order
2023 =item Handling duplicate keys
2025 =item The get_dup method.
2027 =item Matching Partial Keys
2035 =item The bval option
2037 =item A Simple Example
2041 B<$X-E<gt>push(list) ;>, B<$value = $X-E<gt>pop ;>, B<$X-E<gt>shift>,
2042 B<$X-E<gt>unshift(list) ;>, B<$X-E<gt>length>
2044 =item Another Example
2048 =item THE API INTERFACE
2050 B<$status = $X-E<gt>get($key, $value [, $flags]) ;>, B<$status =
2051 $X-E<gt>put($key, $value [, $flags]) ;>, B<$status = $X-E<gt>del($key [,
2052 $flags]) ;>, B<$status = $X-E<gt>fd ;>, B<$status = $X-E<gt>seq($key,
2053 $value, $flags) ;>, B<$status = $X-E<gt>sync([$flags]) ;>
2055 =item HINTS AND TIPS
2059 =item Locking Databases
2061 =item Sharing databases with C applications
2063 =item The untie gotcha
2067 =item COMMON QUESTIONS
2071 =item Why is there Perl source in my database?
2073 =item How do I store complex data structures with DB_File?
2075 =item What does "Invalid Argument" mean?
2077 =item What does "Bareword 'DB_File' not allowed" mean?
2091 =head2 Devel::SelfStubber - generate stubs for a SelfLoading module
2097 =head2 DirHandle - supply object methods for directory handles
2103 =head2 DynaLoader - Dynamically load C libraries into Perl code
2109 @dl_library_path, @dl_resolve_using, @dl_require_symbols, @dl_librefs,
2110 @dl_modules, dl_error(), $dl_debug, dl_findfile(), dl_expandspec(),
2111 dl_load_file(), dl_loadflags(), dl_find_symbol(),
2112 dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(),
2117 =head2 English - use nice English (or awk) names for ugly punctuation
2124 =head2 Env - perl module that imports environment variables
2132 =head2 Exporter - Implements default import method for modules
2140 =item Selecting What To Export
2142 =item Specialised Import Lists
2144 =item Module Version Checking
2146 =item Managing Unknown Symbols
2148 =item Tag Handling Utility Functions
2152 =head2 ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications
2162 xsinit(), Examples, ldopts(), Examples, perl_inc(), ccflags(), ccdlflags(),
2163 ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules)
2171 =head2 ExtUtils::Install - install files from here to there
2177 =head2 ExtUtils::Liblist - determine libraries to use and how to use them
2183 For static extensions, For dynamic extensions, For dynamic extensions
2189 =item LDLOADLIBS and LD_RUN_PATH
2199 =item VMS implementation
2205 =head2 ExtUtils::MM_OS2 - methods to override UN*X behaviour in
2212 =head2 ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker
2222 =item Preloaded methods
2224 canonpath, catdir, catfile, curdir, rootdir, updir
2226 =item SelfLoaded methods
2228 c_o (o), cflags (o), clean (o), const_cccmd (o), const_config (o),
2229 const_loadlibs (o), constants (o), depend (o), dir_target (o), dist (o),
2230 dist_basics (o), dist_ci (o), dist_core (o), dist_dir (o), dist_test (o),
2231 dlsyms (o), dynamic (o), dynamic_bs (o), dynamic_lib (o), exescan,
2232 extliblist, file_name_is_absolute, find_perl
2234 =item Methods to actually produce chunks of text for the Makefile
2236 force (o), guess_name, has_link_code, init_dirscan, init_main, init_others,
2237 install (o), installbin (o), libscan (o), linkext (o), lsdir, macro (o),
2238 makeaperl (o), makefile (o), manifypods (o), maybe_command,
2239 maybe_command_in_dirs, needs_linking (o), nicetext, parse_version, pasthru
2240 (o), path, perl_script, perldepend (o), pm_to_blib, post_constants (o),
2241 post_initialize (o), postamble (o), prefixify, processPL (o), realclean
2242 (o), replace_manpage_separator, static (o), static_lib (o), staticmake (o),
2243 subdir_x (o), subdirs (o), test (o), test_via_harness (o), test_via_script
2244 (o), tool_autosplit (o), tools_other (o), tool_xsubpp (o), top_targets (o),
2245 writedoc, xs_c (o), xs_o (o)
2251 =head2 ExtUtils::MM_VMS - methods to override UN*X behaviour in
2260 =item Methods always loaded
2262 eliminate_macros, fixpath, catdir, catfile, wraplist, curdir (override),
2263 rootdir (override), updir (override)
2265 =item SelfLoaded methods
2267 guess_name (override), find_perl (override), path (override), maybe_command
2268 (override), maybe_command_in_dirs (override), perl_script (override),
2269 file_name_is_absolute (override), replace_manpage_separator, init_others
2270 (override), constants (override), cflags (override), const_cccmd
2271 (override), pm_to_blib (override), tool_autosplit (override), tool_sxubpp
2272 (override), xsubpp_version (override), tools_other (override), dist
2273 (override), c_o (override), xs_c (override), xs_o (override), top_targets
2274 (override), dlsyms (override), dynamic_lib (override), dynamic_bs
2275 (override), static_lib (override), manifypods (override), processPL
2276 (override), installbin (override), subdir_x (override), clean (override),
2277 realclean (override), dist_basics (override), dist_core (override),
2278 dist_dir (override), dist_test (override), install (override), perldepend
2279 (override), makefile (override), test (override), test_via_harness
2280 (override), test_via_script (override), makeaperl (override), nicetext
2285 =head2 ExtUtils::MakeMaker - create an extension Makefile
2293 =item How To Write A Makefile.PL
2295 =item Default Makefile Behaviour
2303 =item PREFIX and LIB attribute
2307 =item Static Linking of a new Perl Binary
2309 =item Determination of Perl Library and Installation Locations
2311 =item Which architecture dependent directory?
2313 =item Using Attributes and Parameters
2315 C, CONFIG, CONFIGURE, DEFINE, DIR, DISTNAME, DL_FUNCS, DL_VARS,
2316 EXCLUDE_EXT, EXE_FILES, NO_VC, FIRST_MAKEFILE, FULLPERL, H, INC,
2317 INCLUDE_EXT, INSTALLARCHLIB, INSTALLBIN, INSTALLDIRS, INSTALLMAN1DIR,
2318 INSTALLMAN3DIR, INSTALLPRIVLIB, INSTALLSCRIPT, INSTALLSITELIB,
2319 INSTALLSITEARCH, INST_ARCHLIB, INST_BIN, INST_EXE, INST_LIB, INST_MAN1DIR,
2320 INST_MAN3DIR, INST_SCRIPT, LDFROM, LIBPERL_A, LIB, LIBS, LINKTYPE,
2321 MAKEAPERL, MAKEFILE, MAN1PODS, MAN3PODS, MAP_TARGET, MYEXTLIB, NAME,
2322 NEEDS_LINKING, NOECHO, NORECURS, OBJECT, OPTIMIZE, PERL, PERLMAINCC,
2323 PERL_ARCHLIB, PERL_LIB, PERL_SRC, PL_FILES, PM, PMLIBDIRS, PREFIX,
2324 PREREQ_PM, SKIP, TYPEMAPS, VERSION, VERSION_FROM, XS, XSOPT, XSPROTOARG,
2327 =item Additional lowercase attributes
2329 clean, depend, dist, dynamic_lib, installpm, linkext, macro, realclean,
2332 =item Overriding MakeMaker Methods
2334 =item Hintsfile support
2336 =item Distribution Support
2338 make distcheck, make skipcheck, make distclean, make manifest,
2339 make distdir, make tardist, make dist, make uutardist, make
2340 shdist, make zipdist, make ci
2348 =head2 ExtUtils::Manifest - utilities to write and check a MANIFEST file
2358 =item GLOBAL VARIABLES
2362 C<Not in MANIFEST:> I<file>, C<No such file:> I<file>, C<MANIFEST:> I<$!>,
2363 C<Added to MANIFEST:> I<file>
2369 =head2 ExtUtils::Mkbootstrap - make a bootstrap file for use by DynaLoader
2375 =head2 ExtUtils::Mksymlists - write linker options files for dynamic
2382 NAME, DL_FUNCS, DL_VARS, FILE, FUNCLIST, DLBASE
2388 =head2 ExtUtils::testlib - add blib/* directories to @INC
2394 =head2 Fatal - replace functions with equivalents which succeed or die
2402 =head2 Fcntl - load the C Fcntl.h defines
2410 =item EXPORTED SYMBOLS
2412 =head2 File::Basename, fileparse - split a pathname into pieces
2418 fileparse_set_fstype, fileparse
2422 C<basename>, C<dirname>
2424 =head2 File::CheckTree, validate - run many filetest checks on a tree
2430 =head2 File::Compare - Compare files or filehandles
2440 =head2 File::Copy - Copy files or filehandles
2448 =item Special behavior if C<syscopy> is defined (VMS and OS/2)
2450 rmscopy($from,$to[,$date_flag])
2458 =head2 File::Find, find - traverse a file tree
2464 =head2 File::Path - create or remove a series of directories
2474 =head2 File::stat - by-name interface to Perl's built-in stat() functions
2484 =head2 FileCache - keep more files open than the system permits
2492 =head2 FileHandle - supply object methods for filehandles
2498 $fh->print, $fh->printf, $fh->getline, $fh->getlines
2502 =head2 FindBin - Locate directory of original perl script
2508 =item EXPORTABLE VARIABLES
2518 =head2 GDBM_File - Perl5 access to the gdbm library.
2530 =head2 Getopt::Long, GetOptions - extended processing of command line
2537 E<lt>noneE<gt>, !, =s, :s, =i, :i, =f, :f
2541 =item Linkage specification
2543 =item Aliases and abbreviations
2545 =item Non-option call-back routine
2547 =item Option starters
2557 =item CONFIGURATION VARIABLES
2559 $Getopt::Long::autoabbrev, $Getopt::Long::getopt_compat,
2560 $Getopt::Long::order, $Getopt::Long::bundling, $Getopt::Long::ignorecase,
2561 $Getopt::Long::passthrough, $Getopt::Long::VERSION, $Getopt::Long::error,
2562 $Getopt::Long::debug
2564 =head2 Getopt::Std, getopt - Process single-character switches with switch
2571 =head2 I18N::Collate - compare 8-bit scalar data according to the current
2578 =head2 IO - load various IO modules
2584 =head2 IO::lib::IO::File, IO::File - supply object methods for filehandles
2596 open( FILENAME [,MODE [,PERMS]] )
2602 =head2 IO::lib::IO::Handle, IO::Handle - supply object methods for I/O
2611 new (), new_from_fd ( FD, MODE )
2615 $fh->getline, $fh->getlines, $fh->fdopen ( FD, MODE ), $fh->write ( BUF,
2616 LEN [, OFFSET }\] ), $fh->opened, $fh->untaint
2626 =head2 IO::lib::IO::Pipe, IO::pipe - supply object methods for pipes
2634 new ( [READER, WRITER] )
2638 reader ([ARGS]), writer ([ARGS]), handles ()
2646 =head2 IO::lib::IO::Seekable, IO::Seekable - supply seek based methods for
2657 =head2 IO::lib::IO::Select, IO::Select - OO interface to the select system
2670 add ( HANDLES ), remove ( HANDLES ), exists ( HANDLE ), handles, can_read (
2671 [ TIMEOUT ] ), can_write ( [ TIMEOUT ] ), has_error ( [ TIMEOUT ] ), count
2672 (), bits(), bits(), select ( READ, WRITE, ERROR [, TIMEOUT ] )
2680 =head2 IO::lib::IO::Socket, IO::Socket - Object interface to socket
2693 accept([PKG]), timeout([VAL]), sockopt(OPT [, VAL]), sockdomain, socktype,
2700 =item IO::Socket::INET
2704 sockaddr (), sockport (), sockhost (), peeraddr (), peerport (), peerhost
2707 =item IO::Socket::UNIX
2711 hostpath(), peerpath()
2721 =head2 IPC::Open2, open2 - open a process for both reading and writing
2731 =head2 IPC::Open3, open3 - open a process for reading, writing, and error
2740 =head2 Math::BigFloat - Arbitrary length float math package
2746 number format, Error returns 'NaN', Division is computed to
2752 =head2 Math::BigInt - Arbitrary size integer math package
2758 Canonical notation, Input, Output
2766 =head2 Math::Complex - complex numbers and associated mathematical
2777 =item STRINGIFICATION
2785 =head2 NDBM_File - Tied access to ndbm files
2791 =head2 Net::Ping - check a remote host for reachability
2801 Net::Ping->new([$proto [, $def_timeout [, $bytes]]]);, $p->ping($host [,
2802 $timeout]);, $p->close();, pingecho($host [, $timeout]);
2810 =head2 Net::hostent - by-name interface to Perl's built-in gethost*()
2823 =head2 Net::netent - by-name interface to Perl's built-in getnet*()
2836 =head2 Net::protoent - by-name interface to Perl's built-in getproto*()
2847 =head2 Net::servent - by-name interface to Perl's built-in getserv*()
2860 =head2 ODBM_File - Tied access to odbm files
2866 =head2 Opcode - Disable named opcodes when compiling perl code
2876 =item Operator Names and Operator Lists
2878 an operator name (opname), an operator tag name (optag), a negated opname
2879 or optag, an operator set (opset)
2881 =item Opcode Functions
2883 opcodes, opset (OP, ...), opset_to_ops (OPSET), opset_to_hex (OPSET),
2884 full_opset, empty_opset, invert_opset (OPSET), verify_opset (OPSET, ...),
2885 define_optag (OPTAG, OPSET), opmask_add (OPSET), opmask, opdesc (OP, ...),
2888 =item Manipulating Opsets
2892 =item Predefined Opcode Tags
2894 :base_core, :base_mem, :base_loop, :base_io, :base_orig, :base_math,
2895 :default, :filesys_read, :sys_db, :browse, :filesys_open, :filesys_write,
2896 :subprocess, :ownprocess, :others, :still_to_be_decided, :dangerous
2902 =head2 Opcode::Safe, Safe - Compile and execute code in restricted
2909 a new namespace, an operator mask
2915 =item RECENT CHANGES
2917 =item Methods in class Safe
2919 permit (OP, ...), permit_only (OP, ...), deny (OP, ...), deny_only (OP,
2920 ...), trap (OP, ...), untrap (OP, ...), share (NAME, ...), share_from
2921 (PACKAGE, ARRAYREF), varglob (VARNAME), reval (STRING), rdo (FILENAME),
2922 root (NAMESPACE), mask (MASK)
2924 =item Some Safety Issues
2926 Memory, CPU, Snooping, Signals, State Changes
2932 =head2 Opcode::ops, ops - Perl pragma to restrict unsafe operations when
2941 =head2 POSIX - Perl interface to IEEE Std 1003.1
2953 _exit, abort, abs, access, acos, alarm, asctime, asin, assert, atan, atan2,
2954 atexit, atof, atoi, atol, bsearch, calloc, ceil, chdir, chmod, chown,
2955 clearerr, clock, close, closedir, cos, cosh, creat, ctermid, ctime,
2956 cuserid, difftime, div, dup, dup2, errno, execl, execle, execlp, execv,
2957 execve, execvp, exit, exp, fabs, fclose, fcntl, fdopen, feof, ferror,
2958 fflush, fgetc, fgetpos, fgets, fileno, floor, fmod, fopen, fork, fpathconf,
2959 fprintf, fputc, fputs, fread, free, freopen, frexp, fscanf, fseek, fsetpos,
2960 fstat, ftell, fwrite, getc, getchar, getcwd, getegid, getenv, geteuid,
2961 getgid, getgrgid, getgrnam, getgroups, getlogin, getpgrp, getpid, getppid,
2962 getpwnam, getpwuid, gets, getuid, gmtime, isalnum, isalpha, isatty,
2963 iscntrl, isdigit, isgraph, islower, isprint, ispunct, isspace, isupper,
2964 isxdigit, kill, labs, ldexp, ldiv, link, localeconv, localtime, log, log10,
2965 longjmp, lseek, malloc, mblen, mbstowcs, mbtowc, memchr, memcmp, memcpy,
2966 memmove, memset, mkdir, mkfifo, mktime, modf, nice, offsetof, open,
2967 opendir, pathconf, pause, perror, pipe, pow, printf, putc, putchar, puts,
2968 qsort, raise, rand, read, readdir, realloc, remove, rename, rewind,
2969 rewinddir, rmdir, scanf, setgid, setjmp, setlocale, setpgid, setsid,
2970 setuid, sigaction, siglongjmp, sigpending, sigprocmask, sigsetjmp,
2971 sigsuspend, sin, sinh, sleep, sprintf, sqrt, srand, sscanf, stat, strcat,
2972 strchr, strcmp, strcoll, strcpy, strcspn, strerror, strftime, strlen,
2973 strncat, strncmp, strncpy, stroul, strpbrk, strrchr, strspn, strstr,
2974 strtod, strtok, strtol, strtoul, strxfrm, sysconf, system, tan, tanh,
2975 tcdrain, tcflow, tcflush, tcgetpgrp, tcsendbreak, tcsetpgrp, time, times,
2976 tmpfile, tmpnam, tolower, toupper, ttyname, tzname, tzset, umask, uname,
2977 ungetc, unlink, utime, vfprintf, vprintf, vsprintf, wait, waitpid,
2978 wcstombs, wctomb, write
2984 =item POSIX::SigAction
2990 new, addset, delset, emptyset, fillset, ismember
2992 =item POSIX::Termios
2994 new, getattr, getcc, getcflag, getiflag, getispeed, getlflag, getoflag,
2995 getospeed, setattr, setcc, setcflag, setiflag, setispeed, setlflag,
2996 setoflag, setospeed, Baud rate values, Terminal interface values, c_cc
2997 field values, c_cflag field values, c_iflag field values, c_lflag field
2998 values, c_oflag field values
3002 =item PATHNAME CONSTANTS
3006 =item POSIX CONSTANTS
3010 =item SYSTEM CONFIGURATION
3068 =head2 Pod::Text - convert POD data to formatted ASCII text
3078 =head2 SDBM_File - Tied access to sdbm files
3084 =head2 Search::Dict, look - search for key in dictionary file
3090 =head2 SelectSaver - save and restore selected file handle
3096 =head2 SelfLoader - load functions only on demand
3104 =item The __DATA__ token
3106 =item SelfLoader autoloading
3108 =item Autoloading and package lexicals
3110 =item SelfLoader and AutoLoader
3112 =item __DATA__, __END__, and the FOOBAR::DATA filehandle.
3114 =item Classes and inherited methods.
3118 =item Multiple packages and fully qualified subroutine names
3120 =head2 Shell - run shell commands transparently within perl
3128 =head2 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C
3129 socket.h defines and structure manipulators
3135 inet_aton HOSTNAME, inet_ntoa IP_ADDRESS, INADDR_ANY, INADDR_BROADCAST,
3136 INADDR_LOOPBACK, INADDR_NONE, sockaddr_in PORT, ADDRESS, sockaddr_in
3137 SOCKADDR_IN, pack_sockaddr_in PORT, IP_ADDRESS, unpack_sockaddr_in
3138 SOCKADDR_IN, sockaddr_un PATHNAME, sockaddr_un SOCKADDR_UN,
3139 pack_sockaddr_un PATH, unpack_sockaddr_un SOCKADDR_UN
3141 =head2 Symbol - manipulate Perl symbols and their names
3147 =head2 Sys::Hostname - Try every conceivable way to get hostname
3155 =head2 Syslog, Sys::Syslog, openlog, closelog, setlogmask, syslog - Perl
3156 interface to the UNIX syslog(3) calls
3162 openlog $ident, $logopt, $facility, syslog $priority, $format, @args,
3163 setlogmask $mask_priority, closelog
3173 =head2 Term::Cap - Perl termcap interface
3181 =head2 Term::Complete - Perl word completion module
3187 E<lt>tabE<gt>Attempts word completion.
3188 Cannot be changed, ^D, ^U, E<lt>delE<gt>, E<lt>bsE<gt>
3196 =head2 Term::ReadLine - Perl interface to various C<readline> packages. If
3197 no real package is found, substitutes stubs instead of basic functions.
3203 =item Minimal set of supported functions
3205 C<ReadLine>, C<new>, C<readline>, C<addhistory>, C<IN>, $C<OUT>,
3206 C<MinLine>, C<findConsole>, C<Features>
3210 =head2 Test::Harness - run perl standard test scripts with statistics
3218 =item The test script output
3226 C<All tests successful.\nFiles=%d, Tests=%d, %s>, C<FAILED tests
3227 %s\n\tFailed %d/%d tests, %.2f%% okay.>, C<Test returned status %d (wstat
3228 %d)>, C<Failed 1 test, %.2f%% okay. %s>, C<Failed %d/%d tests, %.2f%% okay.
3237 =head2 Text::Abbrev, abbrev - create an abbreviation table from a list
3245 =head2 Text::ParseWords - parse text into an array of tokens
3253 =head2 Text::Soundex - Implementation of the Soundex Algorithm as Described
3266 =head2 Text::Tabs -- expand and unexpand tabs per the unix expand(1) and
3277 =head2 Text::Wrap - line wrapping to form simple paragraphs
3289 =head2 Tie::Hash, Tie::StdHash - base class definitions for tied hashes
3295 TIEHASH classname, LIST, STORE this, key, value, FETCH this, key, FIRSTKEY
3296 this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, key, CLEAR this
3300 =item MORE INFORMATION
3302 =head2 Tie::RefHash - use references as hash keys
3316 =head2 Tie::Scalar, Tie::StdScalar - base class definitions for tied
3323 TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this
3325 =item MORE INFORMATION
3327 =head2 Tie::SubstrHash - Fixed-table-size, fixed-key-length hashing
3335 =head2 Time::Local - efficiently compute time from local and GMT time
3341 =head2 Time::gmtime - by-name interface to Perl's built-in gmtime()
3352 =head2 Time::localtime - by-name interface to Perl's built-in localtime()
3363 =head2 Time::tm - internal object used by Time::gmtime and Time::localtime
3371 =head2 UNIVERSAL - base class for ALL classes (blessed references)
3377 isa ( TYPE ), can ( METHOD ), VERSION ( [ REQUIRE ] ), isa ( REF, TYPE )
3379 =head2 User::grent - by-name interface to Perl's built-in getgr*()
3390 =head2 User::pwent - by-name interface to Perl's built-in getpw*()
3401 =head1 AUXILIARY DOCUMENTATION
3403 Here should be listed all the extra programs' documentation, but they
3404 don't all have manual pages yet:
3426 Larry Wall E<lt>F<larry@wall.org>E<gt>, with the help of oodles