X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperltoc.pod;h=5595bda82d068e18e8694f5c5d79d5139091f1a6;hb=56da5a46eac515b5a165aaf05cb06f7bcdfd8e67;hp=7edde527c69bdc13d2df8b0ab1c5f5f1e1762b4f;hpb=ba62762e535f4b26bec252f67a5dcfb2a28c8b16;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perltoc.pod b/pod/perltoc.pod index 7edde52..5595bda 100644 --- a/pod/perltoc.pod +++ b/pod/perltoc.pod @@ -1,4 +1,8 @@ +# !!!!!!! DO NOT EDIT THIS FILE !!!!!!! +# This file is autogenerated by buildtoc from all the other pods. +# Edit those files and run buildtoc --build-toc to effect changes. + =head1 NAME perltoc - perl documentation table of contents @@ -29,6 +33,8 @@ through to locate the proper section you're looking for. =item Miscellaneous +=item Language-Specific + =item Platform-Specific =back @@ -101,274 +107,270 @@ Parentheses for capturing, Other regexp features =back -=head2 perlfaq - frequently asked questions about Perl ($Date: 2001/10/16 -13:27:22 $) +=head2 perlreftut - Mark's very short tutorial about references =over 4 =item DESCRIPTION -=over 4 +=item Who Needs Complicated Data Structures? -=item perlfaq: Structural overview of the FAQ. +=item The Solution -=item L: General Questions About Perl +=item Syntax -=item L: Obtaining and Learning about Perl +=over 4 -=item L: Programming Tools +=item Making References -=item L: Data Manipulation +=item Using References -=item L: Files and Formats +=item An Example -=item L: Regexps +=item Arrow Rule -=item L: General Perl Language Issues +=back -=item L: System Interaction +=item Solution -=item L: Networking +=item The Rest -=back +=item Summary -=item About the perlfaq documents +=item Credits =over 4 -=item Where to get the perlfaq - -=item How to contribute to the perlfaq - -=item What will happen if you mail your Perl programming problems to the -authors +=item Distribution Conditions =back -=item Credits +=back -=item Author and Copyright Information +=head2 perldsc - Perl Data Structures Cookbook =over 4 -=item Bundled Distributions +=item DESCRIPTION -=item Disclaimer +arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes, +more elaborate constructs -=back +=item REFERENCES -=item Changes +=item COMMON MISTAKES -1/November/2000, 23/May/99, 13/April/99, 7/January/99, 22/June/98, -24/April/97, 23/April/97, 25/March/97, 18/March/97, 17/March/97 Version, -Initial Release: 11/March/97 +=item CAVEAT ON PRECEDENCE -=back +=item WHY YOU SHOULD ALWAYS C -=head2 perlbook - Perl book information +=item DEBUGGING -=over 4 +=item CODE EXAMPLES -=item DESCRIPTION +=item ARRAYS OF ARRAYS -=back +=over 4 -=head2 perlsyn - Perl syntax +=item Declaration of an ARRAY OF ARRAYS -=over 4 +=item Generation of an ARRAY OF ARRAYS -=item DESCRIPTION +=item Access and Printing of an ARRAY OF ARRAYS -=over 4 +=back -=item Declarations +=item HASHES OF ARRAYS -=item Simple statements +=over 4 -=item Compound statements +=item Declaration of a HASH OF ARRAYS -=item Loop Control +=item Generation of a HASH OF ARRAYS -=item For Loops +=item Access and Printing of a HASH OF ARRAYS -=item Foreach Loops +=back -=item Basic BLOCKs and Switch Statements +=item ARRAYS OF HASHES -=item Goto +=over 4 -=item PODs: Embedded Documentation +=item Declaration of an ARRAY OF HASHES -=item Plain Old Comments (Not!) +=item Generation of an ARRAY OF HASHES -=back +=item Access and Printing of an ARRAY OF HASHES =back -=head2 perldata - Perl data types +=item HASHES OF HASHES =over 4 -=item DESCRIPTION +=item Declaration of a HASH OF HASHES -=over 4 +=item Generation of a HASH OF HASHES -=item Variable names +=item Access and Printing of a HASH OF HASHES -=item Context +=back -=item Scalar values +=item MORE ELABORATE RECORDS -=item Scalar value constructors +=over 4 -=item List value constructors +=item Declaration of MORE ELABORATE RECORDS -=item Slices +=item Declaration of a HASH OF COMPLEX RECORDS -=item Typeglobs and Filehandles +=item Generation of a HASH OF COMPLEX RECORDS =back +=item Database Ties + =item SEE ALSO +=item AUTHOR + =back -=head2 perlop - Perl operators and precedence +=head2 perllol - Manipulating Arrays of Arrays in Perl =over 4 -=item SYNOPSIS - =item DESCRIPTION =over 4 -=item Terms and List Operators (Leftward) +=item Declaration and Access of Arrays of Arrays -=item The Arrow Operator +=item Growing Your Own -=item Auto-increment and Auto-decrement +=item Access and Printing -=item Exponentiation +=item Slices -=item Symbolic Unary Operators +=back -=item Binding Operators +=item SEE ALSO -=item Multiplicative Operators +=item AUTHOR -=item Additive Operators +=back -=item Shift Operators +=head2 perlrequick - Perl regular expressions quick start -=item Named Unary Operators +=over 4 -=item Relational Operators +=item DESCRIPTION -=item Equality Operators +=item The Guide -=item Bitwise And +=over 4 -=item Bitwise Or and Exclusive Or +=item Simple word matching -=item C-style Logical And +=item Using character classes -=item C-style Logical Or +=item Matching this or that -=item Range Operators +=item Grouping things and hierarchical matching -=item Conditional Operator +=item Extracting matches -=item Assignment Operators +=item Matching repetitions -=item Comma Operator +=item More matching -=item List Operators (Rightward) +=item Search and replace -=item Logical Not +=item The split operator -=item Logical And +=back -=item Logical or and Exclusive Or +=item BUGS -=item C Operators Missing From Perl +=item SEE ALSO -unary &, unary *, (TYPE) +=item AUTHOR AND COPYRIGHT -=item Quote and Quote-like Operators +=over 4 -=item Regexp Quote-Like Operators +=item Acknowledgments -?PATTERN?, m/PATTERN/cgimosx, /PATTERN/cgimosx, q/STRING/, C<'STRING'>, -qq/STRING/, "STRING", qr/STRING/imosx, qx/STRING/, `STRING`, qw/STRING/, -s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds, -y/SEARCHLIST/REPLACEMENTLIST/cds, <, C, C, C, C, C<''>, C, C<"">, -C<``>, C, C, C<< >>, C, C, C, -C,, Interpolation of regular expressions, Optimization of -regular expressions +=head2 perlretut - Perl regular expressions tutorial -=item I/O Operators +=over 4 -=item Constant Folding +=item DESCRIPTION -=item Bitwise String Operators +=item Part 1: The basics -=item Integer Arithmetic +=over 4 -=item Floating-point Arithmetic +=item Simple word matching -=item Bigger Numbers +=item Using character classes -=back +=item Matching this or that + +=item Grouping things and hierarchical matching + +=item Extracting matches + +=item Matching repetitions + +=item Building a regexp + +=item Using regular expressions in Perl =back -=head2 perlsub - Perl subroutines +=item Part 2: Power tools =over 4 -=item SYNOPSIS +=item More on characters, strings, and character classes -=item DESCRIPTION +=item Compiling and saving regular expressions -=over 4 +=item Embedding comments and modifiers in a regular expression -=item Private Variables via my() +=item Non-capturing groupings -=item Persistent Private Variables +=item Looking ahead and looking behind -=item Temporary Values via local() +=item Using independent subexpressions to prevent backtracking -=item Lvalue subroutines +=item Conditional expressions -=item Passing Symbol Table Entries (typeglobs) +=item A bit of magic: executing Perl code in a regular expression -=item When to Still Use local() +=item Pragmas and debugging -=item Pass by Reference +=back -=item Prototypes +=item BUGS -=item Constant Functions +=item SEE ALSO -=item Overriding Built-in Functions +=item AUTHOR AND COPYRIGHT -=item Autoloading +=over 4 -=item Subroutine Attributes +=item Acknowledgments =back -=item SEE ALSO - =back -=head2 perlfunc - Perl builtin functions +=head2 perlboot - Beginner's Object-Oriented Tutorial =over 4 @@ -376,360 +378,271 @@ regular expressions =over 4 -=item Perl Functions by Category +=item If we could talk to the animals... -Functions for SCALARs or strings, Regular expressions and pattern matching, -Numeric functions, Functions for real @ARRAYs, Functions for list data, -Functions for real %HASHes, Input and output functions, Functions for fixed -length data or records, Functions for filehandles, files, or directories, -Keywords related to the control flow of your perl program, Keywords related -to scoping, Miscellaneous functions, Functions for processes and process -groups, Keywords related to perl modules, Keywords related to classes and -object-orientedness, Low-level socket functions, System V interprocess -communication functions, Fetching user and group info, Fetching network -info, Time-related functions, Functions new in perl5, Functions obsoleted -in perl5 +=item Introducing the method invocation arrow -=item Portability - -=item Alphabetical Listing of Perl Functions +=item Invoking a barnyard -I<-X> FILEHANDLE, I<-X> EXPR, I<-X>, abs VALUE, abs, accept -NEWSOCKET,GENERICSOCKET, alarm SECONDS, alarm, atan2 Y,X, bind SOCKET,NAME, -binmode FILEHANDLE, DISCIPLINE, binmode FILEHANDLE, bless REF,CLASSNAME, -bless REF, caller EXPR, caller, chdir EXPR, chmod LIST, chomp VARIABLE, -chomp LIST, chomp, chop VARIABLE, chop LIST, chop, chown LIST, chr NUMBER, -chr, chroot FILENAME, chroot, close FILEHANDLE, close, closedir DIRHANDLE, -connect SOCKET,NAME, continue BLOCK, cos EXPR, cos, crypt PLAINTEXT,SALT, -dbmclose HASH, dbmopen HASH,DBNAME,MASK, defined EXPR, defined, delete -EXPR, die LIST, do BLOCK, do SUBROUTINE(LIST), do EXPR, dump LABEL, dump, -each HASH, eof FILEHANDLE, eof (), eof, eval EXPR, eval BLOCK, exec LIST, -exec PROGRAM LIST, exists EXPR, exit EXPR, exp EXPR, exp, fcntl -FILEHANDLE,FUNCTION,SCALAR, fileno FILEHANDLE, flock FILEHANDLE,OPERATION, -fork, format, formline PICTURE,LIST, getc FILEHANDLE, getc, getlogin, -getpeername SOCKET, getpgrp PID, getppid, getpriority WHICH,WHO, getpwnam -NAME, getgrnam NAME, gethostbyname NAME, getnetbyname NAME, getprotobyname -NAME, getpwuid UID, getgrgid GID, getservbyname NAME,PROTO, gethostbyaddr -ADDR,ADDRTYPE, getnetbyaddr ADDR,ADDRTYPE, getprotobynumber NUMBER, -getservbyport PORT,PROTO, getpwent, getgrent, gethostent, getnetent, -getprotoent, getservent, setpwent, setgrent, sethostent STAYOPEN, setnetent -STAYOPEN, setprotoent STAYOPEN, setservent STAYOPEN, endpwent, endgrent, -endhostent, endnetent, endprotoent, endservent, getsockname SOCKET, -getsockopt SOCKET,LEVEL,OPTNAME, glob EXPR, glob, gmtime EXPR, goto LABEL, -goto EXPR, goto &NAME, grep BLOCK LIST, grep EXPR,LIST, hex EXPR, hex, -import, index STR,SUBSTR,POSITION, index STR,SUBSTR, int EXPR, int, ioctl -FILEHANDLE,FUNCTION,SCALAR, join EXPR,LIST, keys HASH, kill SIGNAL, LIST, -last LABEL, last, lc EXPR, lc, lcfirst EXPR, lcfirst, length EXPR, length, -link OLDFILE,NEWFILE, listen SOCKET,QUEUESIZE, local EXPR, localtime EXPR, -lock, log EXPR, log, lstat EXPR, lstat, m//, map BLOCK LIST, map EXPR,LIST, -mkdir FILENAME,MASK, mkdir FILENAME, msgctl ID,CMD,ARG, msgget KEY,FLAGS, -msgrcv ID,VAR,SIZE,TYPE,FLAGS, msgsnd ID,MSG,FLAGS, my EXPR, my EXPR : -ATTRIBUTES, next LABEL, next, no Module LIST, oct EXPR, oct, open -FILEHANDLE,EXPR, open FILEHANDLE,MODE,EXPR, open FILEHANDLE,MODE,EXPR,LIST, -open FILEHANDLE, opendir DIRHANDLE,EXPR, ord EXPR, ord, our EXPR, our EXPR -: ATTRIBUTES, pack TEMPLATE,LIST, package NAMESPACE, package, pipe -READHANDLE,WRITEHANDLE, pop ARRAY, pop, pos SCALAR, pos, print FILEHANDLE -LIST, print LIST, print, printf FILEHANDLE FORMAT, LIST, printf FORMAT, -LIST, prototype FUNCTION, push ARRAY,LIST, q/STRING/, qq/STRING/, -qr/STRING/, qx/STRING/, qw/STRING/, quotemeta EXPR, quotemeta, rand EXPR, -rand, read FILEHANDLE,SCALAR,LENGTH,OFFSET, read FILEHANDLE,SCALAR,LENGTH, -readdir DIRHANDLE, readline EXPR, readlink EXPR, readlink, readpipe EXPR, -recv SOCKET,SCALAR,LENGTH,FLAGS, redo LABEL, redo, ref EXPR, ref, rename -OLDNAME,NEWNAME, require VERSION, require EXPR, require, reset EXPR, reset, -return EXPR, return, reverse LIST, rewinddir DIRHANDLE, rindex -STR,SUBSTR,POSITION, rindex STR,SUBSTR, rmdir FILENAME, rmdir, s///, scalar -EXPR, seek FILEHANDLE,POSITION,WHENCE, seekdir DIRHANDLE,POS, select -FILEHANDLE, select, select RBITS,WBITS,EBITS,TIMEOUT, semctl -ID,SEMNUM,CMD,ARG, semget KEY,NSEMS,FLAGS, semop KEY,OPSTRING, send -SOCKET,MSG,FLAGS,TO, send SOCKET,MSG,FLAGS, setpgrp PID,PGRP, setpriority -WHICH,WHO,PRIORITY, setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL, shift ARRAY, -shift, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS, shmread ID,VAR,POS,SIZE, -shmwrite ID,STRING,POS,SIZE, shutdown SOCKET,HOW, sin EXPR, sin, sleep -EXPR, sleep, sockatmark SOCKET, socket SOCKET,DOMAIN,TYPE,PROTOCOL, -socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, sort SUBNAME LIST, sort -BLOCK LIST, sort LIST, splice ARRAY,OFFSET,LENGTH,LIST, splice -ARRAY,OFFSET,LENGTH, splice ARRAY,OFFSET, splice ARRAY, split -/PATTERN/,EXPR,LIMIT, split /PATTERN/,EXPR, split /PATTERN/, split, sprintf -FORMAT, LIST, sqrt EXPR, sqrt, srand EXPR, srand, stat FILEHANDLE, stat -EXPR, stat, study SCALAR, study, sub BLOCK, sub NAME, sub NAME BLOCK, -substr EXPR,OFFSET,LENGTH,REPLACEMENT, substr EXPR,OFFSET,LENGTH, substr -EXPR,OFFSET, symlink OLDFILE,NEWFILE, syscall LIST, sysopen -FILEHANDLE,FILENAME,MODE, sysopen FILEHANDLE,FILENAME,MODE,PERMS, sysread -FILEHANDLE,SCALAR,LENGTH,OFFSET, sysread FILEHANDLE,SCALAR,LENGTH, sysseek -FILEHANDLE,POSITION,WHENCE, system LIST, system PROGRAM LIST, syswrite -FILEHANDLE,SCALAR,LENGTH,OFFSET, syswrite FILEHANDLE,SCALAR,LENGTH, -syswrite FILEHANDLE,SCALAR, tell FILEHANDLE, tell, telldir DIRHANDLE, tie -VARIABLE,CLASSNAME,LIST, tied VARIABLE, time, times, tr///, truncate -FILEHANDLE,LENGTH, truncate EXPR,LENGTH, uc EXPR, uc, ucfirst EXPR, -ucfirst, umask EXPR, umask, undef EXPR, undef, unlink LIST, unlink, unpack -TEMPLATE,EXPR, untie VARIABLE, unshift ARRAY,LIST, use Module VERSION LIST, -use Module VERSION, use Module LIST, use Module, use VERSION, utime LIST, -values HASH, vec EXPR,OFFSET,BITS, wait, waitpid PID,FLAGS, wantarray, warn -LIST, write FILEHANDLE, write EXPR, write, y/// +=item The extra parameter of method invocation -=back +=item Calling a second method to simplify things -=back +=item Inheriting the windpipes -=head2 perlreftut - Mark's very short tutorial about references +=item A few notes about @ISA -=over 4 +=item Overriding the methods -=item DESCRIPTION +=item Starting the search from a different place -=item Who Needs Complicated Data Structures? +=item The SUPER way of doing things -=item The Solution +=item Where we're at so far... -=item Syntax +=item A horse is a horse, of course of course -- or is it? -=over 4 +=item Invoking an instance method -=item Making References +=item Accessing the instance data -=item Using References +=item How to build a horse -=back +=item Inheriting the constructor -=item An Example +=item Making a method work with either classes or instances -=item Arrow Rule +=item Adding parameters to a method -=item Solution +=item More interesting instances -=item The Rest +=item A horse of a different color =item Summary -=item Credits - -=over 4 +=back -=item Distribution Conditions +=item SEE ALSO -=back +=item COPYRIGHT =back -=head2 perldsc - Perl Data Structures Cookbook +=head2 perltoot - Tom's object-oriented tutorial for perl =over 4 =item DESCRIPTION -arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes, -more elaborate constructs +=item Creating a Class -=item REFERENCES +=over 4 -=item COMMON MISTAKES +=item Object Representation -=item CAVEAT ON PRECEDENCE +=item Class Interface -=item WHY YOU SHOULD ALWAYS C +=item Constructors and Instance Methods -=item DEBUGGING +=item Planning for the Future: Better Constructors -=item CODE EXAMPLES +=item Destructors -=item ARRAYS OF ARRAYS +=item Other Object Methods + +=back + +=item Class Data =over 4 -=item Declaration of an ARRAY OF ARRAYS +=item Accessing Class Data -=item Generation of an ARRAY OF ARRAYS +=item Debugging Methods -=item Access and Printing of an ARRAY OF ARRAYS +=item Class Destructors + +=item Documenting the Interface =back -=item HASHES OF ARRAYS +=item Aggregation + +=item Inheritance =over 4 -=item Declaration of a HASH OF ARRAYS +=item Overridden Methods -=item Generation of a HASH OF ARRAYS +=item Multiple Inheritance -=item Access and Printing of a HASH OF ARRAYS +=item UNIVERSAL: The Root of All Objects =back -=item ARRAYS OF HASHES +=item Alternate Object Representations =over 4 -=item Declaration of an ARRAY OF HASHES - -=item Generation of an ARRAY OF HASHES +=item Arrays as Objects -=item Access and Printing of an ARRAY OF HASHES +=item Closures as Objects =back -=item HASHES OF HASHES +=item AUTOLOAD: Proxy Methods =over 4 -=item Declaration of a HASH OF HASHES - -=item Generation of a HASH OF HASHES +=item Autoloaded Data Methods -=item Access and Printing of a HASH OF HASHES +=item Inherited Autoloaded Data Methods =back -=item MORE ELABORATE RECORDS +=item Metaclassical Tools =over 4 -=item Declaration of MORE ELABORATE RECORDS - -=item Declaration of a HASH OF COMPLEX RECORDS +=item Class::Struct -=item Generation of a HASH OF COMPLEX RECORDS +=item Data Members as Variables =back -=item Database Ties +=item NOTES + +=over 4 + +=item Object Terminology + +=back =item SEE ALSO -=item AUTHOR +=item AUTHOR AND COPYRIGHT + +=item COPYRIGHT + +=over 4 + +=item Acknowledgments =back -=head2 perlrequick - Perl regular expressions quick start +=back + +=head2 perltooc - Tom's OO Tutorial for Class Data in Perl =over 4 =item DESCRIPTION -=item The Guide +=item Class Data in a Can + +=item Class Data as Package Variables =over 4 -=item Simple word matching +=item Putting All Your Eggs in One Basket -=item Using character classes +=item Inheritance Concerns -=item Matching this or that +=item The Eponymous Meta-Object -=item Grouping things and hierarchical matching +=item Indirect References to Class Data -=item Extracting matches +=item Monadic Classes -=item Matching repetitions +=item Translucent Attributes -=item More matching +=back -=item Search and replace +=item Class Data as Lexical Variables -=item The split operator +=over 4 + +=item Privacy and Responsibility + +=item File-Scoped Lexicals + +=item More Inheritance Concerns + +=item Locking the Door and Throwing Away the Key + +=item Translucency Revisited =back -=item BUGS +=item NOTES =item SEE ALSO =item AUTHOR AND COPYRIGHT -=over 4 - -=item Acknowledgments +=item ACKNOWLEDGEMENTS -=back +=item HISTORY =back -=head2 perlpod - the Plain Old Documentation format +=head2 perlbot - Bag'o Object Tricks (the BOT) =over 4 =item DESCRIPTION -=over 4 +=item OO SCALING TIPS -=item Ordinary Paragraph +=item INSTANCE VARIABLES -=item Verbatim Paragraph +=item SCALAR INSTANCE VARIABLES -=item Command Paragraph +=item INSTANCE VARIABLE INHERITANCE -C<=head1 I>, C<=head2 I>, C<=head3 I>, C<=head4 I>, C<=over I>, C<=item -I>, C<=back>, C<=cut>, C<=pod>, C<=begin I>, C<=end -I>, C<=for I I> +=item OBJECT RELATIONSHIPS -=item Formatting Codes +=item OVERRIDING SUPERCLASS METHODS -CtextE> -- italic text, CtextE> -- bold text, -CcodeE> -- code text, CnameE> -- a hyperlink, -CescapeE> -- a character escape, CfilenameE> -- used -for filenames, CtextE> -- text contains non-breaking spaces, -Ctopic nameE> -- an index entry, CE> -- a null -(zero-effect) formatting code +=item USING RELATIONSHIP WITH SDBM -=item The Intent +=item THINKING OF CODE REUSE -=item Embedding Pods in Perl Modules +=item CLASS CONTEXT AND THE OBJECT -=item Hints for Writing Pod +=item INHERITING A CONSTRUCTOR -=back +=item DELEGATION =item SEE ALSO -=item AUTHOR - =back -=head2 perlpodspec - Plain Old Documentation: format specification and -notes +=head2 perlstyle - Perl style guide =over 4 =item DESCRIPTION -=item Pod Definitions +=back -=item Pod Commands +=head2 perlcheat - Perl 5 Cheat Sheet -"=head1", "=head2", "=head3", "=head4", "=pod", "=cut", "=over", "=item", -"=back", "=begin formatname", "=end formatname", "=for formatname text..." +=over 4 -=item Pod Formatting Codes +=item DESCRIPTION -CtextE> -- italic text, CtextE> -- bold text, -CcodeE> -- code text, CfilenameE> -- style for -filenames, Ctopic nameE> -- an index entry, CE> -- a -null (zero-effect) formatting code, CnameE> -- a hyperlink, -CescapeE> -- a character escape, CtextE> -- text -contains non-breaking spaces +=over 4 -=item Notes on Implementing Pod Processors - -=item About LE...E Codes - -First:, Second:, Third:, Fourth:, Fifth:, Sixth: - -=item About =over...=back Regions - -=item About Data Paragraphs and "=begin/=end" Regions - -=item SEE ALSO - -=item AUTHOR +=item The sheet =back -=head2 perlstyle - Perl style guide +=item ACKNOWLEDGEMENTS -=over 4 +=item AUTHOR -=item DESCRIPTION +=item SEE ALSO =back @@ -743,7 +656,7 @@ First:, Second:, Third:, Fourth:, Fifth:, Sixth: =item Awk Traps -=item C Traps +=item C/C++ Traps =item Sed Traps @@ -766,7 +679,7 @@ Discontinuance, Deprecation, Discontinuance, Discontinuance =item Parsing Traps -Parsing, Parsing, Parsing, Parsing +Parsing, Parsing, Parsing, Parsing, Parsing =item Numerical Traps @@ -790,7 +703,7 @@ Precedence Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression, -Regular Expression +Regular Expression, Regular Expression =item Subroutine, Signal, Sorting Traps @@ -818,52 +731,42 @@ LIMIT specified =back -=head2 perlrun - how to execute the Perl interpreter +=head2 perldebtut - Perl debugging tutorial =over 4 -=item SYNOPSIS - =item DESCRIPTION -=over 4 +=item use strict -=item #! and quoting on non-Unix systems +=item Looking at data and -w and v -OS/2, MS-DOS, Win95/NT, Macintosh, VMS +=item help -=item Location of Perl +=item Stepping through code -=item Command Switches +=item Placeholder for a, w, t, T -B<-0>[I], B<-a>, B<-C>, B<-c>, B<-d>, B<-d:>I, -B<-D>I, B<-D>I, B<-e> I, B<-F>I, -B<-h>, B<-i>[I], B<-I>I, B<-l>[I], -B<-m>[B<->]I, B<-M>[B<->]I, B<-M>[B<->]I<'module ...'>, -B<-[mM]>[B<->]I, B<-n>, B<-p>, B<-P>, B<-s>, B<-S>, -B<-T>, B<-u>, B<-U>, B<-v>, B<-V>, B<-V:>I, B<-w>, B<-W>, B<-X>, -B<-x> I +=item REGULAR EXPRESSIONS -=back +=item OUTPUT TIPS -=item ENVIRONMENT +=item CGI -HOME, LOGDIR, PATH, PERL5LIB, PERL5OPT, PERLLIB, PERL5DB, PERL5SHELL -(specific to the Win32 port), PERL_DEBUG_MSTATS, PERL_DESTRUCT_LEVEL, -PERL_ENCODING, PERL_ROOT (specific to the VMS port), SYS$LOGIN (specific to -the VMS port) +=item GUIs -=back +=item SUMMARY -=head2 perldiag - various Perl diagnostics +=item SEE ALSO -=over 4 +=item AUTHOR -=item DESCRIPTION +=item CONTRIBUTORS =back -=head2 perllexwarn - Perl Lexical Warnings +=head2 perlfaq - frequently asked questions about Perl ($Date: 2003/01/31 +17:37:17 $) =over 4 @@ -871,126 +774,112 @@ the VMS port) =over 4 -=item Default Warnings and Optional Warnings - -=item What's wrong with B<-w> and C<$^W> - -=item Controlling Warnings from the Command Line - -B<-w>, B<-W>, B<-X> - -=item Backward Compatibility - -=item Category Hierarchy +=item Where to get the perlfaq -=item Fatal Warnings +=item How to contribute to the perlfaq -=item Reporting Warnings from a Module +=item What will happen if you mail your Perl programming problems to the +authors =back -=item TODO +=item Credits -=item SEE ALSO +=item Author and Copyright Information -=item AUTHOR +=over 4 -=back +=item Bundled Distributions -=head2 perldebtut - Perl debugging tutorial +=item Disclaimer -=over 4 +=back -=item DESCRIPTION +=item Table of Contents -=item use strict +perlfaq - this document, perlfaq1 - General Questions About Perl, perlfaq2 +- Obtaining and Learning about Perl, perlfaq3 - Programming Tools, perlfaq4 +- Data Manipulation, perlfaq5 - Files and Formats, perlfaq6 - Regular +Expressions, perlfaq7 - General Perl Language Issues, perlfaq8 - System +Interaction, perlfaq9 - Networking -=item Looking at data and -w and w +=item The Questions -=item help +=over 4 -=item Stepping through code +=item L: General Questions About Perl -=item Placeholder for a, w, t, T +=item L: Obtaining and Learning about Perl -=item REGULAR EXPRESSIONS +=item L: Programming Tools -=item OUTPUT TIPS +=item L: Data Manipulation -=item CGI +=item L: Files and Formats -=item GUIs +=item L: Regular Expressions -=item SUMMARY +=item L: General Perl Language Issues -=item SEE ALSO +=item L: System Interaction -=item AUTHOR +=item L: Networking -=item CONTRIBUTORS +=back =back -=head2 perldebug - Perl debugging +=head2 perlfaq1 - General Questions About Perl ($Revision: 1.14 $, $Date: +2003/11/23 08:02:29 $) =over 4 =item DESCRIPTION -=item The Perl Debugger - =over 4 -=item Debugger Commands +=item What is Perl? -h [command], p expr, x expr, V [pkg [vars]], X [vars], T, s [expr], n -[expr], r, , c [line|sub], l, l min+incr, l min-max, l line, l subname, --, w [line], f filename, /pattern/, ?pattern?, L, S [[!]regex], t, t expr, -b [line] [condition], b subname [condition], b postpone subname -[condition], b load filename, b compile subname, d [line], D, a [line] -command, a [line], A, W expr, W, O booloption .., O anyoption? .., O -option=value .., < ?, < [ command ], << command, > ?, > command, >> -command, { ?, { [ command ], {{ command, ! number, ! -number, ! pattern, !! -cmd, @ file, H -number, q or ^D, R, |dbcmd, ||dbcmd, command, m expr, man -[manpage] +=item Who supports Perl? Who develops it? Why is it free? -=item Configurable Options +=item Which version of Perl should I use? -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, C +=item What are perl4 and perl5? -=item Debugger input/output +=item What is Ponie? -Prompt, Multiline commands, Stack backtrace, Line Listing Format, Frame -listing +=item What is perl6? -=item Debugging compile-time statements +=item How stable is Perl? -=item Debugger Customization +=item Is Perl difficult to learn? -=item Readline Support +=item How does Perl compare with other languages like Java, Python, REXX, +Scheme, or Tcl? -=item Editor Support for Debugging +=item Can I do [task] in Perl? -=item The Perl Profiler +=item When shouldn't I program in Perl? -=back +=item What's the difference between "perl" and "Perl"? -=item Debugging regular expressions +=item Is it a Perl program or a Perl script? -=item Debugging memory usage +=item What is a JAPH? -=item SEE ALSO +=item Where can I get a list of Larry Wall witticisms? -=item BUGS +=item How can I convince my sysadmin/supervisor/employees to use version +5/5.6.1/Perl instead of some other language? =back -=head2 perlvar - Perl predefined variables +=item AUTHOR AND COPYRIGHT + +=back + +=head2 perlfaq2 - Obtaining and Learning about Perl ($Revision: 1.25 $, +$Date: 2003/10/16 04:57:38 $) =over 4 @@ -998,524 +887,524 @@ listing =over 4 -=item Predefined Names +=item What machines support Perl? Where do I get it? -$ARG, $_, $a, $b, $>, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $', -$LAST_PAREN_MATCH, $+, $^N, @LAST_MATCH_END, @+, $MULTILINE_MATCHING, $*, -HANDLE->input_line_number(EXPR), $INPUT_LINE_NUMBER, $NR, $, -IO::Handle->input_record_separator(EXPR), $INPUT_RECORD_SEPARATOR, $RS, $/, -HANDLE->autoflush(EXPR), $OUTPUT_AUTOFLUSH, $|, -IO::Handle->output_field_separator EXPR, $OUTPUT_FIELD_SEPARATOR, $OFS, $,, -IO::Handle->output_record_separator EXPR, $OUTPUT_RECORD_SEPARATOR, $ORS, -$\, $LIST_SEPARATOR, $", $SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $OFMT, $#, -HANDLE->format_page_number(EXPR), $FORMAT_PAGE_NUMBER, $%, -HANDLE->format_lines_per_page(EXPR), $FORMAT_LINES_PER_PAGE, $=, -HANDLE->format_lines_left(EXPR), $FORMAT_LINES_LEFT, $-, @LAST_MATCH_START, -@-, C<$`> is the same as C, C<$&> is the same as -C, C<$'> is the same as C, C<$1> is the same as C, C<$2> -is the same as C, C<$3> is the same as -C, HANDLE->format_name(EXPR), -$FORMAT_NAME, $~, HANDLE->format_top_name(EXPR), $FORMAT_TOP_NAME, $^, -IO::Handle->format_line_break_characters EXPR, -$FORMAT_LINE_BREAK_CHARACTERS, $:, IO::Handle->format_formfeed EXPR, -$FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A, $CHILD_ERROR, $?, ${^ENCODING}, -$OS_ERROR, $ERRNO, $!, $EXTENDED_OS_ERROR, $^E, $EVAL_ERROR, $@, -$PROCESS_ID, $PID, $$, $REAL_USER_ID, $UID, $<, $EFFECTIVE_USER_ID, $EUID, -$>, $REAL_GROUP_ID, $GID, $(, $EFFECTIVE_GROUP_ID, $EGID, $), -$PROGRAM_NAME, $0, $[, $], $COMPILING, $^C, $DEBUGGING, $^D, -$SYSTEM_FD_MAX, $^F, $^H, %^H, $INPLACE_EDIT, $^I, $^M, $OSNAME, $^O, -$PERLDB, $^P, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x100, 0x200, -$LAST_REGEXP_CODE_RESULT, $^R, $EXCEPTIONS_BEING_CAUGHT, $^S, $BASETIME, -$^T, ${^TAINT}, $PERL_VERSION, $^V, $WARNING, $^W, ${^WARNING_BITS}, -${^WIDE_SYSTEM_CALLS}, $EXECUTABLE_NAME, $^X, ARGV, $ARGV, @ARGV, @F, @INC, -@_, %INC, %ENV, $ENV{expr}, %SIG, $SIG{expr} +=item How can I get a binary version of Perl? -=item Error Indicators +=item I don't have a C compiler on my system. How can I compile perl? -=item Technical Note on the Syntax of Variable Names +=item I copied the Perl binary from one machine to another, but scripts +don't work. -=back +=item I grabbed the sources and tried to compile but gdbm/dynamic +loading/malloc/linking/... failed. How do I make it work? -=item BUGS +=item What modules and extensions are available for Perl? What is CPAN? +What does CPAN/src/... mean? -=back +=item Is there an ISO or ANSI certified version of Perl? -=head2 perllol - Manipulating Arrays of Arrays in Perl +=item Where can I get information on Perl? -=over 4 +=item What are the Perl newsgroups on Usenet? Where do I post questions? -=item DESCRIPTION +=item Where should I post source code? -=over 4 +=item Perl Books -=item Declaration and Access of Arrays of Arrays +References, Tutorials, Task-Oriented, Special Topics -=item Growing Your Own +=item Perl in Magazines -=item Access and Printing +=item Perl on the Net: FTP and WWW Access -=item Slices +=item What mailing lists are there for Perl? -=back +=item Archives of comp.lang.perl.misc -=item SEE ALSO +=item Where can I buy a commercial version of Perl? -=item AUTHOR +=item Where do I send bug reports? + +=item What is perl.com? Perl Mongers? pm.org? perl.org? cpan.org? =back -=head2 perlopentut - tutorial on opening things in Perl +=item AUTHOR AND COPYRIGHT + +=back + +=head2 perlfaq3 - Programming Tools ($Revision: 1.37 $, $Date: 2003/11/24 +19:55:50 $) =over 4 =item DESCRIPTION -=item Open E la shell - =over 4 -=item Simple Opens +=item How do I do (anything)? -=item Pipe Opens +=item How can I use Perl interactively? -=item The Minus File +=item Is there a Perl shell? -=item Mixing Reads and Writes +=item How do I find which modules are installed on my system? -=item Filters +=item How do I debug my Perl programs? -=back +=item How do I profile my Perl programs? -=item Open E la C +=item How do I cross-reference my Perl programs? -=over 4 +=item Is there a pretty-printer (formatter) for Perl? -=item Permissions E la mode +=item Is there a ctags for Perl? -=back +=item Is there an IDE or Windows Perl Editor? -=item Obscure Open Tricks +Komodo, The Object System, Open Perl IDE, PerlBuilder, visiPerl+, OptiPerl, +GNU Emacs, MicroEMACS, XEmacs, Jed, Elvis, Vile, Vim, Codewright, +MultiEdit, SlickEdit, Bash, Ksh, Tcsh, Zsh, BBEdit and BBEdit Lite, Alpha -=over 4 +=item Where can I get Perl macros for vi? -=item Re-Opening Files (dups) +=item Where can I get perl-mode for emacs? -=item Dispelling the Dweomer +=item How can I use curses with Perl? -=item Paths as Opens +=item How can I use X or Tk with Perl? -=item Single Argument Open +=item How can I generate simple menus without using CGI or Tk? -=item Playing with STDIN and STDOUT +=item How can I make my Perl program run faster? -=back +=item How can I make my Perl program take less memory? -=item Other I/O Issues +Don't slurp!, Use map and grep selectively, Avoid unnecessary quotes and +stringification, Pass by reference, Tie large variables to disk -=over 4 +=item Is it safe to return a reference to local or lexical data? -=item Opening Non-File Files +=item How can I free an array or hash so my program shrinks? -=item Binary Files +=item How can I make my CGI script more efficient? -=item File Locking +=item How can I hide the source for my Perl program? -=back +=item How can I compile my Perl program into byte code or C? -=item SEE ALSO +=item How can I compile Perl into Java? -=item AUTHOR and COPYRIGHT +=item How can I get C<#!perl> to work on [MS-DOS,NT,...]? -=item HISTORY +=item Can I write useful Perl programs on the command line? -=back +=item Why don't Perl one-liners work on my DOS/Mac/VMS system? -=head2 perlretut - Perl regular expressions tutorial +=item Where can I learn about CGI or Web programming in Perl? -=over 4 +=item Where can I learn about object-oriented Perl programming? -=item DESCRIPTION +=item Where can I learn about linking C with Perl? [h2xs, xsubpp] -=item Part 1: The basics +=item I've read perlembed, perlguts, etc., but I can't embed perl in +my C program; what am I doing wrong? -=over 4 +=item When I tried to run my script, I got this message. What does it mean? -=item Simple word matching +=item What's MakeMaker? -=item Using character classes +=back -=item Matching this or that +=item AUTHOR AND COPYRIGHT -=item Grouping things and hierarchical matching +=back -=item Extracting matches +=head2 perlfaq4 - Data Manipulation ($Revision: 1.54 $, $Date: 2003/11/30 +00:50:08 $) -=item Matching repetitions +=over 4 -=item Building a regexp +=item DESCRIPTION -=item Using regular expressions in Perl +=item Data: Numbers -=back +=over 4 -=item Part 2: Power tools +=item Why am I getting long decimals (eg, 19.9499999999999) instead of the +numbers I should be getting (eg, 19.95)? -=over 4 +=item Why is int() broken? -=item More on characters, strings, and character classes +=item Why isn't my octal data interpreted correctly? -=item Compiling and saving regular expressions +=item Does Perl have a round() function? What about ceil() and floor()? +Trig functions? -=item Embedding comments and modifiers in a regular expression +=item How do I convert between numeric representations/bases/radixes? -=item Non-capturing groupings +How do I convert hexadecimal into decimal, How do I convert from decimal to +hexadecimal, How do I convert from octal to decimal, How do I convert from +decimal to octal, How do I convert from binary to decimal, How do I convert +from decimal to binary -=item Looking ahead and looking behind +=item Why doesn't & work the way I want it to? -=item Using independent subexpressions to prevent backtracking +=item How do I multiply matrices? -=item Conditional expressions +=item How do I perform an operation on a series of integers? -=item A bit of magic: executing Perl code in a regular expression +=item How can I output Roman numerals? -=item Pragmas and debugging +=item Why aren't my random numbers random? + +=item How do I get a random number between X and Y? =back -=item BUGS +=item Data: Dates -=item SEE ALSO +=over 4 -=item AUTHOR AND COPYRIGHT +=item How do I find the day or week of the year? -=over 4 +=item How do I find the current century or millennium? -=item Acknowledgments +=item How can I compare two dates and find the difference? -=back +=item How can I take a string and turn it into epoch seconds? -=back +=item How can I find the Julian Day? -=head2 perlre - Perl regular expressions +=item How do I find yesterday's date? -=over 4 +=item Does Perl have a Year 2000 problem? Is Perl Y2K compliant? -=item DESCRIPTION +=back -i, m, s, x +=item Data: Strings =over 4 -=item Regular Expressions - -cntrl, graph, print, punct, xdigit +=item How do I validate input? -=item Extended Patterns +=item How do I unescape a string? -C<(?#text)>, C<(?imsx-imsx)>, C<(?:pattern)>, C<(?imsx-imsx:pattern)>, -C<(?=pattern)>, C<(?!pattern)>, C<(?<=pattern)>, C<(?, C<(?{ -code })>, C<(??{ code })>, C<< (?>pattern) >>, -C<(?(condition)yes-pattern|no-pattern)>, C<(?(condition)yes-pattern)> +=item How do I remove consecutive pairs of characters? -=item Backtracking +=item How do I expand function calls in a string? -=item Version 8 Regular Expressions +=item How do I find matching/nesting anything? -=item Warning on \1 vs $1 +=item How do I reverse a string? -=item Repeated patterns matching zero-length substring +=item How do I expand tabs in a string? -=item Combining pieces together +=item How do I reformat a paragraph? -C, C, C, C, C, C, -C, C, C, C, C, C<< (?>S) >>, C<(?=S)>, C<(?<=S)>, -C<(?!S)>, C<(?, C<(??{ EXPR })>, -C<(?(condition)yes-pattern|no-pattern)> +=item How can I access or change N characters of a string? -=item Creating custom RE engines +=item How do I change the Nth occurrence of something? -=back +=item How can I count the number of occurrences of a substring within a +string? -=item BUGS +=item How do I capitalize all the words on one line? -=item SEE ALSO +=item How can I split a [character] delimited string except when inside +[character]? -=back +=item How do I strip blank space from the beginning/end of a string? -=head2 perlref - Perl references and nested data structures +=item How do I pad a string with blanks or pad a number with zeroes? -=over 4 +=item How do I extract selected columns from a string? -=item NOTE +=item How do I find the soundex value of a string? -=item DESCRIPTION +=item How can I expand variables in text strings? -=over 4 +=item What's wrong with always quoting "$vars"? -=item Making References +=item Why don't my EEHERE documents work? -=item Using References +There must be no space after the EE part, There (probably) should +be a semicolon at the end, You can't (easily) have any space in front of +the tag -=item Symbolic references +=back -=item Not-so-symbolic references +=item Data: Arrays -=item Pseudo-hashes: Using an array as a hash +=over 4 -=item Function Templates +=item What is the difference between a list and an array? -=back +=item What is the difference between $array[1] and @array[1]? -=item WARNING +=item How can I remove duplicate elements from a list or array? -=item SEE ALSO +a), b), c), d), e) -=back +=item How can I tell whether a certain element is contained in a list or +array? -=head2 perlform - Perl formats +=item How do I compute the difference of two arrays? How do I compute the +intersection of two arrays? -=over 4 +=item How do I test whether two arrays or hashes are equal? -=item DESCRIPTION +=item How do I find the first array element for which a condition is true? -=over 4 +=item How do I handle linked lists? -=item Format Variables +=item How do I handle circular lists? -=back +=item How do I shuffle an array randomly? -=item NOTES +=item How do I process/modify each element of an array? -=over 4 +=item How do I select a random element from an array? -=item Footers +=item How do I permute N elements of a list? -=item Accessing Formatting Internals +=item How do I sort an array by (anything)? -=back +=item How do I manipulate arrays of bits? -=item WARNINGS +=item Why does defined() return true on empty arrays and hashes? =back -=head2 perlboot - Beginner's Object-Oriented Tutorial +=item Data: Hashes (Associative Arrays) =over 4 -=item DESCRIPTION +=item How do I process an entire hash? -=over 4 +=item What happens if I add or remove keys from a hash while iterating over +it? -=item If we could talk to the animals... +=item How do I look up a hash element by value? -=item Introducing the method invocation arrow +=item How can I know how many entries are in a hash? -=item Invoking a barnyard +=item How do I sort a hash (optionally by value instead of key)? -=item The extra parameter of method invocation +=item How can I always keep my hash sorted? -=item Calling a second method to simplify things +=item What's the difference between "delete" and "undef" with hashes? -=item Inheriting the windpipes +=item Why don't my tied hashes make the defined/exists distinction? -=item A few notes about @ISA +=item How do I reset an each() operation part-way through? -=item Overriding the methods +=item How can I get the unique keys from two hashes? -=item Starting the search from a different place +=item How can I store a multidimensional array in a DBM file? -=item The SUPER way of doing things +=item How can I make my hash remember the order I put elements into it? -=item Where we're at so far... +=item Why does passing a subroutine an undefined element in a hash create +it? -=item A horse is a horse, of course of course -- or is it? +=item How can I make the Perl equivalent of a C structure/C++ class/hash or +array of hashes or arrays? -=item Invoking an instance method +=item How can I use a reference as a hash key? -=item Accessing the instance data +=back -=item How to build a horse +=item Data: Misc -=item Inheriting the constructor +=over 4 -=item Making a method work with either classes or instances +=item How do I handle binary data correctly? -=item Adding parameters to a method +=item How do I determine whether a scalar is a number/whole/integer/float? -=item More interesting instances +=item How do I keep persistent data across program calls? -=item A horse of a different color +=item How do I print out or copy a recursive data structure? -=item Summary +=item How do I define methods for every class/object? -=back +=item How do I verify a credit card checksum? -=item SEE ALSO +=item How do I pack arrays of doubles or floats for XS code? -=item COPYRIGHT +=back + +=item AUTHOR AND COPYRIGHT =back -=head2 perltoot - Tom's object-oriented tutorial for perl +=head2 perlfaq5 - Files and Formats ($Revision: 1.30 $, $Date: 2003/11/23 +08:07:46 $) =over 4 =item DESCRIPTION -=item Creating a Class - =over 4 -=item Object Representation +=item How do I flush/unbuffer an output filehandle? Why must I do this? -=item Class Interface +=item How do I change one line in a file/delete a line in a file/insert a +line in the middle of a file/append to the beginning of a file? -=item Constructors and Instance Methods +=item How do I count the number of lines in a file? -=item Planning for the Future: Better Constructors +=item How can I use Perl's C<-i> option from within a program? -=item Destructors +=item How do I make a temporary file name? -=item Other Object Methods +=item How can I manipulate fixed-record-length files? -=back +=item How can I make a filehandle local to a subroutine? How do I pass +filehandles between subroutines? How do I make an array of filehandles? -=item Class Data +=item How can I use a filehandle indirectly? -=over 4 +=item How can I set up a footer format to be used with write()? -=item Accessing Class Data +=item How can I write() into a string? -=item Debugging Methods +=item How can I output my numbers with commas added? -=item Class Destructors +=item How can I translate tildes (~) in a filename? -=item Documenting the Interface +=item How come when I open a file read-write it wipes it out? -=back +=item Why do I sometimes get an "Argument list too long" when I use +E*E? -=item Aggregation +=item Is there a leak/bug in glob()? -=item Inheritance +=item How can I open a file with a leading ">" or trailing blanks? -=over 4 +=item How can I reliably rename a file? -=item Overridden Methods +=item How can I lock a file? -=item Multiple Inheritance +=item Why can't I just open(FH, "Efile.lock")? -=item UNIVERSAL: The Root of All Objects +=item I still don't get locking. I just want to increment the number in +the file. How can I do this? -=back +=item All I want to do is append a small amount of text to the end of a +file. Do I still have to use locking? -=item Alternate Object Representations +=item How do I randomly update a binary file? -=over 4 +=item How do I get a file's timestamp in perl? -=item Arrays as Objects +=item How do I set a file's timestamp in perl? -=item Closures as Objects +=item How do I print to more than one file at once? -=back +=item How can I read in an entire file all at once? -=item AUTOLOAD: Proxy Methods +=item How can I read in a file by paragraphs? -=over 4 +=item How can I read a single character from a file? From the keyboard? -=item Autoloaded Data Methods +=item How can I tell whether there's a character waiting on a filehandle? -=item Inherited Autoloaded Data Methods +=item How do I do a C in perl? -=back +=item How do I dup() a filehandle in Perl? -=item Metaclassical Tools +=item How do I close a file descriptor by number? -=over 4 +=item Why can't I use "C:\temp\foo" in DOS paths? Why doesn't +`C:\temp\foo.exe` work? -=item Class::Struct +=item Why doesn't glob("*.*") get all the files? -=item Data Members as Variables +=item Why does Perl let me delete read-only files? Why does C<-i> clobber +protected files? Isn't this a bug in Perl? -=back +=item How do I select a random line from a file? -=item NOTES +=item Why do I get weird spaces when I print an array of lines? -=over 4 +=back -=item Object Terminology +=item AUTHOR AND COPYRIGHT =back -=item SEE ALSO +=head2 perlfaq6 - Regular Expressions ($Revision: 1.20 $, $Date: 2003/01/03 +20:05:28 $) -=item AUTHOR AND COPYRIGHT +=over 4 -=item COPYRIGHT +=item DESCRIPTION =over 4 -=item Acknowledgments - -=back +=item How can I hope to use regular expressions without creating illegible +and unmaintainable code? -=back +Comments Outside the Regex, Comments Inside the Regex, Different Delimiters -=head2 perltooc - Tom's OO Tutorial for Class Data in Perl +=item I'm having trouble matching over more than one line. What's wrong? -=over 4 +=item How can I pull out lines between two patterns that are themselves on +different lines? -=item DESCRIPTION +=item I put a regular expression into $/ but it didn't work. What's wrong? -=item Class Data in a Can +=item How do I substitute case insensitively on the LHS while preserving +case on the RHS? -=item Class Data as Package Variables +=item How can I make C<\w> match national character sets? -=over 4 +=item How can I match a locale-smart version of C? -=item Putting All Your Eggs in One Basket +=item How can I quote a variable to use in a regex? -=item Inheritance Concerns +=item What is C really for? -=item The Eponymous Meta-Object +=item How do I use a regular expression to strip C style comments from a +file? -=item Indirect References to Class Data +=item Can I use Perl regular expressions to match balanced text? -=item Monadic Classes +=item What does it mean that regexes are greedy? How can I get around it? -=item Translucent Attributes +=item How do I process each word on each line? -=back +=item How can I print out a word-frequency or line-frequency summary? -=item Class Data as Lexical Variables +=item How can I do approximate matching? -=over 4 +=item How do I efficiently match many regular expressions at once? -=item Privacy and Responsibility +=item Why don't word-boundary searches with C<\b> work for me? -=item File-Scoped Lexicals +=item Why does using $&, $`, or $' slow my program down? -=item More Inheritance Concerns +=item What good is C<\G> in a regular expression? -=item Locking the Door and Throwing Away the Key +=item Are Perl regexes DFAs or NFAs? Are they POSIX compliant? -=item Translucency Revisited +=item What's wrong with using grep in a void context? -=back +=item How can I match strings with multibyte characters? -=item NOTES +=item How do I match a pattern that is supplied by the user? -=item SEE ALSO +=back =item AUTHOR AND COPYRIGHT -=item ACKNOWLEDGEMENTS - -=item HISTORY - =back -=head2 perlobj - Perl objects +=head2 perlfaq7 - General Perl Language Issues ($Revision: 1.15 $, $Date: +2003/07/24 02:17:21 $) =over 4 @@ -1523,812 +1412,968 @@ C<(?(condition)yes-pattern|no-pattern)> =over 4 -=item An Object is Simply a Reference +=item Can I get a BNF/yacc/RE for the Perl language? -=item A Class is Simply a Package +=item What are all these $@%&* punctuation signs, and how do I know when to +use them? -=item A Method is Simply a Subroutine +=item Do I always/never have to quote my strings or use semicolons and +commas? -=item Method Invocation +=item How do I skip some return values? -=item Indirect Object Syntax +=item How do I temporarily block warnings? -=item Default UNIVERSAL methods +=item What's an extension? -isa(CLASS), can(METHOD), VERSION( [NEED] ) +=item Why do Perl operators have different precedence than C operators? -=item Destructors +=item How do I declare/create a structure? -=item Summary +=item How do I create a module? -=item Two-Phased Garbage Collection +=item How do I create a class? -=back +=item How can I tell if a variable is tainted? -=item SEE ALSO +=item What's a closure? -=back +=item What is variable suicide and how can I prevent it? -=head2 perlbot - Bag'o Object Tricks (the BOT) +=item How can I pass/return a {Function, FileHandle, Array, Hash, Method, +Regex}? -=over 4 +Passing Variables and Functions, Passing Filehandles, Passing Regexes, +Passing Methods -=item DESCRIPTION +=item How do I create a static variable? -=item OO SCALING TIPS +=item What's the difference between dynamic and lexical (static) scoping? +Between local() and my()? -=item INSTANCE VARIABLES +=item How can I access a dynamic variable while a similarly named lexical +is in scope? -=item SCALAR INSTANCE VARIABLES +=item What's the difference between deep and shallow binding? -=item INSTANCE VARIABLE INHERITANCE +=item Why doesn't "my($foo) = EFILEE;" work right? -=item OBJECT RELATIONSHIPS +=item How do I redefine a builtin function, operator, or method? -=item OVERRIDING SUPERCLASS METHODS +=item What's the difference between calling a function as &foo and foo()? -=item USING RELATIONSHIP WITH SDBM +=item How do I create a switch or case statement? -=item THINKING OF CODE REUSE +=item How can I catch accesses to undefined variables, functions, or +methods? -=item CLASS CONTEXT AND THE OBJECT +=item Why can't a method included in this same file be found? -=item INHERITING A CONSTRUCTOR +=item How can I find out my current package? -=item DELEGATION +=item How can I comment out a large block of perl code? + +=item How do I clear a package? + +=item How can I use a variable as a variable name? + +=item What does "bad interpreter" mean? =back -=head2 perltie - how to hide an object class in a simple variable +=item AUTHOR AND COPYRIGHT -=over 4 +=back -=item SYNOPSIS +=head2 perlfaq8 - System Interaction ($Revision: 1.17 $, $Date: 2003/01/26 +17:44:04 $) + +=over 4 =item DESCRIPTION =over 4 -=item Tying Scalars +=item How do I find out which operating system I'm running under? -TIESCALAR classname, LIST, FETCH this, STORE this, value, UNTIE this, -DESTROY this +=item How come exec() doesn't return? -=item Tying Arrays +=item How do I do fancy stuff with the keyboard/screen/mouse? -TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value, -FETCHSIZE this, STORESIZE this, count, EXTEND this, count, EXISTS this, -key, DELETE this, key, CLEAR this, PUSH this, LIST, POP this, SHIFT this, -UNSHIFT this, LIST, SPLICE this, offset, length, LIST, UNTIE this, DESTROY -this +Keyboard, Screen, Mouse -=item Tying Hashes +=item How do I print something out in color? -USER, HOME, CLOBBER, LIST, TIEHASH classname, LIST, FETCH this, key, STORE -this, key, value, DELETE this, key, CLEAR this, EXISTS this, key, FIRSTKEY -this, NEXTKEY this, lastkey, UNTIE this, DESTROY this +=item How do I read just one key without waiting for a return key? -=item Tying FileHandles +=item How do I check whether input is ready on the keyboard? -TIEHANDLE classname, LIST, WRITE this, LIST, PRINT this, LIST, PRINTF this, -LIST, READ this, LIST, READLINE this, GETC this, CLOSE this, UNTIE this, -DESTROY this +=item How do I clear the screen? -=item UNTIE this +=item How do I get the screen size? -=item The C Gotcha +=item How do I ask the user for a password? -=back +=item How do I read and write the serial port? -=item SEE ALSO +lockfiles, open mode, end of line, flushing output, non-blocking input -=item BUGS +=item How do I decode encrypted password files? -=item AUTHOR +=item How do I start a process in the background? -=back +STDIN, STDOUT, and STDERR are shared, Signals, Zombies -=head2 perlipc - Perl interprocess communication (signals, fifos, pipes, -safe subprocesses, sockets, and semaphores) +=item How do I trap control characters/signals? -=over 4 +=item How do I modify the shadow password file on a Unix system? -=item DESCRIPTION +=item How do I set the time and date? -=item Signals +=item How can I sleep() or alarm() for under a second? -=item Named Pipes +=item How can I measure time under a second? -=over 4 +=item How can I do an atexit() or setjmp()/longjmp()? (Exception handling) -=item WARNING +=item Why doesn't my sockets program work under System V (Solaris)? What +does the error message "Protocol not supported" mean? -=back +=item How can I call my system's unique C functions from Perl? -=item Using open() for IPC +=item Where do I get the include files to do ioctl() or syscall()? -=over 4 +=item Why do setuid perl scripts complain about kernel problems? -=item Filehandles +=item How can I open a pipe both to and from a command? -=item Background Processes +=item Why can't I get the output of a command with system()? -=item Complete Dissociation of Child from Parent +=item How can I capture STDERR from an external command? -=item Safe Pipe Opens +=item Why doesn't open() return an error when a pipe open fails? -=item Bidirectional Communication with Another Process +=item What's wrong with using backticks in a void context? -=item Bidirectional Communication with Yourself +=item How can I call backticks without shell processing? -=back +=item Why can't my script read from STDIN after I gave it EOF (^D on Unix, +^Z on MS-DOS)? -=item Sockets: Client/Server Communication +=item How can I convert my shell script to perl? -=over 4 +=item Can I use perl to run a telnet or ftp session? -=item Internet Line Terminators +=item How can I write expect in Perl? -=item Internet TCP Clients and Servers +=item Is there a way to hide perl's command line from programs such as +"ps"? -=item Unix-Domain TCP Clients and Servers +=item I {changed directory, modified my environment} in a perl script. How +come the change disappeared when I exited the script? How do I get my +changes to be visible? -=back +Unix -=item TCP Clients with IO::Socket +=item How do I close a process's filehandle without waiting for it to +complete? -=over 4 +=item How do I fork a daemon process? -=item A Simple Client +=item How do I find out if I'm running interactively or not? -C, C, C +=item How do I timeout a slow event? -=item A Webget Client +=item How do I set CPU limits? -=item Interactive Client with IO::Socket +=item How do I avoid zombies on a Unix system? -=back +=item How do I use an SQL database? -=item TCP Servers with IO::Socket +=item How do I make a system() exit on control-C? -Proto, LocalPort, Listen, Reuse +=item How do I open a file without blocking? -=item UDP: Message Passing +=item How do I install a module from CPAN? -=item SysV IPC +=item What's the difference between require and use? -=item NOTES +=item How do I keep my own module/library directory? -=item BUGS +=item How do I add the directory my program lives in to the module/library +search path? -=item AUTHOR +=item How do I add a directory to my include path (@INC) at runtime? -=item SEE ALSO +=item What is socket.ph and where do I get it? =back -=head2 perlfork - Perl's fork() emulation (EXPERIMENTAL, subject to change) +=item AUTHOR AND COPYRIGHT -=over 4 +=back -=item SYNOPSIS +=head2 perlfaq9 - Networking ($Revision: 1.15 $, $Date: 2003/01/31 17:36:57 +$) + +=over 4 =item DESCRIPTION =over 4 -=item Behavior of other Perl features in forked pseudo-processes +=item What is the correct form of response from a CGI script? -$$ or $PROCESS_ID, %ENV, chdir() and all other builtins that accept -filenames, wait() and waitpid(), kill(), exec(), exit(), Open handles to -files, directories and network sockets +=item My CGI script runs from the command line but not the browser. (500 +Server Error) -=item Resource limits +=item How can I get better error messages from a CGI program? -=item Killing the parent process +=item How do I remove HTML from a string? -=item Lifetime of the parent process and pseudo-processes +=item How do I extract URLs? -=item CAVEATS AND LIMITATIONS +=item How do I download a file from the user's machine? How do I open a +file on another machine? -BEGIN blocks, Open filehandles, Forking pipe open() not yet implemented, -Global state maintained by XSUBs, Interpreter embedded in larger -application, Thread-safety of extensions +=item How do I make a pop-up menu in HTML? -=back +=item How do I fetch an HTML file? -=item BUGS +=item How do I automate an HTML form submission? -=item AUTHOR +=item How do I decode or create those %-encodings on the web? -=item SEE ALSO +=item How do I redirect to another page? -=back +=item How do I put a password on my web pages? -=head2 perlnumber - semantics of numbers and numeric operations in Perl +=item How do I edit my .htpasswd and .htgroup files with Perl? -=over 4 +=item How do I make sure users can't enter values into a form that cause my +CGI script to do bad things? -=item SYNOPSIS +=item How do I parse a mail header? -=item DESCRIPTION +=item How do I decode a CGI form? -=item Storing numbers +=item How do I check a valid mail address? -=item Numeric operators and numeric conversions +=item How do I decode a MIME/BASE64 string? -=item Flavors of Perl numeric operations +=item How do I return the user's mail address? -Arithmetic operators except, C, Arithmetic operators except, -C, Bitwise operators, C, Bitwise operators, C, Operators which expect an integer, Operators which expect a -string +=item How do I send mail? -=item AUTHOR +=item How do I use MIME to make an attachment to a mail message? -=item SEE ALSO +=item How do I read mail? -=back +=item How do I find out my hostname/domainname/IP address? -=head2 perlthrtut - tutorial on threads in Perl +=item How do I fetch a news article or the active newsgroups? -=over 4 +=item How do I fetch/put an FTP file? -=item DESCRIPTION +=item How can I do RPC in Perl? =back -=head2 perlothrtut - old tutorial on threads in Perl +=item AUTHOR AND COPYRIGHT -=over 4 +=back -=item DESCRIPTION +=head2 perlsyn - Perl syntax -=item What Is A Thread Anyway? +=over 4 -=item Threaded Program Models +=item DESCRIPTION =over 4 -=item Boss/Worker - -=item Work Crew +=item Declarations -=item Pipeline +=item Comments -=back +=item Simple Statements -=item Native threads +=item Truth and Falsehood -=item What kind of threads are perl threads? +=item Statement Modifiers -=item Threadsafe Modules +=item Compound Statements -=item Thread Basics +=item Loop Control -=over 4 +=item For Loops -=item Basic Thread Support +=item Foreach Loops -=item Creating Threads +=item Basic BLOCKs and Switch Statements -=item Giving up control +=item Goto -=item Waiting For A Thread To Exit +=item PODs: Embedded Documentation -=item Errors In Threads +=item Plain Old Comments (Not!) -=item Ignoring A Thread +=back =back -=item Threads And Data +=head2 perldata - Perl data types =over 4 -=item Shared And Unshared Data - -=item Thread Pitfall: Races - -=item Controlling access: lock() +=item DESCRIPTION -=item Thread Pitfall: Deadlocks +=over 4 -=item Queues: Passing Data Around +=item Variable names -=back +=item Context -=item Threads And Code +=item Scalar values -=over 4 +=item Scalar value constructors -=item Semaphores: Synchronizing Data Access +=item List value constructors -Basic semaphores, Advanced Semaphores +=item Subscripts -=item Attributes: Restricting Access To Subroutines +=item Slices -=item Subroutine Locks +=item Typeglobs and Filehandles -=item Methods +=back -=item Locking A Subroutine +=item SEE ALSO =back -=item General Thread Utility Routines +=head2 perlop - Perl operators and precedence =over 4 -=item What Thread Am I In? - -=item Thread IDs - -=item Are These Threads The Same? +=item DESCRIPTION -=item What Threads Are Running? +=over 4 -=back +=item Operator Precedence and Associativity -=item A Complete Example +=item Terms and List Operators (Leftward) -=item Conclusion +=item The Arrow Operator -=item Bibliography +=item Auto-increment and Auto-decrement -=over 4 +=item Exponentiation -=item Introductory Texts +=item Symbolic Unary Operators -=item OS-Related References +=item Binding Operators -=item Other References +=item Multiplicative Operators -=back +=item Additive Operators -=item Acknowledgements +=item Shift Operators -=item AUTHOR +=item Named Unary Operators -=item Copyrights +=item Relational Operators -=back +=item Equality Operators -=head2 perlport - Writing portable Perl +=item Bitwise And -=over 4 +=item Bitwise Or and Exclusive Or -=item DESCRIPTION +=item C-style Logical And -Not all Perl programs have to be portable, Nearly all of Perl already I -portable +=item C-style Logical Or -=item ISSUES +=item C-style Logical Defined-Or -=over 4 +=item Range Operators -=item Newlines +=item Conditional Operator -=item Numbers endianness and Width +=item Assignment Operators -=item Files and Filesystems +=item Comma Operator -=item System Interaction +=item List Operators (Rightward) -=item Interprocess Communication (IPC) +=item Logical Not -=item External Subroutines (XS) +=item Logical And -=item Standard Modules +=item Logical or, Defined or, and Exclusive Or -=item Time and Date +=item C Operators Missing From Perl -=item Character sets and character encoding +unary &, unary *, (TYPE) -=item Internationalisation +=item Quote and Quote-like Operators -=item System Resources +=item Regexp Quote-Like Operators -=item Security - -=item Style - -=back +?PATTERN?, m/PATTERN/cgimosx, /PATTERN/cgimosx, q/STRING/, C<'STRING'>, +qq/STRING/, "STRING", qr/STRING/imosx, qx/STRING/, `STRING`, qw/STRING/, +s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds, +y/SEARCHLIST/REPLACEMENTLIST/cds, <, C, C, C, C, C<''>, C, C<"">, +C<``>, C, C, C<< >>, C, C, C, +C,, Interpolation of regular expressions, Optimization of +regular expressions -=item PLATFORMS +=item I/O Operators -=over 4 +=item Constant Folding -=item Unix +=item Bitwise String Operators -=item DOS and Derivatives +=item Integer Arithmetic -=item S +=item Floating-point Arithmetic -=item VMS +=item Bigger Numbers -=item VOS +=back -=item EBCDIC Platforms +=back -=item Acorn RISC OS +=head2 perlsub - Perl subroutines -=item Other perls +=over 4 -=back +=item SYNOPSIS -=item FUNCTION IMPLEMENTATIONS +=item DESCRIPTION =over 4 -=item Alphabetical Listing of Perl Functions +=item Private Variables via my() --I FILEHANDLE, -I EXPR, -I, alarm SECONDS, alarm, binmode -FILEHANDLE, chmod LIST, chown LIST, chroot FILENAME, chroot, crypt -PLAINTEXT,SALT, dbmclose HASH, dbmopen HASH,DBNAME,MODE, dump LABEL, exec -LIST, exit EXPR, exit, fcntl FILEHANDLE,FUNCTION,SCALAR, flock -FILEHANDLE,OPERATION, fork, getlogin, getpgrp PID, getppid, getpriority -WHICH,WHO, getpwnam NAME, getgrnam NAME, getnetbyname NAME, getpwuid UID, -getgrgid GID, getnetbyaddr ADDR,ADDRTYPE, getprotobynumber NUMBER, -getservbyport PORT,PROTO, getpwent, getgrent, gethostent, getnetent, -getprotoent, getservent, setpwent, setgrent, sethostent STAYOPEN, setnetent -STAYOPEN, setprotoent STAYOPEN, setservent STAYOPEN, endpwent, endgrent, -endhostent, endnetent, endprotoent, endservent, getsockopt -SOCKET,LEVEL,OPTNAME, glob EXPR, glob, ioctl FILEHANDLE,FUNCTION,SCALAR, -kill SIGNAL, LIST, link OLDFILE,NEWFILE, lstat FILEHANDLE, lstat EXPR, -lstat, msgctl ID,CMD,ARG, msgget KEY,FLAGS, msgsnd ID,MSG,FLAGS, msgrcv -ID,VAR,SIZE,TYPE,FLAGS, open FILEHANDLE,EXPR, open FILEHANDLE, pipe -READHANDLE,WRITEHANDLE, readlink EXPR, readlink, select -RBITS,WBITS,EBITS,TIMEOUT, semctl ID,SEMNUM,CMD,ARG, semget -KEY,NSEMS,FLAGS, semop KEY,OPSTRING, setgrent, setpgrp PID,PGRP, -setpriority WHICH,WHO,PRIORITY, setpwent, setsockopt -SOCKET,LEVEL,OPTNAME,OPTVAL, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS, -shmread ID,VAR,POS,SIZE, shmwrite ID,STRING,POS,SIZE, sockatmark SOCKET, -socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, stat FILEHANDLE, stat -EXPR, stat, symlink OLDFILE,NEWFILE, syscall LIST, sysopen -FILEHANDLE,FILENAME,MODE,PERMS, system LIST, times, truncate -FILEHANDLE,LENGTH, truncate EXPR,LENGTH, umask EXPR, umask, utime LIST, -wait, waitpid PID,FLAGS +=item Persistent Private Variables -=back +=item Temporary Values via local() -=item CHANGES +=item Lvalue subroutines -v1.48, 02 February 2001, v1.47, 22 March 2000, v1.46, 12 February 2000, -v1.45, 20 December 1999, v1.44, 19 July 1999, v1.43, 24 May 1999, v1.42, 22 -May 1999, v1.41, 19 May 1999, v1.40, 11 April 1999, v1.39, 11 February -1999, v1.38, 31 December 1998, v1.37, 19 December 1998, v1.36, 9 September -1998, v1.35, 13 August 1998, v1.33, 06 August 1998, v1.32, 05 August 1998, -v1.30, 03 August 1998, v1.23, 10 July 1998 +Lvalue subroutines are EXPERIMENTAL -=item Supported Platforms +=item Passing Symbol Table Entries (typeglobs) -=item SEE ALSO +=item When to Still Use local() -=item AUTHORS / CONTRIBUTORS +=item Pass by Reference -=item VERSION +=item Prototypes -=back +=item Constant Functions -=head2 perllocale - Perl locale handling (internationalization and -localization) +=item Overriding Built-in Functions -=over 4 +=item Autoloading -=item DESCRIPTION +=item Subroutine Attributes -=item PREPARING TO USE LOCALES +=back -=item USING LOCALES +=item SEE ALSO -=over 4 +=back -=item The use locale pragma +=head2 perlfunc - Perl builtin functions -=item The setlocale function +=over 4 -=item Finding locales +=item DESCRIPTION -=item LOCALE PROBLEMS +=over 4 -=item Temporarily fixing locale problems +=item Perl Functions by Category -=item Permanently fixing locale problems +Functions for SCALARs or strings, Regular expressions and pattern matching, +Numeric functions, Functions for real @ARRAYs, Functions for list data, +Functions for real %HASHes, Input and output functions, Functions for fixed +length data or records, Functions for filehandles, files, or directories, +Keywords related to the control flow of your perl program, Keywords related +to scoping, Miscellaneous functions, Functions for processes and process +groups, Keywords related to perl modules, Keywords related to classes and +object-orientedness, Low-level socket functions, System V interprocess +communication functions, Fetching user and group info, Fetching network +info, Time-related functions, Functions new in perl5, Functions obsoleted +in perl5 -=item Permanently fixing your system's locale configuration +=item Portability -=item Fixing system locale configuration +=item Alphabetical Listing of Perl Functions -=item The localeconv function +-I FILEHANDLE, -I EXPR, -I, abs VALUE, abs, accept +NEWSOCKET,GENERICSOCKET, alarm SECONDS, alarm, atan2 Y,X, bind SOCKET,NAME, +binmode FILEHANDLE, LAYER, binmode FILEHANDLE, bless REF,CLASSNAME, bless +REF, caller EXPR, caller, chdir EXPR, chmod LIST, chomp VARIABLE, chomp( +LIST ), chomp, chop VARIABLE, chop( LIST ), chop, chown LIST, chr NUMBER, +chr, chroot FILENAME, chroot, close FILEHANDLE, close, closedir DIRHANDLE, +connect SOCKET,NAME, continue BLOCK, cos EXPR, cos, crypt PLAINTEXT,SALT, +dbmclose HASH, dbmopen HASH,DBNAME,MASK, defined EXPR, defined, delete +EXPR, die LIST, do BLOCK, do SUBROUTINE(LIST), do EXPR, dump LABEL, dump, +each HASH, eof FILEHANDLE, eof (), eof, eval EXPR, eval BLOCK, exec LIST, +exec PROGRAM LIST, exists EXPR, exit EXPR, exp EXPR, exp, fcntl +FILEHANDLE,FUNCTION,SCALAR, fileno FILEHANDLE, flock FILEHANDLE,OPERATION, +fork, format, formline PICTURE,LIST, getc FILEHANDLE, getc, getlogin, +getpeername SOCKET, getpgrp PID, getppid, getpriority WHICH,WHO, getpwnam +NAME, getgrnam NAME, gethostbyname NAME, getnetbyname NAME, getprotobyname +NAME, getpwuid UID, getgrgid GID, getservbyname NAME,PROTO, gethostbyaddr +ADDR,ADDRTYPE, getnetbyaddr ADDR,ADDRTYPE, getprotobynumber NUMBER, +getservbyport PORT,PROTO, getpwent, getgrent, gethostent, getnetent, +getprotoent, getservent, setpwent, setgrent, sethostent STAYOPEN, setnetent +STAYOPEN, setprotoent STAYOPEN, setservent STAYOPEN, endpwent, endgrent, +endhostent, endnetent, endprotoent, endservent, getsockname SOCKET, +getsockopt SOCKET,LEVEL,OPTNAME, glob EXPR, glob, gmtime EXPR, goto LABEL, +goto EXPR, goto &NAME, grep BLOCK LIST, grep EXPR,LIST, hex EXPR, hex, +import, index STR,SUBSTR,POSITION, index STR,SUBSTR, int EXPR, int, ioctl +FILEHANDLE,FUNCTION,SCALAR, join EXPR,LIST, keys HASH, kill SIGNAL, LIST, +last LABEL, last, lc EXPR, lc, lcfirst EXPR, lcfirst, length EXPR, length, +link OLDFILE,NEWFILE, listen SOCKET,QUEUESIZE, local EXPR, localtime EXPR, +lock THING, log EXPR, log, lstat EXPR, lstat, m//, map BLOCK LIST, map +EXPR,LIST, mkdir FILENAME,MASK, mkdir FILENAME, msgctl ID,CMD,ARG, msgget +KEY,FLAGS, msgrcv ID,VAR,SIZE,TYPE,FLAGS, msgsnd ID,MSG,FLAGS, my EXPR, my +TYPE EXPR, my EXPR : ATTRS, my TYPE EXPR : ATTRS, next LABEL, next, no +Module VERSION LIST, no Module VERSION, no Module LIST, no Module, oct +EXPR, oct, open FILEHANDLE,EXPR, open FILEHANDLE,MODE,EXPR, open +FILEHANDLE,MODE,EXPR,LIST, open FILEHANDLE,MODE,REFERENCE, open FILEHANDLE, +opendir DIRHANDLE,EXPR, ord EXPR, ord, our EXPR, our EXPR TYPE, our EXPR : +ATTRS, our TYPE EXPR : ATTRS, pack TEMPLATE,LIST, package NAMESPACE, +package, pipe READHANDLE,WRITEHANDLE, pop ARRAY, pop, pos SCALAR, pos, +print FILEHANDLE LIST, print LIST, print, printf FILEHANDLE FORMAT, LIST, +printf FORMAT, LIST, prototype FUNCTION, push ARRAY,LIST, q/STRING/, +qq/STRING/, qr/STRING/, qx/STRING/, qw/STRING/, quotemeta EXPR, quotemeta, +rand EXPR, rand, read FILEHANDLE,SCALAR,LENGTH,OFFSET, read +FILEHANDLE,SCALAR,LENGTH, readdir DIRHANDLE, readline EXPR, readlink EXPR, +readlink, readpipe EXPR, recv SOCKET,SCALAR,LENGTH,FLAGS, redo LABEL, redo, +ref EXPR, ref, rename OLDNAME,NEWNAME, require VERSION, require EXPR, +require, reset EXPR, reset, return EXPR, return, reverse LIST, rewinddir +DIRHANDLE, rindex STR,SUBSTR,POSITION, rindex STR,SUBSTR, rmdir FILENAME, +rmdir, s///, scalar EXPR, seek FILEHANDLE,POSITION,WHENCE, seekdir +DIRHANDLE,POS, select FILEHANDLE, select, select RBITS,WBITS,EBITS,TIMEOUT, +semctl ID,SEMNUM,CMD,ARG, semget KEY,NSEMS,FLAGS, semop KEY,OPSTRING, send +SOCKET,MSG,FLAGS,TO, send SOCKET,MSG,FLAGS, setpgrp PID,PGRP, setpriority +WHICH,WHO,PRIORITY, setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL, shift ARRAY, +shift, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS, shmread ID,VAR,POS,SIZE, +shmwrite ID,STRING,POS,SIZE, shutdown SOCKET,HOW, sin EXPR, sin, sleep +EXPR, sleep, socket SOCKET,DOMAIN,TYPE,PROTOCOL, socketpair +SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, sort SUBNAME LIST, sort BLOCK LIST, +sort LIST, splice ARRAY,OFFSET,LENGTH,LIST, splice ARRAY,OFFSET,LENGTH, +splice ARRAY,OFFSET, splice ARRAY, split /PATTERN/,EXPR,LIMIT, split +/PATTERN/,EXPR, split /PATTERN/, split, sprintf FORMAT, LIST, format +parameter index, flags, vector flag, (minimum) width, precision, or maximum +width, size, order of arguments, sqrt EXPR, sqrt, srand EXPR, srand, stat +FILEHANDLE, stat EXPR, stat, study SCALAR, study, sub NAME BLOCK, sub NAME +(PROTO) BLOCK, sub NAME : ATTRS BLOCK, sub NAME (PROTO) : ATTRS BLOCK, +substr EXPR,OFFSET,LENGTH,REPLACEMENT, substr EXPR,OFFSET,LENGTH, substr +EXPR,OFFSET, symlink OLDFILE,NEWFILE, syscall NUMBER, LIST, sysopen +FILEHANDLE,FILENAME,MODE, sysopen FILEHANDLE,FILENAME,MODE,PERMS, sysread +FILEHANDLE,SCALAR,LENGTH,OFFSET, sysread FILEHANDLE,SCALAR,LENGTH, sysseek +FILEHANDLE,POSITION,WHENCE, system LIST, system PROGRAM LIST, syswrite +FILEHANDLE,SCALAR,LENGTH,OFFSET, syswrite FILEHANDLE,SCALAR,LENGTH, +syswrite FILEHANDLE,SCALAR, tell FILEHANDLE, tell, telldir DIRHANDLE, tie +VARIABLE,CLASSNAME,LIST, tied VARIABLE, time, times, tr///, truncate +FILEHANDLE,LENGTH, truncate EXPR,LENGTH, uc EXPR, uc, ucfirst EXPR, +ucfirst, umask EXPR, umask, undef EXPR, undef, unlink LIST, unlink, unpack +TEMPLATE,EXPR, unpack TEMPLATE, untie VARIABLE, unshift ARRAY,LIST, use +Module VERSION LIST, use Module VERSION, use Module LIST, use Module, use +VERSION, utime LIST, values HASH, vec EXPR,OFFSET,BITS, wait, waitpid +PID,FLAGS, wantarray, warn LIST, write FILEHANDLE, write EXPR, write, y/// -=item I18N::Langinfo +=back =back -=item LOCALE CATEGORIES +=head2 perlopentut - tutorial on opening things in Perl =over 4 -=item Category LC_COLLATE: Collation +=item DESCRIPTION -=item Category LC_CTYPE: Character Types +=item Open E la shell -=item Category LC_NUMERIC: Numeric Formatting +=over 4 -=item Category LC_MONETARY: Formatting of monetary amounts +=item Simple Opens -=item LC_TIME +=item Indirect Filehandles -=item Other categories +=item Pipe Opens -=back +=item The Minus File -=item SECURITY +=item Mixing Reads and Writes -=item ENVIRONMENT +=item Filters -PERL_BADLANG, LC_ALL, LANGUAGE, LC_CTYPE, LC_COLLATE, LC_MONETARY, -LC_NUMERIC, LC_TIME, LANG +=back -=item NOTES +=item Open E la C =over 4 -=item Backward compatibility +=item Permissions E la mode -=item I18N:Collate obsolete +=back -=item Sort speed and memory use impacts +=item Obscure Open Tricks -=item write() and LC_NUMERIC +=over 4 -=item Freely available locale definitions +=item Re-Opening Files (dups) -=item I18n and l10n +=item Dispelling the Dweomer -=item An imperfect standard +=item Paths as Opens + +=item Single Argument Open + +=item Playing with STDIN and STDOUT =back -=item BUGS +=item Other I/O Issues =over 4 -=item Broken systems +=item Opening Non-File Files + +=item Opening Named Pipes + +=item Opening Sockets + +=item Binary Files + +=item File Locking + +=item IO Layers =back -=item SEE ALSO +=item SEE ALSO + +=item AUTHOR and COPYRIGHT =item HISTORY =back -=head2 perlunintro - Perl Unicode introduction +=head2 perlpacktut - tutorial on C and C =over 4 =item DESCRIPTION -=over 4 +=item The Basic Principle -=item Unicode +=item Packing Text -=item Perl's Unicode Support +=item Packing Numbers -=item Perl's Unicode Model +=over 4 -=item Creating Unicode +=item Integers -=item Handling Unicode +=item Unpacking a Stack Frame -=item Legacy Encodings +=item How to Eat an Egg on a Net -=item Unicode I/O +=item Floating point Numbers -=item Special Cases +=back -=item Advanced Topics +=item Exotic Templates -=item Miscellaneous +=over 4 -=item Questions With Answers +=item Bit Strings -Will My Old Scripts Break?, How Do I Make My Scripts Work With Unicode?, -How Do I Know Whether My String Is In Unicode?, How Do I Detect Invalid -UTF-8?, How Do I Convert Data Into UTF-8? Or Vice Versa?, How Do I Display -Unicode? How Do I Input Unicode?, How Does Unicode Work With Traditional -Locales? +=item Uuencoding -=item Hexadecimal Notation +=item Doing Sums -=item Further Resources +=item Unicode + +=item Another Portable Binary Encoding =back -=item SEE ALSO +=item Template Grouping -=item ACKNOWLEDGEMENTS +=item Lengths and Widths -=item AUTHOR, COPYRIGHT, AND LICENSE +=over 4 -=back +=item String Lengths -=head2 perlunicode - Unicode support in Perl +=item Dynamic Templates -=over 4 +=item Counting Repetitions -=item DESCRIPTION +=back + +=item Packing and Unpacking C Structures =over 4 -=item Important Caveats +=item The Alignment Pit -Input and Output Disciplines, Regular Expressions, C still needed -to enable UTF-8/UTF-EBCDIC in scripts +=item Alignment, Take 2 -=item Byte and Character semantics +=item Alignment, Take 3 -=item Effects of character semantics +=item Pointers for How to Use Them -=item Scripts +=back -=item Blocks +=item Pack Recipes -=item Character encodings for input and output +=item Funnies Section + +=item Authors =back -=item CAVEATS +=head2 perlpod - the Plain Old Documentation format -=item UNICODE REGULAR EXPRESSION SUPPORT LEVEL +=over 4 + +=item DESCRIPTION =over 4 -=item Unicode Encodings +=item Ordinary Paragraph -UTF-8, UTF-16, UTF-16BE, UTF16-LE, Surrogates, and BOMs (Byte Order Marks), -UTF-32, UTF-32BE, UTF32-LE, UCS-2, UCS-4, UTF-7 +=item Verbatim Paragraph -=item Security Implications of Malformed UTF-8 +=item Command Paragraph -=item Unicode in Perl on EBCDIC +C<=head1 I>, C<=head2 I>, C<=head3 I>, C<=head4 I>, C<=over I>, C<=item +I>, C<=back>, C<=cut>, C<=pod>, C<=begin I>, C<=end +I>, C<=for I I>, C<=encoding +I> + +=item Formatting Codes + +CtextE> -- italic text, CtextE> -- bold text, +CcodeE> -- code text, CnameE> -- a hyperlink, +CescapeE> -- a character escape, CfilenameE> -- used +for filenames, CtextE> -- text contains non-breaking spaces, +Ctopic nameE> -- an index entry, CE> -- a null +(zero-effect) formatting code + +=item The Intent + +=item Embedding Pods in Perl Modules + +=item Hints for Writing Pod =back =item SEE ALSO +=item AUTHOR + =back -=head2 perlebcdic - Considerations for running Perl on EBCDIC platforms +=head2 perlpodspec - Plain Old Documentation: format specification and +notes =over 4 =item DESCRIPTION -=item COMMON CHARACTER CODE SETS +=item Pod Definitions -=over 4 +=item Pod Commands -=item ASCII +"=head1", "=head2", "=head3", "=head4", "=pod", "=cut", "=over", "=item", +"=back", "=begin formatname", "=end formatname", "=for formatname text...", +"=encoding encodingname" -=item ISO 8859 +=item Pod Formatting Codes -=item Latin 1 (ISO 8859-1) +CtextE> -- italic text, CtextE> -- bold text, +CcodeE> -- code text, CfilenameE> -- style for +filenames, Ctopic nameE> -- an index entry, CE> -- a +null (zero-effect) formatting code, CnameE> -- a hyperlink, +CescapeE> -- a character escape, CtextE> -- text +contains non-breaking spaces -=item EBCDIC +=item Notes on Implementing Pod Processors -=item 13 variant characters +=item About LE...E Codes -=item 0037 +First:, Second:, Third:, Fourth:, Fifth:, Sixth: -=item 1047 +=item About =over...=back Regions -=item POSIX-BC +=item About Data Paragraphs and "=begin/=end" Regions -=item Unicode and UTF +=item SEE ALSO + +=item AUTHOR =back -=item SINGLE OCTET TABLES +=head2 perlrun - how to execute the Perl interpreter -recipe 0, recipe 1, recipe 2, recipe 3, recipe 4, recipe 5, recipe 6 +=over 4 -=item IDENTIFYING CHARACTER CODE SETS +=item SYNOPSIS -=item CONVERSIONS +=item DESCRIPTION =over 4 -=item tr/// +=item #! and quoting on non-Unix systems -=item iconv +OS/2, MS-DOS, Win95/NT, Macintosh, VMS -=item C RTL +=item Location of Perl + +=item Command Switches + +B<-0>[I], B<-A [I]>, B<-a>, B<-C +[I]>, B<-c>, B<-d>, B<-d:>I, B<-D>I, +B<-D>I, B<-e> I, B<-F>I, B<-h>, +B<-i>[I], B<-I>I, B<-l>[I], +B<-m>[B<->]I, B<-M>[B<->]I, B<-M>[B<->]I<'module ...'>, +B<-[mM]>[B<->]I, B<-n>, B<-p>, B<-P>, B<-s>, B<-S>, +B<-t>, B<-T>, B<-u>, B<-U>, B<-v>, B<-V>, B<-V:>I, B<-w>, B<-W>, +B<-X>, B<-x> I =back -=item OPERATOR DIFFERENCES +=item ENVIRONMENT -=item FUNCTION DIFFERENCES +HOME, LOGDIR, PATH, PERL5LIB, PERL5OPT, PERLIO, :bytes, :crlf, :mmap, +:perlio, :pop, :raw, :stdio, :unix, :utf8, :win32, PERLIO_DEBUG, PERLLIB, +PERL5DB, PERL5SHELL (specific to the Win32 port), PERL_DEBUG_MSTATS, +PERL_DESTRUCT_LEVEL, PERL_DL_NONLAZY, PERL_ENCODING, PERL_HASH_SEED, +PERL_HASH_SEED_DEBUG, PERL_ROOT (specific to the VMS port), PERL_SIGNALS, +PERL_UNICODE, SYS$LOGIN (specific to the VMS port) -chr(), ord(), pack(), print(), printf(), sort(), sprintf(), unpack() +=back -=item REGULAR EXPRESSION DIFFERENCES +=head2 perldiag - various Perl diagnostics -=item SOCKETS +=over 4 -=item SORTING +=item DESCRIPTION + +=back + +=head2 perllexwarn - Perl Lexical Warnings =over 4 -=item Ignore ASCII vs. EBCDIC sort differences. +=item DESCRIPTION -=item MONO CASE then sort data. +=over 4 -=item Convert, sort data, then re convert. +=item Default Warnings and Optional Warnings -=item Perform sorting on one type of machine only. +=item What's wrong with B<-w> and C<$^W> -=back +=item Controlling Warnings from the Command Line -=item TRANSFORMATION FORMATS +B<-w>, B<-W>, B<-X> -=over 4 +=item Backward Compatibility -=item URL decoding and encoding +=item Category Hierarchy -=item uu encoding and decoding +=item Fatal Warnings -=item Quoted-Printable encoding and decoding +=item Reporting Warnings from a Module -=item Caesarian ciphers +=back + +=item TODO + +=item SEE ALSO + +=item AUTHOR =back -=item Hashing order and checksums +=head2 perldebug - Perl debugging -=item I18N AND L10N +=over 4 -=item MULTI OCTET CHARACTER SETS +=item DESCRIPTION -=item OS ISSUES +=item The Perl Debugger =over 4 -=item OS/400 +=item Debugger Commands -IFS access +h, h [command], h h, p expr, x [maxdepth] expr, V [pkg [vars]], X [vars], y +[level [vars]], T, s [expr], n [expr], r, , c [line|sub], l, l +min+incr, l min-max, l line, l subname, -, v [line], f filename, /pattern/, +?pattern?, L [abw], S [[!]regex], t, t expr, b, b [line] [condition], b +subname [condition], b postpone subname [condition], b load filename, b +compile subname, B line, B *, a [line] command, A line, A *, w expr, W +expr, W *, o, o booloption .., o anyoption? .., o option=value .., < ?, < [ +command ], < *, << command, > ?, > command, > *, >> command, { ?, { [ +command ], { *, {{ command, ! number, ! -number, ! pattern, !! cmd, source +file, H -number, q or ^D, R, |dbcmd, ||dbcmd, command, m expr, M, man +[manpage] -=item OS/390, z/OS +=item Configurable Options -chcp, dataset access, OS/390, z/OS iconv, locales +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, +C -=item VM/ESA? +=item Debugger input/output -=item POSIX-BC? +Prompt, Multiline commands, Stack backtrace, Line Listing Format, Frame +listing -=back +=item Debugging compile-time statements -=item BUGS +=item Debugger Customization -=item SEE ALSO +=item Readline Support -=item REFERENCES +=item Editor Support for Debugging -=item HISTORY +=item The Perl Profiler -=item AUTHOR +=back + +=item Debugging regular expressions + +=item Debugging memory usage + +=item SEE ALSO + +=item BUGS =back -=head2 perlsec - Perl security +=head2 perlvar - Perl predefined variables =over 4 @@ -2336,49 +2381,97 @@ chcp, dataset access, OS/390, z/OS iconv, locales =over 4 -=item Laundering and Detecting Tainted Data - -=item Switches On the "#!" Line +=item Predefined Names -=item Cleaning Up Your Path +$ARG, $_, $a, $b, $>, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $', +$LAST_PAREN_MATCH, $+, $^N, @LAST_MATCH_END, @+, +HANDLE->input_line_number(EXPR), $INPUT_LINE_NUMBER, $NR, $, +IO::Handle->input_record_separator(EXPR), $INPUT_RECORD_SEPARATOR, $RS, $/, +HANDLE->autoflush(EXPR), $OUTPUT_AUTOFLUSH, $|, +IO::Handle->output_field_separator EXPR, $OUTPUT_FIELD_SEPARATOR, $OFS, $,, +IO::Handle->output_record_separator EXPR, $OUTPUT_RECORD_SEPARATOR, $ORS, +$\, $LIST_SEPARATOR, $", $SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $#, +HANDLE->format_page_number(EXPR), $FORMAT_PAGE_NUMBER, $%, +HANDLE->format_lines_per_page(EXPR), $FORMAT_LINES_PER_PAGE, $=, +HANDLE->format_lines_left(EXPR), $FORMAT_LINES_LEFT, $-, @LAST_MATCH_START, +@-, C<$`> is the same as C, C<$&> is the same as +C, C<$'> is the same as C, C<$1> is the same as C, C<$2> +is the same as C, C<$3> is the same as +C, HANDLE->format_name(EXPR), +$FORMAT_NAME, $~, HANDLE->format_top_name(EXPR), $FORMAT_TOP_NAME, $^, +IO::Handle->format_line_break_characters EXPR, +$FORMAT_LINE_BREAK_CHARACTERS, $:, IO::Handle->format_formfeed EXPR, +$FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A, $CHILD_ERROR, $?, ${^ENCODING}, +$OS_ERROR, $ERRNO, $!, %!, $EXTENDED_OS_ERROR, $^E, $EVAL_ERROR, $@, +$PROCESS_ID, $PID, $$, $REAL_USER_ID, $UID, $<, $EFFECTIVE_USER_ID, $EUID, +$>, $REAL_GROUP_ID, $GID, $(, $EFFECTIVE_GROUP_ID, $EGID, $), +$PROGRAM_NAME, $0, $[, $], $COMPILING, $^C, $DEBUGGING, $^D, +$SYSTEM_FD_MAX, $^F, $^H, %^H, $INPLACE_EDIT, $^I, $^M, $OSNAME, $^O, +${^OPEN}, $PERLDB, $^P, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, +0x100, 0x200, 0x400, $LAST_REGEXP_CODE_RESULT, $^R, +$EXCEPTIONS_BEING_CAUGHT, $^S, $BASETIME, $^T, ${^TAINT}, ${^UNICODE}, +$PERL_VERSION, $^V, $WARNING, $^W, ${^WARNING_BITS}, $EXECUTABLE_NAME, $^X, +ARGV, $ARGV, @ARGV, ARGVOUT, @F, @INC, @_, %INC, %ENV, $ENV{expr}, %SIG, +$SIG{expr} -=item Security Bugs +=item Error Indicators -=item Protecting Your Programs +=item Technical Note on the Syntax of Variable Names =back -=item SEE ALSO +=item BUGS =back -=head2 perlmod - Perl modules (packages and symbol tables) +=head2 perlre - Perl regular expressions =over 4 =item DESCRIPTION +i, m, s, x + =over 4 -=item Packages +=item Regular Expressions -=item Symbol Tables +[1], [2], [3], cntrl, graph, print, punct, xdigit -=item Package Constructors and Destructors +=item Extended Patterns -=item Perl Classes +C<(?#text)>, C<(?imsx-imsx)>, C<(?:pattern)>, C<(?imsx-imsx:pattern)>, +C<(?=pattern)>, C<(?!pattern)>, C<(?<=pattern)>, C<(?, C<(?{ +code })>, C<(??{ code })>, C<< (?>pattern) >>, +C<(?(condition)yes-pattern|no-pattern)>, C<(?(condition)yes-pattern)> -=item Perl Modules +=item Backtracking -=item Making your module threadsafe +=item Version 8 Regular Expressions + +=item Warning on \1 vs $1 + +=item Repeated patterns matching zero-length substring + +=item Combining pieces together + +C, C, C, C, C, C, +C, C, C, C, C, C<< (?>S) >>, C<(?=S)>, C<(?<=S)>, +C<(?!S)>, C<(?, C<(??{ EXPR })>, +C<(?(condition)yes-pattern|no-pattern)> + +=item Creating custom RE engines =back +=item BUGS + =item SEE ALSO =back -=head2 perlmodinstall - Installing CPAN Modules +=head2 perlreref - Perl Regular Expressions Reference =over 4 @@ -2386,1105 +2479,1080 @@ chcp, dataset access, OS/390, z/OS iconv, locales =over 4 -=item PREAMBLE +=item OPERATORS -B the file, B the file into a directory, B the -module (sometimes unnecessary), B the module +=item SYNTAX -=back +=item ESCAPE SEQUENCES -=item PORTABILITY +=item CHARACTER CLASSES -=item HEY +=item ANCHORS -=item AUTHOR +=item QUANTIFIERS -=item COPYRIGHT +=item EXTENDED CONSTRUCTS + +=item VARIABLES + +=item FUNCTIONS + +=item TERMINOLOGY =back -=head2 perlmodlib - constructing new Perl modules and finding existing ones +=item AUTHOR -=over 4 +=item SEE ALSO -=item DESCRIPTION +=item THANKS -=item THE PERL MODULE LIBRARY +=back + +=head2 perlref - Perl references and nested data structures =over 4 -=item Pragmatic Modules +=item NOTE -attributes, attrs, autouse, base, blib, bytes, charnames, constant, -diagnostics, fields, filetest, integer, less, locale, open, ops, overload, -re, sigtrap, strict, subs, threads, utf8, vars, warnings, -warnings::register +=item DESCRIPTION -=item Standard Modules - -AnyDBM_File, Attribute::Handlers, AutoLoader, AutoSplit, B, B::Asmdata, -B::Assembler, B::Bblock, B::Bytecode, B::C, B::CC, B::Concise, B::Debug, -B::Deparse, B::Disassembler, B::Lint, B::Showlex, B::Stackobj, B::Stash, -B::Terse, B::Xref, Benchmark, ByteLoader, CGI, CGI::Apache, CGI::Carp, -CGI::Cookie, CGI::Fast, CGI::Pretty, CGI::Push, CGI::Switch, CGI::Util, -CPAN, CPAN::FirstTime, CPAN::Nox, Carp, Carp::Heavy, Class::ISA, -Class::Struct, Cwd, DB, DB_File, Devel::SelfStubber, Digest, DirHandle, -Dumpvalue, Encode, Encode::EncodeFormat, Encode::Tcl, English, Env, -Exporter, Exporter::Heavy, ExtUtils::Command, ExtUtils::Constant, -ExtUtils::Embed, ExtUtils::Install, ExtUtils::Installed, ExtUtils::Liblist, -ExtUtils::MM_Cygwin, ExtUtils::MM_NW5, ExtUtils::MM_OS2, ExtUtils::MM_Unix, -ExtUtils::MM_VMS, ExtUtils::MM_Win32, ExtUtils::MakeMaker, -ExtUtils::Manifest, ExtUtils::Mkbootstrap, ExtUtils::Mksymlists, -ExtUtils::Packlist, ExtUtils::testlib, Fatal, Fcntl, File::Basename, -File::CheckTree, File::Compare, File::Copy, File::DosGlob, File::Find, -File::Path, File::Spec, File::Spec::Epoc, File::Spec::Functions, -File::Spec::Mac, File::Spec::OS2, File::Spec::Unix, File::Spec::VMS, -File::Spec::Win32, File::Temp, File::stat, FileCache, FileHandle, -Filter::Simple, FindBin, Getopt::Long, Getopt::Std, I18N::Collate, -I18N::LangTags, I18N::LangTags::List, IO, IPC::Open2, IPC::Open3, -Lingua::KO::Hangul::Util, Locale::Constants, Locale::Country, -Locale::Currency, Locale::Language, Locale::Maketext, -Locale::Maketext::TPJ13, Math::BigFloat, Math::BigInt, Math::BigInt::Calc, -Math::Complex, Math::Trig, Memoize, Memoize::AnyDBM_File, Memoize::Expire, -Memoize::ExpireFile, Memoize::ExpireTest, Memoize::NDBM_File, -Memoize::SDBM_File, Memoize::Saves, Memoize::Storable, NDBM_File, NEXT, -Net::Cmd, Net::Config, Net::Domain, Net::FTP, Net::NNTP, Net::Netrc, -Net::POP3, Net::Ping, Net::SMTP, Net::Time, Net::hostent, Net::libnetFAQ, -Net::netent, Net::protoent, Net::servent, O, ODBM_File, Opcode, POSIX, -PerlIO, Pod::Checker, Pod::Find, Pod::Html, Pod::InputObjects, Pod::LaTeX, -Pod::Man, Pod::ParseUtils, Pod::Parser, Pod::Plainer, Pod::Select, -Pod::Text, Pod::Text::Color, Pod::Text::Overstrike, Pod::Text::Termcap, -Pod::Usage, SDBM_File, Safe, Search::Dict, SelectSaver, SelfLoader, Shell, -Socket, Storable, Switch, Symbol, Term::ANSIColor, Term::Cap, -Term::Complete, Term::ReadLine, Test, Test::Harness, Test::More, -Test::Simple, Test::Tutorial, Text::Abbrev, Text::Balanced, -Text::ParseWords, Text::Soundex, Text::Tabs, Text::Wrap, Tie::Array, -Tie::Handle, Tie::Hash, Tie::RefHash, Tie::Scalar, Tie::SubstrHash, -Time::Local, Time::gmtime, Time::localtime, Time::tm, UNIVERSAL, -Unicode::Collate, Unicode::Normalize, Unicode::UCD, User::grent, -User::pwent, Win32 +=over 4 -=item Extension Modules +=item Making References -=back +=item Using References -=item CPAN +=item Symbolic references -=over 4 +=item Not-so-symbolic references -=item Africa +=item Pseudo-hashes: Using an array as a hash -=item Asia +=item Function Templates -=item Central America +=back -=item Europe +=item WARNING -=item North America +=item SEE ALSO -=item Oceania +=back -=item South America +=head2 perlform - Perl formats -=back +=over 4 -=item Modules: Creation, Use, and Abuse +=item DESCRIPTION =over 4 -=item Guidelines for Module Creation +=item Format Variables -Adding a Copyright Notice +=back -=item Guidelines for Converting Perl 4 Library Scripts into Modules +=item NOTES -=item Guidelines for Reusing Application Code +=over 4 + +=item Footers + +=item Accessing Formatting Internals =back -=item NOTE +=item WARNINGS =back -=head2 perlmodstyle - Perl module style guide +=head2 perlobj - Perl objects =over 4 -=item INTRODUCTION - -=item QUICK CHECKLIST +=item DESCRIPTION =over 4 -=item Before you start +=item An Object is Simply a Reference -=item The API +=item A Class is Simply a Package -=item Stability +=item A Method is Simply a Subroutine -=item Documentation +=item Method Invocation -=item Release considerations +=item Indirect Object Syntax -=back +=item Default UNIVERSAL methods -=item BEFORE YOU START WRITING A MODULE +isa(CLASS), can(METHOD), VERSION( [NEED] ) -=over 4 +=item Destructors -=item Has it been done before? +=item Summary -=item Do one thing and do it well +=item Two-Phased Garbage Collection -=item What's in a name? +=back + +=item SEE ALSO =back -=item DESIGNING AND WRITING YOUR MODULE +=head2 perltie - how to hide an object class in a simple variable =over 4 -=item To OO or not to OO? +=item SYNOPSIS -=item Designing your API +=item DESCRIPTION -Write simple routines to do simple things, Separate functionality from -output, Provide sensible shortcuts and defaults, Naming conventions, -Parameter passing +=over 4 -=item Strictness and warnings +=item Tying Scalars -=item Backwards compatibility +TIESCALAR classname, LIST, FETCH this, STORE this, value, UNTIE this, +DESTROY this -=item Error handling and messages +=item Tying Arrays -=back +TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value, +FETCHSIZE this, STORESIZE this, count, EXTEND this, count, EXISTS this, +key, DELETE this, key, CLEAR this, PUSH this, LIST, POP this, SHIFT this, +UNSHIFT this, LIST, SPLICE this, offset, length, LIST, UNTIE this, DESTROY +this -=item DOCUMENTING YOUR MODULE +=item Tying Hashes -=over 4 +USER, HOME, CLOBBER, LIST, TIEHASH classname, LIST, FETCH this, key, STORE +this, key, value, DELETE this, key, CLEAR this, EXISTS this, key, FIRSTKEY +this, NEXTKEY this, lastkey, SCALAR this, UNTIE this, DESTROY this -=item POD +=item Tying FileHandles -=item README, INSTALL, release notes, changelogs +TIEHANDLE classname, LIST, WRITE this, LIST, PRINT this, LIST, PRINTF this, +LIST, READ this, LIST, READLINE this, GETC this, CLOSE this, UNTIE this, +DESTROY this + +=item UNTIE this + +=item The C Gotcha =back -=item RELEASE CONSIDERATIONS +=item SEE ALSO -=over 4 +=item BUGS -=item Version numbering +=item AUTHOR -=item Pre-requisites +=back -=item Testing +=head2 perldbmfilter - Perl DBM Filters -=item Packaging +=over 4 -=item Licensing +=item SYNOPSIS -=back +=item DESCRIPTION -=item COMMON PITFALLS +B, B, B, +B =over 4 -=item Reinventing the wheel +=item The Filter -=item Trying to do too much +=item An Example -- the NULL termination problem. -=item Inappropriate documentation +=item Another Example -- Key is a C int. =back =item SEE ALSO -L, L, L, L, Testing tools, -http://pause.perl.org/, Any good book on software engineering - =item AUTHOR =back -=head2 perlnewmod - preparing a new module for distribution +=head2 perlipc - Perl interprocess communication (signals, fifos, pipes, +safe subprocesses, sockets, and semaphores) =over 4 =item DESCRIPTION +=item Signals + =over 4 -=item Warning +=item Handling the SIGHUP Signal in Daemons -=item What should I make into a module? +=back -=item Step-by-step: Preparing the ground +=item Named Pipes -Look around, Check it's new, Discuss the need, Choose a name, Check again +=over 4 -=item Step-by-step: Making the module +=item Deferred Signals (Safe Signals) -Start with F, Use L and L, Use -L, Use L - wisely!, Use L, Write tests, Write the README +Long running opcodes, Interrupting IO, Restartable system calls, Signals as +"faults", Signals triggered by operating system state -=item Step-by-step: Distributing your module +=back -Get a CPAN user ID, C, Upload the -tarball, Announce to the modules list, Announce to clpa, Fix bugs! +=item Using open() for IPC -=back +=over 4 -=item AUTHOR +=item Filehandles -=item SEE ALSO +=item Background Processes + +=item Complete Dissociation of Child from Parent + +=item Safe Pipe Opens + +=item Bidirectional Communication with Another Process + +=item Bidirectional Communication with Yourself =back -=head2 perlfaq1 - General Questions About Perl ($Revision: 1.2 $, $Date: -2001/11/09 08:06:04 $) +=item Sockets: Client/Server Communication =over 4 -=item DESCRIPTION +=item Internet Line Terminators -=over 4 +=item Internet TCP Clients and Servers -=item What is Perl? +=item Unix-Domain TCP Clients and Servers -=item Who supports Perl? Who develops it? Why is it free? +=back -=item Which version of Perl should I use? +=item TCP Clients with IO::Socket -=item What are perl4 and perl5? +=over 4 -=item What is perl6? +=item A Simple Client -=item How stable is Perl? +C, C, C -=item Is Perl difficult to learn? +=item A Webget Client -=item How does Perl compare with other languages like Java, Python, REXX, -Scheme, or Tcl? +=item Interactive Client with IO::Socket -=item Can I do [task] in Perl? +=back -=item When shouldn't I program in Perl? +=item TCP Servers with IO::Socket -=item What's the difference between "perl" and "Perl"? +Proto, LocalPort, Listen, Reuse -=item Is it a Perl program or a Perl script? +=item UDP: Message Passing -=item What is a JAPH? +=item SysV IPC -=item Where can I get a list of Larry Wall witticisms? +=item NOTES -=item How can I convince my sysadmin/supervisor/employees to use version -5/5.005/Perl instead of some other language? +=item BUGS -=back +=item AUTHOR -=item AUTHOR AND COPYRIGHT +=item SEE ALSO =back -=head2 perlfaq2 - Obtaining and Learning about Perl ($Revision: 1.3 $, -$Date: 2001/11/09 08:06:04 $) +=head2 perlfork - Perl's fork() emulation =over 4 +=item SYNOPSIS + =item DESCRIPTION =over 4 -=item What machines support Perl? Where do I get it? +=item Behavior of other Perl features in forked pseudo-processes -=item How can I get a binary version of Perl? +$$ or $PROCESS_ID, %ENV, chdir() and all other builtins that accept +filenames, wait() and waitpid(), kill(), exec(), exit(), Open handles to +files, directories and network sockets -=item I don't have a C compiler on my system. How can I compile perl? +=item Resource limits -=item I copied the Perl binary from one machine to another, but scripts -don't work. +=item Killing the parent process -=item I grabbed the sources and tried to compile but gdbm/dynamic -loading/malloc/linking/... failed. How do I make it work? +=item Lifetime of the parent process and pseudo-processes -=item What modules and extensions are available for Perl? What is CPAN? -What does CPAN/src/... mean? +=item CAVEATS AND LIMITATIONS -=item Is there an ISO or ANSI certified version of Perl? +BEGIN blocks, Open filehandles, Forking pipe open() not yet implemented, +Global state maintained by XSUBs, Interpreter embedded in larger +application, Thread-safety of extensions -=item Where can I get information on Perl? +=back -=item What are the Perl newsgroups on Usenet? Where do I post questions? +=item BUGS -=item Where should I post source code? +=item AUTHOR -=item Perl Books +=item SEE ALSO -References, Tutorials, Task-Oriented, Special Topics +=back -=item Perl in Magazines +=head2 perlnumber - semantics of numbers and numeric operations in Perl -=item Perl on the Net: FTP and WWW Access +=over 4 -=item What mailing lists are there for Perl? +=item SYNOPSIS -=item Archives of comp.lang.perl.misc +=item DESCRIPTION -=item Where can I buy a commercial version of Perl? +=item Storing numbers -=item Where do I send bug reports? +=item Numeric operators and numeric conversions -=item What is perl.com? Perl Mongers? pm.org? perl.org? +=item Flavors of Perl numeric operations -=back +Arithmetic operators, ++, Arithmetic operators during C, Other +mathematical operators, Bitwise operators, Bitwise operators during C, Operators which expect an integer, Operators which expect a +string -=item AUTHOR AND COPYRIGHT +=item AUTHOR + +=item SEE ALSO =back -=head2 perlfaq3 - Programming Tools ($Revision: 1.9 $, $Date: 2001/11/09 -08:06:04 $) +=head2 perlthrtut - tutorial on threads in Perl =over 4 =item DESCRIPTION +=item Status + +=item What Is A Thread Anyway? + +=item Threaded Program Models + =over 4 -=item How do I do (anything)? +=item Boss/Worker -=item How can I use Perl interactively? +=item Work Crew -=item Is there a Perl shell? +=item Pipeline -=item How do I debug my Perl programs? +=back -=item How do I profile my Perl programs? +=item What kind of threads are Perl threads? -=item How do I cross-reference my Perl programs? +=item Thread-Safe Modules -=item Is there a pretty-printer (formatter) for Perl? +=item Thread Basics -=item Is there a ctags for Perl? +=over 4 -=item Is there an IDE or Windows Perl Editor? +=item Basic Thread Support -Komodo, The Object System, Open Perl IDE, PerlBuilder, visiPerl+, -CodeMagicCD, GNU Emacs, MicroEMACS, XEmacs, Elvis, Vile, Vim, Codewright, -MultiEdit, SlickEdit, Bash, Ksh, Tcsh, Zsh, BBEdit and BBEdit Lite, Alpha +=item A Note about the Examples -=item Where can I get Perl macros for vi? +=item Creating Threads -=item Where can I get perl-mode for emacs? +=item Waiting For A Thread To Exit -=item How can I use curses with Perl? +=item Ignoring A Thread -=item How can I use X or Tk with Perl? +=back -=item How can I generate simple menus without using CGI or Tk? +=item Threads And Data -=item What is undump? +=over 4 -=item How can I make my Perl program run faster? +=item Shared And Unshared Data -=item How can I make my Perl program take less memory? +=item Thread Pitfalls: Races -Don't slurp!, Use map and grep selectively, Avoid unnecessary quotes and -stringification, Pass by reference, Tie large variables to disk +=back -=item Is it unsafe to return a pointer to local data? +=item Synchronization and control -=item How can I free an array or hash so my program shrinks? +=over 4 -=item How can I make my CGI script more efficient? +=item Controlling access: lock() -=item How can I hide the source for my Perl program? +=item A Thread Pitfall: Deadlocks -=item How can I compile my Perl program into byte code or C? +=item Queues: Passing Data Around -=item How can I compile Perl into Java? +=item Semaphores: Synchronizing Data Access -=item How can I get C<#!perl> to work on [MS-DOS,NT,...]? +=item Basic semaphores -=item Can I write useful Perl programs on the command line? +=item Advanced Semaphores -=item Why don't Perl one-liners work on my DOS/Mac/VMS system? +=item cond_wait() and cond_signal() -=item Where can I learn about CGI or Web programming in Perl? +=item Giving up control -=item Where can I learn about object-oriented Perl programming? +=back -=item Where can I learn about linking C with Perl? [h2xs, xsubpp] +=item General Thread Utility Routines -=item I've read perlembed, perlguts, etc., but I can't embed perl in -my C program; what am I doing wrong? +=over 4 -=item When I tried to run my script, I got this message. What does it -mean? +=item What Thread Am I In? -=item What's MakeMaker? +=item Thread IDs -=back +=item Are These Threads The Same? -=item AUTHOR AND COPYRIGHT +=item What Threads Are Running? =back -=head2 perlfaq4 - Data Manipulation ($Revision: 1.8 $, $Date: 2001/11/09 -08:06:04 $) +=item A Complete Example -=over 4 +=item Different implementations of threads -=item DESCRIPTION +=item Performance considerations -=item Data: Numbers +=item Process-scope Changes -=over 4 +=item Thread-Safety of System Libraries -=item Why am I getting long decimals (eg, 19.9499999999999) instead of the -numbers I should be getting (eg, 19.95)? +=item Conclusion -=item Why isn't my octal data interpreted correctly? +=item Bibliography -=item Does Perl have a round() function? What about ceil() and floor()? -Trig functions? +=over 4 -=item How do I convert between numeric representations: +=item Introductory Texts -B, B, B, B, B, B +=item OS-Related References -=item Why doesn't & work the way I want it to? +=item Other References -=item How do I multiply matrices? +=back -=item How do I perform an operation on a series of integers? +=item Acknowledgements -=item How can I output Roman numerals? +=item AUTHOR -=item Why aren't my random numbers random? +=item Copyrights =back -=item Data: Dates +=head2 perlothrtut - old tutorial on threads in Perl =over 4 -=item How do I find the week-of-the-year/day-of-the-year? +=item DESCRIPTION -=item How do I find the current century or millennium? +=item What Is A Thread Anyway? -=item How can I compare two dates and find the difference? +=item Threaded Program Models -=item How can I take a string and turn it into epoch seconds? +=over 4 -=item How can I find the Julian Day? +=item Boss/Worker -=item How do I find yesterday's date? +=item Work Crew -=item Does Perl have a Year 2000 problem? Is Perl Y2K compliant? +=item Pipeline =back -=item Data: Strings +=item Native threads + +=item What kind of threads are perl threads? + +=item Threadsafe Modules + +=item Thread Basics =over 4 -=item How do I validate input? +=item Basic Thread Support -=item How do I unescape a string? +=item Creating Threads -=item How do I remove consecutive pairs of characters? +=item Giving up control -=item How do I expand function calls in a string? +=item Waiting For A Thread To Exit -=item How do I find matching/nesting anything? +=item Errors In Threads -=item How do I reverse a string? +=item Ignoring A Thread -=item How do I expand tabs in a string? +=back -=item How do I reformat a paragraph? +=item Threads And Data -=item How can I access/change the first N letters of a string? +=over 4 -=item How do I change the Nth occurrence of something? +=item Shared And Unshared Data -=item How can I count the number of occurrences of a substring within a -string? +=item Thread Pitfall: Races -=item How do I capitalize all the words on one line? +=item Controlling access: lock() -=item How can I split a [character] delimited string except when inside -[character]? (Comma-separated files) +=item Thread Pitfall: Deadlocks -=item How do I strip blank space from the beginning/end of a string? +=item Queues: Passing Data Around -=item How do I pad a string with blanks or pad a number with zeroes? +=back -=item How do I extract selected columns from a string? +=item Threads And Code -=item How do I find the soundex value of a string? +=over 4 -=item How can I expand variables in text strings? +=item Semaphores: Synchronizing Data Access -=item What's wrong with always quoting "$vars"? +Basic semaphores, Advanced Semaphores -=item Why don't my < +portable -=item How do I look up a hash element by value? +=item ISSUES -=item How can I know how many entries are in a hash? +=over 4 -=item How do I sort a hash (optionally by value instead of key)? +=item Newlines -=item How can I always keep my hash sorted? +=item Numbers endianness and Width -=item What's the difference between "delete" and "undef" with hashes? +=item Files and Filesystems -=item Why don't my tied hashes make the defined/exists distinction? +=item System Interaction -=item How do I reset an each() operation part-way through? +=item Command names versus file pathnames -=item How can I get the unique keys from two hashes? +=item Networking -=item How can I store a multidimensional array in a DBM file? +=item Interprocess Communication (IPC) -=item How can I make my hash remember the order I put elements into it? +=item External Subroutines (XS) -=item Why does passing a subroutine an undefined element in a hash create -it? +=item Standard Modules -=item How can I make the Perl equivalent of a C structure/C++ class/hash or -array of hashes or arrays? +=item Time and Date -=item How can I use a reference as a hash key? +=item Character sets and character encoding -=back +=item Internationalisation -=item Data: Misc +=item System Resources -=over 4 - -=item How do I handle binary data correctly? +=item Security -=item How do I determine whether a scalar is a number/whole/integer/float? +=item Style -=item How do I keep persistent data across program calls? +=back -=item How do I print out or copy a recursive data structure? +=item CPAN Testers -=item How do I define methods for every class/object? +Mailing list: cpan-testers@perl.org, Testing results: +http://testers.cpan.org/ -=item How do I verify a credit card checksum? +=item PLATFORMS -=item How do I pack arrays of doubles or floats for XS code? +=over 4 -=back +=item Unix -=item AUTHOR AND COPYRIGHT +=item DOS and Derivatives -=back +=item S -=head2 perlfaq5 - Files and Formats ($Revision: 1.4 $, $Date: 2001/11/09 -08:06:04 $) +=item VMS -=over 4 +=item VOS -=item DESCRIPTION +=item EBCDIC Platforms -=over 4 +=item Acorn RISC OS -=item How do I flush/unbuffer an output filehandle? Why must I do this? +=item Other perls -=item How do I change one line in a file/delete a line in a file/insert a -line in the middle of a file/append to the beginning of a file? +=back -=item How do I count the number of lines in a file? +=item FUNCTION IMPLEMENTATIONS -=item How do I make a temporary file name? +=over 4 -=item How can I manipulate fixed-record-length files? +=item Alphabetical Listing of Perl Functions -=item How can I make a filehandle local to a subroutine? How do I pass -filehandles between subroutines? How do I make an array of filehandles? +-I FILEHANDLE, -I EXPR, -I, alarm SECONDS, alarm, binmode +FILEHANDLE, chmod LIST, chown LIST, chroot FILENAME, chroot, crypt +PLAINTEXT,SALT, dbmclose HASH, dbmopen HASH,DBNAME,MODE, dump LABEL, exec +LIST, exit EXPR, exit, fcntl FILEHANDLE,FUNCTION,SCALAR, flock +FILEHANDLE,OPERATION, fork, getlogin, getpgrp PID, getppid, getpriority +WHICH,WHO, getpwnam NAME, getgrnam NAME, getnetbyname NAME, getpwuid UID, +getgrgid GID, getnetbyaddr ADDR,ADDRTYPE, getprotobynumber NUMBER, +getservbyport PORT,PROTO, getpwent, getgrent, gethostbyname, gethostent, +getnetent, getprotoent, getservent, sethostent STAYOPEN, setnetent +STAYOPEN, setprotoent STAYOPEN, setservent STAYOPEN, endpwent, endgrent, +endhostent, endnetent, endprotoent, endservent, getsockopt +SOCKET,LEVEL,OPTNAME, glob EXPR, glob, ioctl FILEHANDLE,FUNCTION,SCALAR, +kill SIGNAL, LIST, link OLDFILE,NEWFILE, lstat FILEHANDLE, lstat EXPR, +lstat, msgctl ID,CMD,ARG, msgget KEY,FLAGS, msgsnd ID,MSG,FLAGS, msgrcv +ID,VAR,SIZE,TYPE,FLAGS, open FILEHANDLE,EXPR, open FILEHANDLE, pipe +READHANDLE,WRITEHANDLE, readlink EXPR, readlink, select +RBITS,WBITS,EBITS,TIMEOUT, semctl ID,SEMNUM,CMD,ARG, semget +KEY,NSEMS,FLAGS, semop KEY,OPSTRING, setgrent, setpgrp PID,PGRP, +setpriority WHICH,WHO,PRIORITY, setpwent, setsockopt +SOCKET,LEVEL,OPTNAME,OPTVAL, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS, +shmread ID,VAR,POS,SIZE, shmwrite ID,STRING,POS,SIZE, sockatmark SOCKET, +socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, stat FILEHANDLE, stat +EXPR, stat, symlink OLDFILE,NEWFILE, syscall LIST, sysopen +FILEHANDLE,FILENAME,MODE,PERMS, system LIST, times, truncate +FILEHANDLE,LENGTH, truncate EXPR,LENGTH, umask EXPR, umask, utime LIST, +wait, waitpid PID,FLAGS -=item How can I use a filehandle indirectly? +=back -=item How can I set up a footer format to be used with write()? +=item CHANGES -=item How can I write() into a string? +v1.49, 12 August 2002, v1.48, 02 February 2001, v1.47, 22 March 2000, +v1.46, 12 February 2000, v1.45, 20 December 1999, v1.44, 19 July 1999, +v1.43, 24 May 1999, v1.42, 22 May 1999, v1.41, 19 May 1999, v1.40, 11 April +1999, v1.39, 11 February 1999, v1.38, 31 December 1998, v1.37, 19 December +1998, v1.36, 9 September 1998, v1.35, 13 August 1998, v1.33, 06 August +1998, v1.32, 05 August 1998, v1.30, 03 August 1998, v1.23, 10 July 1998 -=item How can I output my numbers with commas added? +=item Supported Platforms -=item How can I translate tildes (~) in a filename? +=item SEE ALSO -=item How come when I open a file read-write it wipes it out? +=item AUTHORS / CONTRIBUTORS -=item Why do I sometimes get an "Argument list too long" when I use <*>? +=back -=item Is there a leak/bug in glob()? +=head2 perllocale - Perl locale handling (internationalization and +localization) -=item How can I open a file with a leading ">" or trailing blanks? +=over 4 -=item How can I reliably rename a file? +=item DESCRIPTION -=item How can I lock a file? +=item PREPARING TO USE LOCALES -=item Why can't I just open(FH, ">file.lock")? +=item USING LOCALES -=item I still don't get locking. I just want to increment the number in -the file. How can I do this? +=over 4 -=item All I want to do is append a small amount of text to the end of a -file. Do I still have to use locking? +=item The use locale pragma -=item How do I randomly update a binary file? +=item The setlocale function -=item How do I get a file's timestamp in perl? +=item Finding locales -=item How do I set a file's timestamp in perl? +=item LOCALE PROBLEMS -=item How do I print to more than one file at once? +=item Temporarily fixing locale problems -=item How can I read in an entire file all at once? +=item Permanently fixing locale problems -=item How can I read in a file by paragraphs? +=item Permanently fixing your system's locale configuration -=item How can I read a single character from a file? From the keyboard? +=item Fixing system locale configuration -=item How can I tell whether there's a character waiting on a filehandle? +=item The localeconv function -=item How do I do a C in perl? +=item I18N::Langinfo -=item How do I dup() a filehandle in Perl? +=back -=item How do I close a file descriptor by number? +=item LOCALE CATEGORIES -=item Why can't I use "C:\temp\foo" in DOS paths? What doesn't -`C:\temp\foo.exe` work? +=over 4 -=item Why doesn't glob("*.*") get all the files? +=item Category LC_COLLATE: Collation -=item Why does Perl let me delete read-only files? Why does C<-i> clobber -protected files? Isn't this a bug in Perl? +=item Category LC_CTYPE: Character Types -=item How do I select a random line from a file? +=item Category LC_NUMERIC: Numeric Formatting -=item Why do I get weird spaces when I print an array of lines? +=item Category LC_MONETARY: Formatting of monetary amounts -=back +=item LC_TIME -=item AUTHOR AND COPYRIGHT +=item Other categories =back -=head2 perlfaq6 - Regexes ($Revision: 1.4 $, $Date: 2001/11/09 08:06:04 $) +=item SECURITY -=over 4 +=item ENVIRONMENT -=item DESCRIPTION +PERL_BADLANG, LC_ALL, LANGUAGE, LC_CTYPE, LC_COLLATE, LC_MONETARY, +LC_NUMERIC, LC_TIME, LANG -=over 4 +=item NOTES -=item How can I hope to use regular expressions without creating illegible -and unmaintainable code? +=over 4 -Comments Outside the Regex, Comments Inside the Regex, Different Delimiters +=item Backward compatibility -=item I'm having trouble matching over more than one line. What's wrong? +=item I18N:Collate obsolete -=item How can I pull out lines between two patterns that are themselves on -different lines? +=item Sort speed and memory use impacts -=item I put a regular expression into $/ but it didn't work. What's wrong? +=item write() and LC_NUMERIC -=item How do I substitute case insensitively on the LHS while preserving -case on the RHS? +=item Freely available locale definitions -=item How can I make C<\w> match national character sets? +=item I18n and l10n -=item How can I match a locale-smart version of C? +=item An imperfect standard -=item How can I quote a variable to use in a regex? +=back -=item What is C really for? +=item Unicode and UTF-8 -=item How do I use a regular expression to strip C style comments from a -file? +=item BUGS -=item Can I use Perl regular expressions to match balanced text? +=over 4 -=item What does it mean that regexes are greedy? How can I get around it? +=item Broken systems -=item How do I process each word on each line? +=back -=item How can I print out a word-frequency or line-frequency summary? +=item SEE ALSO -=item How can I do approximate matching? +=item HISTORY -=item How do I efficiently match many regular expressions at once? +=back -=item Why don't word-boundary searches with C<\b> work for me? +=head2 perluniintro - Perl Unicode introduction -=item Why does using $&, $`, or $' slow my program down? +=over 4 -=item What good is C<\G> in a regular expression? +=item DESCRIPTION -=item Are Perl regexes DFAs or NFAs? Are they POSIX compliant? +=over 4 -=item What's wrong with using grep or map in a void context? +=item Unicode -=item How can I match strings with multibyte characters? +=item Perl's Unicode Support -=item How do I match a pattern that is supplied by the user? +=item Perl's Unicode Model -=back +=item Unicode and EBCDIC -=item AUTHOR AND COPYRIGHT +=item Creating Unicode -=back +=item Handling Unicode -=head2 perlfaq7 - Perl Language Issues ($Revision: 1.4 $, $Date: 2001/11/07 -02:27:50 $) +=item Legacy Encodings -=over 4 +=item Unicode I/O -=item DESCRIPTION +=item Displaying Unicode As Text -=over 4 +=item Special Cases -=item Can I get a BNF/yacc/RE for the Perl language? +=item Advanced Topics -=item What are all these $@%&* punctuation signs, and how do I know when to -use them? +=item Miscellaneous -=item Do I always/never have to quote my strings or use semicolons and -commas? +=item Questions With Answers -=item How do I skip some return values? +=item Hexadecimal Notation -=item How do I temporarily block warnings? +=item Further Resources -=item What's an extension? +=back -=item Why do Perl operators have different precedence than C operators? +=item UNICODE IN OLDER PERLS -=item How do I declare/create a structure? +=item SEE ALSO -=item How do I create a module? +=item ACKNOWLEDGMENTS -=item How do I create a class? +=item AUTHOR, COPYRIGHT, AND LICENSE -=item How can I tell if a variable is tainted? +=back -=item What's a closure? +=head2 perlunicode - Unicode support in Perl -=item What is variable suicide and how can I prevent it? +=over 4 -=item How can I pass/return a {Function, FileHandle, Array, Hash, Method, -Regex}? +=item DESCRIPTION -Passing Variables and Functions, Passing Filehandles, Passing Regexes, -Passing Methods +=over 4 -=item How do I create a static variable? +=item Important Caveats -=item What's the difference between dynamic and lexical (static) scoping? -Between local() and my()? +Input and Output Layers, Regular Expressions, C still needed to +enable UTF-8/UTF-EBCDIC in scripts, C needed to upgrade +non-Latin-1 byte strings -=item How can I access a dynamic variable while a similarly named lexical -is in scope? +=item Byte and Character Semantics -=item What's the difference between deep and shallow binding? +=item Effects of Character Semantics -=item Why doesn't "my($foo) = ;" work right? +=item Scripts -=item How do I redefine a builtin function, operator, or method? +=item Blocks -=item What's the difference between calling a function as &foo and foo()? +=item User-Defined Character Properties -=item How do I create a switch or case statement? +=item Character Encodings for Input and Output -=item How can I catch accesses to undefined variables/functions/methods? +=item Unicode Regular Expression Support Level -=item Why can't a method included in this same file be found? +=item Unicode Encodings -=item How can I find out my current package? +=item Security Implications of Unicode -=item How can I comment out a large block of perl code? +=item Unicode in Perl on EBCDIC -=item How do I clear a package? +=item Locales -=item How can I use a variable as a variable name? +=item When Unicode Does Not Happen -=back +=item Forcing Unicode in Perl (Or Unforcing Unicode in Perl) -=item AUTHOR AND COPYRIGHT +=item Using Unicode in XS =back -=head2 perlfaq8 - System Interaction ($Revision: 1.4 $, $Date: 2001/11/09 -08:06:04 $) +=item BUGS =over 4 -=item DESCRIPTION +=item Interaction with Locales -=over 4 - -=item How do I find out which operating system I'm running under? - -=item How come exec() doesn't return? - -=item How do I do fancy stuff with the keyboard/screen/mouse? +=item Interaction with Extensions -Keyboard, Screen, Mouse +=item Speed -=item How do I print something out in color? +=item Porting code from perl-5.6.X -=item How do I read just one key without waiting for a return key? +=back -=item How do I check whether input is ready on the keyboard? +=item SEE ALSO -=item How do I clear the screen? +=back -=item How do I get the screen size? +=head2 perlebcdic - Considerations for running Perl on EBCDIC platforms -=item How do I ask the user for a password? +=over 4 -=item How do I read and write the serial port? +=item DESCRIPTION -lockfiles, open mode, end of line, flushing output, non-blocking input +=item COMMON CHARACTER CODE SETS -=item How do I decode encrypted password files? +=over 4 -=item How do I start a process in the background? +=item ASCII -STDIN, STDOUT, and STDERR are shared, Signals, Zombies +=item ISO 8859 -=item How do I trap control characters/signals? +=item Latin 1 (ISO 8859-1) -=item How do I modify the shadow password file on a Unix system? +=item EBCDIC -=item How do I set the time and date? +=item 13 variant characters -=item How can I sleep() or alarm() for under a second? +=item 0037 -=item How can I measure time under a second? +=item 1047 -=item How can I do an atexit() or setjmp()/longjmp()? (Exception handling) +=item POSIX-BC -=item Why doesn't my sockets program work under System V (Solaris)? What -does the error message "Protocol not supported" mean? +=item Unicode code points versus EBCDIC code points -=item How can I call my system's unique C functions from Perl? +=item Remaining Perl Unicode problems in EBCDIC -=item Where do I get the include files to do ioctl() or syscall()? +=item Unicode and UTF -=item Why do setuid perl scripts complain about kernel problems? +=item Using Encode -=item How can I open a pipe both to and from a command? +=back -=item Why can't I get the output of a command with system()? +=item SINGLE OCTET TABLES -=item How can I capture STDERR from an external command? +recipe 0, recipe 1, recipe 2, recipe 3, recipe 4, recipe 5, recipe 6 -=item Why doesn't open() return an error when a pipe open fails? +=item IDENTIFYING CHARACTER CODE SETS -=item What's wrong with using backticks in a void context? +=item CONVERSIONS -=item How can I call backticks without shell processing? +=over 4 -=item Why can't my script read from STDIN after I gave it EOF (^D on Unix, -^Z on MS-DOS)? +=item tr/// -=item How can I convert my shell script to perl? +=item iconv -=item Can I use perl to run a telnet or ftp session? +=item C RTL -=item How can I write expect in Perl? +=back -=item Is there a way to hide perl's command line from programs such as -"ps"? +=item OPERATOR DIFFERENCES -=item I {changed directory, modified my environment} in a perl script. How -come the change disappeared when I exited the script? How do I get my -changes to be visible? +=item FUNCTION DIFFERENCES -Unix +chr(), ord(), pack(), print(), printf(), sort(), sprintf(), unpack() -=item How do I close a process's filehandle without waiting for it to -complete? +=item REGULAR EXPRESSION DIFFERENCES -=item How do I fork a daemon process? +=item SOCKETS -=item How do I find out if I'm running interactively or not? +=item SORTING -=item How do I timeout a slow event? +=over 4 -=item How do I set CPU limits? +=item Ignore ASCII vs. EBCDIC sort differences. -=item How do I avoid zombies on a Unix system? +=item MONO CASE then sort data. -=item How do I use an SQL database? +=item Convert, sort data, then re convert. -=item How do I make a system() exit on control-C? +=item Perform sorting on one type of machine only. -=item How do I open a file without blocking? +=back -=item How do I install a module from CPAN? +=item TRANSFORMATION FORMATS -=item What's the difference between require and use? +=over 4 -=item How do I keep my own module/library directory? +=item URL decoding and encoding -=item How do I add the directory my program lives in to the module/library -search path? +=item uu encoding and decoding -=item How do I add a directory to my include path at runtime? +=item Quoted-Printable encoding and decoding -=item What is socket.ph and where do I get it? +=item Caesarian ciphers =back -=item AUTHOR AND COPYRIGHT - -=back +=item Hashing order and checksums -=head2 perlfaq9 - Networking ($Revision: 1.5 $, $Date: 2001/11/09 08:06:04 -$) +=item I18N AND L10N -=over 4 +=item MULTI OCTET CHARACTER SETS -=item DESCRIPTION +=item OS ISSUES =over 4 -=item What is the correct form of response from a CGI script? - -=item My CGI script runs from the command line but not the browser. (500 -Server Error) +=item OS/400 -=item How can I get better error messages from a CGI program? +PASE, IFS access -=item How do I remove HTML from a string? +=item OS/390, z/OS -=item How do I extract URLs? +chcp, dataset access, OS/390, z/OS iconv, locales -=item How do I download a file from the user's machine? How do I open a -file on another machine? +=item VM/ESA? -=item How do I make a pop-up menu in HTML? +=item POSIX-BC? -=item How do I fetch an HTML file? +=back -=item How do I automate an HTML form submission? +=item BUGS -=item How do I decode or create those %-encodings on the web? +=item SEE ALSO -=item How do I redirect to another page? +=item REFERENCES -=item How do I put a password on my web pages? +=item HISTORY -=item How do I edit my .htpasswd and .htgroup files with Perl? +=item AUTHOR -=item How do I make sure users can't enter values into a form that cause my -CGI script to do bad things? +=back -=item How do I parse a mail header? +=head2 perlsec - Perl security -=item How do I decode a CGI form? +=over 4 -=item How do I check a valid mail address? +=item DESCRIPTION -=item How do I decode a MIME/BASE64 string? +=over 4 -=item How do I return the user's mail address? +=item Laundering and Detecting Tainted Data -=item How do I send mail? +=item Switches On the "#!" Line -=item How do I use MIME to make an attachment to a mail message? +=item Taint mode and @INC -=item How do I read mail? +=item Cleaning Up Your Path -=item How do I find out my hostname/domainname/IP address? +=item Security Bugs -=item How do I fetch a news article or the active newsgroups? +=item Protecting Your Programs -=item How do I fetch/put an FTP file? +=item Unicode -=item How can I do RPC in Perl? +=item Algorithmic Complexity Attacks =back -=item AUTHOR AND COPYRIGHT +=item SEE ALSO =back -=head2 perlcompile - Introduction to the Perl Compiler-Translator +=head2 perlmod - Perl modules (packages and symbol tables) =over 4 @@ -3492,240 +3560,304 @@ CGI script to do bad things? =over 4 -=item Layout +=item Packages -B::Bytecode, B::C, B::CC, B::Lint, B::Deparse, B::Xref +=item Symbol Tables -=back +=item BEGIN, CHECK, INIT and END -=item Using The Back Ends +=item Perl Classes -=over 4 +=item Perl Modules -=item The Cross Referencing Back End +=item Making your module threadsafe -i, &, s, r +=back -=item The Decompiling Back End +=item SEE ALSO -=item The Lint Back End +=back -=item The Simple C Back End +=head2 perlmodlib - constructing new Perl modules and finding existing ones -=item The Bytecode Back End +=over 4 -=item The Optimized C Back End +=item THE PERL MODULE LIBRARY -B, O, B::Asmdata, B::Assembler, B::Bblock, B::Bytecode, B::C, B::CC, -B::Debug, B::Deparse, B::Disassembler, B::Lint, B::Showlex, B::Stackobj, -B::Stash, B::Terse, B::Xref +=over 4 -=back +=item Pragmatic Modules -=item KNOWN PROBLEMS +assertions, assertions::activate, attributes, attrs, autouse, base, bigint, +bignum, bigrat, blib, bytes, charnames, constant, diagnostics, encoding, +fields, filetest, if, integer, less, lib, locale, open, ops, overload, re, +sigtrap, sort, strict, subs, threads, threads::shared, utf8, vars, version, +vmsish, warnings, warnings::register -=item AUTHOR +=item Standard Modules + +AnyDBM_File, Attribute::Handlers, AutoLoader, AutoSplit, B, B::Asmdata, +B::Assembler, B::Bblock, B::Bytecode, B::C, B::CC, B::Concise, B::Debug, +B::Deparse, B::Disassembler, B::Lint, B::Showlex, B::Stackobj, B::Stash, +B::Terse, B::Xref, Benchmark, ByteLoader, CGI, CGI::Apache, CGI::Carp, +CGI::Cookie, CGI::Fast, CGI::Pretty, CGI::Push, CGI::Switch, CGI::Util, +CPAN, CPAN::FirstTime, CPAN::Nox, Carp, Carp::Heavy, Class::ISA, +Class::Struct, Config, Cwd, DB, DB_File, Data::Dumper, Devel::DProf, +Devel::PPPort, Devel::Peek, Devel::SelfStubber, Digest, Digest::MD5, +Digest::base, DirHandle, Dumpvalue, DynaLoader, Encode, Encode::Alias, +Encode::Byte, Encode::CJKConstants, Encode::CN, Encode::CN::HZ, +Encode::Config, Encode::EBCDIC, Encode::Encoder, Encode::Encoding, +Encode::Guess, Encode::JP, Encode::JP::H2Z, Encode::JP::JIS7, Encode::KR, +Encode::KR::2022_KR, Encode::MIME::Header, Encode::PerlIO, +Encode::Supported, Encode::Symbol, Encode::TW, Encode::Unicode, +Encode::Unicode::UTF7, English, Env, Errno, Exporter, Exporter::Heavy, +ExtUtils::Command, ExtUtils::Command::MM, ExtUtils::Constant, +ExtUtils::Embed, ExtUtils::Install, ExtUtils::Installed, ExtUtils::Liblist, +ExtUtils::MM, ExtUtils::MM_Any, ExtUtils::MM_BeOS, ExtUtils::MM_Cygwin, +ExtUtils::MM_DOS, ExtUtils::MM_MacOS, ExtUtils::MM_NW5, ExtUtils::MM_OS2, +ExtUtils::MM_UWIN, ExtUtils::MM_Unix, ExtUtils::MM_VMS, ExtUtils::MM_Win32, +ExtUtils::MM_Win95, ExtUtils::MY, ExtUtils::MakeMaker, +ExtUtils::MakeMaker::FAQ, ExtUtils::MakeMaker::Tutorial, +ExtUtils::MakeMaker::bytes, ExtUtils::MakeMaker::vmsish, +ExtUtils::Manifest, ExtUtils::Mkbootstrap, ExtUtils::Mksymlists, +ExtUtils::Packlist, ExtUtils::testlib, Fatal, Fcntl, File::Basename, +File::CheckTree, File::Compare, File::Copy, File::DosGlob, File::Find, +File::Glob, File::Path, File::Spec, File::Spec::Cygwin, File::Spec::Epoc, +File::Spec::Functions, File::Spec::Mac, File::Spec::OS2, File::Spec::Unix, +File::Spec::VMS, File::Spec::Win32, File::Temp, File::stat, FileCache, +FileHandle, Filter::Simple, Filter::Util::Call, FindBin, GDBM_File, +Getopt::Long, Getopt::Std, Hash::Util, I18N::Collate, I18N::LangTags, +I18N::LangTags::List, I18N::Langinfo, IO, IO::Dir, IO::File, IO::Handle, +IO::Pipe, IO::Poll, IO::Seekable, IO::Select, IO::Socket, IO::Socket::INET, +IO::Socket::UNIX, IPC::Open2, IPC::Open3, IPC::SysV, IPC::SysV::Msg, +IPC::SysV::Semaphore, List::Util, Locale::Constants, Locale::Country, +Locale::Currency, Locale::Language, Locale::Maketext, +Locale::Maketext::TPJ13, Locale::Script, MIME::Base64, +MIME::Base64::QuotedPrint, Math::BigFloat, Math::BigInt, +Math::BigInt::Calc, Math::BigRat, Math::Complex, Math::Trig, Memoize, +Memoize::AnyDBM_File, Memoize::Expire, Memoize::ExpireFile, +Memoize::ExpireTest, Memoize::NDBM_File, Memoize::SDBM_File, +Memoize::Storable, NDBM_File, NEXT, Net::Cmd, Net::Config, Net::Domain, +Net::FTP, Net::NNTP, Net::Netrc, Net::POP3, Net::Ping, Net::SMTP, +Net::Time, Net::hostent, Net::libnetFAQ, Net::netent, Net::protoent, +Net::servent, O, ODBM_File, Opcode, POSIX, PerlIO, PerlIO::encoding, +PerlIO::scalar, PerlIO::via, PerlIO::via::QuotedPrint, Pod::Checker, +Pod::Find, Pod::Functions, Pod::Html, Pod::InputObjects, Pod::LaTeX, +Pod::Man, Pod::ParseLink, Pod::ParseUtils, Pod::Parser, +Pod::Perldoc::ToChecker, Pod::Perldoc::ToMan, Pod::Perldoc::ToNroff, +Pod::Perldoc::ToPod, Pod::Perldoc::ToRtf, Pod::Perldoc::ToText, +Pod::Perldoc::ToTk, Pod::Perldoc::ToXml, Pod::PlainText, Pod::Plainer, +Pod::Select, Pod::Text, Pod::Text::Color, Pod::Text::Overstrike, +Pod::Text::Termcap, Pod::Usage, SDBM_File, Safe, Scalar::Util, +Search::Dict, SelectSaver, SelfLoader, Shell, Socket, Storable, Switch, +Symbol, Sys::Hostname, Sys::Syslog, Term::ANSIColor, Term::Cap, +Term::Complete, Term::ReadLine, Test, Test::Builder, Test::Harness, +Test::Harness::Assert, Test::Harness::Iterator, Test::Harness::Straps, +Test::More, Test::Simple, Test::Tutorial, Text::Abbrev, Text::Balanced, +Text::ParseWords, Text::Soundex, Text::Tabs, Text::Wrap, Thread, +Thread::Queue, Thread::Semaphore, Thread::Signal, Thread::Specific, +Tie::Array, Tie::File, Tie::Handle, Tie::Hash, Tie::Memoize, Tie::RefHash, +Tie::Scalar, Tie::SubstrHash, Time::HiRes, Time::Local, Time::gmtime, +Time::localtime, Time::tm, UNIVERSAL, Unicode::Collate, Unicode::Normalize, +Unicode::UCD, User::grent, User::pwent, Win32, XS::APItest, XS::Typemap, +XSLoader + +=item Extension Modules =back -=head2 perlembed - how to embed perl in your C program +=item CPAN =over 4 -=item DESCRIPTION +=item Africa -=over 4 +South Africa -=item PREAMBLE +=item Asia -B, B, B, B, B +China, Indonesia, Israel, Japan, Malaysia, Russian Federation, Saudi +Arabia, Singapore, South Korea, Taiwan, Thailand -=item ROADMAP +=item Central America -=item Compiling your C program +Costa Rica -=item Adding a Perl interpreter to your C program +=item Europe -=item Calling a Perl subroutine from your C program +Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Czech +Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, +Iceland, Ireland, Italy, Latvia, Lithuania, Netherlands, Norway, Poland, +Portugal, Romania, Russia, Slovakia, Slovenia, Spain, Sweden, Switzerland, +Turkey, Ukraine, United Kingdom -=item Evaluating a Perl statement from your C program +=item North America -=item Performing Perl pattern matches and substitutions from your C program +Canada, Alberta, Manitoba, Nova Scotia, Ontario, Mexico, United States, +Alabama, California, Colorado, Delaware, District of Columbia, Florida, +Indiana, Kentucky, Massachusetts, Michigan, Nevada, New Jersey, New York, +North Carolina, Oklahoma, Oregon, Pennsylvania, Tennessee, Texas, Utah, +Virginia, Washington, Wisconsin -=item Fiddling with the Perl stack from your C program +=item Oceania -=item Maintaining a persistent interpreter +Australia, New Zealand, United States -=item Execution of END blocks +=item South America -=item Maintaining multiple interpreter instances +Argentina, Brazil, Chile -=item Using Perl modules, which themselves use C libraries, from your C -program +=item RSYNC Mirrors =back -=item Embedding Perl under Win32 +=item Modules: Creation, Use, and Abuse -=item MORAL +=over 4 -=item AUTHOR +=item Guidelines for Module Creation -=item COPYRIGHT +=item Guidelines for Converting Perl 4 Library Scripts into Modules + +=item Guidelines for Reusing Application Code =back -=head2 perldebguts - Guts of Perl debugging +=item NOTE -=over 4 - -=item DESCRIPTION +=back -=item Debugger Internals +=head2 perlmodstyle - Perl module style guide =over 4 -=item Writing Your Own Debugger - -=back - -=item Frame Listing Output Examples +=item INTRODUCTION -=item Debugging regular expressions +=item QUICK CHECKLIST =over 4 -=item Compile-time output +=item Before you start -C I C I, C I C -I, C, C, C -I, C, C, C, C, C, C, -C +=item The API -=item Types of nodes +=item Stability -=item Run-time output +=item Documentation + +=item Release considerations =back -=item Debugging Perl memory usage +=item BEFORE YOU START WRITING A MODULE =over 4 -=item Using C<$ENV{PERL_DEBUG_MSTATS}> - -C, Free/Used, C, C, C, C, C - -=item Example of using B<-DL> switch - -C<717>, C<002>, C<054>, C<602>, C<702>, C<704> - -=item B<-DL> details - -C, C, C - -=item Limitations of B<-DL> statistics +=item Has it been done before? -=back +=item Do one thing and do it well -=item SEE ALSO +=item What's in a name? =back -=head2 perlxstut, perlXStut - Tutorial for writing XSUBs +=item DESIGNING AND WRITING YOUR MODULE =over 4 -=item DESCRIPTION +=item To OO or not to OO? -=item SPECIAL NOTES +=item Designing your API -=over 4 +Write simple routines to do simple things, Separate functionality from +output, Provide sensible shortcuts and defaults, Naming conventions, +Parameter passing -=item make +=item Strictness and warnings -=item Version caveat +=item Backwards compatibility -=item Dynamic Loading versus Static Loading +=item Error handling and messages =back -=item TUTORIAL +=item DOCUMENTING YOUR MODULE =over 4 -=item EXAMPLE 1 +=item POD -=item EXAMPLE 2 +=item README, INSTALL, release notes, changelogs -=item What has gone on? +perl Makefile.PL, make, make test, make install, perl Build.PL, perl Build, +perl Build test, perl Build install -=item Writing good test scripts +=back -=item EXAMPLE 3 +=item RELEASE CONSIDERATIONS -=item What's new here? +=over 4 -=item Input and Output Parameters +=item Version numbering -=item The XSUBPP Program +=item Pre-requisites -=item The TYPEMAP file +=item Testing -=item Warning about Output Arguments +=item Packaging -=item EXAMPLE 4 +=item Licensing -=item What has happened here? +=back -=item Anatomy of .xs file +=item COMMON PITFALLS -=item Getting the fat out of XSUBs +=over 4 -=item More about XSUB arguments +=item Reinventing the wheel -=item The Argument Stack +=item Trying to do too much -=item Extending your Extension +=item Inappropriate documentation -=item Documenting your Extension +=back -=item Installing your Extension +=item SEE ALSO -=item EXAMPLE 5 +L, L, L, L, Packaging Tools, +Testing tools, http://pause.perl.org/, Any good book on software +engineering -=item New Things in this Example +=item AUTHOR -=item EXAMPLE 6 +=back -=item New Things in this Example +=head2 perlmodinstall - Installing CPAN Modules -=item EXAMPLE 7 (Coming Soon) +=over 4 -=item EXAMPLE 8 (Coming Soon) +=item DESCRIPTION -=item EXAMPLE 9 (Coming Soon) +=over 4 -=item Troubleshooting these Examples +=item PREAMBLE -=back +B the file, B the file into a directory, B the +module (sometimes unnecessary), B the module -=item See also +=back -=item Author +=item PORTABILITY -=over 4 +=item HEY -=item Last Changed +=item AUTHOR -=back +=item COPYRIGHT =back -=head2 perlxs - XS language reference manual +=head2 perlnewmod - preparing a new module for distribution =over 4 @@ -3733,1018 +3865,1062 @@ C, C, C =over 4 -=item Introduction +=item Warning -=item On The Road +=item What should I make into a module? -=item The Anatomy of an XSUB +=item Step-by-step: Preparing the ground -=item The Argument Stack +Look around, Check it's new, Discuss the need, Choose a name, Check again -=item The RETVAL Variable +=item Step-by-step: Making the module -=item The MODULE Keyword +Start with F, Use L and L, Use +L, Use L - wisely!, Use L, Write tests, Write the README -=item The PACKAGE Keyword +=item Step-by-step: Distributing your module -=item The PREFIX Keyword +Get a CPAN user ID, C, Upload the +tarball, Announce to the modules list, Announce to clpa, Fix bugs! -=item The OUTPUT: Keyword +=back -=item The NO_OUTPUT Keyword +=item AUTHOR -=item The CODE: Keyword +=item SEE ALSO -=item The INIT: Keyword +=back -=item The NO_INIT Keyword +=head2 perlutil - utilities packaged with the Perl distribution -=item Initializing Function Parameters +=over 4 -=item Default Parameter Values +=item DESCRIPTION -=item The PREINIT: Keyword +=over 4 -=item The SCOPE: Keyword +=item DOCUMENTATION -=item The INPUT: Keyword +L, L and L, +L and L, L, +L, L, L, +L -=item The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords +=item CONVERTORS -=item Variable-length Parameter Lists +L, L, L -=item The C_ARGS: Keyword +=item Administration -=item The PPCODE: Keyword +L -=item Returning Undef And Empty Lists +=item Development -=item The REQUIRE: Keyword +L, L, L and L, +L, L, L -=item The CLEANUP: Keyword +=item SEE ALSO -=item The POSTCALL: Keyword +=back -=item The BOOT: Keyword +=back -=item The VERSIONCHECK: Keyword +=head2 perlcompile - Introduction to the Perl Compiler-Translator -=item The PROTOTYPES: Keyword +=over 4 -=item The PROTOTYPE: Keyword +=item DESCRIPTION -=item The ALIAS: Keyword +=over 4 -=item The INTERFACE: Keyword +=item Layout -=item The INTERFACE_MACRO: Keyword +B::Bytecode, B::C, B::CC, B::Lint, B::Deparse, B::Xref -=item The INCLUDE: Keyword +=back -=item The CASE: Keyword +=item Using The Back Ends -=item The & Unary Operator +=over 4 -=item Inserting POD, Comments and C Preprocessor Directives +=item The Cross Referencing Back End -=item Using XS With C++ +i, &, s, r -=item Interface Strategy +=item The Decompiling Back End -=item Perl Objects And C Structures +=item The Lint Back End -=item The Typemap +=item The Simple C Back End + +=item The Bytecode Back End + +=item The Optimized C Back End =back -=item EXAMPLES +=item Module List for the Compiler Suite -=item XS VERSION +B, O, B::Asmdata, B::Assembler, B::Bblock, B::Bytecode, B::C, B::CC, +B::Concise, B::Debug, B::Deparse, B::Disassembler, B::Lint, B::Showlex, +B::Stackobj, B::Stash, B::Terse, B::Xref + +=item KNOWN PROBLEMS =item AUTHOR =back -=head2 perlclib - Internal replacements for standard C library functions +=head2 perlfilter - Source Filters =over 4 =item DESCRIPTION -=over 4 +=item CONCEPTS -=item Conventions +=item USING FILTERS -C, C

, C, C +=item WRITING A SOURCE FILTER -=item File Operations +=item WRITING A SOURCE FILTER IN C -=item File Input and Output +B -=item File Positioning +=item CREATING A SOURCE FILTER AS A SEPARATE EXECUTABLE -=item Memory Management and String Handling +=item WRITING A SOURCE FILTER IN PERL -=item Character Class Tests +=item USING CONTEXT: THE DEBUG FILTER -=item F functions +=item CONCLUSION -=item Miscellaneous functions +=item THINGS TO LOOK OUT FOR -=back +Some Filters Clobber the C Handle -=item SEE ALSO +=item REQUIREMENTS -=back +=item AUTHOR -=head2 perlguts - Introduction to the Perl API - -=over 4 +=item Copyrights -=item DESCRIPTION +=back -=item Variables +=head2 perlembed - how to embed perl in your C program =over 4 -=item Datatypes +=item DESCRIPTION -=item What is an "IV"? +=over 4 -=item Working with SVs +=item PREAMBLE -=item Offsets +B, B, B, B, B -=item What's Really Stored in an SV? +=item ROADMAP -=item Working with AVs +=item Compiling your C program -=item Working with HVs +=item Adding a Perl interpreter to your C program -=item Hash API Extensions +=item Calling a Perl subroutine from your C program -=item References +=item Evaluating a Perl statement from your C program -=item Blessed References and Class Objects +=item Performing Perl pattern matches and substitutions from your C program -=item Creating New Variables +=item Fiddling with the Perl stack from your C program -=item Reference Counts and Mortality +=item Maintaining a persistent interpreter -=item Stashes and Globs +=item Execution of END blocks -=item Double-Typed SVs +=item Maintaining multiple interpreter instances -=item Magic Variables +=item Using Perl modules, which themselves use C libraries, from your C +program -=item Assigning Magic +=back -=item Magic Virtual Tables +=item Embedding Perl under Win32 -=item Finding Magic +=item Hiding Perl_ -=item Understanding the Magic of Tied Hashes and Arrays +=item MORAL -=item Localizing changes +=item AUTHOR -C, C, C, C, -C, C, C, C, C, C, C, -C, -C, -C, C, C, C, C, -C, C, -C, C, C +=item COPYRIGHT =back -=item Subroutines +=head2 perldebguts - Guts of Perl debugging =over 4 -=item XSUBs and the Argument Stack - -=item Calling Perl Routines from within C Programs - -=item Memory Allocation - -=item PerlIO +=item DESCRIPTION -=item Putting a C value on Perl stack +=item Debugger Internals -=item Scratchpads +=over 4 -=item Scratchpads and recursion +=item Writing Your Own Debugger =back -=item Compiled code +=item Frame Listing Output Examples + +=item Debugging regular expressions =over 4 -=item Code tree +=item Compile-time output -=item Examining the tree +C I C I, C I C +I, C, C, C +I, C, C, C, C, C, C, +C -=item Compile pass 1: check routines +=item Types of nodes -=item Compile pass 1a: constant folding +=item Run-time output -=item Compile pass 2: context propagation +=back -=item Compile pass 3: peephole optimization +=item Debugging Perl memory usage -=item Pluggable runops +=over 4 -=back +=item Using C<$ENV{PERL_DEBUG_MSTATS}> -=item Examining internal data structures with the C functions +C, Free/Used, C, C, C, C, C -=item How multiple interpreters and concurrency are supported +=item Example of using B<-DL> switch -=over 4 +C<717>, C<002>, C<054>, C<602>, C<702>, C<704> -=item Background and PERL_IMPLICIT_CONTEXT +=item B<-DL> details -=item So what happened to dTHR? +C, C, C -=item How do I use all this in extensions? +=item Limitations of B<-DL> statistics -=item Should I do anything special if I call perl from multiple threads? +=back -=item Future Plans and PERL_IMPLICIT_SYS +=item SEE ALSO =back -=item Internal Functions +=head2 perlxstut, perlXStut - Tutorial for writing XSUBs + +=over 4 + +=item DESCRIPTION -A, p, d, s, n, r, f, M, o, j, x +=item SPECIAL NOTES =over 4 -=item Formatted Printing of IVs, UVs, and NVs +=item make -=item Pointer-To-Integer and Integer-To-Pointer +=item Version caveat -=item Source Documentation +=item Dynamic Loading versus Static Loading =back -=item Unicode Support +=item TUTORIAL =over 4 -=item What B Unicode, anyway? +=item EXAMPLE 1 -=item How can I recognise a UTF8 string? +=item EXAMPLE 2 -=item How does UTF8 represent Unicode characters? +=item What has gone on? -=item How does Perl store UTF8 strings? +=item Writing good test scripts -=item How do I convert a string to UTF8? +=item EXAMPLE 3 -=item Is there anything else I need to know? +=item What's new here? -=back +=item Input and Output Parameters -=item Custom Operators +=item The XSUBPP Program -=item AUTHORS +=item The TYPEMAP file -=item SEE ALSO +=item Warning about Output Arguments -=back +=item EXAMPLE 4 -=head2 perlcall - Perl calling conventions from C +=item What has happened here? -=over 4 +=item Anatomy of .xs file -=item DESCRIPTION +=item Getting the fat out of XSUBs -An Error Handler, An Event Driven Program +=item More about XSUB arguments -=item THE CALL_ FUNCTIONS +=item The Argument Stack -call_sv, call_pv, call_method, call_argv +=item Extending your Extension -=item FLAG VALUES +=item Documenting your Extension -=over 4 +=item Installing your Extension -=item G_VOID +=item EXAMPLE 5 -=item G_SCALAR +=item New Things in this Example -=item G_ARRAY +=item EXAMPLE 6 -=item G_DISCARD +=item New Things in this Example -=item G_NOARGS +=item EXAMPLE 7 (Coming Soon) -=item G_EVAL +=item EXAMPLE 8 (Coming Soon) -=item G_KEEPERR +=item EXAMPLE 9 Passing open files to XSes -=item Determining the Context +=item Troubleshooting these Examples =back -=item KNOWN PROBLEMS +=item See also -=item EXAMPLES +=item Author =over 4 -=item No Parameters, Nothing returned +=item Last Changed -=item Passing Parameters +=back -=item Returning a Scalar +=back -=item Returning a list of values +=head2 perlxs - XS language reference manual -=item Returning a list in a scalar context +=over 4 -=item Returning Data from Perl via the parameter list +=item DESCRIPTION -=item Using G_EVAL +=over 4 -=item Using G_KEEPERR +=item Introduction -=item Using call_sv +=item On The Road -=item Using call_argv +=item The Anatomy of an XSUB -=item Using call_method +=item The Argument Stack -=item Using GIMME_V +=item The RETVAL Variable -=item Using Perl to dispose of temporaries +=item The MODULE Keyword -=item Strategies for storing Callback Context Information +=item The PACKAGE Keyword -1. Ignore the problem - Allow only 1 callback, 2. Create a sequence of -callbacks - hard wired limit, 3. Use a parameter to map to the Perl -callback +=item The PREFIX Keyword -=item Alternate Stack Manipulation +=item The OUTPUT: Keyword -=item Creating and calling an anonymous subroutine in C +=item The NO_OUTPUT Keyword -=back +=item The CODE: Keyword -=item SEE ALSO +=item The INIT: Keyword -=item AUTHOR +=item The NO_INIT Keyword -=item DATE +=item Initializing Function Parameters -=back +=item Default Parameter Values -=head2 perlutil - utilities packaged with the Perl distribution +=item The PREINIT: Keyword -=over 4 +=item The SCOPE: Keyword -=item DESCRIPTION +=item The INPUT: Keyword -=over 4 +=item The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords -=item DOCUMENTATION +=item The C Keyword -L, L and L, -L and L, L, -L, L, L, -L +=item Variable-length Parameter Lists -=item CONVERTORS +=item The C_ARGS: Keyword -L, L, L +=item The PPCODE: Keyword -=item Administration +=item Returning Undef And Empty Lists -L +=item The REQUIRE: Keyword -=item Development +=item The CLEANUP: Keyword -L, L, L and L, -L, L, L +=item The POSTCALL: Keyword -=item SEE ALSO +=item The BOOT: Keyword -=back +=item The VERSIONCHECK: Keyword -=back +=item The PROTOTYPES: Keyword -=head2 perlfilter - Source Filters +=item The PROTOTYPE: Keyword -=over 4 +=item The ALIAS: Keyword -=item DESCRIPTION +=item The OVERLOAD: Keyword -=item CONCEPTS +=item The FALLBACK: Keyword -=item USING FILTERS +=item The INTERFACE: Keyword -=item WRITING A SOURCE FILTER +=item The INTERFACE_MACRO: Keyword -=item WRITING A SOURCE FILTER IN C +=item The INCLUDE: Keyword -B +=item The CASE: Keyword -=item CREATING A SOURCE FILTER AS A SEPARATE EXECUTABLE +=item The & Unary Operator -=item WRITING A SOURCE FILTER IN PERL +=item Inserting POD, Comments and C Preprocessor Directives -=item USING CONTEXT: THE DEBUG FILTER +=item Using XS With C++ -=item CONCLUSION +=item Interface Strategy -=item REQUIREMENTS +=item Perl Objects And C Structures -=item AUTHOR +=item The Typemap -=item Copyrights +=item Safely Storing Static Data in XS + +MY_CXT_KEY, typedef my_cxt_t, START_MY_CXT, MY_CXT_INIT, dMY_CXT, MY_CXT =back -=head2 perldbmfilter - Perl DBM Filters +=item EXAMPLES -=over 4 +=item XS VERSION -=item SYNOPSIS +=item AUTHOR -=item DESCRIPTION +=back -B, B, B, -B +=head2 perlclib - Internal replacements for standard C library functions =over 4 -=item The Filter +=item DESCRIPTION -=item An Example -- the NULL termination problem. +=over 4 -=item Another Example -- Key is a C int. +=item Conventions -=back +C, C

, C, C -=item SEE ALSO +=item File Operations -=item AUTHOR +=item File Input and Output -=back +=item File Positioning -=head2 perlapi - autogenerated documentation for the perl public API +=item Memory Management and String Handling -=over 4 +=item Character Class Tests -=item DESCRIPTION +=item F functions -AvFILL, av_clear, av_delete, av_exists, av_extend, av_fetch, av_fill, -av_len, av_make, av_pop, av_push, av_shift, av_store, av_undef, av_unshift, -ax, bytes_from_utf8, bytes_to_utf8, call_argv, call_method, call_pv, -call_sv, CLASS, Copy, croak, CvSTASH, cv_const_sv, dAX, dITEMS, dMARK, -dORIGMARK, dSP, dXSARGS, dXSI32, ENTER, eval_pv, eval_sv, EXTEND, -fbm_compile, fbm_instr, FREETMPS, getcwd_sv, get_av, get_cv, get_hv, -get_sv, GIMME, GIMME_V, grok_bin, grok_hex, grok_number, -grok_numeric_radix, grok_oct, GvSV, gv_fetchmeth, gv_fetchmethod, -gv_fetchmethod_autoload, gv_stashpv, gv_stashsv, G_ARRAY, G_DISCARD, -G_EVAL, G_NOARGS, G_SCALAR, G_VOID, HEf_SVKEY, HeHASH, HeKEY, HeKLEN, HePV, -HeSVKEY, HeSVKEY_force, HeSVKEY_set, HeVAL, HvNAME, hv_clear, hv_delete, -hv_delete_ent, hv_exists, hv_exists_ent, hv_fetch, hv_fetch_ent, -hv_iterinit, hv_iterkey, hv_iterkeysv, hv_iternext, hv_iternextsv, -hv_iterval, hv_magic, hv_store, hv_store_ent, hv_undef, isALNUM, isALPHA, -isDIGIT, isLOWER, isSPACE, isUPPER, is_utf8_char, is_utf8_string, items, -ix, LEAVE, load_module, looks_like_number, MARK, mg_clear, mg_copy, -mg_find, mg_free, mg_get, mg_length, mg_magical, mg_set, Move, New, newAV, -Newc, newCONSTSUB, newHV, newRV_inc, newRV_noinc, NEWSV, newSV, newSViv, -newSVnv, newSVpv, newSVpvf, newSVpvn, newSVpvn_share, newSVrv, newSVsv, -newSVuv, newXS, newXSproto, Newz, Nullav, Nullch, Nullcv, Nullhv, Nullsv, -ORIGMARK, perl_alloc, perl_clone, perl_construct, perl_destruct, perl_free, -perl_parse, perl_run, PL_modglobal, PL_na, PL_sv_no, PL_sv_undef, -PL_sv_yes, POPi, POPl, POPn, POPp, POPpbytex, POPpx, POPs, PUSHi, PUSHMARK, -PUSHn, PUSHp, PUSHs, PUSHu, PUTBACK, Renew, Renewc, require_pv, RETVAL, -Safefree, savepv, savepvn, SAVETMPS, scan_bin, scan_hex, scan_oct, -sharedsv_find, sharedsv_init, sharedsv_lock, sharedsv_new, -sharedsv_thrcnt_dec, sharedsv_thrcnt_inc, sharedsv_unlock, sortsv, SP, -SPAGAIN, ST, strEQ, strGE, strGT, strLE, strLT, strNE, strnEQ, strnNE, -StructCopy, SvCUR, SvCUR_set, SvEND, SvGETMAGIC, SvGROW, SvIOK, SvIOKp, -SvIOK_notUV, SvIOK_off, SvIOK_on, SvIOK_only, SvIOK_only_UV, SvIOK_UV, -SvIV, SvIVx, SvIVX, SvLEN, SvNIOK, SvNIOKp, SvNIOK_off, SvNOK, SvNOKp, -SvNOK_off, SvNOK_on, SvNOK_only, SvNV, SvNVX, SvNVx, SvOK, SvOOK, SvPOK, -SvPOKp, SvPOK_off, SvPOK_on, SvPOK_only, SvPOK_only_UTF8, SvPV, SvPVbyte, -SvPVbytex, SvPVbytex_force, SvPVbyte_force, SvPVbyte_nolen, SvPVutf8, -SvPVutf8x, SvPVutf8x_force, SvPVutf8_force, SvPVutf8_nolen, SvPVX, SvPVx, -SvPV_force, SvPV_force_nomg, SvPV_nolen, SvREFCNT, SvREFCNT_dec, -SvREFCNT_inc, SvROK, SvROK_off, SvROK_on, SvRV, SvSETMAGIC, SvSetMagicSV, -SvSetMagicSV_nosteal, SvSetSV, SvSetSV_nosteal, SvSTASH, SvTAINT, -SvTAINTED, SvTAINTED_off, SvTAINTED_on, SvTRUE, svtype, SvTYPE, SVt_IV, -SVt_NV, SVt_PV, SVt_PVAV, SVt_PVCV, SVt_PVHV, SVt_PVMG, SvUOK, SvUPGRADE, -SvUTF8, SvUTF8_off, SvUTF8_on, SvUV, SvUVx, SvUVX, sv_2bool, sv_2cv, -sv_2io, sv_2iv, sv_2mortal, sv_2nv, sv_2pvbyte, sv_2pvbyte_nolen, -sv_2pvutf8, sv_2pvutf8_nolen, sv_2pv_flags, sv_2pv_nolen, sv_2uv, -sv_backoff, sv_bless, sv_catpv, sv_catpvf, sv_catpvf_mg, sv_catpvn, -sv_catpvn_flags, sv_catpvn_mg, sv_catpv_mg, sv_catsv, sv_catsv_flags, -sv_catsv_mg, sv_chop, sv_clear, sv_cmp, sv_cmp_locale, sv_collxfrm, sv_dec, -sv_derived_from, sv_eq, sv_force_normal, sv_force_normal_flags, sv_free, -sv_gets, sv_grow, sv_inc, sv_insert, sv_isa, sv_isobject, sv_iv, sv_len, -sv_len_utf8, sv_magic, sv_mortalcopy, sv_newmortal, sv_newref, sv_nv, -sv_pos_b2u, sv_pos_u2b, sv_pv, sv_pvbyte, sv_pvbyten, sv_pvbyten_force, -sv_pvn, sv_pvn_force, sv_pvn_force_flags, sv_pvutf8, sv_pvutf8n, -sv_pvutf8n_force, sv_recode_to_utf8, sv_reftype, sv_replace, -sv_report_used, sv_reset, sv_rvweaken, sv_setiv, sv_setiv_mg, sv_setnv, -sv_setnv_mg, sv_setpv, sv_setpvf, sv_setpvf_mg, sv_setpviv, sv_setpviv_mg, -sv_setpvn, sv_setpvn_mg, sv_setpv_mg, sv_setref_iv, sv_setref_nv, -sv_setref_pv, sv_setref_pvn, sv_setref_uv, sv_setsv, sv_setsv_flags, -sv_setsv_mg, sv_setuv, sv_setuv_mg, sv_taint, sv_tainted, sv_true, -sv_unmagic, sv_unref, sv_unref_flags, sv_untaint, sv_upgrade, sv_usepvn, -sv_usepvn_mg, sv_utf8_decode, sv_utf8_downgrade, sv_utf8_encode, -sv_utf8_upgrade, sv_utf8_upgrade_flags, sv_uv, sv_vcatpvfn, sv_vsetpvfn, -THIS, toLOWER, toUPPER, to_utf8_case, utf8n_to_uvchr, utf8n_to_uvuni, -utf8_distance, utf8_hop, utf8_length, utf8_to_bytes, utf8_to_uvchr, -utf8_to_uvuni, uvchr_to_utf8, uvuni_to_utf8, warn, XPUSHi, XPUSHn, XPUSHp, -XPUSHs, XPUSHu, XS, XSRETURN, XSRETURN_EMPTY, XSRETURN_IV, XSRETURN_NO, -XSRETURN_NV, XSRETURN_PV, XSRETURN_UNDEF, XSRETURN_YES, XST_mIV, XST_mNO, -XST_mNV, XST_mPV, XST_mUNDEF, XST_mYES, XS_VERSION, XS_VERSION_BOOTCHECK, -Zero +=item Miscellaneous functions -=item AUTHORS +=back =item SEE ALSO =back -=head2 perlintern - autogenerated documentation of purely B - Perl functions +=head2 perlguts - Introduction to the Perl API =over 4 =item DESCRIPTION -djSP, is_gv_magical, LVRET, PL_DBsingle, PL_DBsub, PL_DBtrace, PL_dowarn, -PL_last_in_gv, PL_ofs_sv, PL_rs, report_uninit, start_glob, sv_add_arena, -sv_clean_all, sv_clean_objs, sv_free_arenas - -=item AUTHORS - -=item SEE ALSO - -=back - -=head2 perliol - C API for Perl's implementation of IO in Layers. +=item Variables =over 4 -=item SYNOPSIS +=item Datatypes -=item DESCRIPTION +=item What is an "IV"? -=over 4 +=item Working with SVs -=item History and Background +=item Offsets -=item Layers vs Disciplines +=item What's Really Stored in an SV? -=item Data Structures +=item Working with AVs -1. The functions and attributes of the "layer class", 2. The per-instance -data for a particular handle +=item Working with HVs -=item Functions and Attributes +=item Hash API Extensions -=item Per-instance Data +=item AVs, HVs and undefined values -=item Layers in action. +=item References -=item Per-instance flag bits +=item Blessed References and Class Objects -PERLIO_F_EOF, PERLIO_F_CANWRITE, PERLIO_F_CANREAD, PERLIO_F_ERROR, -PERLIO_F_TRUNCATE, PERLIO_F_APPEND, PERLIO_F_CRLF, PERLIO_F_UTF8, -PERLIO_F_UNBUF, PERLIO_F_WRBUF, PERLIO_F_RDBUF, PERLIO_F_LINEBUF, -PERLIO_F_TEMP, PERLIO_F_OPEN, PERLIO_F_FASTGETS +=item Creating New Variables -=item Methods in Detail +GV_ADDMULTI, GV_ADDWARN - IV (*Pushed)(PerlIO *f,const char *mode, SV *arg);, IV - (*Popped)(PerlIO *f);, PerlIO * (*Open)(...);, SV * -(*Getarg)(PerlIO *f);, IV (*Fileno)(PerlIO *f);, SSize_t -(*Read)(PerlIO *f, void *vbuf, Size_t count);, SSize_t (*Unread)(PerlIO -*f, const void *vbuf, Size_t count);, SSize_t (*Write)(PerlIO *f, const -void *vbuf, Size_t count);, IV (*Seek)(PerlIO *f, Off_t -offset, int whence);, Off_t (*Tell)(PerlIO *f);, IV - (*Close)(PerlIO *f);, IV (*Flush)(PerlIO *f);, IV - (*Fill)(PerlIO *f);, IV (*Eof)(PerlIO *f);, IV - (*Error)(PerlIO *f);, void (*Clearerr)(PerlIO *f);, void - (*Setlinebuf)(PerlIO *f);, STDCHAR * (*Get_base)(PerlIO *f);, -Size_t (*Get_bufsiz)(PerlIO *f);, STDCHAR * -(*Get_ptr)(PerlIO *f);, SSize_t (*Get_cnt)(PerlIO *f);, void - (*Set_ptrcnt)(PerlIO *f,STDCHAR *ptr,SSize_t cnt); +=item Reference Counts and Mortality -=item Core Layers +=item Stashes and Globs -"unix", "perlio", "stdio", "crlf", "mmap", "pending", "raw", "utf8" +=item Double-Typed SVs -=item Extension Layers +=item Magic Variables -":encoding", ":Scalar", ":Object" or ":Perl" +=item Assigning Magic -=back +=item Magic Virtual Tables -=back +=item Finding Magic -=head2 perlapio - perl's IO abstraction interface. +=item Understanding the Magic of Tied Hashes and Arrays -=over 4 +=item Localizing changes -=item SYNOPSIS +C, C, C, C, +C, C, C, C, C, C, C, +C, +C, +C, C, C, C, C, +C, C, +C, C, C -=item DESCRIPTION +=back -1. USE_STDIO, 2. USE_SFIO, 3. USE_PERLIO, B, -B, B, B, -B, B, -B, B, -B, B, -B, B, B, -B, B, B, -B, B, B, -B, B, B, -B, B, B, -B, B, B +=item Subroutines =over 4 -=item Co-existence with stdio +=item XSUBs and the Argument Stack -B, B, -B, B +=item Calling Perl Routines from within C Programs -=item "Fast gets" Functions +=item Memory Allocation -B, B, B, -B, B, B, -B, B, B, -B +=item PerlIO -=item Other Functions +=item Putting a C value on Perl stack -PerlIO_apply_layers(f,mode,layers), PerlIO_binmode(f,ptype,imode,layers), -'E' read, 'E' write, '+' read/write, PerlIO_debug(fmt,...) +=item Scratchpads -=back +=item Scratchpads and recursion =back -=head2 perltodo - Perl TO-DO List +=item Compiled code =over 4 -=item DESCRIPTION +=item Code tree -=item To do during 5.6.x +=item Examining the tree -=over 4 +=item Compile pass 1: check routines -=item Support for I/O disciplines +=item Compile pass 1a: constant folding -=item Autoload bytes.pm +=item Compile pass 2: context propagation -=item Make "\u{XXXX}" et al work +=item Compile pass 3: peephole optimization -=item Create a char *sv_pvprintify(sv, STRLEN *lenp, UV flags) +=item Pluggable runops -=item Overloadable regex assertions +=back -=item Unicode +=item Examining internal data structures with the C functions -=item use Thread for iThreads +=item How multiple interpreters and concurrency are supported -=item make perl_clone optionally clone ops +=over 4 -=item Work out exit/die semantics for threads +=item Background and PERL_IMPLICIT_CONTEXT -=item Typed lexicals for compiler +=item So what happened to dTHR? -=item Compiler workarounds for Win32 +=item How do I use all this in extensions? -=item AUTOLOADing in the compiler +=item Should I do anything special if I call perl from multiple threads? -=item Fixing comppadlist when compiling +=item Future Plans and PERL_IMPLICIT_SYS -=item Cleaning up exported namespace +=back -=item Complete signal handling +=item Internal Functions -=item Out-of-source builds +A, p, d, s, n, r, f, M, o, x, m, X, E, b -=item POSIX realtime support +=over 4 -=item UNIX98 support +=item Formatted Printing of IVs, UVs, and NVs -=item IPv6 Support +=item Pointer-To-Integer and Integer-To-Pointer -=item Long double conversion +=item Source Documentation -=item Locales +=back -=item Thread-safe regexes +=item Unicode Support -=item Arithmetic on non-Arabic numerals +=over 4 -=item POSIX Unicode character classes +=item What B Unicode, anyway? -=item Factoring out common suffices/prefices in regexps (trie optimization) +=item How can I recognise a UTF-8 string? -=item Security audit shipped utilities +=item How does UTF-8 represent Unicode characters? -=item Custom opcodes +=item How does Perl store UTF-8 strings? -=item DLL Versioning +=item How do I convert a string to UTF-8? -=item Introduce @( and @) +=item Is there anything else I need to know? -=item Floating point handling +=back -=item IV/UV preservation +=item Custom Operators -=item Replace pod2html with something using Pod::Parser +=item AUTHORS -=item Automate module testing on CPAN +=item SEE ALSO -=item sendmsg and recvmsg +=back -=item Rewrite perlre documentation +=head2 perlcall - Perl calling conventions from C -=item Convert example code to IO::Handle filehandles +=over 4 -=item Document Win32 choices +=item DESCRIPTION -=item Check new modules +An Error Handler, An Event Driven Program -=item Make roffitall find pods and libs itself +=item THE CALL_ FUNCTIONS -=back +call_sv, call_pv, call_method, call_argv -=item To do at some point +=item FLAG VALUES =over 4 -=item Remove regular expression recursion +=item G_VOID -=item Memory leaks after failed eval +=item G_SCALAR -=item pack "(stuff)*" +=item G_ARRAY -=item bitfields in pack +=item G_DISCARD -=item Cross compilation +=item G_NOARGS -=item Perl preprocessor / macros +=item G_EVAL -=item Perl lexer in Perl +=item G_KEEPERR -=item Using POSIX calls internally +=item Determining the Context -=item -i rename file when changed +=back -=item All ARGV input should act like EE +=item KNOWN PROBLEMS -=item Support for rerunning debugger +=item EXAMPLES -=item Test Suite for the Debugger +=over 4 -=item my sub foo { } +=item No Parameters, Nothing returned -=item One-pass global destruction +=item Passing Parameters -=item Rewrite regexp parser +=item Returning a Scalar -=item Cache recently used regexps +=item Returning a list of values -=item Re-entrant functions +=item Returning a list in a scalar context -=item Cross-compilation support +=item Returning Data from Perl via the parameter list -=item Bit-shifting bitvectors +=item Using G_EVAL -=item debugger pragma +=item Using G_KEEPERR -=item use less pragma +=item Using call_sv -=item switch structures +=item Using call_argv -=item Cache eval tree +=item Using call_method -=item rcatmaybe +=item Using GIMME_V -=item Shrink opcode tables +=item Using Perl to dispose of temporaries -=item Optimize away @_ +=item Strategies for storing Callback Context Information -=item Prototypes versus indirect objects +1. Ignore the problem - Allow only 1 callback, 2. Create a sequence of +callbacks - hard wired limit, 3. Use a parameter to map to the Perl +callback -=item Install HMTL +=item Alternate Stack Manipulation -=item Prototype method calls +=item Creating and calling an anonymous subroutine in C -=item Return context prototype declarations +=back -=item magic_setisa +=item SEE ALSO -=item Garbage collection +=item AUTHOR -=item IO tutorial +=item DATE -=item pack/unpack tutorial +=back -=item Rewrite perldoc +=head2 perlapi - autogenerated documentation for the perl public API -=item Install .3p manpages +=over 4 -=item Unicode tutorial +=item DESCRIPTION -=item Update POSIX.pm for 1003.1-2 +=item "Gimme" Values -=item Retargetable installation +GIMME, GIMME_V, G_ARRAY, G_DISCARD, G_EVAL, G_NOARGS, G_SCALAR, G_VOID -=item POSIX emulation on non-POSIX systems +=item Array Manipulation Functions -=item Rename Win32 headers +AvFILL, av_clear, av_delete, av_exists, av_extend, av_fetch, av_fill, +av_len, av_make, av_pop, av_push, av_shift, av_store, av_undef, av_unshift, +get_av, newAV, Nullav, sortsv -=item Finish off lvalue functions +=item Callback Functions -=item Update sprintf documentation +call_argv, call_method, call_pv, call_sv, ENTER, eval_pv, eval_sv, +FREETMPS, LEAVE, SAVETMPS -=item Use fchown/fchmod internally +=item Character classes -=item Make v-strings overloaded objects +isALNUM, isALPHA, isDIGIT, isLOWER, isSPACE, isUPPER, toLOWER, toUPPER -=back +=item Cloning an interpreter -=item Vague ideas +perl_clone -=over 4 +=item CV Manipulation Functions -=item ref() in list context +CvSTASH, get_cv, Nullcv -=item Make tr/// return histogram of characters in list context +=item Embedding Functions -=item Compile to real threaded code +cv_undef, load_module, nothreadhook, perl_alloc, perl_construct, +perl_destruct, perl_free, perl_parse, perl_run, require_pv -=item Structured types +=item Functions in file pp_pack.c -=item Modifiable $1 et al. +packlist, pack_cat, unpackstring, unpack_str -=item Procedural interfaces for IO::*, etc. +=item Global Variables -=item RPC modules +PL_modglobal, PL_na, PL_sv_no, PL_sv_undef, PL_sv_yes -=item Attach/detach debugger from running program +=item GV Functions -=item Alternative RE syntax module +GvSV, gv_fetchmeth, gv_fetchmethod, gv_fetchmethod_autoload, +gv_fetchmeth_autoload, gv_stashpv, gv_stashsv -=item GUI::Native +=item Handy Values -=item foreach(reverse ...) +HEf_SVKEY, Nullch, Nullsv -=item Constant function cache +=item Hash Manipulation Functions -=item Approximate regular expression matching +get_hv, HeHASH, HeKEY, HeKLEN, HePV, HeSVKEY, HeSVKEY_force, HeSVKEY_set, +HeVAL, HvNAME, hv_assert, hv_clear, hv_clear_placeholders, hv_delete, +hv_delete_ent, hv_exists, hv_exists_ent, hv_fetch, hv_fetch_ent, +hv_iterinit, hv_iterkey, hv_iterkeysv, hv_iternext, hv_iternextsv, +hv_iternext_flags, hv_iterval, hv_magic, hv_scalar, hv_store, hv_store_ent, +hv_undef, newHV, Nullhv -=back +=item Magical Functions -=item Ongoing +mg_clear, mg_copy, mg_find, mg_free, mg_get, mg_length, mg_magical, mg_set, +SvGETMAGIC, SvLOCK, SvSETMAGIC, SvSetMagicSV, SvSetMagicSV_nosteal, +SvSetSV, SvSetSV_nosteal, SvSHARE -=over 4 +=item Memory Management -=item Update guts documentation +Copy, Move, New, Newc, NEWSV, Newz, Poison, Renew, Renewc, Safefree, +savepv, savepvn, savesharedpv, StructCopy, Zero -=item Add more tests +=item Miscellaneous Functions -=item Update auxiliary tools +fbm_compile, fbm_instr, form, getcwd_sv, new_version, scan_version, strEQ, +strGE, strGT, strLE, strLT, strNE, strnEQ, strnNE, sv_nolocking, +sv_nosharing, sv_nounlocking, upg_version, vcmp, vnumify, vstringify -=back +=item Numeric functions -=item Recently done things +grok_bin, grok_hex, grok_number, grok_numeric_radix, grok_oct, scan_bin, +scan_hex, scan_oct -=over 4 +=item Optree Manipulation Functions -=item Safe signal handling +cv_const_sv, newCONSTSUB, newXS -=item Tie Modules +=item Pad Data Structures -=item gettimeofday +pad_sv -=item setitimer and getimiter +=item Stack Manipulation Macros -=item Testing __DIE__ hook +dMARK, dORIGMARK, dSP, EXTEND, MARK, ORIGMARK, POPi, POPl, POPn, POPp, +POPpbytex, POPpx, POPs, PUSHi, PUSHMARK, PUSHn, PUSHp, PUSHs, PUSHu, +PUTBACK, SP, SPAGAIN, XPUSHi, XPUSHn, XPUSHp, XPUSHs, XPUSHu, XSRETURN, +XSRETURN_IV, XSRETURN_NO, XSRETURN_NV, XSRETURN_PV, XSRETURN_UNDEF, +XSRETURN_UV, XSRETURN_YES, XST_mIV, XST_mNO, XST_mNV, XST_mPV, XST_mUNDEF, +XST_mYES -=item CPP equivalent in Perl +=item SV Flags -=item Explicit switch statements +svtype, SVt_IV, SVt_NV, SVt_PV, SVt_PVAV, SVt_PVCV, SVt_PVHV, SVt_PVMG -=item autocroak +=item SV Manipulation Functions -=item UTF/EBCDIC +get_sv, looks_like_number, newRV_inc, newRV_noinc, newSV, newSViv, newSVnv, +newSVpv, newSVpvf, newSVpvn, newSVpvn_share, newSVrv, newSVsv, newSVuv, +SvCUR, SvCUR_set, SvEND, SvGROW, SvIOK, SvIOKp, SvIOK_notUV, SvIOK_off, +SvIOK_on, SvIOK_only, SvIOK_only_UV, SvIOK_UV, SvIsCOW, +SvIsCOW_shared_hash, SvIV, SvIVx, SvIVX, SvLEN, SvNIOK, SvNIOKp, +SvNIOK_off, SvNOK, SvNOKp, SvNOK_off, SvNOK_on, SvNOK_only, SvNV, SvNVX, +SvNVx, SvOK, SvOOK, SvPOK, SvPOKp, SvPOK_off, SvPOK_on, SvPOK_only, +SvPOK_only_UTF8, SvPV, SvPVbyte, SvPVbytex, SvPVbytex_force, +SvPVbyte_force, SvPVbyte_nolen, SvPVutf8, SvPVutf8x, SvPVutf8x_force, +SvPVutf8_force, SvPVutf8_nolen, SvPVx, SvPVX, SvPV_force, SvPV_force_nomg, +SvPV_nolen, SvREFCNT, SvREFCNT_dec, SvREFCNT_inc, SvROK, SvROK_off, +SvROK_on, SvRV, SvSTASH, SvTAINT, SvTAINTED, SvTAINTED_off, SvTAINTED_on, +SvTRUE, SvTYPE, SvUNLOCK, SvUOK, SvUPGRADE, SvUTF8, SvUTF8_off, SvUTF8_on, +SvUV, SvUVX, SvUVx, SvVOK, sv_2bool, sv_2cv, sv_2io, sv_2iv, sv_2mortal, +sv_2nv, sv_2pvbyte, sv_2pvbyte_nolen, sv_2pvutf8, sv_2pvutf8_nolen, +sv_2pv_flags, sv_2pv_nolen, sv_2uv, sv_backoff, sv_bless, sv_catpv, +sv_catpvf, sv_catpvf_mg, sv_catpvn, sv_catpvn_flags, sv_catpvn_mg, +sv_catpv_mg, sv_catsv, sv_catsv_flags, sv_catsv_mg, sv_chop, sv_clear, +sv_cmp, sv_cmp_locale, sv_collxfrm, sv_copypv, sv_dec, sv_derived_from, +sv_eq, sv_force_normal, sv_force_normal_flags, sv_free, sv_gets, sv_grow, +sv_inc, sv_insert, sv_isa, sv_isobject, sv_iv, sv_len, sv_len_utf8, +sv_magic, sv_magicext, sv_mortalcopy, sv_newmortal, sv_newref, sv_nv, +sv_pos_b2u, sv_pos_u2b, sv_pv, sv_pvbyte, sv_pvbyten, sv_pvbyten_force, +sv_pvn, sv_pvn_force, sv_pvn_force_flags, sv_pvutf8, sv_pvutf8n, +sv_pvutf8n_force, sv_reftype, sv_replace, sv_report_used, sv_reset, +sv_rvweaken, sv_setiv, sv_setiv_mg, sv_setnv, sv_setnv_mg, sv_setpv, +sv_setpvf, sv_setpvf_mg, sv_setpviv, sv_setpviv_mg, sv_setpvn, +sv_setpvn_mg, sv_setpv_mg, sv_setref_iv, sv_setref_nv, sv_setref_pv, +sv_setref_pvn, sv_setref_uv, sv_setsv, sv_setsv_flags, sv_setsv_mg, +sv_setuv, sv_setuv_mg, sv_taint, sv_tainted, sv_true, sv_unmagic, sv_unref, +sv_unref_flags, sv_untaint, sv_upgrade, sv_usepvn, sv_usepvn_mg, +sv_utf8_decode, sv_utf8_downgrade, sv_utf8_encode, sv_utf8_upgrade, +sv_utf8_upgrade_flags, sv_uv, sv_vcatpvfn, sv_vsetpvfn -=item UTF Regexes +=item Unicode Support -=item perlcc to produce executable +bytes_from_utf8, bytes_to_utf8, ibcmp_utf8, is_utf8_char, is_utf8_string, +is_utf8_string_loc, pv_uni_display, sv_cat_decode, sv_recode_to_utf8, +sv_uni_display, to_utf8_case, to_utf8_fold, to_utf8_lower, to_utf8_title, +to_utf8_upper, utf8n_to_uvchr, utf8n_to_uvuni, utf8_distance, utf8_hop, +utf8_length, utf8_to_bytes, utf8_to_uvchr, utf8_to_uvuni, uvchr_to_utf8, +uvuni_to_utf8_flags -=item END blocks saved in compiled output +=item Variables created by C and C internal functions -=item Secure temporary file module +ax, CLASS, dAX, dITEMS, dXSARGS, dXSI32, items, ix, newXSproto, RETVAL, ST, +THIS, XS, XSRETURN_EMPTY, XS_VERSION, XS_VERSION_BOOTCHECK -=item Integrate Time::HiRes +=item Warning and Dieing -=item Turn Cwd into XS +croak, warn -=item Mmap for input +=item AUTHORS -=item Byte to/from UTF8 and UTF8 to/from local conversion +=item SEE ALSO -=item Add sockatmark support +=back -=item Mailing list archives +=head2 perlintern - autogenerated documentation of purely B + Perl functions -=item Bug tracking +=over 4 -=item Integrate MacPerl +=item DESCRIPTION -=item Web "nerve center" for Perl +=item CV reference counts and CvOUTSIDE -=item Regular expression tutorial +CvWEAKOUTSIDE -=item Debugging Tutorial +=item Functions in file pad.h -=item Integrate new modules +CX_CURPAD_SAVE, CX_CURPAD_SV, PAD_BASE_SV, PAD_CLONE_VARS, +PAD_COMPNAME_FLAGS, PAD_COMPNAME_GEN, PAD_COMPNAME_OURSTASH, +PAD_COMPNAME_PV, PAD_COMPNAME_TYPE, PAD_DUP, PAD_RESTORE_LOCAL, +PAD_SAVE_LOCAL, PAD_SAVE_SETNULLPAD, PAD_SETSV, PAD_SET_CUR, +PAD_SET_CUR_NOSAVE, PAD_SV, PAD_SVl, SAVECLEARSV, SAVECOMPPAD, SAVEPADSV -=item Integrate profiler +=item Functions in file pp_ctl.c -=item Y2K error detection +find_runcv -=item Regular expression debugger +=item Global Variables -=item POD checker +PL_DBsingle, PL_DBsub, PL_DBtrace, PL_dowarn, PL_last_in_gv, PL_ofs_sv, +PL_rs -=item "Dynamic" lexicals +=item GV Functions -=item Cache precompiled modules +is_gv_magical + +=item IO Functions + +start_glob + +=item Pad Data Structures + +CvPADLIST, cv_clone, cv_dump, do_dump_pad, intro_my, pad_add_anon, +pad_add_name, pad_alloc, pad_block_start, pad_check_dup, pad_findlex, +pad_findmy, pad_fixup_inner_anons, pad_free, pad_leavemy, pad_new, +pad_push, pad_reset, pad_setsv, pad_swipe, pad_tidy, pad_undef + +=item Stack Manipulation Macros + +djSP, LVRET + +=item SV Manipulation Functions + +report_uninit, sv_add_arena, sv_clean_all, sv_clean_objs, sv_free_arenas + +=item AUTHORS + +=item SEE ALSO =back -=item Deprecated Wishes +=head2 perliol - C API for Perl's implementation of IO in Layers. =over 4 -=item Loop control on do{} +=item SYNOPSIS -=item Lexically scoped typeglobs +=item DESCRIPTION -=item format BOTTOM +=over 4 -=item report HANDLE +=item History and Background -=item Generalised want()/caller()) +=item Basic Structure -=item Named prototypes +=item Layers vs Disciplines -=item Built-in globbing +=item Data Structures -=item Regression tests for suidperl +=item Functions and Attributes -=item Cached hash values +=item Per-instance Data -=item Add compression modules +=item Layers in action. -=item Reorganise documentation into tutorials/references +=item Per-instance flag bits -=item Remove distinction between functions and operators +PERLIO_F_EOF, PERLIO_F_CANWRITE, PERLIO_F_CANREAD, PERLIO_F_ERROR, +PERLIO_F_TRUNCATE, PERLIO_F_APPEND, PERLIO_F_CRLF, PERLIO_F_UTF8, +PERLIO_F_UNBUF, PERLIO_F_WRBUF, PERLIO_F_RDBUF, PERLIO_F_LINEBUF, +PERLIO_F_TEMP, PERLIO_F_OPEN, PERLIO_F_FASTGETS -=item Make XS easier to use +=item Methods in Detail -=item Make embedding easier to use +fsize, name, size, kind, PERLIO_K_BUFFERED, PERLIO_K_RAW, PERLIO_K_CANCRLF, +PERLIO_K_FASTGETS, PERLIO_K_MULTIARG, Pushed, Popped, Open, Binmode, +Getarg, Fileno, Dup, Read, Write, Seek, Tell, Close, Flush, Fill, Eof, +Error, Clearerr, Setlinebuf, Get_base, Get_bufsiz, Get_ptr, Get_cnt, +Set_ptrcnt -=item man for perl +=item Utilities -=item my $Package::variable +=item Implementing PerlIO Layers -=item "or" tests defined, not truth +C implementations, Perl implementations -=item "class"-based lexicals +=item Core Layers -=item byteperl +"unix", "perlio", "stdio", "crlf", "mmap", "pending", "raw", "utf8" -=item Lazy evaluation / tail recursion removal +=item Extension Layers -=item Make "use utf8" the default +":encoding", ":scalar", ":via" -=item Unicode collation and normalization +=back -=item Create debugging macros +=item TODO + +=back + +=head2 perlapio - perl's IO abstraction interface. + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +1. USE_STDIO, 2. USE_SFIO, 3. USE_PERLIO, B, +B, B, B, +B, B, +B, B, +B, B, +B, B, B, +B, B, B, +B, B, B, +B, B, B, +B, B, B, +B, B, B + +=over 4 + +=item Co-existence with stdio + +B, B, +B, B + +=item "Fast gets" Functions + +B, B, B, +B, B, B, +B, B, B, +B + +=item Other Functions + +PerlIO_apply_layers(f,mode,layers), PerlIO_binmode(f,ptype,imode,layers), +'E' read, 'E' write, '+' read/write, PerlIO_debug(fmt,...) =back @@ -4760,9 +4936,9 @@ Does concept match the general goals of Perl?, Where is the implementation?, Backwards compatibility, Could it be a module instead?, Is the feature generic enough?, Does it potentially introduce new bugs?, Does it preclude other desirable features?, Is the implementation robust?, Is -the implementation generic enough to be portable?, Is there enough -documentation?, Is there another way to do it?, Does it create too much -work?, Patches speak louder than words +the implementation generic enough to be portable?, Is the implementation +tested?, Is there enough documentation?, Is there another way to do it?, +Does it create too much work?, Patches speak louder than words =over 4 @@ -4773,17 +4949,14 @@ NFS, rsync'ing the patches =item Why rsync the source tree -It's easier to rsync the source tree, It's more recent, It's more reliable +It's easier to rsync the source tree, It's more reliable =item Why rsync the patches It's easier to rsync the patches, It's a good reference, Finding a start point, Finding how to fix a bug, Finding the source of misbehaviour -=item Perlbug remote interface - -1 http://bugs.perl.org, 2 bugdb@perl.org, 3 -commands_and_bugdids@bugs.perl.org, notes, patches, tests +=item Perlbug administration =item Submitting patches @@ -4808,6 +4981,8 @@ Argument stack, Mark stack, Save stack =item Millions of Macros +=item The .i Targets + =item Poking at Perl =item Using a source-level debugger @@ -4815,6 +4990,8 @@ Argument stack, Mark stack, Save stack run [args], break function_name, break source.c:xxx, step, next, continue, finish, 'enter', print +=item gdb macro support + =item Dumping Perl Data Structures =item Patching @@ -4826,7 +5003,19 @@ finish, 'enter', print =item Writing a test F, F, F, F, F, F, -F, F, t/base t/comp, t/cmd t/run t/io t/op, t/lib ext lib +F, F, F, F, F, t/base t/comp, +t/cmd t/run t/io t/op, t/lib ext lib + +=item Special Make Test Targets + +coretest, test.deparse, test.taintwarn, minitest, test.valgrind +check.valgrind utest.valgrind ucheck.valgrind, test.third check.third +utest.third ucheck.third, test.torture torturetest, utest ucheck test.utf8 +check.utf8, test_harness + +=item Running tests by hand + +PERL_CORE=1, PERL_DESTRUCT_LEVEL=2, PERL, PERL_SKIP_TTY_TEST =back @@ -4844,7 +5033,9 @@ F, F, t/base t/comp, t/cmd t/run t/io t/op, t/lib ext lib DEFINES, USE_MULTI = define, #PERL_MALLOC = define, CFG = Debug -=item Compaq's/Digital's Third Degree +=item valgrind + +=item Compaq's/Digital's/HP's Third Degree =item PERL_DESTRUCT_LEVEL @@ -4861,6 +5052,8 @@ DEFINES, USE_MULTI = define, #PERL_MALLOC = define, CFG = Debug -h, -l, -p[rocedures], -h[eavy], -i[nvocations], -l[ines], -testcoverage, -z[ero] +=item Miscellaneous tricks + =item CONCLUSION I @@ -4871,1275 +5064,3997 @@ I =back -=head2 perlhist - the Perl history records +=head2 perlbook - Perl book information =over 4 =item DESCRIPTION -=item INTRODUCTION +=back -=item THE KEEPERS OF THE PUMPKIN +=head2 perltodo - Perl TO-DO List =over 4 -=item PUMPKIN? - -=back +=item DESCRIPTION -=item THE RECORDS +=item To do during 5.6.x =over 4 -=item SELECTED RELEASE SIZES +=item Support for I/O disciplines -=item SELECTED PATCH SIZES +=item Autoload bytes.pm -=back +=item Make "\u{XXXX}" et al work -=item THE KEEPERS OF THE RECORDS +=item Create a char *sv_pvprintify(sv, STRLEN *lenp, UV flags) -=back +=item Overloadable regex assertions -=head2 perldelta - what will be new for perl v5.8.0 +=item Unicode -=over 4 +=item Work out exit/die semantics for threads -=item DESCRIPTION +=item Better support for nonpreemptive threading systems like GNU pth -=item Reporting Bugs +=item Typed lexicals for compiler -=item SEE ALSO +=item Compiler workarounds for Win32 -=item HISTORY +=item AUTOLOADing in the compiler -=back +=item Fixing comppadlist when compiling -=head2 perl572delta - what's new for perl v5.7.2 +=item Cleaning up exported namespace -=over 4 +=item Complete signal handling -=item DESCRIPTION +=item Out-of-source builds -=item Security Vulnerability Closed +=item POSIX realtime support -=item Incompatible Changes +=item UNIX98 support -=over 4 +=item IPv6 Support -=item 64-bit platforms and malloc +=item Long double conversion -=item AIX Dynaloading +=item Locales -=item Socket Extension Dynamic in VMS +=item Arithmetic on non-Arabic numerals -=item Different Definition of the Unicode Character Classes \p{In...} +=item POSIX Unicode character classes -=item Deprecations +=item Factoring out common suffices/prefices in regexps (trie optimization) -=back +=item Security audit shipped utilities -=item Core Enhancements +=item Sort out the uid-setting mess -=item Modules and Pragmata +=item Custom opcodes -=over 4 +=item DLL Versioning -=item New Modules and Distributions +=item Introduce @( and @) -=item Updated And Improved Modules and Pragmata +=item Floating point handling -=back +=item IV/UV preservation -=item Utility Changes +=item Replace pod2html with something using Pod::Parser -=item New Documentation +=item Automate module testing on CPAN -=item Installation and Configuration Improvements +=item sendmsg and recvmsg -=over 4 +=item Rewrite perlre documentation -=item New Or Improved Platforms +=item Convert example code to IO::Handle filehandles -=item Generic Improvements +=item Document Win32 choices -=back +=item Check new modules -=item Selected Bug Fixes +=item Make roffitall find pods and libs itself -=over 4 +=back -=item Platform Specific Changes and Fixes +=item To do at some point -=back +=over 4 -=item New or Changed Diagnostics +=item Remove regular expression recursion -=item Source Code Enhancements +=item Memory leaks after failed eval -=over 4 +=item bitfields in pack -=item MAGIC constants +=item Cross compilation -=item Better commented code +=item Perl preprocessor / macros -=item Regex pre-/post-compilation items matched up +=item Perl lexer in Perl -=item gcc -Wall +=item Using POSIX calls internally -=back +=item -i rename file when changed -=item New Tests +=item All ARGV input should act like EE -=item Known Problems +=item Support for rerunning debugger -=over 4 +=item Test Suite for the Debugger -=item AIX +=item my sub foo { } -=item Amiga Perl Invoking Mystery +=item One-pass global destruction -=item lib/ftmp-security tests warn 'system possibly insecure' +=item Rewrite regexp parser -=item Cygwin intermittent failures of lib/Memoize/t/expire_file 11 and 12 +=item Cache recently used regexps -=item HP-UX lib/io_multihomed Fails When LP64-Configur +=item Cross-compilation support -=item HP-UX lib/posix Subtest 9 Fails When LP64-Configured +=item Bit-shifting bitvectors -=item Linux With Sfio Fails op/misc Test 48 +=item debugger pragma -=item OS/390 +=item use less pragma -=item op/sprintf tests 129 and 130 +=item switch structures -=item Failure of Thread tests +=item Cache eval tree -=item UNICOS +=item rcatmaybe -=item UTS +=item Shrink opcode tables -=item VMS +=item Optimize away @_ -=item Win32 +=item Prototypes versus indirect objects -=item Localising a Tied Variable Leaks Memory +=item Install HTML -=item Self-tying of Arrays and Hashes Is Forbidden +=item Prototype method calls -=item Variable Attributes are not Currently Usable for Tieing +=item Return context prototype declarations -=item Building Extensions Can Fail Because Of Largefiles +=item magic_setisa -=item The Compiler Suite Is Still Experimental +=item Garbage collection -=item The Long Double Support is Still Experimental +=item IO tutorial -=back +=item Rewrite perldoc -=item Reporting Bugs +=item Install .3p manpages -=item SEE ALSO +=item Unicode tutorial -=item HISTORY +=item Update POSIX.pm for 1003.1-2 -=back +=item Retargetable installation -=head2 perl571delta - what's new for perl v5.7.1 +=item POSIX emulation on non-POSIX systems -=over 4 +=item Rename Win32 headers -=item DESCRIPTION +=item Finish off lvalue functions -=item Security Vulnerability Closed +=item Update sprintf documentation -=item Incompatible Changes +=item Use fchown/fchmod internally -=item Core Enhancements +=item Make v-strings overloaded objects -=over 4 +=item Allow restricted hash assignment -=item AUTOLOAD Is Now Lvaluable +=item Should overload be inheritable? -=item PerlIO is Now The Default +=item Taint rethink -=item Signals Are Now Safe +=item Perform correctly when XSUBs call subroutines that exit via +goto(LABEL) and friends =back -=item Modules and Pragmata +=item Vague ideas =over 4 -=item New Modules - -=item Updated And Improved Modules and Pragmata +=item ref() in list context -=back +=item Make tr/// return histogram of characters in list context -=item Performance Enhancements +=item Compile to real threaded code -=item Utility Changes +=item Structured types -=item New Documentation +=item Modifiable $1 et al. -=over 4 +=item Procedural interfaces for IO::*, etc. -=item perlclib +=item RPC modules -=item perliol +=item Attach/detach debugger from running program -=item README.aix +=item GUI::Native -=item README.bs2000 +=item foreach(reverse ...) -=item README.macos +=item Constant function cache -=item README.mpeix +=item Approximate regular expression matching -=item README.solaris +=back -=item README.vos +=item Ongoing -=item Porting/repository.pod +=over 4 -=back +=item Update guts documentation -=item Installation and Configuration Improvements +=item Add more tests -=over 4 +=item Update auxiliary tools -=item New Or Improved Platforms +=item Create debugging macros -=item Generic Improvements +=item truncate to the people -d_cmsghdr, d_fcntl_can_lock, d_fsync, d_getitimer, d_getpagsz, d_msghdr_s, -need_va_copy, d_readv, d_recvmsg, d_sendmsg, sig_size, d_sockatmark, -d_strtoq, d_u32align, d_ualarm, d_usleep +=item Unicode in Filenames =back -=item Selected Bug Fixes +=item Unicode in %ENV + +=item Recently done things =over 4 -=item Platform Specific Changes and Fixes +=item Alternative RE syntax module -=back +=item Safe signal handling -=item New or Changed Diagnostics +=item Tie Modules -=item Changed Internals +=item gettimeofday -=item New Tests +=item setitimer and getimiter -=item Known Problems +=item Testing __DIE__ hook -=over 4 +=item CPP equivalent in Perl -=item AIX vac 5.0.0.0 May Produce Buggy Code For Perl +=item Explicit switch statements -=item lib/ftmp-security tests warn 'system possibly insecure' +=item autocroak -=item lib/io_multihomed Fails In LP64-Configured HP-UX +=item UTF/EBCDIC -=item Test lib/posix Subtest 9 Fails In LP64-Configured HP-UX +=item UTF Regexes -=item lib/b test 19 +=item perlcc to produce executable -=item Linux With Sfio Fails op/misc Test 48 +=item END blocks saved in compiled output -=item sigaction test 13 in VMS +=item Secure temporary file module -=item sprintf tests 129 and 130 +=item Integrate Time::HiRes -=item Failure of Thread tests - -=item Localising a Tied Variable Leaks Memory - -=item Self-tying of Arrays and Hashes Is Forbidden - -=item Building Extensions Can Fail Because Of Largefiles +=item Turn Cwd into XS -=item The Compiler Suite Is Still Experimental +=item Mmap for input -=back +=item Byte to/from UTF-8 and UTF-8 to/from local conversion -=item Reporting Bugs +=item Add sockatmark support -=item SEE ALSO +=item Mailing list archives -=item HISTORY +=item Bug tracking -=back +=item Integrate MacPerl -=head2 perl570delta - what's new for perl v5.7.0 +=item Web "nerve center" for Perl -=over 4 +=item Regular expression tutorial -=item DESCRIPTION +=item Debugging Tutorial -=item Security Vulnerability Closed +=item Integrate new modules -=item Incompatible Changes +=item Integrate profiler -=item Core Enhancements +=item Y2K error detection -=item Modules and Pragmata +=item Regular expression debugger -=over 4 +=item POD checker -=item New Modules +=item "Dynamic" lexicals -=item Updated And Improved Modules and Pragmata +=item Cache precompiled modules =back -=item Utility Changes - -=item New Documentation - -=item Performance Enhancements - -=item Installation and Configuration Improvements +=item Deprecated Wishes =over 4 -=item Generic Improvements +=item Loop control on do{} -=back +=item Lexically scoped typeglobs -=item Selected Bug Fixes +=item format BOTTOM -=over 4 +=item report HANDLE -=item Platform Specific Changes and Fixes +=item Generalised want()/caller()) -=back +=item Named prototypes -=item New or Changed Diagnostics +=item Built-in globbing -=item Changed Internals +=item Regression tests for suidperl -=item Known Problems +=item Cached hash values -=over 4 +=item Add compression modules -=item Unicode Support Still Far From Perfect +=item Reorganise documentation into tutorials/references -=item EBCDIC Still A Lost Platform +=item Remove distinction between functions and operators -=item Building Extensions Can Fail Because Of Largefiles +=item Make XS easier to use -=item ftmp-security tests warn 'system possibly insecure' +=item Make embedding easier to use -=item Test lib/posix Subtest 9 Fails In LP64-Configured HP-UX +=item man for perl -=item Long Doubles Still Don't Work In Solaris +=item my $Package::variable -=item Linux With Sfio Fails op/misc Test 48 +=item "or" tests defined, not truth -=item Storable tests fail in some platforms +=item "class"-based lexicals -=item Threads Are Still Experimental +=item byteperl -=item The Compiler Suite Is Still Experimental +=item Lazy evaluation / tail recursion removal -=back +=item Make "use utf8" the default -=item Reporting Bugs +=item Unicode collation and normalization -=item SEE ALSO +=item pack/unpack tutorial -=item HISTORY +=back =back -=head2 perl56delta, perldelta - what's new for perl v5.6.0 +=head2 perldoc - Look up Perl documentation in Pod format. =over 4 -=item DESCRIPTION +=item SYNOPSIS -=item Core Enhancements +=item DESCRIPTION -=over 4 +=item OPTIONS -=item Interpreter cloning, threads, and concurrency +B<-h>, B<-v>, B<-t>, B<-u>, B<-m> I, B<-l>, B<-F>, B<-f> +I, B<-q> I, B<-T>, B<-d> +I, B<-o> I, B<-M> I, +B<-w> I or B<-w> I

    tag), 4. end_ul() (generates +a
tag) =back -=item MAGIC AUTOGENERATION +=item GENERATING DYNAMIC DOCUMENTS -I, I, -I, C, I, I, -I, I, I, I, -I +=over 4 -=item Losing overloading +=item CREATING A STANDARD HTTP HEADER: -=item Run-time Overloading +=item GENERATING A REDIRECTION HEADER -=item Public functions +=item CREATING THE HTML DOCUMENT HEADER -overload::StrVal(arg), overload::Overloaded(arg), overload::Method(obj,op) +B, 4, 5, 6.. -=item Overloading constants +=item ENDING THE HTML DOCUMENT: -integer, float, binary, q, qr +=item CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION: -=item IMPLEMENTATION +=item OBTAINING THE SCRIPT'S URL -=item Metaphor clash +B<-absolute>, B<-relative>, B<-full>, B<-path> (B<-path_info>), B<-query> +(B<-query_string>), B<-base> -=item Cookbook +=item MIXING POST AND URL PARAMETERS -=over 4 +=back -=item Two-face scalars +=item CREATING STANDARD HTML ELEMENTS: -=item Two-face references +=over 4 -=item Symbolic calculator +=item PROVIDING ARGUMENTS TO HTML SHORTCUTS -=item I symbolic calculator +=item THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS -=back +=item HTML SHORTCUTS AND LIST INTERPOLATION -=item AUTHOR +=item NON-STANDARD HTML SHORTCUTS -=item DIAGNOSTICS +=item AUTOESCAPING HTML -Odd number of arguments for overload::constant, `%s' is not an overloadable -type, `%s' is not a code reference +$escaped_string = escapeHTML("unescaped string");, $charset = +charset([$charset]);, $flag = autoEscape([$flag]); -=item BUGS +=item PRETTY-PRINTING HTML =back -=head2 re - Perl pragma to alter regular expression behaviour +=item CREATING FILL-OUT FORMS: =over 4 -=item SYNOPSIS +=item CREATING AN ISINDEX TAG -=item DESCRIPTION +=item STARTING AND ENDING A FORM -=back +B, B -=head2 sigtrap - Perl pragma to enable simple signal handling +=item CREATING A TEXT FIELD -=over 4 +B -=item SYNOPSIS +=item CREATING A BIG TEXT FIELD -=item DESCRIPTION +=item CREATING A PASSWORD FIELD -=item OPTIONS +=item CREATING A FILE UPLOAD FIELD -=over 4 +B -=item SIGNAL HANDLERS +=item CREATING A POPUP MENU -B, B, B I +=item CREATING AN OPTION GROUP -=item SIGNAL LISTS +=item CREATING A SCROLLING LIST -B, B, B +B -=item OTHER +=item CREATING A GROUP OF RELATED CHECKBOXES -B, B, I, I +B -=back +=item CREATING A STANDALONE CHECKBOX -=item EXAMPLES +B -=back +=item CREATING A RADIO BUTTON GROUP -=head2 strict - Perl pragma to restrict unsafe constructs +B -=over 4 +=item CREATING A SUBMIT BUTTON -=item SYNOPSIS +B -=item DESCRIPTION +=item CREATING A RESET BUTTON -C, C, C +=item CREATING A DEFAULT BUTTON -=back +=item CREATING A HIDDEN FIELD -=head2 subs - Perl pragma to predeclare sub names +B -=over 4 +=item CREATING A CLICKABLE IMAGE BUTTON -=item SYNOPSIS +B, 3. The third option (-align, optional) is an alignment +type, and may be TOP, BOTTOM or MIDDLE -=item DESCRIPTION +=item CREATING A JAVASCRIPT ACTION BUTTON =back -=head2 utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source -code +=item HTTP COOKIES + +1. an expiration time, 2. a domain, 3. a path, 4. a "secure" flag, +B<-name>, B<-value>, B<-path>, B<-domain>, B<-expires>, B<-secure> + +=item WORKING WITH FRAMES + +1. Create a document, 2. Specify the destination for the +document in the HTTP header, 3. Specify the destination for the document in +the
tag + +=item LIMITED SUPPORT FOR CASCADING STYLE SHEETS + +=item DEBUGGING =over 4 -=item SYNOPSIS - -=item DESCRIPTION +=item DUMPING OUT ALL THE NAME/VALUE PAIRS -=over 4 +=back -=item Utility functions +=item FETCHING ENVIRONMENT VARIABLES -$num_octets = utf8::upgrade($string);, utf8::downgrade($string[, CHECK]), -utf8::encode($string), $flag = utf8::decode($string) +B, B, B, B, +B, B, B Return the script +name as a partial URL, for self-refering scripts, B, B, B, B, B, +B, B, B, +B, B, B, B -=back +=item USING NPH SCRIPTS -=item SEE ALSO +In the B statement, By calling the B method:, By using B<-nph> +parameters -=back +=item Server Push -=head2 vars - Perl pragma to predeclare global variable names (obsolete) +multipart_init(), multipart_start(), multipart_end(), multipart_final() -=over 4 +=item Avoiding Denial of Service Attacks -=item SYNOPSIS +B<$CGI::POST_MAX>, B<$CGI::DISABLE_UPLOADS>, B<1. On a script-by-script +basis>, B<2. Globally for all scripts> -=item DESCRIPTION +=item COMPATIBILITY WITH CGI-LIB.PL -=back +=item AUTHOR INFORMATION -=head2 vmsish - Perl pragma to control VMS-specific language features +=item CREDITS -=over 4 +Matt Heffron (heffron@falstaff.css.beckman.com), James Taylor +(james.taylor@srs.gov), Scott Anguish , Mike Jewell +(mlj3u@virginia.edu), Timothy Shimmin (tes@kbs.citri.edu.au), Joergen Haegg +(jh@axis.se), Laurent Delfosse (delfosse@delfosse.com), Richard Resnick +(applepi1@aol.com), Craig Bishop (csb@barwonwater.vic.gov.au), Tony Curtis +(tc@vcpc.univie.ac.at), Tim Bunce (Tim.Bunce@ig.co.uk), Tom Christiansen +(tchrist@convex.com), Andreas Koenig (k@franz.ww.TU-Berlin.DE), Tim +MacKenzie (Tim.MacKenzie@fulcrum.com.au), Kevin B. Hendricks +(kbhend@dogwood.tyler.wm.edu), Stephen Dahmen (joyfire@inxpress.net), Ed +Jordan (ed@fidalgo.net), David Alan Pisoni (david@cnation.com), Doug +MacEachern (dougm@opengroup.org), Robin Houston (robin@oneworld.org), +...and many many more.. -=item SYNOPSIS +=item A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT -=item DESCRIPTION +=item BUGS -C, C, C, C +=item SEE ALSO =back -=head2 warnings - Perl pragma to control optional warnings +=head2 CGI::Apache - Backward compatibility module for CGI.pm =over 4 =item SYNOPSIS +=item ABSTRACT + =item DESCRIPTION -use warnings::register, warnings::enabled(), warnings::enabled($category), -warnings::enabled($object), warnings::warn($message), -warnings::warn($category, $message), warnings::warn($object, $message), -warnings::warnif($message), warnings::warnif($category, $message), -warnings::warnif($object, $message) +=item AUTHOR INFORMATION + +=item BUGS + +=item SEE ALSO =back -=head2 warnings::register - warnings import function +=head2 CGI::Carp, B - CGI routines for writing to the HTTPD (or +other) error log =over 4 @@ -7907,74 +10896,61 @@ warnings::warnif($object, $message) =item DESCRIPTION -=back - -=head1 MODULE DOCUMENTATION +=item REDIRECTING ERROR MESSAGES -=head2 AnyDBM_File - provide framework for multiple DBMs +=item MAKING PERL ERRORS APPEAR IN THE BROWSER WINDOW =over 4 -=item SYNOPSIS - -=item DESCRIPTION +=item Changing the default message -=over 4 +=back -=item DBM Comparisons +=item MAKING WARNINGS APPEAR AS HTML COMMENTS -[0], [1], [2], [3] +=item OVERRIDING THE NAME OF THE PROGRAM -=back +=item AUTHORS =item SEE ALSO =back -=head2 Attribute::Handlers - Simpler definition of attribute handlers +=head2 CGI::Cookie - Interface to Netscape Cookies =over 4 -=item VERSION - =item SYNOPSIS =item DESCRIPTION -[0], [1], [2], [3], [4], [5] +=item USING CGI::Cookie + +B<1. expiration date>, B<2. domain>, B<3. path>, B<4. secure flag> =over 4 -=item Typed lexicals +=item Creating New Cookies -=item Type-specific attribute handlers +=item Sending the Cookie to the Browser -=item Non-interpretive attribute handlers +=item Recovering Previous Cookies -=item Phase-specific attribute handlers +=item Manipulating Cookies -=item Attributes as C interfaces +B, B, B, B, B =back -=item EXAMPLES - -=item DIAGNOSTICS - -C, C, C, C, -C, C - -=item AUTHOR +=item AUTHOR INFORMATION =item BUGS -=item COPYRIGHT +=item SEE ALSO =back -=head2 AutoLoader - load subroutines only on demand +=head2 CGI::Fast - CGI Interface for Fast CGI =over 4 @@ -7982,29 +10958,29 @@ C, C =item DESCRIPTION -=over 4 +=item OTHER PIECES OF THE PUZZLE -=item Subroutine Stubs +=item WRITING FASTCGI PERL SCRIPTS -=item Using B's AUTOLOAD Subroutine +=item INSTALLING FASTCGI SCRIPTS -=item Overriding B's AUTOLOAD Subroutine +=item USING FASTCGI SCRIPTS AS CGI SCRIPTS -=item Package Lexicals +=item EXTERNAL FASTCGI SERVER INVOCATION -=item Not Using AutoLoader +FCGI_SOCKET_PATH, FCGI_LISTEN_QUEUE -=item B vs. B +=item CAVEATS -=back +=item AUTHOR INFORMATION -=item CAVEATS +=item BUGS =item SEE ALSO =back -=head2 AutoSplit - split a package for autoloading +=head2 CGI::Pretty - module to produce nicely formatted HTML code =over 4 @@ -8012,19 +10988,23 @@ C, C =item DESCRIPTION -$keep, $check, $modtime - =over 4 -=item Multiple packages +=item Tags that won't be formatted + +=item Customizing the Indenting =back -=item DIAGNOSTICS +=item BUGS + +=item AUTHOR + +=item SEE ALSO =back -=head2 B - The Perl Compiler +=head2 CGI::Push - Simple Interface to Server Push =over 4 @@ -8032,157 +11012,181 @@ $keep, $check, $modtime =item DESCRIPTION -=item OVERVIEW OF CLASSES +=item USING CGI::Push + +-next_page, -last_page, -type, -delay, -cookie, -target, -expires, -nph =over 4 -=item SV-RELATED CLASSES +=item Heterogeneous Pages -=item B::SV METHODS +=item Changing the Page Delay on the Fly -REFCNT, FLAGS +=back -=item B::IV METHODS +=item INSTALLING CGI::Push SCRIPTS -IV, IVX, UVX, int_value, needs64bits, packiv +=item AUTHOR INFORMATION -=item B::NV METHODS +=item BUGS -NV, NVX +=item SEE ALSO -=item B::RV METHODS +=back -RV +=head2 CGI::Switch - Backward compatibility module for defunct CGI::Switch -=item B::PV METHODS +=over 4 -PV, PVX +=item SYNOPSIS -=item B::PVMG METHODS +=item ABSTRACT -MAGIC, SvSTASH +=item DESCRIPTION -=item B::MAGIC METHODS +=item AUTHOR INFORMATION -MOREMAGIC, PRIVATE, TYPE, FLAGS, OBJ, PTR +=item BUGS -=item B::PVLV METHODS +=item SEE ALSO -TARGOFF, TARGLEN, TYPE, TARG +=back -=item B::BM METHODS +=head2 CGI::Util - Internal utilities used by CGI module -USEFUL, PREVIOUS, RARE, TABLE +=over 4 -=item B::GV METHODS +=item SYNOPSIS -is_empty, NAME, SAFENAME, STASH, SV, IO, FORM, AV, HV, EGV, CV, CVGEN, -LINE, FILE, FILEGV, GvREFCNT, FLAGS +=item DESCRIPTION -=item B::IO METHODS +=item AUTHOR INFORMATION -LINES, PAGE, PAGE_LEN, LINES_LEFT, TOP_NAME, TOP_GV, FMT_NAME, FMT_GV, -BOTTOM_NAME, BOTTOM_GV, SUBPROCESS, IoTYPE, IoFLAGS +=item SEE ALSO -=item B::AV METHODS +=back -FILL, MAX, OFF, ARRAY, AvFLAGS +=head2 CPAN - query, download and build perl modules from CPAN sites -=item B::CV METHODS +=over 4 -STASH, START, ROOT, GV, FILE, DEPTH, PADLIST, OUTSIDE, XSUB, XSUBANY, -CvFLAGS, const_sv +=item SYNOPSIS -=item B::HV METHODS +=item STATUS -FILL, MAX, KEYS, RITER, NAME, PMROOT, ARRAY +=item DESCRIPTION -=item OP-RELATED CLASSES +=over 4 -=item B::OP METHODS +=item Interactive Mode -next, sibling, name, ppaddr, desc, targ, type, seq, flags, private +Searching for authors, bundles, distribution files and modules, make, test, +install, clean modules or distributions, get, readme, look module or +distribution, ls author, Signals -=item B::UNOP METHOD +=item CPAN::Shell -first +=item autobundle -=item B::BINOP METHOD +=item recompile -last +=item The four C Classes: Author, Bundle, Module, Distribution -=item B::LOGOP METHOD +=item Programmer's interface -other +expand($type,@things), expandany(@things), Programming Examples -=item B::LISTOP METHOD +=item Methods in the other Classes -children +CPAN::Author::as_glimpse(), CPAN::Author::as_string(), +CPAN::Author::email(), CPAN::Author::fullname(), CPAN::Author::name(), +CPAN::Bundle::as_glimpse(), CPAN::Bundle::as_string(), +CPAN::Bundle::clean(), CPAN::Bundle::contains(), +CPAN::Bundle::force($method,@args), CPAN::Bundle::get(), +CPAN::Bundle::inst_file(), CPAN::Bundle::inst_version(), +CPAN::Bundle::uptodate(), CPAN::Bundle::install(), CPAN::Bundle::make(), +CPAN::Bundle::readme(), CPAN::Bundle::test(), +CPAN::Distribution::as_glimpse(), CPAN::Distribution::as_string(), +CPAN::Distribution::clean(), CPAN::Distribution::containsmods(), +CPAN::Distribution::cvs_import(), CPAN::Distribution::dir(), +CPAN::Distribution::force($method,@args), CPAN::Distribution::get(), +CPAN::Distribution::install(), CPAN::Distribution::isa_perl(), +CPAN::Distribution::look(), CPAN::Distribution::make(), +CPAN::Distribution::prereq_pm(), CPAN::Distribution::readme(), +CPAN::Distribution::test(), CPAN::Distribution::uptodate(), +CPAN::Index::force_reload(), CPAN::Index::reload(), CPAN::InfoObj::dump(), +CPAN::Module::as_glimpse(), CPAN::Module::as_string(), +CPAN::Module::clean(), CPAN::Module::cpan_file(), +CPAN::Module::cpan_version(), CPAN::Module::cvs_import(), +CPAN::Module::description(), CPAN::Module::force($method,@args), +CPAN::Module::get(), CPAN::Module::inst_file(), +CPAN::Module::inst_version(), CPAN::Module::install(), +CPAN::Module::look(), CPAN::Module::make(), +CPAN::Module::manpage_headline(), CPAN::Module::readme(), +CPAN::Module::test(), CPAN::Module::uptodate(), CPAN::Module::userid() -=item B::PMOP METHODS +=item Cache Manager -pmreplroot, pmreplstart, pmnext, pmregexp, pmflags, pmpermflags, precomp +=item Bundles -=item B::SVOP METHOD +=item Prerequisites -sv, gv +=item Finding packages and VERSION -=item B::PADOP METHOD +=item Debugging -padix +=item Floppy, Zip, Offline Mode -=item B::PVOP METHOD +=back -pv +=item CONFIGURATION -=item B::LOOP METHODS +Cscalar optionE>, Cscalar optionE +EvalueE>, Clist optionE>, Clist +optionE [shift|pop]>, Clist optionE +[unshift|push|splice] ElistE> -redoop, nextop, lastop +=over 4 -=item B::COP METHODS +=item Note on urllist parameter's format -label, stash, file, cop_seq, arybase, line +=item urllist parameter has CD-ROM support =back -=item FUNCTIONS EXPORTED BY C - -main_cv, init_av, main_root, main_start, comppadlist, sv_undef, sv_yes, -sv_no, amagic_generation, walkoptree(OP, METHOD), walkoptree_debug(DEBUG), -walksymtable(SYMREF, METHOD, RECURSE, PREFIX), svref_2object(SV), -ppname(OPNUM), hash(STR), cast_I32(I), minus_c, cstring(STR), class(OBJ), -threadsv_names +=item SECURITY -=item AUTHOR +=item EXPORT -=back +=item POPULATE AN INSTALLATION WITH LOTS OF MODULES -=head2 B::Asmdata - Autogenerated data about Perl ops, used to generate -bytecode +=item WORKING WITH CPAN.pm BEHIND FIREWALLS =over 4 -=item SYNOPSIS +=item Three basic types of firewalls -=item DESCRIPTION +http firewall, ftp firewall, One way visibility, SOCKS, IP Masquerade -=item AUTHOR +=item Configuring lynx or ncftp for going through a firewall =back -=head2 B::Assembler - Assemble Perl bytecode +=item FAQ -=over 4 +1), 2), 3), 4), 5), 6), 7), 8), 9), 10) -=item SYNOPSIS +=item BUGS -=item DESCRIPTION +=item AUTHOR -=item AUTHORS +=item TRANSLATIONS + +=item SEE ALSO =back -=head2 B::Bblock - Walk basic blocks +=head2 CPAN::FirstTime - Utility for CPAN::Config file Initialization =over 4 @@ -8190,11 +11194,10 @@ bytecode =item DESCRIPTION -=item AUTHOR - =back -=head2 B::Bytecode - Perl compiler's bytecode backend +=head2 CPANox, CPAN::Nox - Wrapper around CPAN.pm without using any XS +module =over 4 @@ -8202,21 +11205,11 @@ bytecode =item DESCRIPTION -=item OPTIONS - -B<-ofilename>, B<-afilename>, B<-->, B<-f>, B<-fcompress-nullops>, -B<-fomit-sequence-numbers>, B<-fbypass-nullops>, B<-On>, B<-D>, B<-Do>, -B<-Db>, B<-Da>, B<-DC>, B<-S>, B<-upackage> - -=item EXAMPLES - -=item BUGS - -=item AUTHORS +=item SEE ALSO =back -=head2 B::C - Perl compiler's C backend +=head2 Carp, carp - warn of errors (from perspective of caller) =over 4 @@ -8224,20 +11217,19 @@ B<-Db>, B<-Da>, B<-DC>, B<-S>, B<-upackage> =item DESCRIPTION -=item OPTIONS +=over 4 -B<-ofilename>, B<-v>, B<-->, B<-uPackname>, B<-D>, B<-Do>, B<-Dc>, B<-DA>, -B<-DC>, B<-DM>, B<-f>, B<-fcog>, B<-fno-cog>, B<-On>, B<-llimit> +=item Forcing a Stack Trace -=item EXAMPLES +=back =item BUGS -=item AUTHOR - =back -=head2 B::CC - Perl compiler's optimized C translation backend +=head2 Carp::Heavy, Carp heavy machinery - no user serviceable parts inside + +=head2 Class::ISA -- report the search path for a class's ISA tree =over 4 @@ -8245,35 +11237,21 @@ B<-DC>, B<-DM>, B<-f>, B<-fcog>, B<-fno-cog>, B<-On>, B<-llimit> =item DESCRIPTION -=item OPTIONS - -B<-ofilename>, B<-v>, B<-->, B<-uPackname>, B<-mModulename>, B<-D>, B<-Dr>, -B<-DO>, B<-Ds>, B<-Dp>, B<-Dq>, B<-Dl>, B<-Dt>, B<-f>, -B<-ffreetmps-each-bblock>, B<-ffreetmps-each-loop>, B<-fomit-taint>, B<-On> - -=item EXAMPLES - -=item BUGS - -=item DIFFERENCES - -=over 4 - -=item Loops - -=item Context of ".." +=item FUNCTIONS -=item Arithmetic +the function Class::ISA::super_path($CLASS), the function +Class::ISA::self_and_super_path($CLASS), the function +Class::ISA::self_and_super_versions($CLASS) -=item Deprecated features +=item CAUTIONARY NOTES -=back +=item COPYRIGHT =item AUTHOR =back -=head2 B::Concise - Walk Perl syntax tree, printing concise info about ops +=head2 Class::Struct - declare struct-like datatypes as Perl classes =over 4 @@ -8281,52 +11259,30 @@ B<-ffreetmps-each-bblock>, B<-ffreetmps-each-loop>, B<-fomit-taint>, B<-On> =item DESCRIPTION -=item OPTIONS - -B<-basic>, B<-exec>, B<-tree>, B<-compact>, B<-loose>, B<-vt>, B<-ascii>, -B<-main>, B<-base>I, B<-bigendian>, B<-littleendian>, B<-concise>, -B<-terse>, B<-linenoise>, B<-debug>, B<-env> - -=item FORMATTING SPECIFICATIONS - -B<(x(>IB<;>IB<)x)>, B<(*(>IB<)*)>, -B<(*(>IB<;>IB<)*)>, B<(?(>IB<#>IIB<)?)>, -B<#>I, B<#>II, B<~>, B<#addr>, B<#arg>, B<#class>, -B<#classym>, B<#coplabel>, B<#exname>, B<#extarg>, B<#firstaddr>, -B<#flags>, B<#flagval>, B<#hyphenseq>, B<#label>, B<#lastaddr>, B<#name>, -B<#NAME>, B<#next>, B<#nextaddr>, B<#noise>, B<#private>, B<#privval>, -B<#seq>, B<#seqnum>, B<#sibaddr>, B<#svaddr>, B<#svclass>, B<#svval>, -B<#targ>, B<#targarg>, B<#targarglife>, B<#typenum> - -=item ABBREVIATIONS - =over 4 -=item OP flags abbreviations +=item The C function -=item OP class abbreviations +=item Class Creation at Compile Time -=back +=item Element Types and Accessor Methods -=item Using B::Concise outside of the O framework +Scalar (C<'$'> or C<'*$'>), Array (C<'@'> or C<'*@'>), Hash (C<'%'> or +C<'*%'>), Class (C<'Class_Name'> or C<'*Class_Name'>) -=item AUTHOR +=item Initializing with C =back -=head2 B::Debug - Walk Perl syntax tree, printing debug info about ops - -=over 4 - -=item SYNOPSIS +=item EXAMPLES -=item DESCRIPTION +Example 1, Example 2, Example 3 -=item AUTHOR +=item Author and Modification History =back -=head2 B::Deparse - Perl compiler backend to produce perl code +=head2 Config - access Perl configuration information =over 4 @@ -8334,155 +11290,330 @@ B<#targ>, B<#targarg>, B<#targarglife>, B<#typenum> =item DESCRIPTION -=item OPTIONS - -B<-l>, B<-p>, B<-q>, B<-f>I, B<-s>I, B, BI, -B, BIB<.>, B<-x>I - -=item USING B::Deparse AS A MODULE - -=over 4 - -=item Synopsis - -=item Description - -=item new - -=item ambient_pragmas - -strict, $[, bytes, utf8, integer, re, warnings, hint_bits, warning_bits - -=item coderef2text - -=back - -=item BUGS +myconfig(), config_sh(), config_re($regex), config_vars(@names) -=item AUTHOR +=item EXAMPLE -=back +=item WARNING -=head2 B::Disassembler - Disassemble Perl bytecode +=item GLOSSARY =over 4 -=item SYNOPSIS +=item _ -=item DESCRIPTION +C<_a>, C<_exe>, C<_o> -=item AUTHOR +=item a -=back +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, C, +C, C -=head2 B::Lint - Perl lint +=item b -=over 4 +C, C, C, C, C, C, C -=item SYNOPSIS +=item c -=item DESCRIPTION +C, C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C -=item OPTIONS AND LINT CHECKS +=item d -B, B and B, B, -B, B, B, B, B +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C -=item NON LINT-CHECK OPTIONS +=item e -B<-u Package> +C, C, C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C -=item BUGS +=item f -=item AUTHOR +C, C, C, C, C, +C, C, C, C, C, C, +C -=back +=item g -=head2 B::O, O - Generic interface to Perl Compiler backends +C, C, C, C, +C, C, C, +C, C, C, +C, C, C, +C, C, +C, C, C, +C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C -=over 4 +=item h -=item SYNOPSIS +C, C, C, C, C, C, +C, C -=item DESCRIPTION +=item i -=item CONVENTIONS +C, C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, +C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, +C, C, C, +C, C, C, +C, C, C, +C, C, C, +C, C, C, +C, C, C, +C, C, C, C, C -=item IMPLEMENTATION +=item k -=item AUTHOR +C, C -=back +=item l -=head2 B::Showlex - Show lexical variables used in functions or files +C, C, C, C, C, +C, C, C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, C, +C -=over 4 +=item m -=item SYNOPSIS +C, C, C, C, C, C, +C, C, C, C, C, +C, C -=item DESCRIPTION +=item M -=item AUTHOR +C, C, C, C, C, C, +C, C, C, C, C, C, +C -=back +=item n -=head2 B::Stackobj - Helper module for CC backend +C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C -=over 4 +=item o -=item SYNOPSIS +C, C, C, C, +C, C, C, C -=item DESCRIPTION +=item p -=item AUTHOR +C, C, C, C, C, C, +C, C -=back +=item P -=head2 B::Stash - show what stashes are loaded +C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C -=head2 B::Terse - Walk Perl syntax tree, printing terse info about ops +=item q -=over 4 +C, C -=item SYNOPSIS +=item r -=item DESCRIPTION +C, C, C, C, C, +C, C, C, C, C, +C, C, C -=item AUTHOR +=item s -=back +C, C, C, C, C, +C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C -=head2 B::Xref - Generates cross reference reports for Perl programs +=item t -=over 4 +C, C, C, C, C, C, C, +C, C, C, C, C, C, C, +C -=item SYNOPSIS +=item u -=item DESCRIPTION +C, C, C, C, C, C, +C, C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C -=item OPTIONS +=item v -C<-oFILENAME>, C<-r>, C<-D[tO]> +C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C, +C, C, C, C, +C, C, C, +C, C, C -=item BUGS +=item x -=item AUTHOR +C, C -=back +=item y -=head2 Bblock, B::Bblock - Walk basic blocks +C, C -=over 4 +=item z -=item SYNOPSIS +C, C -=item DESCRIPTION +=back -=item AUTHOR +=item NOTE =back -=head2 Benchmark - benchmark running times of Perl code +=head2 Cwd - get pathname of current working directory =over 4 @@ -8492,41 +11623,27 @@ C<-oFILENAME>, C<-r>, C<-D[tO]> =over 4 -=item Methods - -new, debug, iters +=item getcwd and friends -=item Standard Exports +getcwd, cwd, fastcwd, fastgetcwd -timeit(COUNT, CODE), timethis ( COUNT, CODE, [ TITLE, [ STYLE ]] ), -timethese ( COUNT, CODEHASHREF, [ STYLE ] ), timediff ( T1, T2 ), timestr ( -TIMEDIFF, [ STYLE, [ FORMAT ] ] ) +=item abs_path and friends -=item Optional Exports +abs_path, realpath, fast_abs_path -clearcache ( COUNT ), clearallcache ( ), cmpthese ( COUT, CODEHASHREF, [ -STYLE ] ), cmpthese ( RESULTSHASHREF, [ STYLE ] ), countit(TIME, CODE), -disablecache ( ), enablecache ( ), timesum ( T1, T2 ) +=item $ENV{PWD} =back =item NOTES -=item EXAMPLES - -=item INHERITANCE - -=item CAVEATS - =item SEE ALSO -=item AUTHORS - -=item MODIFICATION HISTORY - =back -=head2 ByteLoader - load byte compiled perl code +=head2 DB - programmatic interface to the Perl debugging API (draft, +subject to +change) =over 4 @@ -8534,286 +11651,230 @@ disablecache ( ), enablecache ( ), timesum ( T1, T2 ) =item DESCRIPTION -=item AUTHOR - -=item SEE ALSO - -=back +=over 4 -=head2 Bytecode, B::Bytecode - Perl compiler's bytecode backend +=item Global Variables -=over 4 + $DB::sub, %DB::sub, $DB::single, $DB::signal, $DB::trace, @DB::args, +@DB::dbline, %DB::dbline, $DB::package, $DB::filename, $DB::subname, +$DB::lineno -=item SYNOPSIS +=item API Methods -=item DESCRIPTION +CLIENT->register(), CLIENT->evalcode(STRING), CLIENT->skippkg('D::hide'), +CLIENT->run(), CLIENT->step(), CLIENT->next(), CLIENT->done() -=item OPTIONS +=item Client Callback Methods -B<-ofilename>, B<-afilename>, B<-->, B<-f>, B<-fcompress-nullops>, -B<-fomit-sequence-numbers>, B<-fbypass-nullops>, B<-On>, B<-D>, B<-Do>, -B<-Db>, B<-Da>, B<-DC>, B<-S>, B<-upackage> +CLIENT->init(), CLIENT->prestop([STRING]), CLIENT->stop(), CLIENT->idle(), +CLIENT->poststop([STRING]), CLIENT->evalcode(STRING), CLIENT->cleanup(), +CLIENT->output(LIST) -=item EXAMPLES +=back =item BUGS -=item AUTHORS +=item AUTHOR =back -=head2 CGI - Simple Common Gateway Interface Class +=head2 DB_File - Perl5 access to Berkeley DB version 1.x =over 4 =item SYNOPSIS -=item ABSTRACT - =item DESCRIPTION -=over 4 - -=item PROGRAMMING STYLE - -=item CALLING CGI.PM ROUTINES - -=item CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE): - -=item CREATING A NEW QUERY OBJECT FROM AN INPUT FILE - -=item FETCHING A LIST OF KEYWORDS FROM THE QUERY: - -=item FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT: - -=item FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER: - -=item SETTING THE VALUE(S) OF A NAMED PARAMETER: - -=item APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER: - -=item IMPORTING ALL PARAMETERS INTO A NAMESPACE: - -=item DELETING A PARAMETER COMPLETELY: - -=item DELETING ALL PARAMETERS: +B, B, B -=item DIRECT ACCESS TO THE PARAMETER LIST: +=over 4 -=item FETCHING THE PARAMETER LIST AS A HASH: +=item Using DB_File with Berkeley DB version 2 or greater -=item SAVING THE STATE OF THE SCRIPT TO A FILE: +=item Interface to Berkeley DB -=item RETRIEVING CGI ERRORS +=item Opening a Berkeley DB Database File -=item USING THE FUNCTION-ORIENTED INTERFACE +=item Default Parameters -B<:cgi>, B<:form>, B<:html2>, B<:html3>, B<:netscape>, B<:html>, -B<:standard>, B<:all> +=item In Memory Databases -=item PRAGMAS +=back --any, -compile, -nosticky, -no_undef_params, -no_xhtml, -nph, --newstyle_urls, -oldstyle_urls, -autoload, -no_debug, -debug, --private_tempfiles +=item DB_HASH -=item SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS +=over 4 -1. start_table() (generates a tag), 2. end_table() (generates a -
tag), 3. start_ul() (generates a
    tag), 4. end_ul() (generates -a
tag) +=item A Simple Example =back -=item GENERATING DYNAMIC DOCUMENTS +=item DB_BTREE =over 4 -=item CREATING A STANDARD HTTP HEADER: - -=item GENERATING A REDIRECTION HEADER - -=item CREATING THE HTML DOCUMENT HEADER - -B, 4, 5, 6.. +=item Changing the BTREE sort order -=item ENDING THE HTML DOCUMENT: +=item Handling Duplicate Keys -=item CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION: +=item The get_dup() Method -=item OBTAINING THE SCRIPT'S URL +=item The find_dup() Method -B<-absolute>, B<-relative>, B<-full>, B<-path> (B<-path_info>), B<-query> -(B<-query_string>), B<-base> +=item The del_dup() Method -=item MIXING POST AND URL PARAMETERS +=item Matching Partial Keys =back -=item CREATING STANDARD HTML ELEMENTS: +=item DB_RECNO =over 4 -=item PROVIDING ARGUMENTS TO HTML SHORTCUTS - -=item THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS - -=item HTML SHORTCUTS AND LIST INTERPOLATION +=item The 'bval' Option -=item NON-STANDARD HTML SHORTCUTS +=item A Simple Example -=item AUTOESCAPING HTML +=item Extra RECNO Methods -$escaped_string = escapeHTML("unescaped string");, $charset = -charset([$charset]);, $flag = autoEscape([$flag]); +B<$X-Epush(list) ;>, B<$value = $X-Epop ;>, B<$X-Eshift>, +B<$X-Eunshift(list) ;>, B<$X-Elength>, B<$X-Esplice(offset, +length, elements);> -=item PRETTY-PRINTING HTML +=item Another Example =back -=item CREATING FILL-OUT FORMS: +=item THE API INTERFACE -=over 4 +B<$status = $X-Eget($key, $value [, $flags]) ;>, B<$status = +$X-Eput($key, $value [, $flags]) ;>, B<$status = $X-Edel($key [, +$flags]) ;>, B<$status = $X-Efd ;>, B<$status = $X-Eseq($key, +$value, $flags) ;>, B<$status = $X-Esync([$flags]) ;> -=item CREATING AN ISINDEX TAG +=item DBM FILTERS -=item STARTING AND ENDING A FORM +B, B, B, +B -B, B +=over 4 -=item CREATING A TEXT FIELD +=item The Filter -B +=item An Example -- the NULL termination problem. -=item CREATING A BIG TEXT FIELD +=item Another Example -- Key is a C int. -=item CREATING A PASSWORD FIELD +=back -=item CREATING A FILE UPLOAD FIELD +=item HINTS AND TIPS -B +=over 4 -=item CREATING A POPUP MENU +=item Locking: The Trouble with fd -=item CREATING A SCROLLING LIST +=item Safe ways to lock a database -B +B, B, B -=item CREATING A GROUP OF RELATED CHECKBOXES +=item Sharing Databases With C Applications -B +=item The untie() Gotcha -=item CREATING A STANDALONE CHECKBOX +=back -B +=item COMMON QUESTIONS -=item CREATING A RADIO BUTTON GROUP +=over 4 -B +=item Why is there Perl source in my database? -=item CREATING A SUBMIT BUTTON +=item How do I store complex data structures with DB_File? -B +=item What does "Invalid Argument" mean? -=item CREATING A RESET BUTTON +=item What does "Bareword 'DB_File' not allowed" mean? -=item CREATING A DEFAULT BUTTON +=back -=item CREATING A HIDDEN FIELD +=item REFERENCES -B +=item HISTORY -=item CREATING A CLICKABLE IMAGE BUTTON +=item BUGS -B, 3. The third option (-align, optional) is an alignment -type, and may be TOP, BOTTOM or MIDDLE +=item AVAILABILITY -=item CREATING A JAVASCRIPT ACTION BUTTON +=item COPYRIGHT -=back +=item SEE ALSO -=item HTTP COOKIES +=item AUTHOR -1. an expiration time, 2. a domain, 3. a path, 4. a "secure" flag, -B<-name>, B<-value>, B<-path>, B<-domain>, B<-expires>, B<-secure> +=back -=item WORKING WITH FRAMES +=head2 Data::Dumper - stringified perl data structures, suitable for both +printing and C -1. Create a document, 2. Specify the destination for the -document in the HTTP header, 3. Specify the destination for the document in -the tag +=over 4 -=item LIMITED SUPPORT FOR CASCADING STYLE SHEETS +=item SYNOPSIS -=item DEBUGGING +=item DESCRIPTION =over 4 -=item DUMPING OUT ALL THE NAME/VALUE PAIRS - -=back +=item Methods -=item FETCHING ENVIRONMENT VARIABLES +I->new(I, I), I<$OBJ>->Dump I +I->Dump(I, I), I<$OBJ>->Seen(I<[HASHREF]>), +I<$OBJ>->Values(I<[ARRAYREF]>), I<$OBJ>->Names(I<[ARRAYREF]>), +I<$OBJ>->Reset -B, B, B, B, -B, B, B Return the script -name as a partial URL, for self-refering scripts, B, B, B, B, B, -B, B, B, -B, B, B, B +=item Functions -=item USING NPH SCRIPTS +Dumper(I) -In the B statement, By calling the B method:, By using B<-nph> -parameters +=item Configuration Variables or Methods -=item Server Push +=item Exports -multipart_init(), multipart_start(), multipart_end(), multipart_final() +Dumper -=item Avoiding Denial of Service Attacks +=back -B<$CGI::POST_MAX>, B<$CGI::DISABLE_UPLOADS>, B<1. On a script-by-script -basis>, B<2. Globally for all scripts> +=item EXAMPLES -=item COMPATIBILITY WITH CGI-LIB.PL +=item BUGS -=item AUTHOR INFORMATION +=over 4 -=item CREDITS +=item NOTE -Matt Heffron (heffron@falstaff.css.beckman.com), James Taylor -(james.taylor@srs.gov), Scott Anguish , Mike Jewell -(mlj3u@virginia.edu), Timothy Shimmin (tes@kbs.citri.edu.au), Joergen Haegg -(jh@axis.se), Laurent Delfosse (delfosse@delfosse.com), Richard Resnick -(applepi1@aol.com), Craig Bishop (csb@barwonwater.vic.gov.au), Tony Curtis -(tc@vcpc.univie.ac.at), Tim Bunce (Tim.Bunce@ig.co.uk), Tom Christiansen -(tchrist@convex.com), Andreas Koenig (k@franz.ww.TU-Berlin.DE), Tim -MacKenzie (Tim.MacKenzie@fulcrum.com.au), Kevin B. Hendricks -(kbhend@dogwood.tyler.wm.edu), Stephen Dahmen (joyfire@inxpress.net), Ed -Jordan (ed@fidalgo.net), David Alan Pisoni (david@cnation.com), Doug -MacEachern (dougm@opengroup.org), Robin Houston (robin@oneworld.org), -...and many many more.. +=back -=item A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT +=item AUTHOR -=item BUGS +=item VERSION =item SEE ALSO =back -=head2 CGI::Apache - Backward compatibility module for CGI.pm +=head2 Devel::DProf - a Perl code profiler =over 4 =item SYNOPSIS -=item ABSTRACT - =item DESCRIPTION -=item AUTHOR INFORMATION +=item PROFILE FORMAT + +=item AUTOLOAD + +=item ENVIRONMENT =item BUGS @@ -8821,8 +11882,7 @@ MacEachern (dougm@opengroup.org), Robin Houston (robin@oneworld.org), =back -=head2 CGI::Carp, B - CGI routines for writing to the HTTPD (or -other) error log +=head2 Devel::PPPort - Perl/Pollution/Portability =over 4 @@ -8830,27 +11890,21 @@ other) error log =item DESCRIPTION -=item REDIRECTING ERROR MESSAGES - -=item MAKING PERL ERRORS APPEAR IN THE BROWSER WINDOW - =over 4 -=item Changing the default message +=item WriteFile =back -=item MAKING WARNINGS APPEAR AS HTML COMMENTS - -=item CHANGE LOG +=item ppport.h -=item AUTHORS +=item AUTHOR =item SEE ALSO =back -=head2 CGI::Cookie - Interface to Netscape Cookies +=head2 Devel::Peek - A data debugging tool for the XS programmer =over 4 @@ -8858,33 +11912,49 @@ other) error log =item DESCRIPTION -=item USING CGI::Cookie +=over 4 -B<1. expiration date>, B<2. domain>, B<3. path>, B<4. secure flag> +=item Runtime debugging + +=item Memory footprint debugging + +=back + +=item EXAMPLES =over 4 -=item Creating New Cookies +=item A simple scalar string -=item Sending the Cookie to the Browser +=item A simple scalar number -=item Recovering Previous Cookies +=item A simple scalar with an extra reference -=item Manipulating Cookies +=item A reference to a simple scalar -B, B, B, B, B +=item A reference to an array + +=item A reference to a hash + +=item Dumping a large array or hash + +=item A reference to an SV which holds a C pointer + +=item A reference to a subroutine =back -=item AUTHOR INFORMATION +=item EXPORTS =item BUGS +=item AUTHOR + =item SEE ALSO =back -=head2 CGI::Fast - CGI Interface for Fast CGI +=head2 Devel::SelfStubber - generate stubs for a SelfLoading module =over 4 @@ -8892,29 +11962,33 @@ B, B, B, B, B =item DESCRIPTION -=item OTHER PIECES OF THE PUZZLE - -=item WRITING FASTCGI PERL SCRIPTS +=back -=item INSTALLING FASTCGI SCRIPTS +=head2 Digest:: - Modules that calculate message digests -=item USING FASTCGI SCRIPTS AS CGI SCRIPTS +=over 4 -=item EXTERNAL FASTCGI SERVER INVOCATION +=item SYNOPSIS -FCGI_SOCKET_PATH, FCGI_LISTEN_QUEUE +=item DESCRIPTION -=item CAVEATS +I, I, I -=item AUTHOR INFORMATION +=item OO INTERFACE -=item BUGS +$ctx = Digest->XXX($arg,...), $ctx = Digest->new(XXX => $arg,...), $ctx = +Digest::XXX->new($arg,...), $other_ctx = $ctx->clone, $ctx->reset, +$ctx->add($data,...), $ctx->addfile($io_handle), $ctx->add_bits($data, +$nbits), $ctx->add_bits($bitstring), $ctx->digest, $ctx->hexdigest, +$ctx->b64digest =item SEE ALSO +=item AUTHOR + =back -=head2 CGI::Pretty - module to produce nicely formatted HTML code +=head2 Digest::MD5 - Perl interface to the MD5 Algorithm =over 4 @@ -8922,23 +11996,39 @@ FCGI_SOCKET_PATH, FCGI_LISTEN_QUEUE =item DESCRIPTION -=over 4 +=item FUNCTIONS -=item Tags that won't be formatted +md5($data,...), md5_hex($data,...), md5_base64($data,...) -=item Customizing the Indenting +=item METHODS + +$md5 = Digest::MD5->new, $md5->reset, $md5->clone, $md5->add($data,...), +$md5->addfile($io_handle), $md5->add_bits($data, $nbits), +$md5->add_bits($bitstring), $md5->digest, $md5->hexdigest, $md5->b64digest + +=item EXAMPLES + +=item SEE ALSO + +=item COPYRIGHT + +=item AUTHORS =back -=item BUGS +=head2 Digest::base - Digest base class -=item AUTHOR +=over 4 + +=item SYNPOSIS + +=item DESCRIPTION =item SEE ALSO =back -=head2 CGI::Push - Simple Interface to Server Push +=head2 DirHandle - supply object methods for directory handles =over 4 @@ -8946,47 +12036,56 @@ FCGI_SOCKET_PATH, FCGI_LISTEN_QUEUE =item DESCRIPTION -=item USING CGI::Push +=item NOTES --next_page, -last_page, -type, -delay, -cookie, -target, -expires, -nph +=back + +=head2 Dumpvalue - provides screen dump of Perl data. =over 4 -=item Heterogeneous Pages +=item SYNOPSIS -=item Changing the Page Delay on the Fly +=item DESCRIPTION -=back +=over 4 -=item INSTALLING CGI::Push SCRIPTS +=item Creation -=item AUTHOR INFORMATION +C, C, C, C, C, +C, C, C, C, C, +C, C, unctrl, subdump, bareStringify, quoteHighBit, +stopDbSignal -=item BUGS +=item Methods -=item SEE ALSO +dumpValue, dumpValues, stringify, dumpvars, set_quote, set_unctrl, +compactDump, veryCompact, set, get =back -=head2 CGI::Switch - Backward compatibility module for defunct CGI::Switch +=back + +=head2 DynaLoader - Dynamically load C libraries into Perl code =over 4 =item SYNOPSIS -=item ABSTRACT - =item DESCRIPTION -=item AUTHOR INFORMATION - -=item BUGS +@dl_library_path, @dl_resolve_using, @dl_require_symbols, @dl_librefs, +@dl_modules, dl_error(), $dl_debug, dl_findfile(), dl_expandspec(), +dl_load_file(), dl_unload_file(), dl_load_flags(), dl_find_symbol(), +dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), +bootstrap() -=item SEE ALSO +=item AUTHOR =back -=head2 CGI::Util - Internal utilities used by CGI module +=head2 DynaLoader::XSLoader, XSLoader - Dynamically load C libraries into +Perl code =over 4 @@ -8994,131 +12093,137 @@ FCGI_SOCKET_PATH, FCGI_LISTEN_QUEUE =item DESCRIPTION -=item AUTHOR INFORMATION +=over 4 -=item SEE ALSO +=item Migration from C + +=item Backward compatible boilerplate =back -=head2 CPAN - query, download and build perl modules from CPAN sites +=item Order of initialization: early load() =over 4 -=item SYNOPSIS +=item The most hairy case -=item DESCRIPTION +=back + +=item LIMITATIONS + +=item AUTHOR + +=back + +=head2 Encode - character encodings =over 4 -=item Interactive Mode +=item SYNOPSIS -Searching for authors, bundles, distribution files and modules, make, test, -install, clean modules or distributions, get, readme, look module or -distribution, ls author, Signals +=over 4 + +=item Table of Contents + +=back + +=item DESCRIPTION -=item CPAN::Shell +=over 4 -=item autobundle +=item TERMINOLOGY -=item recompile +=back -=item The four C Classes: Author, Bundle, Module, Distribution +=item PERL ENCODING API -=item Programmer's interface +$octets = encode(ENCODING, $string [, CHECK]), $string = decode(ENCODING, +$octets [, CHECK]), [$length =] from_to($octets, FROM_ENC, TO_ENC [, +CHECK]), $octets = encode_utf8($string);, $string = decode_utf8($octets [, +CHECK]); -expand($type,@things), expandany(@things), Programming Examples +=over 4 -=item Methods in the other Classes +=item Listing available encodings -CPAN::Author::as_glimpse(), CPAN::Author::as_string(), -CPAN::Author::email(), CPAN::Author::fullname(), CPAN::Author::name(), -CPAN::Bundle::as_glimpse(), CPAN::Bundle::as_string(), -CPAN::Bundle::clean(), CPAN::Bundle::contains(), -CPAN::Bundle::force($method,@args), CPAN::Bundle::get(), -CPAN::Bundle::inst_file(), CPAN::Bundle::inst_version(), -CPAN::Bundle::uptodate(), CPAN::Bundle::install(), CPAN::Bundle::make(), -CPAN::Bundle::readme(), CPAN::Bundle::test(), -CPAN::Distribution::as_glimpse(), CPAN::Distribution::as_string(), -CPAN::Distribution::clean(), CPAN::Distribution::containsmods(), -CPAN::Distribution::cvs_import(), CPAN::Distribution::dir(), -CPAN::Distribution::force($method,@args), CPAN::Distribution::get(), -CPAN::Distribution::install(), CPAN::Distribution::isa_perl(), -CPAN::Distribution::look(), CPAN::Distribution::make(), -CPAN::Distribution::prereq_pm(), CPAN::Distribution::readme(), -CPAN::Distribution::test(), CPAN::Distribution::uptodate(), -CPAN::Index::force_reload(), CPAN::Index::reload(), CPAN::InfoObj::dump(), -CPAN::Module::as_glimpse(), CPAN::Module::as_string(), -CPAN::Module::clean(), CPAN::Module::cpan_file(), -CPAN::Module::cpan_version(), CPAN::Module::cvs_import(), -CPAN::Module::description(), CPAN::Module::force($method,@args), -CPAN::Module::get(), CPAN::Module::inst_file(), -CPAN::Module::inst_version(), CPAN::Module::install(), -CPAN::Module::look(), CPAN::Module::make(), -CPAN::Module::manpage_headline(), CPAN::Module::readme(), -CPAN::Module::test(), CPAN::Module::uptodate(), CPAN::Module::userid() +=item Defining Aliases -=item Cache Manager +=back -=item Bundles +=item Encoding via PerlIO -=item Prerequisites +=item Handling Malformed Data -=item Finding packages and VERSION +I = Encode::FB_DEFAULT ( == 0), I = Encode::FB_CROAK ( == 1), +I = Encode::FB_QUIET, I = Encode::FB_WARN, perlqq mode +(I = Encode::FB_PERLQQ), HTML charref mode (I = +Encode::FB_HTMLCREF), XML charref mode (I = Encode::FB_XMLCREF), The +bitmask -=item Debugging +=over 4 -=item Floppy, Zip, Offline Mode +=item Unimplemented fallback schemes =back -=item CONFIGURATION +=item Defining Encodings -Cscalar optionE>, Cscalar optionE -EvalueE>, Clist optionE>, Clist -optionE [shift|pop]>, Clist optionE -[unshift|push|splice] ElistE> +=item The UTF-8 flag + +Goal #1:, Goal #2:, Goal #3:, Goal #4: =over 4 -=item Note on urllist parameter's format +=item Messing with Perl's Internals -=item urllist parameter has CD-ROM support +is_utf8(STRING [, CHECK]), _utf8_on(STRING), _utf8_off(STRING) =back -=item SECURITY +=item SEE ALSO -=item EXPORT +=item MAINTAINER -=item POPULATE AN INSTALLATION WITH LOTS OF MODULES +=back -=item WORKING WITH CPAN.pm BEHIND FIREWALLS +=head2 Encode::Alias - alias definitions to encodings =over 4 -=item Three basic types of firewalls +=item SYNOPSIS -http firewall, ftp firewall, One way visibility, SOCKS, IP Masquerade +=item DESCRIPTION -=item Configuring lynx or ncftp for going through a firewall +As a simple string, As a qr// compiled regular expression, e.g.:, As a code +reference, e.g.: + +=over 4 + +=item Alias overloading =back -=item FAQ +=item SEE ALSO -1), 2), 3), 4), 5), 6), 7), 8), 9), 10) +=back -=item BUGS +=head2 Encode::Byte - Single Byte Encodings -=item AUTHOR +=over 4 -=item TRANSLATIONS +=item SYNOPSIS + +=item ABSTRACT + +=item DESCRIPTION =item SEE ALSO =back -=head2 CPAN::FirstTime - Utility for CPAN::Config file Initialization +=head2 Encode::CJKConstants -- Internally used by Encode::??::ISO_2022_* + +=head2 Encode::CN - China-based Chinese Encodings =over 4 @@ -9126,22 +12231,33 @@ http firewall, ftp firewall, One way visibility, SOCKS, IP Masquerade =item DESCRIPTION +=item NOTES + +=item BUGS + +=item SEE ALSO + =back -=head2 CPANox, CPAN::Nox - Wrapper around CPAN.pm without using any XS -module +=head2 Encode::CN::HZ -- internally used by Encode::CN + +=head2 Encode::Config -- internally used by Encode + +=head2 Encode::EBCDIC - EBCDIC Encodings =over 4 =item SYNOPSIS +=item ABSTRACT + =item DESCRIPTION -=item SEE ALSO +=item SEE ALSO =back -=head2 Carp, carp - warn of errors (from perspective of caller) +=head2 Encode::Encoding - Encode Implementation Base Class =over 4 @@ -9151,422 +12267,318 @@ module =over 4 -=item Forcing a Stack Trace +=item Methods you should implement + +-Eencode($string [,$check]), -Edecode($octets [,$check]), +-Ecat_decode($destination, $octets, $offset, $terminator [,$check]) + +=item Other methods defined in Encode::Encodings + +-Ename, -Erenew, -Eperlio_ok(), -Eneeds_lines() + +=item Example: Encode::ROT13 =back -=item BUGS +=item Why the heck Encode API is different? + +=over 4 + +=item Compiled Encodings =back -=head2 Carp::Heavy, Carp heavy machinery - no user serviceable parts inside +=item SEE ALSO -=head2 Class::ISA -- report the search path for a class's ISA tree +Scheme 1, Scheme 2, Other Schemes + +=back + +=head2 Encode::Guess -- Guesses encoding from data =over 4 =item SYNOPSIS -=item DESCRIPTION +=item ABSTRACT -=item FUNCTIONS +=item DESCRIPTION -the function Class::ISA::super_path($CLASS), the function -Class::ISA::self_and_super_path($CLASS), the function -Class::ISA::self_and_super_versions($CLASS) +Encode::Guess->set_suspects, Encode::Guess->add_suspects, +Encode::decode("Guess" ...), Encode::Guess->guess($data), +guess_encoding($data, [, I]) -=item CAUTIONARY NOTES +=item CAVEATS -=item COPYRIGHT +=item TO DO -=item AUTHOR +=item SEE ALSO =back -=head2 Class::Struct - declare struct-like datatypes as Perl classes +=head2 Encode::JP - Japanese Encodings =over 4 =item SYNOPSIS +=item ABSTRACT + =item DESCRIPTION -=over 4 +=item Note on ISO-2022-JP(-1)? -=item The C function +=item BUGS -=item Class Creation at Compile Time +=item SEE ALSO -=item Element Types and Accessor Methods +=back -Scalar (C<'$'> or C<'*$'>), Array (C<'@'> or C<'*@'>), Hash (C<'%'> or -C<'*%'>), Class (C<'Class_Name'> or C<'*Class_Name'>) +=head2 Encode::JP::H2Z -- internally used by Encode::JP::2022_JP* -=item Initializing with C +=head2 Encode::JP::JIS7 -- internally used by Encode::JP -=back +=head2 Encode::KR - Korean Encodings -=item EXAMPLES +=over 4 -Example 1, Example 2, Example 3 +=item SYNOPSIS -=item Author and Modification History +=item DESCRIPTION + +=item BUGS + +=item SEE ALSO =back -=head2 Config - access Perl configuration information +=head2 Encode::KR::2022_KR -- internally used by Encode::KR + +=head2 Encode::MIME::Header -- MIME 'B' and 'Q' header encoding =over 4 =item SYNOPSIS +=item ABSTRACT + =item DESCRIPTION -myconfig(), config_sh(), config_vars(@names) +=item BUGS -=item EXAMPLE +=item SEE ALSO -=item WARNING +=back -=item GLOSSARY +=head2 Encode::PerlIO -- a detailed document on Encode and PerlIO =over 4 -=item _ +=item Overview -C<_a>, C<_exe>, C<_o> +=item How does it work? -=item a +=item Line Buffering -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, C, -C +=over 4 -=item b +=item How can I tell whether my encoding fully supports PerlIO ? -C, C, C, C, C, C, -C, C +=back -=item c +=item SEE ALSO -C, C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C +=back -=item d +=head2 Encode::Supported -- Encodings supported by Encode -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, -C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, -C, C, C, C, C, -C, C, C +=over 4 -=item e +=item DESCRIPTION -C, C, C, C, C, C, -C, C, C, C +=over 4 -=item f +=item Encoding Names -C, C, C, C, C, -C, C, C, C, C, C, -C +=back -=item g +=item Supported Encodings -C, C, C, C, C, -C, C, C, C, C, C +=over 4 -=item h +=item Built-in Encodings -C, C, C, C +=item Encode::Unicode -- other Unicode encodings -=item i +=item Encode::Byte -- Extended ASCII -C, C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, -C, C, C, -C, C, C, C, C, -C, C, C, -C, C, C, C, -C, C, C, -C, C, C, C, -C, C, C, C +ISO-8859 and corresponding vendor mappings, KOI8 - De Facto Standard for +the Cyrillic world, gsm0338 - Hentai Latin 1 -=item k +=item CJK: Chinese, Japanese, Korean (Multibyte) -C, C +Encode::CN -- Continental China, Encode::JP -- Japan, Encode::KR -- Korea, +Encode::TW -- Taiwan, Encode::HanExtra -- More Chinese via CPAN, +Encode::JIS2K -- JIS X 0213 encodings via CPAN -=item l +=item Miscellaneous encodings -C, C, C, C, C, -C, C, C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C +Encode::EBCDIC, Encode::Symbols, Encode::MIME::Header, Encode::Guess -=item m +=back -C, C, C, C, C, C, -C, C, C, C, C, -C, C +=item Unsupported encodings -=item M + ISO-2022-JP-2 [RFC1554], ISO-2022-CN [RFC1922], Various HP-UX encodings, +Cyrillic encoding ISO-IR-111, ISO-8859-8-1 [Hebrew], ISIRI 3342, Iran +System, ISIRI 2900 [Farsi], Thai encoding TCVN, Vietnamese encodings VPS, +Various Mac encodings, (Mac) Indic encodings -C, C, C, C, C, C, -C, C, C, C, C, C +=item Encoding vs. Charset -- terminology -=item n +=item Encoding Classification (by Anton Tagunov and Dan Kogai) -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C +=over 4 -=item o +=item Microsoft-related naming mess -C, C, C, C, -C, C, C, C +KS_C_5601-1987, GB2312, Big5, Shift_JIS + +=back + +=item Glossary -=item p +character repertoire, coded character set (CCS), character encoding scheme +(CES), charset (in MIME context), EUC, ISO-2022, UCS, UCS-2, Unicode, UTF, +UTF-16 -C, C, C, C, C, C, -C, C +=item See Also -=item P +=item References -C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, C, -C, C, C +ECMA, ECMA-035 (eq C), IANA, Assigned Charset Names by IANA, ISO, +RFC, UC, Unicode Glossary -=item q +=over 4 -C, C +=item Other Notable Sites -=item r +czyborra.com, CJK.inf, Jungshik Shin's Hangul FAQ, debian.org: +"Introduction to i18n" -C, C, C, C, C, -C, C, C, C, C +=item Offline sources -=item s +C by Ken Lunde -C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, C +=back -=item t +=back -C, C, C, C, C, C, C, -C, C, C, C, C, C +=head2 Encode::Symbol - Symbol Encodings -=item u +=over 4 -C, C, C, C, C, C, -C, C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, -C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C +=item SYNOPSIS -=item v +=item ABSTRACT -C, C, C, C, -C, C, C, C, -C, C, C, -C, C, C +=item DESCRIPTION -=item x +=item SEE ALSO -C, C +=back -=item y +=head2 Encode::TW - Taiwan-based Chinese Encodings -C, C +=over 4 -=item z +=item SYNOPSIS -C, C +=item DESCRIPTION -=back +=item NOTES -=item NOTE +=item BUGS + +=item SEE ALSO =back -=head2 Cwd - get pathname of current working directory +=head2 Encode::Unicode -- Various Unicode Transformation Formats =over 4 =item SYNOPSIS -=item DESCRIPTION +=item ABSTRACT -=over 4 +L says:, Quick Reference -=item getcwd and friends +=item Size, Endianness, and BOM -getcwd, cwd, fastcwd, fastgetcwd +=over 4 -=item abs_path and friends +=item by size -abs_path, realpath, fast_abs_path +=item by endianness -=item $ENV{PWD} +BOM as integer when fetched in network byte order =back -=item NOTES +=item Surrogate Pairs =item SEE ALSO =back -=head2 DB - programmatic interface to the Perl debugging API (draft, -subject to -change) +=head2 Encode::Unicode::UTF7 -- UTF-7 encoding =over 4 =item SYNOPSIS -=item DESCRIPTION +=item ABSTRACT + +=item In Practice + +=item SEE ALSO + +=back + +=head2 Encode::lib::Encode::Alias, Encode::Alias - alias definitions to +encodings =over 4 -=item Global Variables +=item SYNOPSIS - $DB::sub, %DB::sub, $DB::single, $DB::signal, $DB::trace, @DB::args, -@DB::dbline, %DB::dbline, $DB::package, $DB::filename, $DB::subname, -$DB::lineno +=item DESCRIPTION -=item API Methods +As a simple string, As a qr// compiled regular expression, e.g.:, As a code +reference, e.g.: -CLIENT->register(), CLIENT->evalcode(STRING), CLIENT->skippkg('D::hide'), -CLIENT->run(), CLIENT->step(), CLIENT->next(), CLIENT->done() +=over 4 -=item Client Callback Methods +=item Alias overloading -CLIENT->init(), CLIENT->prestop([STRING]), CLIENT->stop(), CLIENT->idle(), -CLIENT->poststop([STRING]), CLIENT->evalcode(STRING), CLIENT->cleanup(), -CLIENT->output(LIST) +=back + +=item SEE ALSO =back -=item BUGS +=head2 Encode::lib::Encode::CJKConstants, Encode::CJKConstants.pm -- +Internally used by Encode::??::ISO_2022_* -=item AUTHOR +=head2 Encode::lib::Encode::CN::HZ, Encode::CN::HZ -- internally used by +Encode::CN -=back +=head2 Encode::lib::Encode::Config, Encode::Config -- internally used by +Encode -=head2 DB_File - Perl5 access to Berkeley DB version 1.x +=head2 Encode::lib::Encode::Encoding, Encode::Encoding - Encode +Implementation Base Class =over 4 @@ -9574,293 +12586,325 @@ CLIENT->output(LIST) =item DESCRIPTION -B, B, B - =over 4 -=item Using DB_File with Berkeley DB version 2 or greater +=item Methods you should implement -=item Interface to Berkeley DB +-Eencode($string [,$check]), -Edecode($octets [,$check]), +-Ecat_decode($destination, $octets, $offset, $terminator [,$check]) -=item Opening a Berkeley DB Database File +=item Other methods defined in Encode::Encodings -=item Default Parameters +-Ename, -Erenew, -Eperlio_ok(), -Eneeds_lines() -=item In Memory Databases +=item Example: Encode::ROT13 =back -=item DB_HASH +=item Why the heck Encode API is different? =over 4 -=item A Simple Example +=item Compiled Encodings =back -=item DB_BTREE +=item SEE ALSO + +Scheme 1, Scheme 2, Other Schemes + +=back + +=head2 Encode::lib::Encode::Guess, Encode::Guess -- Guesses encoding from +data =over 4 -=item Changing the BTREE sort order +=item SYNOPSIS -=item Handling Duplicate Keys +=item ABSTRACT -=item The get_dup() Method +=item DESCRIPTION -=item The find_dup() Method +Encode::Guess->set_suspects, Encode::Guess->add_suspects, +Encode::decode("Guess" ...), Encode::Guess->guess($data), +guess_encoding($data, [, I]) -=item The del_dup() Method +=item CAVEATS -=item Matching Partial Keys +=item TO DO + +=item SEE ALSO =back -=item DB_RECNO +=head2 Encode::lib::Encode::JP::H2Z, Encode::JP::H2Z -- internally used by +Encode::JP::2022_JP* + +=head2 Encode::lib::Encode::JP::JIS7, Encode::JP::JIS7 -- internally used +by Encode::JP + +=head2 Encode::lib::Encode::KR::2022_KR, Encode::KR::2022_KR -- internally +used by Encode::KR + +=head2 Encode::lib::Encode::MIME::Header, Encode::MIME::Header -- MIME 'B' +and 'Q' header encoding =over 4 -=item The 'bval' Option +=item SYNOPSIS -=item A Simple Example +=item ABSTRACT -=item Extra RECNO Methods +=item DESCRIPTION -B<$X-Epush(list) ;>, B<$value = $X-Epop ;>, B<$X-Eshift>, -B<$X-Eunshift(list) ;>, B<$X-Elength>, B<$X-Esplice(offset, -length, elements);> +=item BUGS -=item Another Example +=item SEE ALSO =back -=item THE API INTERFACE +=head2 Encode::lib::Encode::PerlIO, Encode::PerlIO -- a detailed document +on Encode and PerlIO -B<$status = $X-Eget($key, $value [, $flags]) ;>, B<$status = -$X-Eput($key, $value [, $flags]) ;>, B<$status = $X-Edel($key [, -$flags]) ;>, B<$status = $X-Efd ;>, B<$status = $X-Eseq($key, -$value, $flags) ;>, B<$status = $X-Esync([$flags]) ;> +=over 4 -=item DBM FILTERS +=item Overview -B, B, B, -B +=item How does it work? + +=item Line Buffering =over 4 -=item The Filter +=item How can I tell whether my encoding fully supports PerlIO ? -=item An Example -- the NULL termination problem. +=back -=item Another Example -- Key is a C int. +=item SEE ALSO =back -=item HINTS AND TIPS +=head2 Encode::lib::Encode::Supported, Encode::Supported -- Encodings +supported by Encode =over 4 -=item Locking: The Trouble with fd - -=item Safe ways to lock a database - -B, B, B +=item DESCRIPTION -=item Sharing Databases With C Applications +=over 4 -=item The untie() Gotcha +=item Encoding Names =back -=item COMMON QUESTIONS +=item Supported Encodings =over 4 -=item Why is there Perl source in my database? - -=item How do I store complex data structures with DB_File? +=item Built-in Encodings -=item What does "Invalid Argument" mean? +=item Encode::Unicode -- other Unicode encodings -=item What does "Bareword 'DB_File' not allowed" mean? +=item Encode::Byte -- Extended ASCII -=back +ISO-8859 and corresponding vendor mappings, KOI8 - De Facto Standard for +the Cyrillic world, gsm0338 - Hentai Latin 1 -=item REFERENCES +=item CJK: Chinese, Japanese, Korean (Multibyte) -=item HISTORY +Encode::CN -- Continental China, Encode::JP -- Japan, Encode::KR -- Korea, +Encode::TW -- Taiwan, Encode::HanExtra -- More Chinese via CPAN, +Encode::JIS2K -- JIS X 0213 encodings via CPAN -=item BUGS +=item Miscellaneous encodings -=item AVAILABILITY +Encode::EBCDIC, Encode::Symbols, Encode::MIME::Header, Encode::Guess -=item COPYRIGHT +=back -=item SEE ALSO +=item Unsupported encodings -=item AUTHOR + ISO-2022-JP-2 [RFC1554], ISO-2022-CN [RFC1922], Various HP-UX encodings, +Cyrillic encoding ISO-IR-111, ISO-8859-8-1 [Hebrew], ISIRI 3342, Iran +System, ISIRI 2900 [Farsi], Thai encoding TCVN, Vietnamese encodings VPS, +Various Mac encodings, (Mac) Indic encodings -=back +=item Encoding vs. Charset -- terminology -=head2 Data::Dumper - stringified perl data structures, suitable for both -printing and C +=item Encoding Classification (by Anton Tagunov and Dan Kogai) =over 4 -=item SYNOPSIS +=item Microsoft-related naming mess -=item DESCRIPTION +KS_C_5601-1987, GB2312, Big5, Shift_JIS -=over 4 +=back -=item Methods +=item Glossary -I->new(I, I), I<$OBJ>->Dump I -I->Dump(I, I), I<$OBJ>->Seen(I<[HASHREF]>), -I<$OBJ>->Values(I<[ARRAYREF]>), I<$OBJ>->Names(I<[ARRAYREF]>), -I<$OBJ>->Reset +character repertoire, coded character set (CCS), character encoding scheme +(CES), charset (in MIME context), EUC, ISO-2022, UCS, UCS-2, Unicode, UTF, +UTF-16 -=item Functions +=item See Also -Dumper(I) +=item References -=item Configuration Variables or Methods +ECMA, ECMA-035 (eq C), IANA, Assigned Charset Names by IANA, ISO, +RFC, UC, Unicode Glossary -$Data::Dumper::Indent I I<$OBJ>->Indent(I<[NEWVAL]>), -$Data::Dumper::Purity I I<$OBJ>->Purity(I<[NEWVAL]>), -$Data::Dumper::Pad I I<$OBJ>->Pad(I<[NEWVAL]>), -$Data::Dumper::Varname I I<$OBJ>->Varname(I<[NEWVAL]>), -$Data::Dumper::Useqq I I<$OBJ>->Useqq(I<[NEWVAL]>), -$Data::Dumper::Terse I I<$OBJ>->Terse(I<[NEWVAL]>), -$Data::Dumper::Freezer I $I->Freezer(I<[NEWVAL]>), -$Data::Dumper::Toaster I $I->Toaster(I<[NEWVAL]>), -$Data::Dumper::Deepcopy I $I->Deepcopy(I<[NEWVAL]>), -$Data::Dumper::Quotekeys I $I->Quotekeys(I<[NEWVAL]>), -$Data::Dumper::Bless I $I->Bless(I<[NEWVAL]>), -$Data::Dumper::Maxdepth I $I->Maxdepth(I<[NEWVAL]>), -$Data::Dumper::Useperl I $I->Useperl(I<[NEWVAL]>), -$Data::Dumper::Sortkeys I $I->Sortkeys(I<[NEWVAL]>), -$Data::Dumper::Deparse I $I->Deparse(I<[NEWVAL]>) +=over 4 -=item Exports +=item Other Notable Sites -Dumper +czyborra.com, CJK.inf, Jungshik Shin's Hangul FAQ, debian.org: +"Introduction to i18n" + +=item Offline sources + +C by Ken Lunde =back -=item EXAMPLES +=back -=item BUGS +=head2 Encode::lib::Encode::Unicode::UTF7, Encode::Unicode::UTF7 -- UTF-7 +encoding -=item AUTHOR +=over 4 -=item VERSION +=item SYNOPSIS + +=item ABSTRACT + +=item In Practice =item SEE ALSO =back -=head2 Devel::DProf - a Perl code profiler +=head2 Encode::lib::Encoder, Encode::Encoder -- Object Oriented Encoder =over 4 =item SYNOPSIS -=item DESCRIPTION +=item ABSTRACT -=item PROFILE FORMAT +=item Description -=item AUTOLOAD +=over 4 -=item ENVIRONMENT +=item Predefined Methods -=item BUGS +$e = Encode::Encoder-Enew([$data, $encoding]);, encoder(), +$e-Edata([$data]), $e-Eencoding([$encoding]), +$e-Ebytes([$encoding]) + +=item Example: base64 transcoder + +=item Operator Overloading + +=back =item SEE ALSO =back -=head2 Devel::Peek - A data debugging tool for the XS programmer +=head2 Encodencoding, encoding - allows you to write your script in +non-ascii or non-utf8 =over 4 =item SYNOPSIS -=item DESCRIPTION +=item ABSTRACT =over 4 -=item Memory footprint debugging +=item Literal Conversions + +=item PerlIO layers for C + +=item Implicit upgrading for byte strings =back -=item EXAMPLES +=item FEATURES THAT REQUIRE 5.8.1 -=over 4 +"NON-EUC" doublebyte encodings, tr//, DATA pseudo-filehandle -=item A simple scalar string +=item USAGE -=item A simple scalar number +use encoding [I] ;, use encoding I [ STDIN =E +I ...] ;, use encoding I Filter=E1;, no encoding; -=item A simple scalar with an extra reference +=item The Filter Option -=item A reference to a simple scalar +=over 4 -=item A reference to an array +=item Filter-related changes at Encode version 1.87 -=item A reference to a hash +=back -=item Dumping a large array or hash +=item CAVEATS -=item A reference to an SV which holds a C pointer +=over 4 -=item A reference to a subroutine +=item NOT SCOPED + +=item DO NOT MIX MULTIPLE ENCODINGS + +=item tr/// with ranges + +Legend of characters above =back -=item EXPORTS +=item EXAMPLE - Greekperl -=item BUGS +=item KNOWN PROBLEMS -=item AUTHOR +literals in regex that are longer than 127 bytes, EBCDIC, format + +=item HISTORY =item SEE ALSO =back -=head2 Devel::SelfStubber - generate stubs for a SelfLoading module +=head2 Encoder, Encode::Encoder -- Object Oriented Encoder =over 4 =item SYNOPSIS -=item DESCRIPTION - -=back +=item ABSTRACT -=head2 Digest:: - Modules that calculate message digests +=item Description =over 4 -=item SYNOPSIS +=item Predefined Methods -=item DESCRIPTION +$e = Encode::Encoder-Enew([$data, $encoding]);, encoder(), +$e-Edata([$data]), $e-Eencoding([$encoding]), +$e-Ebytes([$encoding]) -I, I, I +=item Example: base64 transcoder -=item OO INTERFACE +=item Operator Overloading -$ctx = Digest->XXX($arg,...), $ctx = Digest->new(XXX => $arg,...), $ctx = -Digest::XXX->new($arg,...), $ctx->reset, $ctx->add($data,...), -$ctx->addfile($io_handle), $ctx->digest, $ctx->hexdigest, $ctx->b64digest +=back =item SEE ALSO -=item AUTHOR - =back -=head2 Digest::MD5 - Perl interface to the MD5 Algorithm +=head2 English - use nice English (or awk) names for ugly punctuation +variables =over 4 @@ -9868,26 +12912,26 @@ $ctx->addfile($io_handle), $ctx->digest, $ctx->hexdigest, $ctx->b64digest =item DESCRIPTION -=item FUNCTIONS +=item PERFORMANCE -md5($data,...), md5_hex($data,...), md5_base64($data,...) +=back -=item METHODS +=head2 Env - perl module that imports environment variables as scalars or +arrays -$md5 = Digest::MD5->new, $md5->reset, $md5->add($data,...), -$md5->addfile($io_handle), $md5->digest, $md5->hexdigest, $md5->b64digest +=over 4 -=item EXAMPLES +=item SYNOPSIS -=item SEE ALSO +=item DESCRIPTION -=item COPYRIGHT +=item LIMITATIONS -=item AUTHORS +=item AUTHOR =back -=head2 DirHandle - supply object methods for directory handles +=head2 Errno - System errno constants =over 4 @@ -9895,11 +12939,15 @@ $md5->addfile($io_handle), $md5->digest, $md5->hexdigest, $md5->b64digest =item DESCRIPTION -=item NOTES +=item CAVEATS + +=item AUTHOR + +=item COPYRIGHT =back -=head2 Dumpvalue - provides screen dump of Perl data. +=head2 Exporter - Implements default import method for modules =over 4 @@ -9909,42 +12957,41 @@ $md5->addfile($io_handle), $md5->digest, $md5->hexdigest, $md5->b64digest =over 4 -=item Creation - -C, C, C, C, C, -C, C, C, C, C, -C, C, unctrl, subdump, bareStringify, quoteHighBit, -stopDbSignal +=item How to Export -=item Methods +=item Selecting What To Export -dumpValue, dumpValues, dumpvars, set_quote, set_unctrl, compactDump, -veryCompact, set, get +=item How to Import -=back +C, C, C =back -=head2 DynaLoader - Dynamically load C libraries into Perl code +=item Advanced features =over 4 -=item SYNOPSIS +=item Specialised Import Lists -=item DESCRIPTION +=item Exporting without using Exporter's import method -@dl_library_path, @dl_resolve_using, @dl_require_symbols, @dl_librefs, -@dl_modules, dl_error(), $dl_debug, dl_findfile(), dl_expandspec(), -dl_load_file(), dl_unload_file(), dl_loadflags(), dl_find_symbol(), -dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), -bootstrap() +=item Exporting without inheriting from Exporter -=item AUTHOR +=item Module Version Checking + +=item Managing Unknown Symbols + +=item Tag Handling Utility Functions + +=item Generating combined tags + +=item Ced Constants =back -=head2 DynaLoader::XSLoader, XSLoader - Dynamically load C libraries into -Perl code +=back + +=head2 Exporter::Heavy - Exporter guts =over 4 @@ -9952,11 +12999,10 @@ Perl code =item DESCRIPTION -=item AUTHOR - =back -=head2 Encode - character encodings +=head2 ExtUtils::Command - utilities to replace common UNIX commands in +Makefiles etc. =over 4 @@ -9964,121 +13010,115 @@ Perl code =item DESCRIPTION -=over 4 - -=item TERMINOLOGY - =back -=item ENCODINGS +cat -=over 4 +eqtime src dst -=item Characteristics of an Encoding +rm_rf files... -=item Types of Encodings +rm_f files... -Fixed length 8-bit (or less) encodings, Fixed length 16-bit encodings, -Fixed length 32-bit encodings, Multi-byte encodings, "Escape" encodings +touch files .. -=item Specifying Encodings +mv source... destination -1. By name, 2. As an object +cp source... destination -=item Encoding Names +chmod mode files.. -The MIME name as defined in IETF RFCs, The name in the IANA registry, The -name used by the organization that defined it +mkpath directory.. -=back +test_f file -=item PERL ENCODING API +dos2unix =over 4 -=item Generic Encoding Interface +=item BUGS -=item Handling Malformed Data +=item SEE ALSO -Scheme 1, Scheme 2, Other Schemes +=item AUTHOR -=item UTF-8 / utf8 +=back -=item Other Encodings of Unicode +=head2 ExtUtils::Command::MM - Commands for the MM's to use in Makefiles -=item Listing available encodings +=over 4 -=item Defining Aliases +=item SYNOPSIS -As a simple string, As a qr// compiled regular expression, e.g.:, As a code -reference, e.g.: +=item DESCRIPTION -=item Defining Encodings +B =back -=item Encoding and IO +B -=item Encoding How to ... +B -IO with mixed content (faking iso-2020-*), MIME's Content-Length:, UTF-8 -strings in binary data, Perl/Encode wrappers on non-Unicode XS modules +B -=item Messing with Perl's Internals +B + +=head2 ExtUtils::Constant - generate XS code to import C header constants -is_utf8(STRING [, CHECK]), valid_utf8(STRING) +=over 4 -=item IMPLEMENTATION CLASSES +=item SYNOPSIS --Ename, -Enew_sequence, -Eencode($string,$check), --Edecode($octets,$check) +=item DESCRIPTION -=over 4 +=item USAGE -=item Compiled Encodings +IV, UV, NV, PV, PVN, SV, YES, NO, UNDEF -.enc, .ucm, .ucm, .c, .xs, ascii and iso-8859-*, IBM-1047 and two other -variants of EBCDIC, symbol and dingbats as used by Tk on X11 +=item FUNCTIONS =back -=item SEE ALSO +C_stringify NAME -=back +perl_stringify NAME -=head2 Encode::EncodeFormat, EncodeFormat - the format of encoding tables -of the Encode extension +constant_types -=over 4 +memEQ_clause NAME, CHECKED_AT, INDENT -=item DESCRIPTION +assign INDENT, TYPE, PRE, POST, VALUE.. -[1] B, [2] B, [3] B, [4] B +return_clause -=item KEYWORDS +switch_clause INDENT, NAMELEN, ITEMHASH, ITEM.. -=item COPYRIGHT +params WHAT -=back +dump_names -=head2 Encode::Tcl - Tcl encodings +dogfood -=head2 EncodeFormat - the format of encoding tables of the Encode extension +C_constant, name, type, value, macro, default, pre, post, def_pre =item +def_post, utf8 -=over 4 +XS_constant PACKAGE, TYPES, SUBNAME, C_SUBNAME -=item DESCRIPTION +autoload PACKAGE, VERSION, AUTOLOADER -[1] B, [2] B, [3] B, [4] B +WriteMakefileSnippet -=item KEYWORDS +WriteConstants ATTRIBUTE =E VALUE [, ...], NAME, DEFAULT_TYPE, +BREAKOUT_AT, NAMES, C_FILE, XS_FILE, SUBNAME, C_SUBNAME -=item COPYRIGHT +=over 4 + +=item AUTHOR =back -=head2 English - use nice English (or awk) names for ugly punctuation -variables +=head2 ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications =over 4 @@ -10086,26 +13126,22 @@ variables =item DESCRIPTION -=item PERFORMANCE - -=back - -=head2 Env - perl module that imports environment variables as scalars or -arrays +=item @EXPORT -=over 4 +=item FUNCTIONS -=item SYNOPSIS +xsinit(), Examples, ldopts(), Examples, perl_inc(), ccflags(), ccdlflags(), +ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules) -=item DESCRIPTION +=item EXAMPLES -=item LIMITATIONS +=item SEE ALSO =item AUTHOR =back -=head2 Errno - System errno constants +=head2 ExtUtils::Install - install files from here to there =over 4 @@ -10113,54 +13149,58 @@ arrays =item DESCRIPTION -=item CAVEATS +=over 4 -=item AUTHOR +=item Functions -=item COPYRIGHT +B =back -=head2 Exporter - Implements default import method for modules +=back -=over 4 +B I -=item SYNOPSIS +B -=item DESCRIPTION +B + +_autosplit =over 4 -=item How to Export +=item ENVIRONMENT -=item Selecting What To Export +B -=item Specialised Import Lists +=item AUTHOR -=item Exporting without using Export's import method +=item LICENSE -=item Module Version Checking +=back -=item Managing Unknown Symbols +=head2 ExtUtils::Installed - Inventory management of installed modules -=item Tag Handling Utility Functions +=over 4 -=back +=item SYNOPSIS -=back +=item DESCRIPTION -=head2 Exporter::Heavy - Exporter guts +=item USAGE -=over 4 +=item FUNCTIONS + +new(), modules(), files(), directories(), directory_tree(), validate(), +packlist(), version() -=item SYNOPIS +=item EXAMPLE -=item DESCRIPTION +=item AUTHOR =back -=head2 ExtUtils::Command - utilities to replace common UNIX commands in -Makefiles etc. +=head2 ExtUtils::Liblist - determine libraries to use and how to use them =over 4 @@ -10168,39 +13208,44 @@ Makefiles etc. =item DESCRIPTION -=back +For static extensions, For dynamic extensions at build/link time, For +dynamic extensions at load time -cat +=over 4 -eqtime src dst +=item EXTRALIBS -rm_rf files... +=item LDLOADLIBS and LD_RUN_PATH -rm_f files... +=item BSLOADLIBS -touch files .. +=back -mv source... destination +=item PORTABILITY -cp source... destination +=over 4 -chmod mode files.. +=item VMS implementation -mkpath directory.. +=item Win32 implementation -test_f file +=back -=over 4 +=item SEE ALSO -=item BUGS +=back -=item SEE ALSO +=head2 ExtUtils::MM - OS adjusted ExtUtils::MakeMaker subclass -=item AUTHOR +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION =back -=head2 ExtUtils::Constant - generate XS code to import C header constants +=head2 ExtUtils::MM_Any - Platform-agnostic MM methods =over 4 @@ -10208,74 +13253,86 @@ test_f file =item DESCRIPTION -=item USAGE +=item Inherently Cross-Platform Methods -IV, UV, NV, PV, PVN, SV, YES, NO, UNDEF +installvars -=item FUNCTIONS +=back + +os_flavor_is + +blibdirs_target (o) + +=over 4 + +=item File::Spec wrappers + +catfile =back -C_stringify NAME +=over 4 -constant_types +=item Thought To Be Cross-Platform Methods + +B -memEQ_clause NAME, CHECKED_AT, INDENT +=back -assign INDENT, TYPE, PRE, POST, VALUE.. +B -return_clause +init_VERSION -switch_clause INDENT, NAMELEN, ITEMHASH, ITEM.. +wraplist -params WHAT +manifypods -dump_names +manifypods_target -dogfood +makemakerdflt_target -C_constant, name, type, value, macro, default, pre, post, def_pre =item -def_post +special_targets -XS_constant PACKAGE, TYPES, SUBNAME, C_SUBNAME +POD2MAN_macro -autoload PACKAGE, VERSION, AUTOLOADER +test_via_harness -WriteMakefileSnippet +test_via_script -WriteConstants ATTRIBUTE =E VALUE [, ...], NAME, DEFAULT_TYPE, -BREAKOUT_AT, NAMES, C_FILE, XS_FILE, SUBNAME, C_SUBNAME +libscan -=over 4 +tool_autosplit -=item AUTHOR +all_target -=back +metafile_target -=head2 ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications +signature_target -=over 4 +metafile_addtomanifest_target -=item SYNOPSIS +signature_addtomanifest_target -=item DESCRIPTION +=over 4 -=item @EXPORT +=item Abstract methods -=item FUNCTIONS +oneliner, B, B, max_exec_len, +B, init_DIRFILESEP, init_linker, init_platform, +platform_constants -xsinit(), Examples, ldopts(), Examples, perl_inc(), ccflags(), ccdlflags(), -ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules) +=back -=item EXAMPLES +os_flavor -=item SEE ALSO +=over 4 =item AUTHOR =back -=head2 ExtUtils::Install - install files from here to there +=head2 ExtUtils::MM_BeOS - methods to override UN*X behaviour in +ExtUtils::MakeMaker =over 4 @@ -10285,7 +13342,12 @@ ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules) =back -=head2 ExtUtils::Installed - Inventory management of installed modules +os_flavor (o) + +init_linker + +=head2 ExtUtils::MM_Cygwin - methods to override UN*X behaviour in +ExtUtils::MakeMaker =over 4 @@ -10293,20 +13355,17 @@ ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules) =item DESCRIPTION -=item USAGE - -=item FUNCTIONS +os_flavor (o) -new(), modules(), files(), directories(), directory_tree(), validate(), -packlist(), version() +=back -=item EXAMPLE +cflags (o) -=item AUTHOR +replace_manpage_separator (o) -=back +init_linker -=head2 ExtUtils::Liblist - determine libraries to use and how to use them +=head2 ExtUtils::MM_DOS - DOS specific subclass of ExtUtils::MM_Unix =over 4 @@ -10314,33 +13373,27 @@ packlist(), version() =item DESCRIPTION -For static extensions, For dynamic extensions, For dynamic extensions - =over 4 -=item EXTRALIBS +=item Overridden methods -=item LDLOADLIBS and LD_RUN_PATH +os_flavor -=item BSLOADLIBS +=back =back -=item PORTABILITY +B =over 4 -=item VMS implementation - -=item Win32 implementation - -=back +=item AUTHOR =item SEE ALSO =back -=head2 ExtUtils::MM_Cygwin - methods to override UN*X behaviour in +=head2 ExtUtils::MM_MacOS - methods to override UN*X behaviour in ExtUtils::MakeMaker =over 4 @@ -10349,56 +13402,68 @@ ExtUtils::MakeMaker =item DESCRIPTION -canonpath, cflags, manifypods, perl_archive - =back -=head2 ExtUtils::MM_NW5 - methods to override UN*X behaviour in -ExtUtils::MakeMaker +maybe_command -=over 4 +guess_name -=item SYNOPSIS +macify -=item DESCRIPTION +patternify -=back +init_main -catfile +init_others -constants (o) +init_platform, platform_constants -static_lib (o) +init_dirscan -dynamic_bs (o) +init_VERSION (o) -dynamic_lib (o) +special_targets (o) -canonpath +static (o) -perl_script +dlsyms (o) -pm_to_blib +dynamic (o) -test_via_harness (o) +clean (o) -tool_autosplit (override) +clean_subdirs_target -tools_other (o) +realclean (o) -xs_o (o) +realclean_subdirs_target -top_targets (o) +rulez (o) -htmlifypods (o) +processPL (o) -manifypods (o) +os_flavor -dist_ci (o) +=head2 ExtUtils::MM_NW5 - methods to override UN*X behaviour in +ExtUtils::MakeMaker -dist_core (o) +=over 4 -pasthru (o) +=item SYNOPSIS + +=item DESCRIPTION + +=back + +os_flavor + +init_platform (o), platform_constants + +const_cccmd (o) + +static_lib (o) + +dynamic_lib (o) =head2 ExtUtils::MM_OS2 - methods to override UN*X behaviour in ExtUtils::MakeMaker @@ -10411,11 +13476,15 @@ ExtUtils::MakeMaker =item METHODS +init_dist (o) + =back -perl_archive_after +init_linker -=head2 ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker +os_flavor + +=head2 ExtUtils::MM_UWIN - U/WIN specific subclass of ExtUtils::MM_Unix =over 4 @@ -10423,40 +13492,54 @@ perl_archive_after =item DESCRIPTION -=item METHODS - =over 4 -=item Preloaded methods +=item Overridden methods -canonpath +os_flavor =back =back -catdir +B -catfile +=over 4 -curdir +=item AUTHOR -rootdir +=item SEE ALSO -updir +=back + +=head2 ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker =over 4 -=item SelfLoaded methods +=item SYNOPSIS -c_o (o) +=item DESCRIPTION + +=item METHODS + +=back + +=over 4 + +=item Methods + +os_flavor (o) =back +c_o (o) + cflags (o) clean (o) +clean_subdirs_target + const_cccmd (o) const_config (o) @@ -10467,7 +13550,11 @@ constants (o) depend (o) -dir_target (o) +dir_target B + +init_DEST + +init_dist dist (o) @@ -10477,9 +13564,23 @@ dist_ci (o) dist_core (o) -dist_dir (o) +B + +B + +B + +B + +zipfile_target + +uutardist_target + +shdist_target + +distdir -dist_test (o) +dist_test dlsyms (o) @@ -10493,10 +13594,10 @@ exescan extliblist -file_name_is_absolute - find_perl +find_tests + =over 4 =item Methods to actually produce chunks of text for the Makefile @@ -10511,20 +13612,34 @@ guess_name has_link_code -htmlifypods (o) - init_dirscan +init_DIRFILESEP + init_main init_others +init_INST + +init_INSTALL + +init_linker + +init_lib2arch + +init_PERL + +init_platform (o), platform_constants (o) + +init_PERM + +init_xs + install (o) installbin (o) -libscan (o) - linkext (o) lsdir @@ -10535,30 +13650,22 @@ makeaperl (o) makefile (o) -manifypods (o) - maybe_command -maybe_command_in_dirs - needs_linking (o) nicetext -parse_version - parse_abstract -pasthru (o) +parse_version -path +pasthru (o) perl_script perldepend (o) -ppd - perm_rw (o) perm_rwx (o) @@ -10571,6 +13678,8 @@ post_initialize (o) postamble (o) +ppd + prefixify processPL (o) @@ -10579,8 +13688,18 @@ quote_paren realclean (o) +realclean_subdirs_target + replace_manpage_separator +oneliner (o) + +quote_literal + +escape_newlines + +max_exec_len + static (o) static_lib (o) @@ -10593,16 +13712,16 @@ subdirs (o) test (o) -test_via_harness (o) - -test_via_script (o) +test_via_harness (override) -tool_autosplit (o) +test_via_script (override) tools_other (o) tool_xsubpp (o) +all_target + top_targets (o) writedoc @@ -10613,12 +13732,6 @@ xs_cpp (o) xs_o (o) -perl_archive - -perl_archive_after - -export_list - =over 4 =item SEE ALSO @@ -10644,11 +13757,9 @@ wraplist =back -rootdir (override) - =over 4 -=item SelfLoaded methods +=item Methods guess_name (override) @@ -10656,92 +13767,158 @@ guess_name (override) find_perl (override) -path (override) - maybe_command (override) -maybe_command_in_dirs (override) - perl_script (override) -file_name_is_absolute (override) - replace_manpage_separator +init_DEST + +init_DIRFILESEP + +init_main (override) + init_others (override) +init_platform (override) + +platform_constants + +init_VERSION (override) + constants (override) +special_targets + cflags (override) const_cccmd (override) -pm_to_blib (override) +tool_sxubpp (override) -tool_autosplit (override) +tools_other (override) -tool_sxubpp (override) +init_dist (override) + +c_o (override) + +xs_c (override) + +xs_o (override) + +dlsyms (override) + +dynamic_lib (override) + +dynamic_bs (override) + +static_lib (override) + +processPL (override) + +installbin (override) + +subdir_x (override) + +clean (override) + +clean_subdirs_target + +realclean (override) + +zipfile_target (o), tarfile_target (o), shdist_target (o) + +dist_test (override) + +install (override) + +perldepend (override) + +makefile (override) + +find_tests (override) + +test (override) + +makeaperl (override) + +nicetext (override) + +prefixify (override) + +oneliner (o) + +B (o) + +quote_literal + +escape_newlines + +max_exec_len + +init_linker (o) -xsubpp_version (override) +eliminate_macros -tools_other (override) +fixpath -dist (override) +os_flavor -c_o (override) +=head2 ExtUtils::MM_Win32 - methods to override UN*X behaviour in +ExtUtils::MakeMaker -xs_c (override) +=over 4 -xs_o (override) +=item SYNOPSIS -top_targets (override) +=item DESCRIPTION -dlsyms (override) +=back -dynamic_lib (override) +=over 4 -dynamic_bs (override) +=item Overridden methods -static_lib (override) +B -manifypods (override) +=back -processPL (override) +replace_manpage_separator -installbin (override) +B -subdir_x (override) +B -clean (override) +B -realclean (override) +B -dist_basics (override) +init_platform (o), platform_constants (o) -dist_core (override) +special_targets (o) -dist_dir (override) +static_lib (o) -dist_test (override) +dynamic_lib (o) -install (override) +clean -perldepend (override) +init_linker -makefile (override) +perl_script -test (override) +xs_o (o) -test_via_harness (override) +pasthru (o) -test_via_script (override) +oneliner (o) -makeaperl (override) +max_exec_len -nicetext (override) +os_flavor -=head2 ExtUtils::MM_Win32 - methods to override UN*X behaviour in -ExtUtils::MakeMaker +=head2 ExtUtils::MM_Win95 - method to customize MakeMaker for Win9X =over 4 @@ -10749,45 +13926,47 @@ ExtUtils::MakeMaker =item DESCRIPTION -=back +=over 4 -catfile +=item Overriden methods -constants (o) +dist_test -static_lib (o) +=back -dynamic_bs (o) +=back -dynamic_lib (o) +subdir_x -canonpath +xs_c -perl_script +xs_cpp -pm_to_blib +xs_o -test_via_harness (o) +clean_subdirs_target -tool_autosplit (override) +realclean_subdirs_target -tools_other (o) +os_flavor -xs_o (o) +=over 4 -top_targets (o) +=item AUTHOR -htmlifypods (o) +=back -manifypods (o) +=head2 ExtUtils::MY - ExtUtils::MakeMaker subclass for customization -dist_ci (o) +=over 4 -dist_core (o) +=item SYNOPSIS -pasthru (o) +=item DESCRIPTION -=head2 ExtUtils::MakeMaker - create an extension Makefile +=back + +=head2 ExtUtils::MakeMaker - Create a module Makefile =over 4 @@ -10820,39 +13999,51 @@ pasthru (o) =item Using Attributes and Parameters ABSTRACT, ABSTRACT_FROM, AUTHOR, BINARY_LOCATION, C, CCFLAGS, CONFIG, -CONFIGURE, DEFINE, DIR, DISTNAME, DL_FUNCS, DL_VARS, EXCLUDE_EXT, -EXE_FILES, FIRST_MAKEFILE, FULLPERL, FUNCLIST, H, HTMLLIBPODS, -HTMLSCRIPTPODS, IMPORTS, INC, INCLUDE_EXT, INSTALLARCHLIB, INSTALLBIN, -INSTALLDIRS, INSTALLHTMLPRIVLIBDIR, INSTALLHTMLSCRIPTDIR, -INSTALLHTMLSITELIBDIR, INSTALLMAN1DIR, INSTALLMAN3DIR, INSTALLPRIVLIB, -INSTALLSCRIPT, INSTALLSITEARCH, INSTALLSITELIB, INST_ARCHLIB, INST_BIN, -INST_EXE, INST_HTMLLIBDIR, INST_HTMLSCRIPTDIR, INST_LIB, INST_MAN1DIR, -INST_MAN3DIR, INST_SCRIPT, LDFROM, LIB, LIBPERL_A, LIBS, LINKTYPE, -MAKEAPERL, MAKEFILE, MAN1PODS, MAN3PODS, MAP_TARGET, MYEXTLIB, NAME, -NEEDS_LINKING, NOECHO, NORECURS, NO_VC, OBJECT, OPTIMIZE, PERL, PERL_CORE, -PERLMAINCC, PERL_ARCHLIB, PERL_LIB, PERL_MALLOC_OK, PERLRUN, PERM_RW, +CONFIGURE, DEFINE, DESTDIR, DIR, DISTNAME, DISTVNAME, DL_FUNCS, DL_VARS, +EXCLUDE_EXT, EXE_FILES, FIRST_MAKEFILE, FULLPERL, FULLPERLRUN, +FULLPERLRUNINST, FUNCLIST, H, IMPORTS, INC, INCLUDE_EXT, INSTALLARCHLIB, +INSTALLBIN, INSTALLDIRS, INSTALLMAN1DIR, INSTALLMAN3DIR, INSTALLPRIVLIB, +INSTALLSCRIPT, INSTALLSITEARCH, INSTALLSITEBIN, INSTALLSITELIB, +INSTALLSITEMAN1DIR, INSTALLSITEMAN3DIR, INSTALLVENDORARCH, +INSTALLVENDORBIN, INSTALLVENDORLIB, INSTALLVENDORMAN1DIR, +INSTALLVENDORMAN3DIR, INST_ARCHLIB, INST_BIN, INST_LIB, INST_MAN1DIR, +INST_MAN3DIR, INST_SCRIPT, LD, LDDLFLAGS, LDFROM, LIB, LIBPERL_A, LIBS, +LINKTYPE, MAKEAPERL, MAKEFILE_OLD, MAN1PODS, MAN3PODS, MAP_TARGET, +MYEXTLIB, NAME, NEEDS_LINKING, NOECHO, NORECURS, NO_META, NO_VC, OBJECT, +OPTIMIZE, PERL, PERL_CORE, PERLMAINCC, PERL_ARCHLIB, PERL_LIB, +PERL_MALLOC_OK, PERLPREFIX, PERLRUN, PERLRUNINST, PERL_SRC, PERM_RW, PERM_RWX, PL_FILES, PM, PMLIBDIRS, PM_FILTER, POLLUTE, PPM_INSTALL_EXEC, -PPM_INSTALL_SCRIPT, PREFIX, PREREQ_PM, PREREQ_FATAL, PREREQ_PRINT, -PRINT_PREREQ, SKIP, TEST_LIBS, VERSION, VERSION_FROM, XS, XSOPT, -XSPROTOARG, XS_VERSION +PPM_INSTALL_SCRIPT, PREFIX, PREREQ_FATAL, PREREQ_PM, PREREQ_PRINT, +PRINT_PREREQ, SITEPREFIX, SIGN, SKIP, TYPEMAPS, VENDORPREFIX, VERBINST, +VERSION, VERSION_FROM, VERSION_SYM, XS, XSOPT, XSPROTOARG, XS_VERSION =item Additional lowercase attributes -clean, depend, dist, dynamic_lib, linkext, macro, realclean, test, -tool_autosplit +clean, depend, dist, dynamic_lib, linkext, macro, postamble, realclean, +test, tool_autosplit =item Overriding MakeMaker Methods +=item The End Of Cargo Cult Programming + +C< ' '>> + =item Hintsfile support =item Distribution Support make distcheck, make skipcheck, make distclean, make manifest, - make distdir, make tardist, make dist, make uutardist, make -shdist, make zipdist, make ci + make distdir, make disttest, make tardist, make dist, make +uutardist, make shdist, make zipdist, make ci + +=item Module Meta-Data =item Disabling an extension +=item Other Handy Functions + +prompt + =back =item ENVIRONMENT @@ -10863,6 +14054,87 @@ PERL_MM_OPT, PERL_MM_USE_DEFAULT =item AUTHORS +=item LICENSE + +=back + +=head2 ExtUtils::MakeMaker::FAQ - Frequently Asked Questions About +MakeMaker + +=over 4 + +=item DESCRIPTION + +=over 4 + +=item Philosophy and History + +Why not just use ?, What's +Module::Build and how does it relate to MakeMaker?, pure perl. no make, no +shell commands, easier to customize, cleaner internals, less cruft + +=item Module Writing + +How do I keep my $VERSION up to date without resetting it manually?, What's +this F thing and how did it get in my F?! + +=item XS + +How to I prevent "object version X.XX does not match bootstrap parameter +Y.YY" errors?, How do I make two or more XS files coexist in the same +directory? + +=back + +=item PATCHING + +=item AUTHOR + +=item SEE ALSO + +=back + +=head2 ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=over 4 + +=item The Mantra + +=item The Layout + +Makefile.PL, MANIFEST, lib/, t/, Changes, README, INSTALL, MANIFEST.SKIP, +bin/ + +=back + +=item SEE ALSO + +=back + +=head2 ExtUtils::MakeMaker::bytes - Version-agnostic bytes.pm + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=back + +=head2 ExtUtils::MakeMaker::vmsish - Platform-agnostic vmsish.pm + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + =back =head2 ExtUtils::Manifest - utilities to write and check a MANIFEST file @@ -10873,16 +14145,50 @@ PERL_MM_OPT, PERL_MM_USE_DEFAULT =item DESCRIPTION +=over 4 + +=item Functions + +mkmanifest + +=back + +=back + +manifind + +manicheck + +filecheck + +fullcheck + +skipcheck + +maniread + +manicopy + +maniadd + +=over 4 + +=item MANIFEST + =item MANIFEST.SKIP =item EXPORT_OK =item GLOBAL VARIABLES +=back + +=over 4 + =item DIAGNOSTICS -C I, C I, C I<$!>, -C I +C I, C I, C I, +C I<$!>, C I =item ENVIRONMENT @@ -11013,6 +14319,10 @@ C, C =item DESCRIPTION +=item AUTHOR + +=item HISTORY + =back =head2 File::Compare - Compare files or filehandles @@ -11075,7 +14385,7 @@ rmscopy($from,$to[,$date_flag]) =back -=head2 File::Find, find - traverse a file tree +=head2 File::Find - Traverse a directory tree. =over 4 @@ -11083,10 +14393,24 @@ rmscopy($from,$to[,$date_flag]) =item DESCRIPTION +B, B + +=over 4 + +=item %options + C, C, C, C, C, C, C, C, C, C, C, C +=item The wanted function + +C<$File::Find::dir> is the current directory name,, C<$_> is the current +filename within that directory, C<$File::Find::name> is the complete +pathname to the file + +=back + =item WARNINGS =item CAVEAT @@ -11129,6 +14453,8 @@ C, C =item DESCRIPTION +=item DIAGNOSTICS + =item AUTHORS =back @@ -11153,7 +14479,7 @@ splitdir, catpath(), abs2rel, rel2abs() =back -=head2 File::Spec::Epoc - methods for Epoc file specs +=head2 File::Spec::Cygwin - methods for Cygwin file specs =over 4 @@ -11161,25 +14487,27 @@ splitdir, catpath(), abs2rel, rel2abs() =item DESCRIPTION -devnull - =back -tmpdir +canonpath -path +file_name_is_absolute -canonpath() +tmpdir (override) -splitpath +=head2 File::Spec::Epoc - methods for Epoc file specs -splitdir +=over 4 -catpath +=item SYNOPSIS -abs2rel +=item DESCRIPTION -rel2abs() +=item AUTHORS + +=back + +canonpath() =over 4 @@ -11263,6 +14591,8 @@ rel2abs =item DESCRIPTION +tmpdir, splitpath + =back =head2 File::Spec::Unix - File::Spec for Unix, base for other File::Spec @@ -11404,6 +14734,12 @@ catpath =over 4 +=item Note For File::Spec::Win32 Maintainers + +=back + +=over 4 + =item SEE ALSO =back @@ -11422,6 +14758,18 @@ catpath =over 4 +=item OO INTERFACE + +B + +=back + +B + +B + +=over 4 + =item FUNCTIONS B @@ -11470,6 +14818,10 @@ B =back +B + +B + =over 4 =item PACKAGE VARIABLES @@ -11506,6 +14858,8 @@ TopSystemUID =item DESCRIPTION +=item BUGS + =item NOTE =item AUTHOR @@ -11520,8 +14874,14 @@ TopSystemUID =item DESCRIPTION +cacheout EXPR, cacheout MODE, EXPR + +=item CAVEATS + =item BUGS +=item NOTES + =back =head2 FileHandle - supply object methods for filehandles @@ -11556,6 +14916,21 @@ $fh->print, $fh->printf, $fh->getline, $fh->getlines =item All-in-one interface +=item Filtering only specific components of source code + +C<"code">, C<"executable">, C<"quotelike">, C<"string">, C<"regex">, +C<"all"> + +=item Filtering only the code parts of source code + +Most source code ceases to be grammatically correct when it is broken up +into the pieces between string literals and regexes. So the C<'code'> +component filter behaves slightly differently from the other partial +filters +described in the previous section. + +=item Using Filter::Simple with an explicit C subroutine + =item Using Filter::Simple and Exporter together =item How it works @@ -11680,7 +15055,8 @@ B<$_>, B<$status>, B and B, B =item Summary of Option Specifications -!, +, s, i, o, f, : I [ I ] +!, +, s, i, o, f, : I [ I ], : I [ I ], : ++ [ I ] =back @@ -11690,6 +15066,8 @@ B<$_>, B<$status>, B and B, B =item Object oriented interface +=item Thread Safety + =item Documentation and help texts =item Storing options in a hash @@ -11707,9 +15085,14 @@ B<$_>, B<$status>, B and B, B default, posix_default, auto_abbrev, getopt_compat, gnu_compat, gnu_getopt, require_order, permute, bundling (default: disabled), bundling_override (default: disabled), ignore_case (default: enabled), ignore_case_always -(default: disabled), pass_through (default: disabled), prefix, +(default: disabled), auto_version (default:disabled), auto_help +(default:disabled), pass_through (default: disabled), prefix, prefix_pattern, debug (default: disabled) +=item Exportable Methods + +VersionMessage, C<-message>, C<-msg>, C<-exitval>, C<-output>, HelpMessage + =item Return values and Errors =item Legacy @@ -11718,41 +15101,77 @@ prefix_pattern, debug (default: disabled) =item Default destinations -=item Alternative option starters +=item Alternative option starters + +=item Configuration variables + +=back + +=item Trouble Shooting + +=over 4 + +=item GetOptions does not return a false result when an option is not +supplied + +=item GetOptions does not split the command line correctly + +=item Undefined subroutine &main::GetOptions called + +=item How do I put a "-?" option into a Getopt::Long? + +=back + +=item AUTHOR + +=item COPYRIGHT AND DISCLAIMER + +=back + +=head2 Getopt::Std, getopt, getopts - Process single-character switches +with switch clustering + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION -=item Configuration variables +=item C<--help> and C<--version> =back -=item Trouble Shooting +=head2 Hash::Util - A selection of general-utility hash subroutines =over 4 -=item Warning: Ignoring '!' modifier for short option +=item SYNOPSIS -=item GetOptions does not return a false result when an option is not -supplied +=item DESCRIPTION -=item GetOptions does not split the command line correctly +=over 4 -=item How do I put a "-?" option into a Getopt::Long? +=item Restricted hashes + +lock_keys, unlock_keys =back -=item AUTHOR +=back -=item COPYRIGHT AND DISCLAIMER +lock_value, unlock_value -=back +B, B -=head2 Getopt::Std, getopt - Process single-character switches with switch -clustering +B =over 4 -=item SYNOPSIS +=item CAVEATS -=item DESCRIPTION +=item AUTHOR + +=item SEE ALSO =back @@ -11824,88 +15243,93 @@ the function @langs = panic_languages(@accept_languages) =item LIST OF LANGUAGES -{ab} : Abkhazian, {ace} : Achinese, {ach} : Acoli, {ada} : Adangme, {aa} : -Afar, {afh} : Afrihili, {af} : Afrikaans, [{afa} : Afro-Asiatic (Other)], -{aka} : Akan, {akk} : Akkadian, {sq} : Albanian, {ale} : Aleut, [{alg} : -Algonquian languages], [{tut} : Altaic (Other)], {am} : Amharic, {i-ami} : -Ami, [{apa} : Apache languages], {ar} : Arabic, {arc} : Aramaic, {arp} : -Arapaho, {arn} : Araucanian, {arw} : Arawak, {hy} : Armenian, [{art} : -Artificial (Other)], {as} : Assamese, [{ath} : Athapascan languages], -[{aus} : Australian languages], [{map} : Austronesian (Other)], {ava} : -Avaric, {ae} : Avestan, {awa} : Awadhi, {ay} : Aymara, {az} : Azerbaijani, -{ban} : Balinese, [{bat} : Baltic (Other)], {bal} : Baluchi, {bam} : -Bambara, [{bai} : Bamileke languages], {bad} : Banda, [{bnt} : Bantu -(Other)], {bas} : Basa, {ba} : Bashkir, {eu} : Basque, {btk} : Batak -(Indonesia), {bej} : Beja, {be} : Belarusian, {bem} : Bemba, {bn} : -Bengali, [{ber} : Berber (Other)], {bho} : Bhojpuri, {bh} : Bihari, {bik} : -Bikol, {bin} : Bini, {bi} : Bislama, {bs} : Bosnian, {bra} : Braj, {br} : -Breton, {bug} : Buginese, {bg} : Bulgarian, {i-bnn} : Bunun, {bua} : -Buriat, {my} : Burmese, {cad} : Caddo, {car} : Carib, {ca} : Catalan, -[{cau} : Caucasian (Other)], {ceb} : Cebuano, [{cel} : Celtic (Other)], -[{cai} : Central American Indian (Other)], {chg} : Chagatai, [{cmc} : -Chamic languages], {ch} : Chamorro, {ce} : Chechen, {chr} : Cherokee, {chy} -: Cheyenne, {chb} : Chibcha, {ny} : Chichewa, {zh} : Chinese, {chn} : -Chinook Jargon, {chp} : Chipewyan, {cho} : Choctaw, {cu} : Church Slavic, -{chk} : Chuukese, {cv} : Chuvash, {cop} : Coptic, {kw} : Cornish, {co} : -Corsican, {cre} : Cree, {mus} : Creek, [{cpe} : English-based Creoles and -pidgins (Other)], [{cpf} : French-based Creoles and pidgins (Other)], -[{cpp} : Portuguese-based Creoles and pidgins (Other)], [{crp} : Creoles -and pidgins (Other)], {hr} : Croatian, [{cus} : Cushitic (Other)], {cs} : -Czech, {dak} : Dakota, {da} : Danish, {day} : Dayak, {i-default} : Default -(Fallthru) Language, {del} : Delaware, {din} : Dinka, {div} : Divehi, {doi} -: Dogri, {dgr} : Dogrib, [{dra} : Dravidian (Other)], {dua} : Duala, {nl} : -Dutch, {dum} : Middle Dutch (ca.1050-1350), {dyu} : Dyula, {dz} : Dzongkha, -{efi} : Efik, {egy} : Ancient Egyptian, {eka} : Ekajuk, {elx} : Elamite, -{en} : English, {enm} : Old English (1100-1500), {ang} : Old English -(ca.450-1100), {eo} : Esperanto, {et} : Estonian, {ewe} : Ewe, {ewo} : -Ewondo, {fan} : Fang, {fat} : Fanti, {fo} : Faroese, {fj} : Fijian, {fi} : -Finnish, [{fiu} : Finno-Ugrian (Other)], {fon} : Fon, {fr} : French, {frm} -: Middle French (ca.1400-1600), {fro} : Old French (842-ca.1400), {fy} : -Frisian, {fur} : Friulian, {ful} : Fulah, {gaa} : Ga, {gd} : Scots Gaelic, -{gl} : Gallegan, {lug} : Ganda, {gay} : Gayo, {gba} : Gbaya, {gez} : Geez, -{ka} : Georgian, {de} : German, {gmh} : Middle High German (ca.1050-1500), -{goh} : Old High German (ca.750-1050), [{gem} : Germanic (Other)], {gil} : -Gilbertese, {gon} : Gondi, {gor} : Gorontalo, {got} : Gothic, {grb} : -Grebo, {grc} : Ancient Greek, {el} : Modern Greek, {gn} : Guarani, {gu} : -Gujarati, {gwi} : Gwich'in, {hai} : Haida, {ha} : Hausa, {haw} : Hawaiian, +{ab} : Abkhazian, {ace} : Achinese, {ach} : Acoli, {ada} : Adangme, {ady} : +Adyghe, {aa} : Afar, {afh} : Afrihili, {af} : Afrikaans, [{afa} : +Afro-Asiatic (Other)], {ak} : Akan, {akk} : Akkadian, {sq} : Albanian, +{ale} : Aleut, [{alg} : Algonquian languages], [{tut} : Altaic (Other)], +{am} : Amharic, {i-ami} : Ami, [{apa} : Apache languages], {ar} : Arabic, +{arc} : Aramaic, {arp} : Arapaho, {arn} : Araucanian, {arw} : Arawak, {hy} +: Armenian, {an} : Aragonese, [{art} : Artificial (Other)], {ast} : +Asturian, {as} : Assamese, [{ath} : Athapascan languages], [{aus} : +Australian languages], [{map} : Austronesian (Other)], {av} : Avaric, {ae} +: Avestan, {awa} : Awadhi, {ay} : Aymara, {az} : Azerbaijani, {ban} : +Balinese, [{bat} : Baltic (Other)], {bal} : Baluchi, {bm} : Bambara, [{bai} +: Bamileke languages], {bad} : Banda, [{bnt} : Bantu (Other)], {bas} : +Basa, {ba} : Bashkir, {eu} : Basque, {btk} : Batak (Indonesia), {bej} : +Beja, {be} : Belarusian, {bem} : Bemba, {bn} : Bengali, [{ber} : Berber +(Other)], {bho} : Bhojpuri, {bh} : Bihari, {bik} : Bikol, {bin} : Bini, +{bi} : Bislama, {bs} : Bosnian, {bra} : Braj, {br} : Breton, {bug} : +Buginese, {bg} : Bulgarian, {i-bnn} : Bunun, {bua} : Buriat, {my} : +Burmese, {cad} : Caddo, {car} : Carib, {ca} : Catalan, [{cau} : Caucasian +(Other)], {ceb} : Cebuano, [{cel} : Celtic (Other)], [{cai} : Central +American Indian (Other)], {chg} : Chagatai, [{cmc} : Chamic languages], +{ch} : Chamorro, {ce} : Chechen, {chr} : Cherokee, {chy} : Cheyenne, {chb} +: Chibcha, {ny} : Chichewa, {zh} : Chinese, {chn} : Chinook Jargon, {chp} : +Chipewyan, {cho} : Choctaw, {cu} : Church Slavic, {chk} : Chuukese, {cv} : +Chuvash, {cop} : Coptic, {kw} : Cornish, {co} : Corsican, {cr} : Cree, +{mus} : Creek, [{cpe} : English-based Creoles and pidgins (Other)], [{cpf} +: French-based Creoles and pidgins (Other)], [{cpp} : Portuguese-based +Creoles and pidgins (Other)], [{crp} : Creoles and pidgins (Other)], {hr} : +Croatian, [{cus} : Cushitic (Other)], {cs} : Czech, {dak} : Dakota, {da} : +Danish, {dar} : Dargwa, {day} : Dayak, {i-default} : Default (Fallthru) +Language, {del} : Delaware, {din} : Dinka, {dv} : Divehi, {doi} : Dogri, +{dgr} : Dogrib, [{dra} : Dravidian (Other)], {dua} : Duala, {nl} : Dutch, +{dum} : Middle Dutch (ca.1050-1350), {dyu} : Dyula, {dz} : Dzongkha, {efi} +: Efik, {egy} : Ancient Egyptian, {eka} : Ekajuk, {elx} : Elamite, {en} : +English, {enm} : Old English (1100-1500), {ang} : Old English +(ca.450-1100), {i-enochian} : Enochian (Artificial), {myv} : Erzya, {eo} : +Esperanto, {et} : Estonian, {ee} : Ewe, {ewo} : Ewondo, {fan} : Fang, {fat} +: Fanti, {fo} : Faroese, {fj} : Fijian, {fi} : Finnish, [{fiu} : +Finno-Ugrian (Other)], {fon} : Fon, {fr} : French, {frm} : Middle French +(ca.1400-1600), {fro} : Old French (842-ca.1400), {fy} : Frisian, {fur} : +Friulian, {ff} : Fulah, {gaa} : Ga, {gd} : Scots Gaelic, {gl} : Gallegan, +{lg} : Ganda, {gay} : Gayo, {gba} : Gbaya, {gez} : Geez, {ka} : Georgian, +{de} : German, {gmh} : Middle High German (ca.1050-1500), {goh} : Old High +German (ca.750-1050), [{gem} : Germanic (Other)], {gil} : Gilbertese, {gon} +: Gondi, {gor} : Gorontalo, {got} : Gothic, {grb} : Grebo, {grc} : Ancient +Greek, {el} : Modern Greek, {gn} : Guarani, {gu} : Gujarati, {gwi} : +Gwich'in, {hai} : Haida, {ht} : Haitian, {ha} : Hausa, {haw} : Hawaiian, {he} : Hebrew, {hz} : Herero, {hil} : Hiligaynon, {him} : Himachali, {hi} : Hindi, {ho} : Hiri Motu, {hit} : Hittite, {hmn} : Hmong, {hu} : Hungarian, -{hup} : Hupa, {iba} : Iban, {is} : Icelandic, {ibo} : Igbo, {ijo} : Ijo, -{ilo} : Iloko, [{inc} : Indic (Other)], [{ine} : Indo-European (Other)], -{id} : Indonesian, {ia} : Interlingua (International Auxiliary Language -Association), {ie} : Interlingue, {iu} : Inuktitut, {ik} : Inupiaq, [{ira} -: Iranian (Other)], {ga} : Irish, {mga} : Middle Irish (900-1200), {sga} : -Old Irish (to 900), [{iro} : Iroquoian languages], {it} : Italian, {ja} : -Japanese, {jw} : Javanese, {jrb} : Judeo-Arabic, {jpr} : Judeo-Persian, -{kab} : Kabyle, {kac} : Kachin, {kl} : Kalaallisut, {kam} : Kamba, {kn} : -Kannada, {kau} : Kanuri, {kaa} : Kara-Kalpak, {kar} : Karen, {ks} : -Kashmiri, {kaw} : Kawi, {kk} : Kazakh, {kha} : Khasi, {km} : Khmer, [{khi} -: Khoisan (Other)], {kho} : Khotanese, {ki} : Kikuyu, {kmb} : Kimbundu, -{rw} : Kinyarwanda, {ky} : Kirghiz, {i-klingon} : Klingon, {kv} : Komi, -{kon} : Kongo, {kok} : Konkani, {ko} : Korean, {kos} : Kosraean, {kpe} : -Kpelle, {kro} : Kru, {kj} : Kuanyama, {kum} : Kumyk, {ku} : Kurdish, {kru} -: Kurukh, {kut} : Kutenai, {lad} : Ladino, {lah} : Lahnda, {lam} : Lamba, -{lo} : Lao, {la} : Latin, {lv} : Latvian, {lb} : Letzeburgesch, {lez} : -Lezghian, {ln} : Lingala, {lt} : Lithuanian, {nds} : Low German, {loz} : -Lozi, {lub} : Luba-Katanga, {lua} : Luba-Lulua, {lui} : Luiseno, {lun} : -Lunda, {luo} : Luo (Kenya and Tanzania), {lus} : Lushai, {mk} : Macedonian, -{mad} : Madurese, {mag} : Magahi, {mai} : Maithili, {mak} : Makasar, {mg} : -Malagasy, {ms} : Malay, {ml} : Malayalam, {mt} : Maltese, {mnc} : Manchu, -{mdr} : Mandar, {man} : Mandingo, {mni} : Manipuri, [{mno} : Manobo -languages], {gv} : Manx, {mi} : Maori, {mr} : Marathi, {chm} : Mari, {mh} : -Marshall, {mwr} : Marwari, {mas} : Masai, [{myn} : Mayan languages], {men} -: Mende, {mic} : Micmac, {min} : Minangkabau, {i-mingo} : Mingo, [{mis} : -Miscellaneous languages], {moh} : Mohawk, {mo} : Moldavian, [{mkh} : -Mon-Khmer (Other)], {lol} : Mongo, {mn} : Mongolian, {mos} : Mossi, [{mul} -: Multiple languages], [{mun} : Munda languages], {nah} : Nahuatl, {na} : -Nauru, {nv} : Navajo, {nd} : North Ndebele, {nr} : South Ndebele, {ng} : -Ndonga, {ne} : Nepali, {new} : Newari, {nia} : Nias, [{nic} : +{hup} : Hupa, {iba} : Iban, {is} : Icelandic, {io} : Ido, {ig} : Igbo, +{ijo} : Ijo, {ilo} : Iloko, [{inc} : Indic (Other)], [{ine} : Indo-European +(Other)], {id} : Indonesian, {inh} : Ingush, {ia} : Interlingua +(International Auxiliary Language Association), {ie} : Interlingue, {iu} : +Inuktitut, {ik} : Inupiaq, [{ira} : Iranian (Other)], {ga} : Irish, {mga} : +Middle Irish (900-1200), {sga} : Old Irish (to 900), [{iro} : Iroquoian +languages], {it} : Italian, {ja} : Japanese, {jv} : Javanese, {jrb} : +Judeo-Arabic, {jpr} : Judeo-Persian, {kbd} : Kabardian, {kab} : Kabyle, +{kac} : Kachin, {kl} : Kalaallisut, {xal} : Kalmyk, {kam} : Kamba, {kn} : +Kannada, {kr} : Kanuri, {krc} : Karachay-Balkar, {kaa} : Kara-Kalpak, {kar} +: Karen, {ks} : Kashmiri, {csb} : Kashubian, {kaw} : Kawi, {kk} : Kazakh, +{kha} : Khasi, {km} : Khmer, [{khi} : Khoisan (Other)], {kho} : Khotanese, +{ki} : Kikuyu, {kmb} : Kimbundu, {rw} : Kinyarwanda, {ky} : Kirghiz, +{i-klingon} : Klingon, {kv} : Komi, {kg} : Kongo, {kok} : Konkani, {ko} : +Korean, {kos} : Kosraean, {kpe} : Kpelle, {kro} : Kru, {kj} : Kuanyama, +{kum} : Kumyk, {ku} : Kurdish, {kru} : Kurukh, {kut} : Kutenai, {lad} : +Ladino, {lah} : Lahnda, {lam} : Lamba, {lo} : Lao, {la} : Latin, {lv} : +Latvian, {lb} : Letzeburgesch, {lez} : Lezghian, {li} : Limburgish, {ln} : +Lingala, {lt} : Lithuanian, {nds} : Low German, {art-lojban} : Lojban +(Artificial), {loz} : Lozi, {lu} : Luba-Katanga, {lua} : Luba-Lulua, {lui} +: Luiseno, {lun} : Lunda, {luo} : Luo (Kenya and Tanzania), {lus} : Lushai, +{mk} : Macedonian, {mad} : Madurese, {mag} : Magahi, {mai} : Maithili, +{mak} : Makasar, {mg} : Malagasy, {ms} : Malay, {ml} : Malayalam, {mt} : +Maltese, {mnc} : Manchu, {mdr} : Mandar, {man} : Mandingo, {mni} : +Manipuri, [{mno} : Manobo languages], {gv} : Manx, {mi} : Maori, {mr} : +Marathi, {chm} : Mari, {mh} : Marshall, {mwr} : Marwari, {mas} : Masai, +[{myn} : Mayan languages], {men} : Mende, {mic} : Micmac, {min} : +Minangkabau, {i-mingo} : Mingo, [{mis} : Miscellaneous languages], {moh} : +Mohawk, {mdf} : Moksha, {mo} : Moldavian, [{mkh} : Mon-Khmer (Other)], +{lol} : Mongo, {mn} : Mongolian, {mos} : Mossi, [{mul} : Multiple +languages], [{mun} : Munda languages], {nah} : Nahuatl, {nap} : Neapolitan, +{na} : Nauru, {nv} : Navajo, {nd} : North Ndebele, {nr} : South Ndebele, +{ng} : Ndonga, {ne} : Nepali, {new} : Newari, {nia} : Nias, [{nic} : Niger-Kordofanian (Other)], [{ssa} : Nilo-Saharan (Other)], {niu} : Niuean, -{non} : Old Norse, [{nai} : North American Indian], {se} : Northern Sami, -{no} : Norwegian, {nb} : Norwegian Bokmal, {nn} : Norwegian Nynorsk, [{nub} -: Nubian languages], {nym} : Nyamwezi, {nyn} : Nyankole, {nyo} : Nyoro, -{nzi} : Nzima, {oc} : Occitan (post 1500), {oji} : Ojibwa, {or} : Oriya, -{om} : Oromo, {osa} : Osage, {os} : Ossetian; Ossetic, [{oto} : Otomian +{nog} : Nogai, {non} : Old Norse, [{nai} : North American Indian], {no} : +Norwegian, {nb} : Norwegian Bokmal, {nn} : Norwegian Nynorsk, [{nub} : +Nubian languages], {nym} : Nyamwezi, {nyn} : Nyankole, {nyo} : Nyoro, {nzi} +: Nzima, {oc} : Occitan (post 1500), {oj} : Ojibwa, {or} : Oriya, {om} : +Oromo, {osa} : Osage, {os} : Ossetian; Ossetic, [{oto} : Otomian languages], {pal} : Pahlavi, {i-pwn} : Paiwan, {pau} : Palauan, {pi} : Pali, {pam} : Pampanga, {pag} : Pangasinan, {pa} : Panjabi, {pap} : Papiamento, [{paa} : Papuan (Other)], {fa} : Persian, {peo} : Old Persian @@ -11915,34 +15339,37 @@ Papiamento, [{paa} : Papuan (Other)], {fa} : Persian, {peo} : Old Persian Raeto-Romance, {raj} : Rajasthani, {rap} : Rapanui, {rar} : Rarotongan, [{qaa - qtz} : Reserved for local use.], [{roa} : Romance (Other)], {ro} : Romanian, {rom} : Romany, {rn} : Rundi, {ru} : Russian, [{sal} : Salishan -languages], {sam} : Samaritan Aramaic, [{smi} : Sami languages (Other)], -{sm} : Samoan, {sad} : Sandawe, {sg} : Sango, {sa} : Sanskrit, {sat} : -Santali, {sc} : Sardinian, {sas} : Sasak, {sco} : Scots, {sel} : Selkup, -[{sem} : Semitic (Other)], {sr} : Serbian, {srr} : Serer, {shn} : Shan, -{sn} : Shona, {sid} : Sidamo, {sgn-...} : Sign Languages, {bla} : Siksika, -{sd} : Sindhi, {si} : Sinhalese, [{sit} : Sino-Tibetan (Other)], [{sio} : -Siouan languages], {den} : Slave (Athapascan), [{sla} : Slavic (Other)], -{sk} : Slovak, {sl} : Slovenian, {sog} : Sogdian, {so} : Somali, {son} : -Songhai, {snk} : Soninke, {wen} : Sorbian languages, {nso} : Northern -Sotho, {st} : Southern Sotho, [{sai} : South American Indian (Other)], {es} -: Spanish, {suk} : Sukuma, {sux} : Sumerian, {su} : Sundanese, {sus} : -Susu, {sw} : Swahili, {ss} : Swati, {sv} : Swedish, {syr} : Syriac, {tl} : -Tagalog, {ty} : Tahitian, [{tai} : Tai (Other)], {tg} : Tajik, {tmh} : -Tamashek, {ta} : Tamil, {i-tao} : Tao, {tt} : Tatar, {i-tay} : Tayal, {te} -: Telugu, {ter} : Tereno, {tet} : Tetum, {th} : Thai, {bo} : Tibetan, {tig} -: Tigre, {ti} : Tigrinya, {tem} : Timne, {tiv} : Tiv, {tli} : Tlingit, -{tpi} : Tok Pisin, {tkl} : Tokelau, {tog} : Tonga (Nyasa), {to} : Tonga -(Tonga Islands), {tsi} : Tsimshian, {ts} : Tsonga, {i-tsu} : Tsou, {tn} : -Tswana, {tum} : Tumbuka, {tr} : Turkish, {ota} : Ottoman Turkish -(1500-1928), {tk} : Turkmen, {tvl} : Tuvalu, {tyv} : Tuvinian, {tw} : Twi, -{uga} : Ugaritic, {ug} : Uighur, {uk} : Ukrainian, {umb} : Umbundu, {und} : -Undetermined, {ur} : Urdu, {uz} : Uzbek, {vai} : Vai, {ven} : Venda, {vi} : -Vietnamese, {vo} : Volapuk, {vot} : Votic, [{wak} : Wakashan languages], -{wal} : Walamo, {war} : Waray, {was} : Washo, {cy} : Welsh, {wo} : Wolof, -{x-...} : Unregistered (Semi-Private Use), {xh} : Xhosa, {sah} : Yakut, -{yao} : Yao, {yap} : Yapese, {yi} : Yiddish, {yo} : Yoruba, [{ypk} : Yupik -languages], {znd} : Zande, [{zap} : Zapotec], {zen} : Zenaga, {za} : -Zhuang, {zu} : Zulu, {zun} : Zuni +languages], {sam} : Samaritan Aramaic, {se} : Northern Sami, {sma} : +Southern Sami, {smn} : Inari Sami, {smj} : Lule Sami, {sms} : Skolt Sami, +[{smi} : Sami languages (Other)], {sm} : Samoan, {sad} : Sandawe, {sg} : +Sango, {sa} : Sanskrit, {sat} : Santali, {sc} : Sardinian, {sas} : Sasak, +{sco} : Scots, {sel} : Selkup, [{sem} : Semitic (Other)], {sr} : Serbian, +{srr} : Serer, {shn} : Shan, {sn} : Shona, {sid} : Sidamo, {sgn-...} : Sign +Languages, {bla} : Siksika, {sd} : Sindhi, {si} : Sinhalese, [{sit} : +Sino-Tibetan (Other)], [{sio} : Siouan languages], {den} : Slave +(Athapascan), [{sla} : Slavic (Other)], {sk} : Slovak, {sl} : Slovenian, +{sog} : Sogdian, {so} : Somali, {son} : Songhai, {snk} : Soninke, {wen} : +Sorbian languages, {nso} : Northern Sotho, {st} : Southern Sotho, [{sai} : +South American Indian (Other)], {es} : Spanish, {suk} : Sukuma, {sux} : +Sumerian, {su} : Sundanese, {sus} : Susu, {sw} : Swahili, {ss} : Swati, +{sv} : Swedish, {syr} : Syriac, {tl} : Tagalog, {ty} : Tahitian, [{tai} : +Tai (Other)], {tg} : Tajik, {tmh} : Tamashek, {ta} : Tamil, {i-tao} : Tao, +{tt} : Tatar, {i-tay} : Tayal, {te} : Telugu, {ter} : Tereno, {tet} : +Tetum, {th} : Thai, {bo} : Tibetan, {tig} : Tigre, {ti} : Tigrinya, {tem} : +Timne, {tiv} : Tiv, {tli} : Tlingit, {tpi} : Tok Pisin, {tkl} : Tokelau, +{tog} : Tonga (Nyasa), {to} : Tonga (Tonga Islands), {tsi} : Tsimshian, +{ts} : Tsonga, {i-tsu} : Tsou, {tn} : Tswana, {tum} : Tumbuka, [{tup} : +Tupi languages], {tr} : Turkish, {ota} : Ottoman Turkish (1500-1928), {crh} +: Crimean Turkish, {tk} : Turkmen, {tvl} : Tuvalu, {tyv} : Tuvinian, {tw} : +Twi, {udm} : Udmurt, {uga} : Ugaritic, {ug} : Uighur, {uk} : Ukrainian, +{umb} : Umbundu, {und} : Undetermined, {ur} : Urdu, {uz} : Uzbek, {vai} : +Vai, {ve} : Venda, {vi} : Vietnamese, {vo} : Volapuk, {vot} : Votic, [{wak} +: Wakashan languages], {wa} : Walloon, {wal} : Walamo, {war} : Waray, {was} +: Washo, {cy} : Welsh, {wo} : Wolof, {x-...} : Unregistered (Semi-Private +Use), {xh} : Xhosa, {sah} : Yakut, {yao} : Yao, {yap} : Yapese, {ii} : +Sichuan Yi, {yi} : Yiddish, {yo} : Yoruba, [{ypk} : Yupik languages], {znd} +: Zande, [{zap} : Zapotec], {zen} : Zenaga, {za} : Zhuang, {zu} : Zulu, +{zun} : Zuni =item SEE ALSO @@ -11982,6 +15409,8 @@ Zhuang, {zu} : Zulu, {zun} : Zuni =item DESCRIPTION +=item DEPRECATED + =back =head2 IO::Dir - supply object methods for directory handles @@ -11993,7 +15422,7 @@ Zhuang, {zu} : Zulu, {zun} : Zuni =item DESCRIPTION new ( [ DIRNAME ] ), open ( DIRNAME ), read (), seek ( POS ), tell (), -rewind (), close (), tie %hash, IO::Dir, DIRNAME [, OPTIONS ] +rewind (), close (), tie %hash, 'IO::Dir', DIRNAME [, OPTIONS ] =item SEE ALSO @@ -12017,7 +15446,7 @@ new ( FILENAME [,MODE [,PERMS]] ), new_tmpfile =item METHODS -open( FILENAME [,MODE [,PERMS]] ) +open( FILENAME [,MODE [,PERMS]] ), open( FILENAME, IOLAYERS ) =item SEE ALSO @@ -12133,7 +15562,7 @@ new ( [ HANDLES ] ) add ( HANDLES ), remove ( HANDLES ), exists ( HANDLE ), handles, can_read ( [ TIMEOUT ] ), can_write ( [ TIMEOUT ] ), has_exception ( [ TIMEOUT ] ), -count (), bits(), select ( READ, WRITE, ERROR [, TIMEOUT ] ) +count (), bits(), select ( READ, WRITE, EXCEPTION [, TIMEOUT ] ) =item EXAMPLE @@ -12231,7 +15660,7 @@ handles =item DESCRIPTION new ( [ DIRNAME ] ), open ( DIRNAME ), read (), seek ( POS ), tell (), -rewind (), close (), tie %hash, IO::Dir, DIRNAME [, OPTIONS ] +rewind (), close (), tie %hash, 'IO::Dir', DIRNAME [, OPTIONS ] =item SEE ALSO @@ -12255,7 +15684,7 @@ new ( FILENAME [,MODE [,PERMS]] ), new_tmpfile =item METHODS -open( FILENAME [,MODE [,PERMS]] ) +open( FILENAME [,MODE [,PERMS]] ), open( FILENAME, IOLAYERS ) =item SEE ALSO @@ -12374,7 +15803,7 @@ new ( [ HANDLES ] ) add ( HANDLES ), remove ( HANDLES ), exists ( HANDLE ), handles, can_read ( [ TIMEOUT ] ), can_write ( [ TIMEOUT ] ), has_exception ( [ TIMEOUT ] ), -count (), bits(), select ( READ, WRITE, ERROR [, TIMEOUT ] ) +count (), bits(), select ( READ, WRITE, EXCEPTION [, TIMEOUT ] ) =item EXAMPLE @@ -12612,6 +16041,8 @@ set ( NAME => VALUE [, NAME => VALUE ...] ), setall ( VALUES ), setval ( N first BLOCK LIST, max LIST, maxstr LIST, min LIST, minstr LIST, reduce BLOCK LIST, shuffle LIST, sum LIST +=item KNOWN BUGS + =item SUGGESTED ADDITIONS =item COPYRIGHT @@ -12630,6 +16061,8 @@ general-utility list subroutines first BLOCK LIST, max LIST, maxstr LIST, min LIST, minstr LIST, reduce BLOCK LIST, shuffle LIST, sum LIST +=item KNOWN BUGS + =item SUGGESTED ADDITIONS =item COPYRIGHT @@ -12645,8 +16078,11 @@ general-utility scalar subroutines =item DESCRIPTION -blessed EXPR, dualvar NUM, STRING, isweak EXPR, readonly SCALAR, reftype -EXPR, tainted EXPR, weaken REF +blessed EXPR, dualvar NUM, STRING, isvstring EXPR, isweak EXPR, +looks_like_number EXPR, openhandle FH, refaddr EXPR, reftype EXPR, +set_prototype CODEREF, PROTOTYPE, tainted EXPR, weaken REF + +=item KNOWN BUGS =item COPYRIGHT @@ -12666,7 +16102,7 @@ EXPR, tainted EXPR, weaken REF =item SEE ALSO -Locale::Language, Locale::Country, Locale::Currency +Locale::Language, Locale::Country, Locale::Script, Locale::Currency =item AUTHOR @@ -12680,40 +16116,28 @@ Locale::Language, Locale::Country, Locale::Currency =item SYNOPSIS -=back - -=over 4 - =item DESCRIPTION B, B, B -=back - -=over 4 - =item CONVERSION ROUTINES code2country( CODE, [ CODESET ] ), country2code( STRING, [ CODESET ] ), country_code2code( CODE, CODESET, CODESET ) -=back - -=over 4 - =item QUERY ROUTINES C, C -=back +=item SEMI-PRIVATE ROUTINES =over 4 -=item CODE ALIASING +=item alias_code -=back +=item rename_country -=over 4 +=back =item EXAMPLES @@ -12723,10 +16147,10 @@ C, C =item SEE ALSO -Locale::Language, Locale::Currency, ISO 3166, -http://www.din.de/gremien/nas/nabd/iso3166ma/, +Locale::Language, Locale::Script, Locale::Currency, Locale::SubCountry, ISO +3166-1, http://www.iso.org/iso/en/prods-services/iso3166ma/index.html, http://www.egt.ie/standards/iso3166/iso3166-1-en.html, -http://www.cia.gov/cia/publications/factbook/docs/app-f.html +http://www.cia.gov/cia/publications/factbook/docs/app-d-1.html =item AUTHOR @@ -12741,41 +16165,26 @@ identification (ISO 4217) =item SYNOPSIS -=back - -=over 4 - =item DESCRIPTION XTS, XXX -=back - -=over 4 - =item CONVERSION ROUTINES code2currency(), currency2code() -=back - -=over 4 - =item QUERY ROUTINES C, C -=back - -=over 4 - =item EXAMPLES =item KNOWN BUGS AND LIMITATIONS =item SEE ALSO -Locale::Country, ISO 4217:1995, http://www.bsi-global.com/iso4217currency +Locale::Country, Locale::Script, ISO 4217:1995, +http://www.bsi-global.com/iso4217currency =item AUTHOR @@ -12790,39 +16199,23 @@ Locale::Country, ISO 4217:1995, http://www.bsi-global.com/iso4217currency =item SYNOPSIS -=back - -=over 4 - =item DESCRIPTION -=back - -=over 4 - =item CONVERSION ROUTINES code2language(), language2code() -=back - -=over 4 - =item QUERY ROUTINES C, C -=back - -=over 4 - =item EXAMPLES =item KNOWN BUGS AND LIMITATIONS =item SEE ALSO -Locale::Country, Locale::Currency, ISO 639:1988 (E/F), +Locale::Country, Locale::Script, Locale::Currency, ISO 639:1988 (E/F), http://lcweb.loc.gov/standards/iso639-2/langhome.html =item AUTHOR @@ -12831,7 +16224,7 @@ http://lcweb.loc.gov/standards/iso639-2/langhome.html =back -=head2 Locale::Maketext -- framework for localization +=head2 Locale::Maketext - framework for localization =over 4 @@ -12920,6 +16313,46 @@ $language->language_tag(), $language->encoding() =back +=head2 Locale::Script - ISO codes for script identification (ISO 15924) + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +B, B, B + +=over 4 + +=item SPECIAL CODES + +=back + +=item CONVERSION ROUTINES + +code2script( CODE, [ CODESET ] ), script2code( STRING, [ CODESET ] ), +script_code2code( CODE, CODESET, CODESET ) + +=item QUERY ROUTINES + +C, C + +=item EXAMPLES + +=item KNOWN BUGS AND LIMITATIONS + +=item SEE ALSO + +Locale::Language, Locale::Currency, Locale::Country, ISO 15924, +http://www.evertype.com/standards/iso15924/ + +=item AUTHOR + +=item COPYRIGHT + +=back + =head2 MIME::Base64 - Encoding and decoding of base64 strings =over 4 @@ -12928,7 +16361,7 @@ $language->language_tag(), $language->encoding() =item DESCRIPTION -encode_base64($str, [$eol]), decode_base64($str) +encode_base64($str), encode_base64($str, $eol);, decode_base64($str) =item DIAGNOSTICS @@ -12938,6 +16371,8 @@ Premature end of base64 data, Premature padding of base64 data =item COPYRIGHT +=item SEE ALSO + =back =head2 MIME::Base64::QuotedPrint, MIME::QuotedPrint - Encoding and decoding @@ -12949,10 +16384,12 @@ of quoted-printable strings =item DESCRIPTION -encode_qp($str), decode_qp($str); +encode_qp($str), encode_qp($str, $eol), decode_qp($str); =item COPYRIGHT +=item SEE ALSO + =back =head2 MIME::QuotedPrint - Encoding and decoding of quoted-printable @@ -12964,10 +16401,12 @@ strings =item DESCRIPTION -encode_qp($str), decode_qp($str); +encode_qp($str), encode_qp($str, $eol), decode_qp($str); =item COPYRIGHT +=item SEE ALSO + =back =head2 Math::BigFloat - Arbitrary size floating point math package @@ -13001,12 +16440,22 @@ ffround ( +$scale ), ffround ( -$scale ), ffround ( 0 ), fround ( +$scale =item Autocreating constants +=over 4 + +=item Math library + +=item Using Math::BigInt::Lite + +=back + =item BUGS -=item CAVEAT +=item CAVEATS stringify, bstr(), bdiv, Modifying and =, bpow +=item SEE ALSO + =item LICENSE =item AUTHORS @@ -13021,7 +16470,122 @@ stringify, bstr(), bdiv, Modifying and =, bpow =item DESCRIPTION -Canonical notation, Input, Output +Input, Output + +=item METHODS + +=over 4 + +=item config + +=item accuracy + +=item precision + +=item brsft + +=item new + +=item bnan + +=item bzero + +=item binf + +=item bone + +=item is_one()/is_zero()/is_nan()/is_inf() + +=item is_positive()/is_negative() + + $x->is_positive(); # true if >= 0 + $x->is_negative(); # true if < 0 + +=item is_odd()/is_even()/is_int() + +=item bcmp + +=item bacmp + +=item sign + +=item digit + +=item bneg + +=item babs + +=item bnorm + +=item bnot + +=item binc + +=item bdec + +=item badd + +=item bsub + +=item bmul + +=item bdiv + +=item bmod + +=item bmodinv + +=item bmodpow + +=item bpow + +=item blsft + +=item brsft + +=item band + +=item bior + +=item bxor + +=item bnot + +=item bsqrt + +=item bfac + +=item round + +=item bround + +=item bfround + +=item bfloor + +=item bceil + +=item bgcd + +=item blcm + +=item exponent + +=item mantissa + +=item parts + +=item copy + +=item as_number + +=item bsstr + +=item as_hex + +=item as_bin + +=back =item ACCURACY and PRECISION @@ -13056,7 +16620,7 @@ Remarks =item EXAMPLES - use Math::BigInt qw(bstr); + use Math::BigInt; =item Autocreating constants @@ -13066,17 +16630,32 @@ Remarks =item Alternative math libraries +=item SUBCLASSING + +=back + +=item Subclassing Math::BigInt + +=item UPGRADING + +=over 4 + +=item Auto-upgrade + +bsqrt(), div(), blog() + =back =item BUGS -Out of Memory!, Fails to load Calc on Perl prior 5.6.0 +broot() does not work, Out of Memory!, Fails to load Calc on Perl prior +5.6.0 =item CAVEATS -stringify, bstr(), bsstr() and 'cmp', int(), length, bdiv, infinity -handling, Modifying and =, bpow, Overloading -$x, Mixing different object -types, bsqrt() +bstr(), bsstr() and 'cmp', int(), length, bdiv, infinity handling, +Modifying and =, bpow, Overloading -$x, Mixing different object types, +bsqrt(), brsft() =item LICENSE @@ -13094,20 +16673,97 @@ types, bsqrt() =item DESCRIPTION -=item EXPORT +=item STORAGE + +=item METHODS + +=item WRAP YOUR OWN + +=item LICENSE + +This program is free software; you may redistribute it and/or modify it +under +the same terms as Perl itself. + +=item AUTHORS + +=item SEE ALSO + +=back + +=head2 Math::BigRat - arbitrarily big rationals + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=over 4 + +=item MATH LIBRARY + +=back + +=item METHODS + +=over 4 + +=item new() + +=item numerator() + +=item denominator() + + $d = $x->denominator(); + +=item parts() + +=item as_number() + +=item bfac() + +=item blog() + +=item bround()/round()/bfround() + +=item bmod() + +=item is_one() + +=item is_zero() + +=item is_positive() + +=item is_negative() + +=item is_int() + +=item is_odd() + +=item is_even() + +=item bceil() + +=item bfloor() + + $x->bfloor(); + +=item config + +=back + +=item BUGS -=item WRAP YOUR OWN +inf handling (partial), NaN handling (partial), rounding (not implemented +except for bceil/bfloor), $x ** $y where $y is not an integer =item LICENSE -This program is free software; you may redistribute it and/or modify it -under -the same terms as Perl itself. +=item SEE ALSO =item AUTHORS -=item SEE ALSO - =back =head2 Math::Complex - complex numbers and associated mathematical @@ -13194,7 +16850,7 @@ cylindrical_to_spherical, spherical_to_cartesian, spherical_to_cylindrical =back -=head2 Memoize - Make your functions faster by trading space for time +=head2 Memoize - Make functions faster by trading space for time =over 4 @@ -13312,23 +16968,6 @@ Storable use =back -=head2 Memoize::Saves - Plug-in module to specify which return values -should be memoized - -=over 4 - -=item SYNOPSIS - -=item DESCRIPTION - -=item CAVEATS - -=item AUTHOR - -=item SEE ALSO - -=back - =head2 Memoize::Storable - store Memoized data in Storable database =over 4 @@ -13359,7 +16998,8 @@ C, C, C =back -=head2 NEXT - Provide a pseudo-class NEXT that allows method redispatch +=head2 NEXT - Provide a pseudo-class NEXT (et al) that allows method +redispatch =over 4 @@ -13367,6 +17007,18 @@ C, C, C =item DESCRIPTION +=over 4 + +=item Enforcing redispatch + +=item Avoiding repetitions + +=item Invoking all versions of a method with a single call + +=item Using C methods + +=back + =item AUTHOR =item BUGS AND IRRITATIONS @@ -13392,7 +17044,7 @@ dataend () debug_print ( DIR, TEXT ), debug_text ( TEXT ), command ( CMD [, ARGS, ... ]), unsupported (), response (), parse_response ( TEXT ), getline (), -ungetline ( TEXT ), read_until_dot () +ungetline ( TEXT ), rawdatasend ( DATA ), read_until_dot (), tied_fh () =item EXPORTS @@ -13456,18 +17108,18 @@ new (HOST [,OPTIONS]) =item METHODS login ([LOGIN [,PASSWORD [, ACCOUNT] ] ]), authorize ( [AUTH [, RESP]]), -site (ARGS), type (TYPE [, ARGS]), ascii ([ARGS]) binary([ARGS]) -ebcdic([ARGS]) byte([ARGS]), rename ( OLDNAME, NEWNAME ), delete ( FILENAME -), cwd ( [ DIR ] ), cdup (), pwd (), restart ( WHERE ), rmdir ( DIR ), -mkdir ( DIR [, RECURSE ]), ls ( [ DIR ] ), dir ( [ DIR ] ), get ( -REMOTE_FILE [, LOCAL_FILE [, WHERE]] ), put ( LOCAL_FILE [, REMOTE_FILE ] -), put_unique ( LOCAL_FILE [, REMOTE_FILE ] ), append ( LOCAL_FILE [, -REMOTE_FILE ] ), unique_name (), mdtm ( FILE ), size ( FILE ), supported ( -CMD ), hash ( [FILEHANDLE_GLOB_REF],[ BYTES_PER_HASH_MARK] ), nlst ( [ DIR -] ), list ( [ DIR ] ), retr ( FILE ), stor ( FILE ), stou ( FILE ), appe ( -FILE ), port ( [ PORT ] ), pasv (), pasv_xfer ( SRC_FILE, DEST_SERVER [, -DEST_FILE ] ), pasv_xfer_unique ( SRC_FILE, DEST_SERVER [, DEST_FILE ] ), -pasv_wait ( NON_PASV_SERVER ), abort (), quit () +site (ARGS), ascii, binary, rename ( OLDNAME, NEWNAME ), delete ( FILENAME +), cwd ( [ DIR ] ), cdup (), pwd (), restart ( WHERE ), rmdir ( DIR [, +RECURSE ]), mkdir ( DIR [, RECURSE ]), ls ( [ DIR ] ), alloc ( SIZE [, +RECORD_SIZE] ), dir ( [ DIR ] ), get ( REMOTE_FILE [, LOCAL_FILE [, WHERE]] +), put ( LOCAL_FILE [, REMOTE_FILE ] ), put_unique ( LOCAL_FILE [, +REMOTE_FILE ] ), append ( LOCAL_FILE [, REMOTE_FILE ] ), unique_name (), +mdtm ( FILE ), size ( FILE ), supported ( CMD ), hash ( +[FILEHANDLE_GLOB_REF],[ BYTES_PER_HASH_MARK] ), nlst ( [ DIR ] ), list ( [ +DIR ] ), retr ( FILE ), stor ( FILE ), stou ( FILE ), appe ( FILE ), port ( +[ PORT ] ), pasv (), pasv_xfer ( SRC_FILE, DEST_SERVER [, DEST_FILE ] ), +pasv_xfer_unique ( SRC_FILE, DEST_SERVER [, DEST_FILE ] ), pasv_wait ( +NON_PASV_SERVER ), abort (), quit () =over 4 @@ -13484,7 +17136,7 @@ bytes_read (), abort (), close () =item UNIMPLEMENTED -B, B, B, B, B, B, B, B +B, B, B, B, B, B, B =item REPORTING BUGS @@ -13494,7 +17146,7 @@ B, B, B, B, B, B, B, B =item USE EXAMPLES -http://www.csh.rit.edu/~adam/Progs/autoftp-2.0.tar.gz +http://www.csh.rit.edu/~adam/Progs/ =item CREDITS @@ -13517,11 +17169,12 @@ new ( [ HOST ] [, OPTIONS ]) =item METHODS article ( [ MSGID|MSGNUM ], [FH] ), body ( [ MSGID|MSGNUM ], [FH] ), head ( -[ MSGID|MSGNUM ], [FH] ), nntpstat ( [ MSGID|MSGNUM ] ), group ( [ GROUP ] -), ihave ( MSGID [, MESSAGE ]), last (), date (), postok (), authinfo ( -USER, PASS ), list (), newgroups ( SINCE [, DISTRIBUTIONS ]), newnews ( -SINCE [, GROUPS [, DISTRIBUTIONS ]]), next (), post ( [ MESSAGE ] ), slave -(), quit () +[ MSGID|MSGNUM ], [FH] ), articlefh ( [ MSGID|MSGNUM ] ), bodyfh ( [ +MSGID|MSGNUM ] ), headfh ( [ MSGID|MSGNUM ] ), nntpstat ( [ MSGID|MSGNUM ] +), group ( [ GROUP ] ), ihave ( MSGID [, MESSAGE ]), last (), date (), +postok (), authinfo ( USER, PASS ), list (), newgroups ( SINCE [, +DISTRIBUTIONS ]), newnews ( SINCE [, GROUPS [, DISTRIBUTIONS ]]), next (), +post ( [ MESSAGE ] ), postfh (), slave (), quit () =over 4 @@ -13549,7 +17202,7 @@ MESSAGE-SPEC, PATTERN, Examples, C<[^]-]>, C<*bdc>, C<[0-9a-zA-Z]>, C =back -=head2 Net::POP3 - Post Office Protocol 3 Client class (RFC1081) +=head2 Net::POP3 - Post Office Protocol 3 Client class (RFC1939) =over 4 @@ -13557,18 +17210,16 @@ MESSAGE-SPEC, PATTERN, Examples, C<[^]-]>, C<*bdc>, C<[0-9a-zA-Z]>, C =item DESCRIPTION -=item EXAMPLES - =item CONSTRUCTOR new ( [ HOST, ] [ OPTIONS ] ) =item METHODS -user ( USER ), pass ( PASS ), login ( [ USER [, PASS ]] ), apop ( USER, -PASS ), top ( MSGNUM [, NUMLINES ] ), list ( [ MSGNUM ] ), get ( MSGNUM [, -FH ] ), last (), popstat (), ping ( USER ), uidl ( [ MSGNUM ] ), delete ( -MSGNUM ), reset (), quit () +user ( USER ), pass ( PASS ), login ( [ USER [, PASS ]] ), apop ( [ USER [, +PASS ]] ), top ( MSGNUM [, NUMLINES ] ), list ( [ MSGNUM ] ), get ( MSGNUM +[, FH ] ), getfh ( MSGNUM ), last (), popstat (), ping ( USER ), uidl ( [ +MSGNUM ] ), delete ( MSGNUM ), reset (), quit () =item NOTES @@ -13588,19 +17239,29 @@ MSGNUM ), reset (), quit () =item DESCRIPTION -icmp, udp, tcp, stream, external - =over 4 =item Functions -Net::Ping->new([$proto [, $def_timeout [, $bytes]]]);, $p->ping($host [, -$timeout]);, $p->open($host);, $p->close();, pingecho($host [, $timeout]); +Net::Ping->new([$proto [, $def_timeout [, $bytes [, $device [, $tos +]]]]]);, $p->ping($host [, $timeout]);, $p->source_verify( { 0 | 1 } );, +$p->service_check( { 0 | 1 } );, $p->tcp_service_check( { 0 | 1 } );, +$p->hires( { 0 | 1 } );, $p->bind($local_addr);, $p->open($host);, $p->ack( +[ $host ] );, $p->nack( $failed_ack_host );, $p->close();, pingecho($host +[, $timeout]); =back =item NOTES +=item INSTALL + +=item BUGS + +=item AUTHORS + +=item COPYRIGHT + =back =head2 Net::SMTP - Simple Mail Transfer Protocol Client @@ -13619,12 +17280,15 @@ new Net::SMTP [ HOST, ] [ OPTIONS ] =item METHODS -banner (), domain (), hello ( DOMAIN ), etrn ( DOMAIN ), mail ( ADDRESS [, -OPTIONS] ), send ( ADDRESS ), send_or_mail ( ADDRESS ), send_and_mail ( -ADDRESS ), reset (), recipient ( ADDRESS [, ADDRESS [ ...]] [, OPTIONS ] ), -to ( ADDRESS [, ADDRESS [...]] ), cc ( ADDRESS [, ADDRESS [...]] ), bcc ( -ADDRESS [, ADDRESS [...]] ), data ( [ DATA ] ), expand ( ADDRESS ), verify -( ADDRESS ), help ( [ $subject ] ), quit () +banner (), domain (), hello ( DOMAIN ), etrn ( DOMAIN ), auth ( USERNAME, +PASSWORD ), mail ( ADDRESS [, OPTIONS] ), send ( ADDRESS ), send_or_mail ( +ADDRESS ), send_and_mail ( ADDRESS ), reset (), recipient ( ADDRESS [, +ADDRESS [ ...]] [, OPTIONS ] ), to ( ADDRESS [, ADDRESS [...]] ), cc ( +ADDRESS [, ADDRESS [...]] ), bcc ( ADDRESS [, ADDRESS [...]] ), data ( [ +DATA ] ), expand ( ADDRESS ), verify ( ADDRESS ), help ( [ $subject ] ), +quit () + +=item ADDRESSES =item SEE ALSO @@ -13859,6 +17523,8 @@ login (), password (), account (), lpa () =item IMPLEMENTATION +=item BUGS + =item AUTHOR =back @@ -13998,17 +17664,17 @@ cuserid, difftime, div, dup, dup2, errno, execl, execle, execlp, execv, execve, execvp, exit, exp, fabs, fclose, fcntl, fdopen, feof, ferror, fflush, fgetc, fgetpos, fgets, fileno, floor, fmod, fopen, fork, fpathconf, fprintf, fputc, fputs, fread, free, freopen, frexp, fscanf, fseek, fsetpos, -fstat, ftell, fwrite, getc, getchar, getcwd, getegid, getenv, geteuid, -getgid, getgrgid, getgrnam, getgroups, getlogin, getpgrp, getpid, getppid, -getpwnam, getpwuid, gets, getuid, gmtime, isalnum, isalpha, isatty, -iscntrl, isdigit, isgraph, islower, isprint, ispunct, isspace, isupper, -isxdigit, kill, labs, ldexp, ldiv, link, localeconv, localtime, log, log10, -longjmp, lseek, malloc, mblen, mbstowcs, mbtowc, memchr, memcmp, memcpy, -memmove, memset, mkdir, mkfifo, mktime, modf, nice, offsetof, open, -opendir, pathconf, pause, perror, pipe, pow, printf, putc, putchar, puts, -qsort, raise, rand, read, readdir, realloc, remove, rename, rewind, -rewinddir, rmdir, scanf, setgid, setjmp, setlocale, setpgid, setsid, -setuid, sigaction, siglongjmp, sigpending, sigprocmask, sigsetjmp, +fstat, fsync, ftell, fwrite, getc, getchar, getcwd, getegid, getenv, +geteuid, getgid, getgrgid, getgrnam, getgroups, getlogin, getpgrp, getpid, +getppid, getpwnam, getpwuid, gets, getuid, gmtime, isalnum, isalpha, +isatty, iscntrl, isdigit, isgraph, islower, isprint, ispunct, isspace, +isupper, isxdigit, kill, labs, ldexp, ldiv, link, localeconv, localtime, +log, log10, longjmp, lseek, malloc, mblen, mbstowcs, mbtowc, memchr, +memcmp, memcpy, memmove, memset, mkdir, mkfifo, mktime, modf, nice, +offsetof, open, opendir, pathconf, pause, perror, pipe, pow, printf, putc, +putchar, puts, qsort, raise, rand, read, readdir, realloc, remove, rename, +rewind, rewinddir, rmdir, scanf, setgid, setjmp, setlocale, setpgid, +setsid, setuid, sigaction, siglongjmp, sigpending, sigprocmask, sigsetjmp, sigsuspend, sin, sinh, sleep, sprintf, sqrt, srand, sscanf, stat, strcat, strchr, strcmp, strcoll, strcpy, strcspn, strerror, strftime, strlen, strncat, strncmp, strncpy, strpbrk, strrchr, strspn, strstr, strtod, @@ -14024,7 +17690,7 @@ wctomb, write =item POSIX::SigAction -new +new, handler, mask, flags, safe =item POSIX::SigSet @@ -14102,7 +17768,8 @@ Constants =item WAIT -Constants, Macros +Constants, WNOHANG, WUNTRACED, Macros, WIFEXITED, WEXITSTATUS, WIFSIGNALED, +WTERMSIG, WIFSTOPPED, WSTOPSIG =back @@ -14115,12 +17782,20 @@ name space =item DESCRIPTION -unix, stdio, perlio, crlf, utf8, raw +:unix, :stdio, :perlio, :crlf, :mmap, :utf8, :bytes, :raw, :pop, :win32 =over 4 +=item Custom Layers + +:encoding, :via + +=item Alternatives to raw + =item Defaults and how to override them +=item Querying the layers of filehandles + =back =item AUTHOR @@ -14129,7 +17804,19 @@ unix, stdio, perlio, crlf, utf8, raw =back -=head2 PerlIO::Scalar - support module for in-memory IO. +=head2 PerlIO::encoding - encoding layer + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=back + +=head2 PerlIO::scalar - in-memory IO, scalar IO =over 4 @@ -14137,9 +17824,11 @@ unix, stdio, perlio, crlf, utf8, raw =item DESCRIPTION +=item IMPLEMENTATION NOTE + =back -=head2 PerlIO::Via - Helper class for PerlIO layers implemented in perl +=head2 PerlIO::via - Helper class for PerlIO layers implemented in perl =over 4 @@ -14147,14 +17836,41 @@ unix, stdio, perlio, crlf, utf8, raw =item DESCRIPTION -$class->PUSHED([$mode][,$fh]), $obj->POPPED([$fh]), -$class->OPEN($path,$mode[,$fh]), $class->FDOPEN($fd), -$class->SYSOPEN($path,$imode,$perm,$fh), $obj->FILENO($fh), +=item EXPECTED METHODS + +$class->PUSHED([$mode[,$fh]]), $obj->POPPED([$fh]), +$obj->UTF8($bellowFlag,[$fh]), $obj->OPEN($path,$mode[,$fh]), +$obj->BINMODE([,$fh]), $obj->FDOPEN($fd[,$fh]), +$obj->SYSOPEN($path,$imode,$perm,[,$fh]), $obj->FILENO($fh), $obj->READ($buffer,$len,$fh), $obj->WRITE($buffer,$fh), $obj->FILL($fh), $obj->CLOSE($fh), $obj->SEEK($posn,$whence,$fh), $obj->TELL($fh), $obj->UNREAD($buffer,$fh), $obj->FLUSH($fh), $obj->SETLINEBUF($fh), $obj->CLEARERR($fh), $obj->ERROR($fh), $obj->EOF($fh) +=item EXAMPLES + +=over 4 + +=item Example - a Hexadecimal Handle + +=back + +=back + +=head2 PerlIO::via::QuotedPrint - PerlIO layer for quoted-printable strings + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=item ACKNOWLEDGEMENTS + +=item COPYRIGHT + =back =head2 Pod::Checker, podchecker() - check pod documents for syntax errors @@ -14193,12 +17909,13 @@ after =back =item Warnings -multiple occurence of link target I, line containing nothing but +multiple occurrence of link target I, line containing nothing but whitespace in paragraph, file does not start with =head, previous =item has no contents, preceding non-item paragraph(s), =item type mismatch (I vs. I), I unescaped CE> in paragraph, Unknown entity, No items in =over, No argument for =item, empty section in previous paragraph, -Verbatim paragraph in NAME section +Verbatim paragraph in NAME section, =headI without preceding higher +level =item Hyperlinks @@ -14222,6 +17939,8 @@ C<$checker-Epoderror( @args )>, C<$checker-Epoderror( {%opts}, C<$checker-Enum_errors()> +C<$checker-Enum_warnings()> + C<$checker-Ename()> C<$checker-Enode()> @@ -14294,9 +18013,9 @@ C<-inc =E 1>, C<-dirs =E [ $dir1, $dir2, ... ]>, C<-verbose =E =item ARGUMENTS -backlink, cachedir, css, flush, header, help, htmldir, htmlroot, index, -infile, libpods, netscape, outfile, podpath, podroot, quiet, recurse, -title, verbose +backlink, cachedir, css, flush, header, help, hiddendirs, htmldir, +htmlroot, index, infile, libpods, netscape, outfile, podpath, podroot, +quiet, recurse, title, verbose =item EXAMPLE @@ -14638,12 +18357,16 @@ B<_output> B<_replace_special_chars> +B<_replace_special_chars_late> + B<_create_label> B<_create_index> B<_clean_latex_commands> +B<_split_delimited> + =over 4 =item NOTES @@ -14666,17 +18389,36 @@ B<_clean_latex_commands> =item DESCRIPTION -center, date, fixed, fixedbold, fixeditalic, fixedbolditalic, quotes, +center, date, fixed, fixedbold, fixeditalic, fixedbolditalic, name, quotes, release, section =item DIAGNOSTICS roff font should be 1 or 2 chars, not "%s", Invalid link %s, Invalid quote specification "%s", %s:%d: Unknown command paragraph "%s", %s:%d: Unknown -escape EE%sE, %s:%d: Unknown sequence %s, %s:%d: Unmatched =back +escape EE%sE, %s:%d: Unknown formatting code %s, %s:%d: Unmatched +=back =item BUGS +=item CAVEATS + +=item SEE ALSO + +=item AUTHOR + +=item COPYRIGHT AND LICENSE + +=back + +=head2 Pod::ParseLink - Parse an LEE formatting code in POD text + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + =item SEE ALSO =item AUTHOR @@ -15028,6 +18770,163 @@ I|I =back +=head2 Pod::Perldoc::ToChecker - let Perldoc check Pod for errors + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToMan - let Perldoc render Pod as man pages + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item CAVEAT + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToNroff - let Perldoc convert Pod to nroff + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item CAVEAT + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToPod - let Perldoc render Pod as ... Pod! + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToRtf - let Perldoc render Pod as RTF + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToText - let Perldoc render Pod as plaintext + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item CAVEAT + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToTk - let Perldoc use Tk::Pod to render Pod + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=item AUTHOR + +=back + +=head2 Pod::Perldoc::ToXml - let Perldoc render Pod as XML + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=item COPYRIGHT AND DISCLAIMERS + +=item AUTHOR + +=back + +=head2 Pod::PlainText - Convert POD data to formatted ASCII text + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +alt, indent, loose, sentence, width + +=item DIAGNOSTICS + +Bizarre space in item, Can't open %s for reading: %s, Unknown escape: %s, +Unknown sequence: %s, Unmatched =back + +=item RESTRICTIONS + +=item NOTES + +=item SEE ALSO + +=item AUTHOR + +=back + =head2 Pod::Plainer - Perl extension for converting Pod to old style Pod. =over 4 @@ -15163,13 +19062,13 @@ B<-output>, B<-sections>, B<-ranges> =item DESCRIPTION -alt, code, indent, loose, quotes, sentence, width +alt, code, indent, loose, margin, quotes, sentence, width =item DIAGNOSTICS Bizarre space in item, Item called without tag, Can't open %s for reading: -%s, Invalid quote specification "%s", %s:%d: Unknown command paragraph -"%s", %s:%d: Unknown escape: %s, %s:%d: Unknown sequence: %s, %s:%d: +%s, Invalid quote specification "%s", %s:%d: Unknown command paragraph: %s, +%s:%d: Unknown escape: %s, %s:%d: Unknown formatting code: %s, %s:%d: Unmatched =back =item RESTRICTIONS @@ -15221,8 +19120,8 @@ text =back -=head2 Pod::Text::Termcap, Pod::Text::Color - Convert POD data to ASCII -text with format escapes +=head2 Pod::Text::Termcap - Convert POD data to ASCII text with format +escapes =over 4 @@ -15230,6 +19129,8 @@ text with format escapes =item DESCRIPTION +=item NOTES + =item SEE ALSO =item AUTHOR @@ -15331,8 +19232,11 @@ Memory, CPU, Snooping, Signals, State Changes =item DESCRIPTION -blessed EXPR, dualvar NUM, STRING, isweak EXPR, readonly SCALAR, reftype -EXPR, tainted EXPR, weaken REF +blessed EXPR, dualvar NUM, STRING, isvstring EXPR, isweak EXPR, +looks_like_number EXPR, openhandle FH, refaddr EXPR, reftype EXPR, +set_prototype CODEREF, PROTOTYPE, tainted EXPR, weaken REF + +=item KNOWN BUGS =item COPYRIGHT @@ -15416,14 +19320,14 @@ socket.h defines and structure manipulators =item DESCRIPTION inet_aton HOSTNAME, inet_ntoa IP_ADDRESS, INADDR_ANY, INADDR_BROADCAST, -INADDR_LOOPBACK, INADDR_NONE, sockaddr_in PORT, ADDRESS, sockaddr_in -SOCKADDR_IN, pack_sockaddr_in PORT, IP_ADDRESS, unpack_sockaddr_in -SOCKADDR_IN, sockaddr_un PATHNAME, sockaddr_un SOCKADDR_UN, -pack_sockaddr_un PATH, unpack_sockaddr_un SOCKADDR_UN +INADDR_LOOPBACK, INADDR_NONE, sockaddr_family SOCKADDR, sockaddr_in PORT, +ADDRESS, sockaddr_in SOCKADDR_IN, pack_sockaddr_in PORT, IP_ADDRESS, +unpack_sockaddr_in SOCKADDR_IN, sockaddr_un PATHNAME, sockaddr_un +SOCKADDR_UN, pack_sockaddr_un PATH, unpack_sockaddr_un SOCKADDR_UN =back -=head2 Storable - persistency for perl data structures +=head2 Storable - persistence for Perl data structures =over 4 @@ -15439,6 +19343,12 @@ pack_sockaddr_un PATH, unpack_sockaddr_un SOCKADDR_UN =item CANONICAL REPRESENTATION +=item CODE REFERENCES + +=item FORWARD COMPATIBILITY + +utf8 data, restricted hashes, files from future versions of Storable + =item ERROR REPORTING =item WIZARDS ONLY @@ -15461,16 +19371,22 @@ C =back +=item Storable magic + =item EXAMPLES =item WARNING =item BUGS +=over 4 + +=item 64 bit data in perl 5.6.0 and 5.6.1 + +=back + =item CREDITS -=item TRANSLATIONS - =item AUTHOR =item SEE ALSO @@ -15521,6 +19437,8 @@ C =item DESCRIPTION +=item BUGS + =back =head2 Sys::Hostname - Try every conceivable way to get hostname @@ -15545,8 +19463,8 @@ interface to the UNIX syslog(3) calls =item DESCRIPTION openlog $ident, $logopt, $facility, syslog $priority, $format, @args, -setlogmask $mask_priority, setlogsock $sock_type (added in 5.004_02), -closelog +setlogmask $mask_priority, setlogsock $sock_type [$stream_location] (added +in 5.004_02), closelog =item EXAMPLES @@ -15566,8 +19484,8 @@ Perl interface to the UNIX syslog(3) calls =item DESCRIPTION openlog $ident, $logopt, $facility, syslog $priority, $format, @args, -setlogmask $mask_priority, setlogsock $sock_type (added in 5.004_02), -closelog +setlogmask $mask_priority, setlogsock $sock_type [$stream_location] (added +in 5.004_02), closelog =item EXAMPLES @@ -15603,7 +19521,7 @@ ANSI_COLORS_DISABLED =item AUTHORS -=item LICENSE +=item COPYRIGHT AND LICENSE =back @@ -15615,8 +19533,34 @@ ANSI_COLORS_DISABLED =item DESCRIPTION +=over 4 + +=item METHODS + +=back + +=back + +B, OSPEED, TERM + +B, B<$string>, B<$cnt>, B<$FH> + +B, B<$cap>, B<$cnt>, B<$FH> + +B, B<$cap>, B<$col>, B<$row>, B<$FH> + +B + +=over 4 + =item EXAMPLES +=item COPYRIGHT AND LICENSE + +=item AUTHOR + +=item SEE ALSO + =back =head2 Term::Complete - Perl word completion module @@ -15637,8 +19581,8 @@ EtabE, ^D, ^U, EdelE, EbsE =back -=head2 Term::ReadLine - Perl interface to various C packages. If -no real package is found, substitutes stubs instead of basic functions. +=head2 Term::ReadLine - Perl interface to various C packages. +If no real package is found, substitutes stubs instead of basic functions. =over 4 @@ -15648,8 +19592,8 @@ no real package is found, substitutes stubs instead of basic functions. =item Minimal set of supported functions -C, C, C, C, C, $C, -C, C, Attribs, C +C, C, C, C, C, C, C, +C, Attribs, C =item Additional supported functions @@ -15671,11 +19615,14 @@ C, C, C =item DESCRIPTION +=item QUICK START GUIDE + =over 4 =item Functions -B +C, C I>, C [I<1,5,14>]>, +C sub { ... }>, C \&some_sub> =back @@ -15683,7 +19630,9 @@ B B<_to_value> -B +C + +C, I)> =over 4 @@ -15695,7 +19644,7 @@ NORMAL TESTS, SKIPPED TESTS, TODO TESTS =item BUGS and CAVEATS -=item TODO +=item NOTE =item SEE ALSO @@ -15717,160 +19666,383 @@ NORMAL TESTS, SKIPPED TESTS, TODO TESTS B -=back +=back + +=back + +=over 4 + +=item Setting up tests + +B + +=back + +B + +B + +B + +B + +B + +=over 4 + +=item Running tests + +B + +=back + +B, B + +B, B + +B, B + +B + +B + +B + +B + +B + +B + +=over 4 + +=item Test style + +B + +=back + +B + +B, B + +=over 4 + +=item Output + +B + +=back + +B<_print> + +B, B, B + +=over 4 + +=item Test Status and Info + +B + +=back + +B + +B
+ +B + +B + +B<_sanity_check> + +B<_whoa> + +B<_my_exit> + +=over 4 + +=item THREADS + +=item EXAMPLES + +=item SEE ALSO + +=item AUTHORS + +=item COPYRIGHT + +=back + +=head2 Test::Harness - Run Perl standard test scripts with statistics + +=over 4 + +=item VERSION + +=back + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=over 4 + +=item The test script output + +B<'1..M'>, B<'ok', 'not ok'. Ok?>, B, B, +B, B, B, B, B + +=item Taint mode + +=item Configuration variables. + +B<$Test::Harness::Verbose>, B<$Test::Harness::switches> + +=item Failure + +B, B, B, B, B, B, B + +=item Functions + +B + +=back + +=back + +B<_all_ok> + +B<_globdir> + +B<_run_all_tests> + +B<_mk_leader> + +B<_leader_width> + +=over 4 + +=item EXPORT + +=item DIAGNOSTICS + +C, C, C, C, C, C + +=item ENVIRONMENT + +C, C, C, +C, C, C, +C, C, C, +C, C + +=item EXAMPLE + +=item SEE ALSO + +=item AUTHORS + +=item LICENSE + +=item TODO + +=item BUGS + +=item AUTHORS + +=item COPYRIGHT + +=back + +=head2 Test::Harness::Assert - simple assert + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item FUNCTIONS + +=over 4 + +=item C + +=back + +=back + +=over 4 + +=item AUTHOR + +=item SEE ALSO + +=back + +=head2 Test::Harness::Iterator - Internal Test::Harness Iterator + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=back + +=head2 Test::Harness::Straps - detailed analysis of test results + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item Construction + +=over 4 + +=item C + +=back + +=back + +=over 4 + +=item C<_init> =back =over 4 -=item Setting up tests +=item Analysis -B +=over 4 + +=item C =back -B +=back -B +=over 4 -B +=item C -B +=back =over 4 -=item Running tests - -B +=item C =back -B, B - -B +=over 4 -B +=item C<_command_line( $file )> -B +=back =over 4 -=item Test style - -B +=item C<_command> =back -B - -B, B - =over 4 -=item Output - -B +=item C<_switches> =back -B<_print> +=over 4 -B, B, B +=item C<_cleaned_switches> -=over 4 +=back -=item Test Status and Info +=over 4 -B +=item C<_INC2PERL5LIB> =back -B +=over 4 -B
I, B +=item C<_filtered_INC> -B +=back -B<_sanity_check> +=over 4 -B<_whoa> +=item C<_restore_PERL5LIB> -B<_my_exit> +=back =over 4 -=item EXAMPLES +=item Parsing -=item AUTHOR +=over 4 -=item SEE ALSO +=item C<_is_comment> =back -=head2 Test::Harness - run perl standard test scripts with statistics +=back =over 4 -=item SYNOPSIS +=item C<_is_header> -=item DESCRIPTION +=back =over 4 -=item The test script output - -B<'1..M'>, B<'ok', 'not ok'. Ok?>, B, -B<$Test::Harness::verbose>, B<$Test::Harness::switches>, B, -B, B, B, B - -=item Failure +=item C<_is_test> -B, B, B, B, B, B, B +=back -=item Functions +=over 4 -B +=item C<_is_bail_out> =back -=back +=over 4 -B<_all_ok> +=item C<_reset_file_state> -B<_globdir> +=back -B<_run_all_tests> +=over 4 -B<_mk_leader> +=item Results =over 4 -=item EXPORT +=item C<_detailize> -=item DIAGNOSTICS +=back -C, C, C, C, C, C +=back -=item ENVIRONMENT +=over 4 -C, C, C, -C, C, C, -C +=item EXAMPLES -=item EXAMPLE +=item AUTHOR =item SEE ALSO -=item AUTHORS - -=item TODO - -=item BUGS - =back =head2 Test::More - yet another framework for writing test scripts @@ -15903,6 +20075,10 @@ B, B B +B + +B + B B @@ -15911,6 +20087,14 @@ B, B =over 4 +=item Diagnostics + +B + +=back + +=over 4 + =item Module tests B @@ -15927,11 +20111,13 @@ B =back -B +B, B + +When do I use SKIP vs. TODO? =over 4 -=item Comparision functions +=item Comparison functions B @@ -15945,19 +20131,29 @@ B =over 4 +=item Extending and Embedding Test::More + +B + +=back + +=over 4 + =item NOTES =item BUGS and CAVEATS -Making your own ok(), The eq_* family have some caveats, Test::Harness +Making your own ok(), The eq_* family has some caveats, Test::Harness upgrades -=item AUTHOR - =item HISTORY =item SEE ALSO +=item AUTHORS + +=item COPYRIGHT + =back =head2 Test::Simple - Basic utilities for writing tests. @@ -15982,13 +20178,15 @@ B =item HISTORY -=item AUTHOR - =item SEE ALSO -L, L, L, L, L, +L, L, L, L, L, L +=item AUTHORS + +=item COPYRIGHT + =back =head2 Test::Tutorial - A tutorial about writing really basic tests @@ -16023,6 +20221,10 @@ L =item FOOTNOTES +=item AUTHORS + +=item COPYRIGHT + =back =head2 Text::Abbrev, abbrev - create an abbreviation table from a list @@ -16059,6 +20261,10 @@ L =item C +=item C + +[0], [1], [2] + =item C C $listref>, C $listref>, C $str>, @@ -16169,8 +20375,7 @@ unexpand(1) =back -=head2 Thread - manipulate threads in Perl (EXPERIMENTAL, subject to -change) +=head2 Thread - manipulate threads in Perl (for old code only) =over 4 @@ -16182,9 +20387,9 @@ change) =item FUNCTIONS -new \&start_sub, new \&start_sub, LIST, lock VARIABLE, async BLOCK;, -Thread->self, Thread->list, cond_wait VARIABLE, cond_signal VARIABLE, -cond_broadcast VARIABLE, yield +$thread = Thread->new(\&start_sub), $thread = Thread->new(\&start_sub, +LIST), lock VARIABLE, async BLOCK;, Thread->self, cond_wait VARIABLE, +cond_signal VARIABLE, cond_broadcast VARIABLE, yield =item METHODS @@ -16227,9 +20432,12 @@ new, new NUMBER, down, down NUMBER, up, up NUMBER =back =head2 Thread::Signal - Start a thread which runs signal handlers reliably +(for old code) =over 4 +=item CAVEAT + =item SYNOPSIS =item DESCRIPTION @@ -16267,6 +20475,74 @@ SHIFT this, UNSHIFT this, LIST, SPLICE this, offset, length, LIST =back +=head2 Tie::File - Access the lines of a disk file via a Perl array + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=over 4 + +=item C + +=item C + +=item C + +=item C + +=item C + +=item Option Format + +=back + +=item Public Methods + +=over 4 + +=item C + +=item C + +=item C, C, C, and C + +=item C + +=back + +=item Tying to an already-opened filehandle + +=item Deferred Writing + +=over 4 + +=item Autodeferring + +=back + +=item CONCURRENT ACCESS TO FILES + +=item CAVEATS + +=item SUBCLASSING + +=item WHAT ABOUT C? + +=item AUTHOR + +=item LICENSE + +=item WARRANTY + +=item THANKS + +=item TODO + +=back + =head2 Tie::Handle, Tie::StdHandle - base class definitions for tied handles @@ -16287,7 +20563,8 @@ EOF this, TELL this, SEEK this, offset, whence, DESTROY this =back -=head2 Tie::Hash, Tie::StdHash - base class definitions for tied hashes +=head2 Tie::Hash, Tie::StdHash, Tie::ExtraHash - base class definitions for +tied hashes =over 4 @@ -16296,14 +20573,37 @@ EOF this, TELL this, SEEK this, offset, whence, DESTROY this =item DESCRIPTION TIEHASH classname, LIST, STORE this, key, value, FETCH this, key, FIRSTKEY -this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, key, CLEAR this +this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, key, CLEAR +this, SCALAR this -=item CAVEATS +=item Inheriting from B + +=item Inheriting from B + +=item C, C and C =item MORE INFORMATION =back +=head2 Tie::Memoize - add data to hash when needed + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item Inheriting from B + +=item EXAMPLE + +=item BUGS + +=item AUTHOR + +=back + =head2 Tie::RefHash - use references as hash keys =over 4 @@ -16360,20 +20660,29 @@ timers gettimeofday (), usleep ( $useconds ), ualarm ( $useconds [, $interval_useconds ] ), tv_interval, time (), sleep ( $floating_seconds ), -alarm ( $floating_seconds [, $interval_floating_seconds ] ), setitimer, -getitimer ( $which ) +alarm ( $floating_seconds [, $interval_floating_seconds ] ), setitimer ( +$which, $floating_seconds [, $interval_floating_seconds ] ), getitimer ( +$which ) =item EXAMPLES =item C API +=item DIAGNOSTICS + +=over 4 + +=item negative time not invented yet + +=item internal error: useconds < 0 (unsigned ... signed ...) + +=back + =item CAVEATS =item AUTHORS -=item REVISION - -=item COPYRIGHT +=item COPYRIGHT AND LICENSE =back @@ -16389,6 +20698,10 @@ getitimer ( $which ) =item BUGS +=item SUPPORT + +=item AUTHOR + =back =head2 Time::gmtime - by-name interface to Perl's built-in gmtime() @@ -16441,12 +20754,15 @@ function =item DESCRIPTION -$obj->isa( TYPE ), CLASS->isa( TYPE ), isa( VAL, TYPE ), $obj->can( METHOD -), CLASS->can( METHOD ), can( VAL, METHOD ), VERSION ( [ REQUIRE ] ) +C<< $obj->isa( TYPE ) >>, C<< CLASS->isa( TYPE ) >>, C, +C, C<$obj>, C, C, C<< $obj->can( METHOD ) >>, C<< +CLASS->can( METHOD ) >>, C, C + +=item EXPORTS =back -=head2 Unicode::Collate - use UCA (Unicode Collation Algorithm) +=head2 Unicode::Collate - Unicode Collation Algorithm =over 4 @@ -16458,36 +20774,55 @@ $obj->isa( TYPE ), CLASS->isa( TYPE ), isa( VAL, TYPE ), $obj->can( METHOD =item Constructor and Tailoring -alternate, backwards, entry, ignoreName, ignoreChar, level, normalization, -overrideCJK, overrideHangul, preprocess, rearrange, table, undefName, -undefChar, katakana_before_hiragana, upper_before_lower +UCA_Version, backwards, entry, hangul_terminator, ignoreName, ignoreChar, +level, normalization, overrideCJK, overrideHangul, preprocess, rearrange, +table, undefName, undefChar, katakana_before_hiragana, upper_before_lower, +variable, alternate -=item Other methods +=item Methods for Collation C<@sorted = $Collator-Esort(@not_sorted)>, C<$result = $Collator-Ecmp($a, $b)>, C<$result = $Collator-Eeq($a, $b)>, C<$result = $Collator-Ene($a, $b)>, C<$result = $Collator-Elt($a, $b)>, C<$result = $Collator-Ele($a, $b)>, C<$result = $Collator-Egt($a, $b)>, C<$result = $Collator-Ege($a, $b)>, -C<$sortKey = $Collator-EgetSortKey($string)>, C<$position = -$Collator-Eindex($string, $substring)>, C<($position, $length) = -$Collator-Eindex($string, $substring)> +C<$sortKey = $Collator-EgetSortKey($string)>, C<$sortKeyForm = +$Collator-EviewSortKey($string)> + +=item Methods for Searching + +C<$position = $Collator-Eindex($string, $substring[, $position])>, +C<($position, $length) = $Collator-Eindex($string, $substring[, +$position])>, C<$match_ref = $Collator-Ematch($string, $substring)>, +C<($match) = $Collator-Ematch($string, $substring)>, C<@match = +$Collator-Egmatch($string, $substring)>, C<$count = +$Collator-Esubst($string, $substring, $replacement)>, C<$count = +$Collator-Egsubst($string, $substring, $replacement)> + +=item Other Methods + +C<%old_tailoring = $Collator-Echange(%new_tailoring)>, C<$version = +$Collator-Eversion()>, C, C =item EXPORT =item CAVEAT +=item Conformance Test + =back =item AUTHOR =item SEE ALSO -Unicode Collation Algorithm - Unicode TR #10, L +Unicode Collation Algorithm - UTS #10, The Default Unicode Collation +Element Table (DUCET), The conformance test for the UCA, Hangul Syllable +Type, Unicode Normalization Forms - UAX #15, L =back -=head2 Unicode::Normalize - normalized forms of Unicode text +=head2 Unicode::Normalize - Unicode Normalization Forms =over 4 @@ -16495,12 +20830,38 @@ Unicode Collation Algorithm - Unicode TR #10, L =item DESCRIPTION -C<$string_NFD = NFD($raw_string)>, C<$string_NFC = NFC($raw_string)>, -C<$string_NFKD = NFKD($raw_string)>, C<$string_NFKC = NFKC($raw_string)>, -C<$normalized_string = normalize($form_name, $raw_string)> - =over 4 +=item Normalization Forms + +C<$NFD_string = NFD($string)>, C<$NFC_string = NFC($string)>, +C<$NFKD_string = NFKD($string)>, C<$NFKC_string = NFKC($string)>, +C<$FCD_string = FCD($string)>, C<$FCC_string = FCC($string)>, +C<$normalized_string = normalize($form_name, $string)> + +=item Decomposition and Composition + +C<$decomposed_string = decompose($string)>, C<$decomposed_string = +decompose($string, $useCompatMapping)>, C<$reordered_string = +reorder($string)>, C<$composed_string = compose($string)> + +=item Quick Check + +C<$result = checkNFD($string)>, C<$result = checkNFC($string)>, C<$result = +checkNFKD($string)>, C<$result = checkNFKC($string)>, C<$result = +checkFCD($string)>, C<$result = checkFCC($string)>, C<$result = +check($form_name, $string)> + +=item Character Data + +C<$canonical_decomposed = getCanon($codepoint)>, +C<$compatibility_decomposed = getCompat($codepoint)>, +C<$codepoint_composite = getComposite($codepoint_here, $codepoint_next)>, +C<$combining_class = getCombinClass($codepoint)>, C<$is_exclusion = +isExclusion($codepoint)>, C<$is_singleton = isSingleton($codepoint)>, +C<$is_non_starter_decomposition = isNonStDecomp($codepoint)>, +C<$may_be_composed_with_prev_char = isComp2nd($codepoint)> + =item EXPORT =back @@ -16509,7 +20870,9 @@ C<$normalized_string = normalize($form_name, $raw_string)> =item SEE ALSO -L, http://www.unicode.org/unicode/reports/tr15/ +http://www.unicode.org/reports/tr15/, +http://www.unicode.org/Public/UNIDATA/DerivedNormalizationProps.txt, +http://www.unicode.org/notes/tn5/ =back @@ -16657,24 +21020,26 @@ Win32::AbortSystemShutdown(MACHINE), Win32::BuildNumber(), Win32::CopyFile(FROM, TO, OVERWRITE), Win32::DomainName(), Win32::ExpandEnvironmentStrings(STRING), Win32::FormatMessage(ERRORCODE), Win32::FsType(), Win32::FreeLibrary(HANDLE), Win32::GetArchName(), -Win32::GetChipName(), Win32::GetCwd(), Win32::GetFullPathName(FILENAME), -Win32::GetLastError(), Win32::GetLongPathName(PATHNAME), -Win32::GetNextAvailDrive(), Win32::GetOSVersion(), +Win32::GetChipName(), Win32::GetCwd(), Win32::GetFolderPath(FOLDER [, +CREATE]), Win32::GetFullPathName(FILENAME), Win32::GetLastError(), +Win32::GetLongPathName(PATHNAME), Win32::GetNextAvailDrive(), +Win32::GetOSVersion(), Win32::GetOSName(), Win32::GetShortPathName(PATHNAME), Win32::GetProcAddress(INSTANCE, PROCNAME), Win32::GetTickCount(), Win32::InitiateSystemShutdown, Win32::IsWinNT(), Win32::IsWin95(), Win32::LoadLibrary(LIBNAME), Win32::LoginName(), Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID, SIDTYPE), Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE), Win32::MsgBox(MESSAGE [, FLAGS [, TITLE]]), Win32::NodeName(), -Win32::RegisterServer(LIBRARYNAME), Win32::SetCwd(NEWDIRECTORY), -Win32::SetLastError(ERROR), Win32::Sleep(TIME), Win32::Spawn(COMMAND, ARGS, -PID), Win32::UnregisterServer(LIBRARYNAME) +Win32::RegisterServer(LIBRARYNAME), Win32::SetChildShowWindow(SHOWWINDOW), +Win32::SetCwd(NEWDIRECTORY), Win32::SetLastError(ERROR), +Win32::Sleep(TIME), Win32::Spawn(COMMAND, ARGS, PID), +Win32::UnregisterServer(LIBRARYNAME) =back =back -=head2 XS::Typemap - module to test the XS typemaps distributed with perl +=head2 XSLoader - Dynamically load C libraries into Perl code =over 4 @@ -16682,23 +21047,23 @@ PID), Win32::UnregisterServer(LIBRARYNAME) =item DESCRIPTION -=back - =over 4 -=item NOTES +=item Migration from C -=item AUTHOR +=item Backward compatible boilerplate =back -=head2 XSLoader - Dynamically load C libraries into Perl code +=item Order of initialization: early load() =over 4 -=item SYNOPSIS +=item The most hairy case -=item DESCRIPTION +=back + +=item LIMITATIONS =item AUTHOR @@ -16713,21 +21078,29 @@ don't all have manual pages yet: =item a2p -=item s2p +=item c2ph -=item find2perl +=item dprofpp =item h2ph -=item c2ph - =item h2xs -=item xsubpp +=item perlbug + +=item perldoc + +=item pl2pm + +=item pod2html =item pod2man -=item wrapsuid +=item s2p + +=item splain + +=item xsubpp =back