X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperltoc.pod;h=989c1efe019307d0487d2ab2990547bed10df392;hb=5d3b0638f4c2cf44af3831abe68fc08048b89bc2;hp=4de23502b58c80e89476bf713c046c67c353f830;hpb=cb1a09d0194fed9b905df7b04a4bc031d354609d;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perltoc.pod b/pod/perltoc.pod index 4de2350..989c1ef 100644 --- a/pod/perltoc.pod +++ b/pod/perltoc.pod @@ -6,2755 +6,4926 @@ perltoc - perl documentation table of contents =head1 DESCRIPTION This page provides a brief table of contents for the rest of the Perl -documentation set. +documentation set. It is meant to be scanned quickly or grepped +through to locate the proper section you're looking for. =head1 BASIC DOCUMENTATION - - - =head2 perl - Practical Extraction and Report Language =item SYNOPSIS - =item DESCRIPTION - Many usability enhancements, Simplified grammar, Lexical scoping, Arbitrarily nested data structures, Modularity and reusability, -Object-oriented programming, Embeddible and Extensible, POSIX -compliant, Package constructors and destructors, Multiple simultaneous -DBM implementations, Subroutine definitions may now be autoloaded, -Regular expression enhancements +Object-oriented programming, Embeddable and Extensible, POSIX compliant, +Package constructors and destructors, Multiple simultaneous DBM +implementations, Subroutine definitions may now be autoloaded, Regular +expression enhancements, Innumerable Unbundled Modules, Compilability =item ENVIRONMENT - -HOME, LOGDIR, PATH, PERL5LIB, PERL5DB, PERLLIB - =item AUTHOR - =item FILES - =item SEE ALSO - =item DIAGNOSTICS - =item BUGS - =item NOTES - - - - -=head2 perldata - Perl data types +=head2 perlfaq - frequently asked questions about Perl ($Date: 1997/04/24 +22:46:06 $) =item DESCRIPTION +perlfaq: Structural overview of the FAQ, L: General Questions +About Perl, L: Obtaining and Learning about Perl, L: +Programming Tools, L: Data Manipulation, L: Files and +Formats, L: Regexps, L: General Perl Language Issues, +L: System Interaction, L: Networking =over -=item Variable names +=item Where to get this document +=item How to contribute to this document -=item Context +=item What will happen if you mail your Perl programming problems to the +authors +=back -=item Scalar values +=item Credits +=item Author and Copyright Information -=item Scalar value constructors +=over +=item Noncommercial Reproduction -=item List value constructors +=item Commercial Reproduction +=item Disclaimer -=item Typeglobs and FileHandles +=back +=item Changes +24/April/97, 23/April/97, 25/March/97, 18/March/97, 17/March/97 Version, +Initial Release: 11/March/97 +=head2 perlfaq1 - General Questions About Perl ($Revision: 1.12 $, $Date: +1997/04/24 22:43:34 $) -=back +=item DESCRIPTION +=over +=item What is Perl? +=item Who supports Perl? Who develops it? Why is it free? -=head2 perlsyn - Perl syntax +=item Which version of Perl should I use? -=item DESCRIPTION +=item What are perl4 and perl5? +=item How stable is Perl? -=over +=item Is Perl difficult to learn? -=item Declarations +=item How does Perl compare with other languages like Java, Python, REXX, +Scheme, or Tcl? +=item Can I do [task] in Perl? -=item Simple statements +=item When shouldn't I program in Perl? +=item What's the difference between "perl" and "Perl"? -=item Compound statements +=item Is it a Perl program or a Perl script? +=item What is a JAPH? -=item Loop Control +=item Where can I get a list of Larry Wall witticisms? +=item How can I convince my sysadmin/supervisor/employees to use version +(5/5.004/Perl instead of some other language)? -=item For Loops +=back +=item AUTHOR AND COPYRIGHT -=item Foreach Loops +=head2 perlfaq2 - Obtaining and Learning about Perl ($Revision: 1.16 $, +$Date: 1997/04/23 18:04:09 $) +=item DESCRIPTION -=item Basic BLOCKs and Switch Statements +=over +=item What machines support Perl? Where do I get it? -=item Goto +=item How can I get a binary version of Perl? +=item I don't have a C compiler on my system. How can I compile perl? -=item PODs: Embedded Documentation +=item I copied the Perl binary from one machine to another, but scripts +don't work. +=item I grabbed the sources and tried to compile but gdbm/dynamic +loading/malloc/linking/... failed. How do I make it work? +=item What modules and extensions are available for Perl? What is CPAN? +What does CPAN/src/... mean? +=item Is there an ISO or ANSI certified version of Perl? -=back +=item Where can I get information on Perl? +=item What are the Perl newsgroups on USENET? Where do I post questions? +=item Where should I post source code? +=item Perl Books -=head2 perlop - Perl operators and precedence +=item Perl in Magazines -=item SYNOPSIS +=item Perl on the Net: FTP and WWW Access +=item What mailing lists are there for perl? -=item DESCRIPTION +MacPerl, Perl5-Porters, NTPerl, Perl-Packrats +=item Archives of comp.lang.perl.misc -=over +=item Perl Training -=item Terms and List Operators (Leftward) +=item Where can I buy a commercial version of Perl? +=item Where do I send bug reports? -=item The Arrow Operator +=item What is perl.com? perl.org? The Perl Institute? +=item How do I learn about object-oriented Perl programming? -=item Autoincrement and Autodecrement +=back +=item AUTHOR AND COPYRIGHT -=item Exponentiation +=head2 perlfaq3 - Programming Tools ($Revision: 1.22 $, $Date: 1997/04/24 +22:43:42 $) +=item DESCRIPTION -=item Symbolic Unary Operators +=over +=item How do I do (anything)? -=item Binding Operators +=item How can I use Perl interactively? +=item Is there a Perl shell? -=item Multiplicative Operators +=item How do I debug my Perl programs? +=item How do I profile my Perl programs? -=item Additive Operators +=item How do I cross-reference my Perl programs? +=item Is there a pretty-printer (formatter) for Perl? -=item Shift Operators +=item Is there a ctags for Perl? +=item Where can I get Perl macros for vi? -=item Named Unary Operators +=item Where can I get perl-mode for emacs? +=item How can I use curses with Perl? -=item Relational Operators +=item How can I use X or Tk with Perl? +=item How can I generate simple menus without using CGI or Tk? -=item Equality Operators +=item Can I dynamically load C routines into Perl? +=item What is undump? -=item Bitwise And +=item How can I make my Perl program run faster? +=item How can I make my Perl program take less memory? -=item Bitwise Or and Exclusive Or +=item Is it unsafe to return a pointer to local data? +=item How can I free an array or hash so my program shrinks? -=item C-style Logical And +=item How can I make my CGI script more efficient? +=item How can I hide the source for my Perl program? -=item C-style Logical Or +=item How can I compile my Perl program into byte code or C? +=item How can I get '#!perl' to work on [MS-DOS,NT,...]? -=item Range Operator +=item Can I write useful perl programs on the command line? +=item Why don't perl one-liners work on my DOS/Mac/VMS system? -=item Conditional Operator +=item Where can I learn about CGI or Web programming in Perl? +=item Where can I learn about object-oriented Perl programming? -=item Assignment Operators +=item Where can I learn about linking C with Perl? [h2xs, xsubpp] +=item I've read perlembed, perlguts, etc., but I can't embed perl in +my C program, what am I doing wrong? -=item Comma Operator +=item When I tried to run my script, I got this message. What does it +mean? +=item What's MakeMaker? -=item List Operators (Rightward) +=back +=item AUTHOR AND COPYRIGHT -=item Logical Not +=head2 perlfaq4 - Data Manipulation ($Revision: 1.19 $, $Date: 1997/04/24 +22:43:57 $) +=item DESCRIPTION -=item Logical And +=item Data: Numbers +=over -=item Logical or and Exclusive Or +=item Why am I getting long decimals (eg, 19.9499999999999) instead of the +numbers I should be getting (eg, 19.95)? +=item Why isn't my octal data interpreted correctly? -=item C Operators Missing From Perl +=item Does perl have a round function? What about ceil() and floor()? +Trig functions? +=item How do I convert bits into ints? -unary &, unary *, (TYPE) +=item How do I multiply matrices? -=item Quote and Quotelike Operators +=item How do I perform an operation on a series of integers? +=item How can I output Roman numerals? -=item Regexp Quotelike Operators +=item Why aren't my random numbers random? +=back -?PATTERN?, m/PATTERN/gimosx, /PATTERN/gimosx, q/STRING/, C<'STRING'>, -qq/STRING/, "STRING", qx/STRING/, `STRING`, qw/STRING/, -s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds, -y/SEARCHLIST/REPLACEMENTLIST/cds +=item Data: Dates -=item I/O Operators +=over +=item How do I find the week-of-the-year/day-of-the-year? -=item Constant Folding +=item How can I compare two date strings? +=item How can I take a string and turn it into epoch seconds? -=item Integer arithmetic +=item How can I find the Julian Day? +=item Does Perl have a year 2000 problem? +=back +=item Data: Strings -=back +=over +=item How do I validate input? +=item How do I unescape a string? +=item How do I remove consecutive pairs of characters? -=head2 perlre - Perl regular expressions +=item How do I expand function calls in a string? -=item DESCRIPTION +=item How do I find matching/nesting anything? +=item How do I reverse a string? -=over +=item How do I expand tabs in a string? -=item Regular Expressions +=item How do I reformat a paragraph? +=item How can I access/change the first N letters of a string? -(?#text), (?:regexp), (?=regexp), (?!regexp), (?imsx) +=item How do I change the Nth occurrence of something? -=item Version 8 Regular Expressions +=item How can I count the number of occurrences of a substring within a +string? +=item How do I capitalize all the words on one line? -=item WARNING on \1 vs $1 +=item How can I split a [character] delimited string except when inside +[character]? (Comma-separated files) +=item How do I strip blank space from the beginning/end of a string? +=item How do I extract selected columns from a string? +=item How do I find the soundex value of a string? -=back +=item How can I expand variables in text strings? +=item What's wrong with always quoting "$vars"? +=item Why don't my <I, B<-a>, B<-c>, B<-d>, B<-D>I, B<-D>I, -B<-e> I, B<-F>I, B<-i>I, -B<-I>I, B<-l>I, B<-n>, B<-p>, B<-P>, B<-s>, B<-S>, -B<-T>, B<-u>, B<-U>, B<-v>, B<-w>, B<-x> I +=item How do I find the first array element for which a condition is true? +=item How do I handle linked lists? +=item How do I handle circular lists? -=back +=item How do I shuffle an array randomly? +=item How do I process/modify each element of an array? +=item How do I select a random element from an array? +=item How do I permute N elements of a list? -=head2 perlfunc - Perl builtin functions +=item How do I sort an array by (anything)? -=item DESCRIPTION +=item How do I manipulate arrays of bits? +=item Why does defined() return true on empty arrays and hashes? +=back +=item Data: Hashes (Associative Arrays) =over -=item Perl Functions by Category - +=item How do I process an entire hash? -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 +=item What happens if I add or remove keys from a hash while iterating over +it? -=item Alphabetical Listing of Perl Functions +=item How do I look up a hash element by value? +=item How can I know how many entries are in a hash? --X FILEHANDLE, -X EXPR, -X, abs VALUE, accept NEWSOCKET,GENERICSOCKET, -alarm SECONDS, atan2 Y,X, bind SOCKET,NAME, 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, chroot FILENAME, close FILEHANDLE, closedir -DIRHANDLE, connect SOCKET,NAME, continue BLOCK, cos EXPR, crypt -PLAINTEXT,SALT, dbmclose ASSOC_ARRAY, dbmopen ASSOC,DBNAME,MODE, -defined EXPR, delete EXPR, die LIST, do BLOCK, do SUBROUTINE(LIST), do -EXPR, dump LABEL, each ASSOC_ARRAY, eof FILEHANDLE, eof (), eof, eval -EXPR, eval BLOCK, exec LIST, exists EXPR, exit EXPR, exp EXPR, 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, getservb +=item How do I sort a hash (optionally by value instead of key)? +=item How can I always keep my hash sorted? +=item What's the difference between "delete" and "undef" with hashes? -=back +=item Why don't my tied hashes make the defined/exists distinction? +=item How do I reset an each() operation part-way through? +=item How can I get the unique keys from two hashes? +=item How can I store a multidimensional array in a DBM file? -=head2 perlvar - Perl predefined variables +=item How can I make my hash remember the order I put elements into it? -=item DESCRIPTION +=item Why does passing a subroutine an undefined element in a hash create +it? +=item How can I make the Perl equivalent of a C structure/C++ class/hash or +array of hashes or arrays? -=over +=item How can I use a reference as a hash key? -=item Predefined Names +=back +=item Data: Misc -$ARG, $_, $>, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $', -$LAST_PAREN_MATCH, $+, $MULTILINE_MATCHING, $*, input_line_number -HANDLE EXPR, $INPUT_LINE_NUMBER, $NR, $, input_record_separator HANDLE -EXPR, $INPUT_RECORD_SEPARATOR, $RS, $/, autoflush HANDLE EXPR, -$OUTPUT_AUTOFLUSH, $|, output_field_separator HANDLE EXPR, -$OUTPUT_FIELD_SEPARATOR, $OFS, $,, output_record_separator HANDLE EXPR, -$OUTPUT_RECORD_SEPARATOR, $ORS, $\, $LIST_SEPARATOR, $", -$SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $OFMT, $#, format_page_number HANDLE -EXPR, $FORMAT_PAGE_NUMBER, $%, format_lines_per_page HANDLE EXPR, -$FORMAT_LINES_PER_PAGE, $=, format_lines_left HANDLE EXPR, -$FORMAT_LINES_LEFT, $-, format_name HANDLE EXPR, $FORMAT_NAME, $~, -format_top_name HANDLE EXPR, $FORMAT_TOP_NAME, $^, -format_line_break_characters HANDLE EXPR, -$FORMAT_LINE_BREAK_CHARACTERS, $:, format_formfeed HANDLE EXPR, -$FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A, $CHILD_ERROR, $?, $OS_ERROR, -$ERRNO, $!, $EVAL_ERROR, $@, $PROCESS_ID, $PID, $$, $REAL_USER_ID, -$UID, $<, +=over +=item How do I handle binary data correctly? +=item How do I determine whether a scalar is a number/whole/integer/float? -=back +=item How do I keep persistent data across program calls? +=item How do I print out or copy a recursive data structure? +=item How do I define methods for every class/object? +=item How do I verify a credit card checksum? -=head2 perlsub - Perl subroutines +=back -=item SYNOPSIS +=item AUTHOR AND COPYRIGHT +=head2 perlfaq5 - Files and Formats ($Revision: 1.22 $, $Date: 1997/04/24 +22:44:02 $) =item DESCRIPTION - =over -=item Private Variables via my() +=item How do I flush/unbuffer a filehandle? Why must I do this? +=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 Temporary Values via local() +=item How do I count the number of lines in a file? +=item How do I make a temporary file name? -=item Passing Symbol Table Entries (typeglobs) +=item How can I manipulate fixed-record-length files? +=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 Pass by Reference +=item How can I set up a footer format to be used with write()? +=item How can I write() into a string? -=item Prototypes +=item How can I output my numbers with commas added? +=item How can I translate tildes (~) in a filename? -=item Overriding Builtin Functions +=item How come when I open the file read-write it wipes it out? +=item Why do I sometimes get an "Argument list too long" when I use <*>? -=item Autoloading +=item Is there a leak/bug in glob()? +=item How can I open a file with a leading "E" or trailing blanks? +=item How can I reliably rename a file? +=item How can I lock a file? -=back +=item What can't I just open(FH, ">file.lock")? -=item SEE ALSO +=item I still don't get locking. I just want to increment the number in +the file. How can I do this? +=item How do I randomly update a binary file? +=item How do I get a file's timestamp in perl? +=item How do I set a file's timestamp in perl? +=item How do I print to more than one file at once? -=head2 perlmod - Perl modules (packages) +=item How can I read in a file by paragraphs? -=item DESCRIPTION +=item How can I read a single character from a file? From the keyboard? +=item How can I tell if there's a character waiting on a filehandle? -=over +=item How do I open a file without blocking? -=item Packages +=item How do I create a file only if it doesn't exist? +=item How do I do a C in perl? -=item Symbol Tables +=item How do I dup() a filehandle in Perl? +=item How do I close a file descriptor by number? -=item Package Constructors and Destructors +=item Why can't I use "C:\temp\foo" in DOS paths? What doesn't +`C:\temp\foo.exe` work? +=item Why doesn't glob("*.*") get all the files? -=item Perl Classes +=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 How do I select a random line from a file? -=item Perl Modules +=back +=item AUTHOR AND COPYRIGHT +=head2 perlfaq6 - Regexps ($Revision: 1.17 $, $Date: 1997/04/24 22:44:10 $) +=item DESCRIPTION -=back +=over -=item NOTE +=item How can I hope to use regular expressions without creating illegible +and unmaintainable code? +Comments Outside the Regexp, Comments Inside the Regexp, Different +Delimiters -=item THE PERL MODULE LIBRARY +=item I'm having trouble matching over more than one line. What's wrong? +=item How can I pull out lines between two patterns that are themselves on +different lines? -=over +=item I put a regular expression into $/ but it didn't work. What's wrong? -=item Pragmatic Modules +=item How do I substitute case insensitively on the LHS, but preserving +case on the RHS? +=item How can I make C<\w> match accented characters? -diagnostics, integer, less, overload, sigtrap, strict, subs +=item How can I match a locale-smart version of C? -=item Standard Modules +=item How can I quote a variable to use in a regexp? +=item What is C really for? -AnyDBM_File, AutoLoader, AutoSplit, Benchmark, Carp, Config, Cwd, -DB_File, Devel::SelfStubber, DynaLoader, English, Env, Exporter, -ExtUtils::Liblist, ExtUtils::MakeMaker, ExtUtils::Manifest, -ExtUtils::Mkbootstrap, ExtUtils::Miniperl, Fcntl, File::Basename, -File::CheckTree, File::Find, FileHandle, File::Path, Getopt::Long, -Getopt::Std, I18N::Collate, IPC::Open2, IPC::Open3, Net::Ping, POSIX, -SelfLoader, Socket, Test::Harness, Text::Abbrev +=item How do I use a regular expression to strip C style comments from a +file? -=item Extension Modules +=item Can I use Perl regular expressions to match balanced text? +=item What does it mean that regexps are greedy? How can I get around it? +=item How do I process each word on each line? +=item How can I print out a word-frequency or line-frequency summary? -=back +=item How can I do approximate matching? -=item CPAN +=item How do I efficiently match many regular expressions at once? +=item Why don't word-boundary searches with C<\b> work for me? -Language Extensions and Documentation Tools, Development Support, -Operating System Interfaces, Networking, Device Control (modems) and -InterProcess Communication, Data Types and Data Type Utilities, -Database Interfaces, User Interfaces, Interfaces to / Emulations of -Other Programming Languages, File Names, File Systems and File Locking -(see also File Handles), String Processing, Language Text Processing, -Parsing and Searching, Option, Argument, Parameter and Configuration -File Processing, Internationalization and Locale, Authentication, -Security and Encryption, World Wide Web, HTML, HTTP, CGI, MIME, Server -and Daemon Utilities, Archiving and Compression, Images, Pixmap and -Bitmap Manipulation, Drawing and Graphing, Mail and Usenet News, -Control Flow Utilities (callbacks and exceptions etc), File Handle and -Input/Output Stream Utilities, Miscellaneous Modules +=item Why does using $&, $`, or $' slow my program down? -=item Modules: Creation, Use and Abuse +=item What good is C<\G> in a regular expression? +=item Are Perl regexps DFAs or NFAs? Are they POSIX compliant? -=over +=item What's wrong with using grep or map in a void context? -=item Guidelines for Module Creation +=item How can I match strings with multibyte characters? +=back -Do similar modules already exist in some form?, Try to design the new -module to be easy to extend and reuse, Some simple style guidelines, -Select what to export, Select a name for the module, Have you got it -right?, README and other Additional Files, A description of the -module/package/extension etc, A copyright notice - see below, -Prerequisites - what else you may need to have, How to build it - -possible changes to Makefile.PL etc, How to install it, Recent changes -in this release, especially incompatibilities, Changes / enhancements -you plan to make in the future, Adding a Copyright Notice, Give the -module a version/issue/release number, How to release and distribute a -module, Take care when changing a released module +=item AUTHOR AND COPYRIGHT -=item Guidelines for Converting Perl 4 Library Scripts into Modules +=head2 perlfaq7 - Perl Language Issues ($Revision: 1.18 $, $Date: +1997/04/24 22:44:14 $) +=item DESCRIPTION -There is no requirement to convert anything, Consider the implications, -Make the most of the opportunity, The pl2pm utility will get you -started, Adds the standard Module prologue lines, Converts package -specifiers from ' to ::, Converts die(...) to croak(...), Several other -minor changes +=over -=item Guidelines for Reusing Application Code +=item Can I get a BNF/yacc/RE for the Perl language? +=item What are all these $@%* punctuation signs, and how do I know when to +use them? -Complete applications rarely belong in the Perl Module Library, Many -applications contain some perl code which could be reused, Break-out -the reusable code into one or more separate module files, Take the -opportunity to reconsider and redesign the interfaces, In some cases -the 'application' can then be reduced to a small +=item Do I always/never have to quote my strings or use semicolons and +commas? +=item How do I skip some return values? +=item How do I temporarily block warnings? -=back +=item What's an extension? +=item Why do Perl operators have different precedence than C operators? +=item How do I declare/create a structure? +=item How do I create a module? -=head2 perlref - Perl references and nested data structures +=item How do I create a class? -=item DESCRIPTION +=item How can I tell if a variable is tainted? +=item What's a closure? -=over +=item What is variable suicide and how can I prevent it? -=item Symbolic references +=item How can I pass/return a {Function, FileHandle, Array, Hash, Method, +Regexp}? +Passing Variables and Functions, Passing Filehandles, Passing Regexps, +Passing Methods -=item Not-so-symbolic references +=item How do I create a static variable? +=item What's the difference between dynamic and lexical (static) scoping? +Between local() and my()? +=item How can I access a dynamic variable while a similarly named lexical +is in scope? +=item What's the difference between deep and shallow binding? -=back +=item Why doesn't "local($foo) = ;" work right? -=item WARNING +=item How do I redefine a builtin function, operator, or method? +=item What's the difference between calling a function as &foo and foo()? -=item SEE ALSO +=item How do I create a switch or case statement? +=item How can I catch accesses to undefined variables/functions/methods? +=item Why can't a method included in this same file be found? +=item How can I find out my current package? +=item How can I comment out a large block of perl code? -=head2 perldsc - Perl Data Structures Cookbook +=back -=item DESCRIPTION +=item AUTHOR AND COPYRIGHT +=head2 perlfaq8 - System Interaction ($Revision: 1.21 $, $Date: 1997/04/24 +22:44:19 $) -arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes, -more elaborate constructs, recursive and self-referential data -structures, objects +=item DESCRIPTION -=item REFERENCES +=over +=item How do I find out which operating system I'm running under? -=item COMMON MISTAKES +=item How come exec() doesn't return? +=item How do I do fancy stuff with the keyboard/screen/mouse? -=item CAVEAT ON PRECEDENCE +Keyboard, Screen, Mouse +=item How do I ask the user for a password? -=item WHY YOU SHOULD ALWAYS C +=item How do I read and write the serial port? +lockfiles, open mode, end of line, flushing output, non-blocking input -=item DEBUGGING +=item How do I decode encrypted password files? +=item How do I start a process in the background? -=item CODE EXAMPLES +STDIN, STDOUT and STDERR are shared, Signals, Zombies +=item How do I trap control characters/signals? -=item LISTS OF LISTS +=item How do I modify the shadow password file on a Unix system? +=item How do I set the time and date? -=over +=item How can I sleep() or alarm() for under a second? -=item Declaration of a LIST OF LISTS +=item How can I measure time under a second? +=item How can I do an atexit() or setjmp()/longjmp()? (Exception handling) -=item Generation of a LIST OF LISTS +=item Why doesn't my sockets program work under System V (Solaris)? What +does the error message "Protocol not supported" mean? +=item How can I call my system's unique C functions from Perl? -=item Access and Printing of a LIST OF LISTS +=item Where do I get the include files to do ioctl() or syscall()? +=item Why do setuid perl scripts complain about kernel problems? +=item How can I open a pipe both to and from a command? +=item Why can't I get the output of a command with system()? -=back +=item How can I capture STDERR from an external command? -=item HASHES OF LISTS +=item Why doesn't open() return an error when a pipe open fails? +=item What's wrong with using backticks in a void context? -=over +=item How can I call backticks without shell processing? -=item Declaration of a HASH OF LISTS +=item Why can't my script read from STDIN after I gave it EOF (^D on Unix, +^Z on MS-DOS)? +=item How can I convert my shell script to perl? -=item Generation of a HASH OF LISTS +=item Can I use perl to run a telnet or ftp session? +=item How can I write expect in Perl? -=item Access and Printing of a HASH OF LISTS +=item Is there a way to hide perl's command line from programs such as +"ps"? +=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? +Unix, VMS +=item How do I close a process's filehandle without waiting for it to +complete? -=back +=item How do I fork a daemon process? -=item LISTS OF HASHES +=item How do I make my program run with sh and csh? +=item How do I find out if I'm running interactively or not? -=over +=item How do I timeout a slow event? -=item Declaration of a LIST OF HASHES +=item How do I set CPU limits? +=item How do I avoid zombies on a Unix system? -=item Generation of a LIST OF HASHES +=item How do I use an SQL database? +=item How do I make a system() exit on control-C? -=item Access and Printing of a LIST OF HASHES +=item How do I open a file without blocking? + +=item How do I install a CPAN module? +=item How do I keep my own module/library directory? +=item How do I add the directory my program lives in to the module/library +search path? +=item How do I add a directory to my include path at runtime? =back -=item HASHES OF HASHES +=item How do I get one key from the terminal at a time, under POSIX? + +=item AUTHOR AND COPYRIGHT +=head2 perlfaq9 - Networking ($Revision: 1.17 $, $Date: 1997/04/24 22:44:29 +$) + +=item DESCRIPTION =over -=item Declaration of a HASH OF HASHES +=item My CGI script runs from the command line but not the browser. Can +you help me fix it? +=item How do I remove HTML from a string? -=item Generation of a HASH OF HASHES +=item How do I extract URLs? +=item How do I download a file from the user's machine? How do I open a +file on another machine? -=item Access and Printing of a HASH OF HASHES +=item How do I make a pop-up menu in HTML? +=item How do I fetch an HTML file? +=item how do I decode or create those %-encodings on the web? +=item How do I redirect to another page? -=back +=item How do I put a password on my web pages? -=item MORE ELABORATE RECORDS +=item How do I edit my .htpasswd and .htgroup files with Perl? +=item How do I make sure users can't enter values into a form that cause my +CGI script to do bad things? -=over +=item How do I parse an email header? -=item Declaration of MORE ELABORATE RECORDS +=item How do I decode a CGI form? +=item How do I check a valid email address? -=item Declaration of a HASH OF COMPLEX RECORDS +=item How do I decode a MIME/BASE64 string? +=item How do I return the user's email address? -=item Generation of a HASH OF COMPLEX RECORDS +=item How do I send/read mail? + +=item How do I find out my hostname/domainname/IP address? +=item How do I fetch a news article or the active newsgroups? +=item How do I fetch/put an FTP file? +=item How can I do RPC in Perl? =back -=item SEE ALSO +=item AUTHOR AND COPYRIGHT +=head2 perldelta - what's new for perl5.004 -=item AUTHOR +=item DESCRIPTION +=item Supported Environments +=item Core Changes +=over +=item List assignment to %ENV works -=head2 perllol, perlLoL - Manipulating Lists of Lists in Perl +=item "Can't locate Foo.pm in @INC" error now lists @INC -=item DESCRIPTION +=item Compilation option: Binary compatibility with 5.003 +=item $PERL5OPT environment variable -=item Declaration and Access of Lists of Lists +=item Limitations on B<-M>, B<-m>, and B<-T> options +=item More precise warnings -=item Growing Your Own +=item Deprecated: Inherited C for non-methods +=item Previously deprecated %OVERLOAD is no longer usable -=item Access and Printing +=item Subroutine arguments created only when they're modified +=item Group vector changeable with C<$)> -=item Slices +=item Fixed parsing of $$, &$, etc. +=item No resetting of $. on implicit close -=item SEE ALSO +=item C may return undef +=item Changes to tainting checks -=item AUTHOR +No glob() or <*>, No spawning if tainted $CDPATH, $ENV, $BASH_ENV, No +spawning if tainted $TERM doesn't look like a terminal name +=item New Opcode module and revised Safe module +=item Embedding improvements +=item Internal change: FileHandle class based on IO::* classes +=item Internal change: PerlIO abstraction interface -=head2 perlobj - Perl objects +=item New and changed syntax -=item DESCRIPTION +$coderef->(PARAMS) +=item New and changed builtin constants -=over +__PACKAGE__ -=item An Object is Simply a Reference +=item New and changed builtin variables +$^E, $^H, $^M -=item A Class is Simply a Package +=item New and changed builtin functions +delete on slices, flock, printf and sprintf, keys as an lvalue, my() in +Control Structures, pack() and unpack(), sysseek(), use VERSION, use Module +VERSION LIST, prototype(FUNCTION), srand, $_ as Default, C does not +reset search position on failure, C ignores whitespace before ?*+{}, +nested C closures work now, formats work right on changing lexicals -=item A Method is Simply a Subroutine +=item New builtin methods +isa(CLASS), can(METHOD), VERSION( [NEED] ) -=item Method Invocation +=item TIEHANDLE now supported +TIEHANDLE classname, LIST, PRINT this, LIST, PRINTF this, LIST, READ this +LIST, READLINE this, GETC this, DESTROY this -=item Destructors +=item Malloc enhancements +-DDEBUGGING_MSTATS, -DEMERGENCY_SBRK, -DPACK_MALLOC, -DTWO_POT_OPTIMIZE -=item WARNING +=item Miscellaneous efficiency enhancements +=back -=item Summary +=item Support for More Operating Systems +=over -=item Two-Phased Garbage Collection +=item Win32 +=item Plan 9 +=item QNX +=item AmigaOS =back -=item SEE ALSO +=item Pragmata +use autouse MODULE => qw(sub1 sub2 sub3), use blib, use blib 'dir', use +constant NAME => VALUE, use locale, use ops, use vmsish +=item Modules +=over +=item Required Updates -=head2 perltie - how to hide an object class in a simple variable +=item Installation directories -=item SYNOPSIS +=item Module information summary +=item Fcntl -=item DESCRIPTION +=item IO +=item Math::Complex -=over +=item Math::Trig -=item Tying Scalars +=item DB_File +=item Net::Ping -TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this +=item Object-oriented overrides for builtin operators -=item Tying Arrays +=back +=item Utility Changes -TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value, -DESTROY this +=over -=item Tying Hashes +=item pod2html +Sends converted HTML to standard output -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, DESTROY this +=item xsubpp -=item Tying FileHandles +C XSUBs now default to returning nothing + +=back + +=item C Language API Changes + +C and C, C, Extended API for +manipulating hashes + +=item Documentation Changes + +L, L, L, L, L, +L, L, L + +=item New Diagnostics + +"my" variable %s masks earlier declaration in same scope, %s argument is +not a HASH element or slice, Allocation too large: %lx, Allocation too +large, Applying %s to %s will act on scalar(%s), Attempt to free +nonexistent shared string, Attempt to use reference as lvalue in substr, +Can't redefine active sort subroutine %s, Can't use bareword ("%s") as %s +ref while "strict refs" in use, Cannot resolve method `%s' overloading `%s' +in package `%s', Constant subroutine %s redefined, Constant subroutine %s +undefined, Copy method did not return a reference, Died, Exiting +pseudo-block via %s, Identifier too long, Illegal character %s (carriage +return), Illegal switch in PERL5OPT: %s, Integer overflow in hex number, +Integer overflow in octal number, internal error: glob failed, Invalid +conversion in %s: "%s", Invalid type in pack: '%s', Invalid type in unpack: +'%s', Name "%s::%s" used only once: possible typo, Null picture in +formline, Offset outside string, Out of memory!, Out of memory during +request for %s, panic: frexp, Possible attempt to put comments in qw() +list, Possible attempt to separate words with commas, Scalar value @%s{%s} +better written as $%s{%s}, Stub found while resolving method `%s' +overloading `%s' in package `%s', Too late for "B<-T>" option, untie +attempted while %d inner references still exist, Unrecognized character %s, +Unsupported function fork, Use of "$$" to mean "${$}" is +deprecated, Value of %s can be "0"; test with defined(), Variable "%s" may +be unavailable, Variable "%s" will not stay shared, Warning: something's +wrong, Ill-formed logical name |%s| in prime_env_iter, Got an error from +DosAllocMem, Malformed PERLLIB_PREFIX, PERL_SH_DIR too long, Process +terminated by SIG%s + +=item BUGS + +=item SEE ALSO + +=item HISTORY + +=head2 perldata - Perl data types + +=item DESCRIPTION + +=over +=item Variable names + +=item Context + +=item Scalar values + +=item Scalar value constructors +=item List value constructors +=item Typeglobs and Filehandles =back -=item SEE ALSO +=head2 perlsyn - Perl syntax +=item DESCRIPTION -=item BUGS +=over +=item Declarations -=item AUTHOR +=item Simple statements +=item Compound statements + +=item Loop Control +=item For Loops +=item Foreach Loops +=item Basic BLOCKs and Switch Statements -=head2 perlbot - Bag'o Object Tricks (the BOT) +=item Goto + +=item PODs: Embedded Documentation + +=item Plain Old Comments (Not!) + +=back + +=head2 perlop - Perl operators and precedence + +=item SYNOPSIS =item DESCRIPTION +=over -=item OO SCALING TIPS +=item Terms and List Operators (Leftward) +=item The Arrow Operator -=item INSTANCE VARIABLES +=item Auto-increment and Auto-decrement +=item Exponentiation -=item SCALAR INSTANCE VARIABLES +=item Symbolic Unary Operators +=item Binding Operators -=item INSTANCE VARIABLE INHERITANCE +=item Multiplicative Operators +=item Additive Operators -=item OBJECT RELATIONSHIPS +=item Shift Operators + +=item Named Unary Operators +=item Relational Operators -=item OVERRIDING SUPERCLASS METHODS +=item Equality Operators +=item Bitwise And -=item USING RELATIONSHIP WITH SDBM +=item Bitwise Or and Exclusive Or +=item C-style Logical And -=item THINKING OF CODE REUSE +=item C-style Logical Or +=item Range Operator -=item CLASS CONTEXT AND THE OBJECT +=item Conditional Operator +=item Assignment Operators -=item INHERITING A CONSTRUCTOR +=item Comma Operator +=item List Operators (Rightward) -=item DELEGATION +=item Logical Not +=item Logical And +=item Logical or and Exclusive Or +=item C Operators Missing From Perl +unary &, unary *, (TYPE) -=head2 perldebug - Perl debugging +=item Quote and Quote-like Operators + +=item Regexp Quote-Like Operators + +?PATTERN?, m/PATTERN/gimosx, /PATTERN/gimosx, q/STRING/, C<'STRING'>, +qq/STRING/, "STRING", qx/STRING/, `STRING`, qw/STRING/, +s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds, +y/SEARCHLIST/REPLACEMENTLIST/cds + +=item I/O Operators + +=item Constant Folding + +=item Integer Arithmetic + +=item Floating-point Arithmetic + +=back + +=head2 perlre - Perl regular expressions =item DESCRIPTION +i, m, s, x =over -=item Debugging +=item Regular Expressions + +(?#text), (?:regexp), (?=regexp), (?!regexp), (?imsx) +=item Backtracking -h, T, s, n, f, c, c line, , l min+incr, l min-max, l line, l, -, w -line, l subname, /pattern/, ?pattern?, L, S, t, b line [ condition ], b -subname [ condition ], d line, D, a line command, A, < command, > -command, V package [symbols], X [symbols], ! number, ! -number, H --number, q or ^D, command, p expr +=item Version 8 Regular Expressions -=item Customization +=item WARNING on \1 vs $1 +=item SEE ALSO -=item Other resources +=back + +=head2 perlrun - how to execute the Perl interpreter + +=item SYNOPSIS + +=item DESCRIPTION + +=over + +=item #! and quoting on non-Unix systems +OS/2, MS-DOS, Win95/NT, Macintosh +=item Switches +B<-0>[I], B<-a>, 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<-x> I =back -=item BUGS +=item ENVIRONMENT +HOME, LOGDIR, PATH, PERL5LIB, PERL5OPT, PERLLIB, PERL5DB, PERL5SHELL +(specific to WIN32 port), PERL_DEBUG_MSTATS, PERL_DESTRUCT_LEVEL +=head2 perlfunc - Perl builtin functions +=item DESCRIPTION + I -=head2 perldiag - various Perl diagnostics +=over + +=item Perl Functions by Category + +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 Alphabetical Listing of Perl Functions + +-I FILEHANDLE, -I EXPR, -I, abs VALUE, abs, accept +NEWSOCKET,GENERICSOCKET, alarm SECONDS, alarm, atan2 Y,X, bind SOCKET,NAME, +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, closedir DIRHANDLE, connect SOCKET,NAME, continue BLOCK, +cos EXPR, crypt PLAINTEXT,SALT, dbmclose HASH, dbmopen HASH,DBNAME,MODE, +defined EXPR, defined, delete EXPR, die LIST, do BLOCK, do +SUBROUTINE(LIST), do EXPR, dump LABEL, each HASH, eof FILEHANDLE, eof (), +eof, eval EXPR, eval BLOCK, exec 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 LIST, last LABEL, last, lc EXPR, lc, lcfirst +EXPR, lcfirst, length EXPR, length, link OLDFILE,NEWFILE, listen +SOCKET,QUEUESIZE, local EXPR, localtime EXPR, log EXPR, log, lstat +FILEHANDLE, lstat EXPR, lstat, m//, map BLOCK LIST, map EXPR,LIST, mkdir +FILENAME,MODE, msgctl ID,CMD,ARG, msgget KEY,FLAGS, msgsnd ID,MSG,FLAGS, +msgrcv ID,VAR,SIZE,TYPE,FLAGS, my EXPR, next LABEL, next, no Module LIST, +oct EXPR, oct, open FILEHANDLE,EXPR, open FILEHANDLE, opendir +DIRHANDLE,EXPR, ord EXPR, ord, pack TEMPLATE,LIST, package NAMESPACE, 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/, +qx/STRING/, qw/STRING/, quotemeta EXPR, quotemeta, rand EXPR, rand, read +FILEHANDLE,SCALAR,LENGTH,OFFSET, read FILEHANDLE,SCALAR,LENGTH, readdir +DIRHANDLE, readlink EXPR, readlink, recv SOCKET,SCALAR,LEN,FLAGS, redo +LABEL, redo, ref EXPR, ref, rename OLDNAME,NEWNAME, 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, 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,LEN, 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, syswrite +FILEHANDLE,SCALAR,LENGTH,OFFSET, syswrite FILEHANDLE,SCALAR,LENGTH, 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 LIST, use Module, use Module VERSION LIST, +use VERSION, utime LIST, values HASH, vec EXPR,OFFSET,BITS, wait, waitpid +PID,FLAGS, wantarray, warn LIST, write FILEHANDLE, write EXPR, write, y/// + +=back + +=head2 perlvar - Perl predefined variables =item DESCRIPTION +=over +=item Predefined Names +$ARG, $_, $EIE, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $', +$LAST_PAREN_MATCH, $+, $MULTILINE_MATCHING, $*, input_line_number HANDLE +EXPR, $INPUT_LINE_NUMBER, $NR, $, input_record_separator HANDLE EXPR, +$INPUT_RECORD_SEPARATOR, $RS, $/, autoflush HANDLE EXPR, $OUTPUT_AUTOFLUSH, +$|, output_field_separator HANDLE EXPR, $OUTPUT_FIELD_SEPARATOR, $OFS, $,, +output_record_separator HANDLE EXPR, $OUTPUT_RECORD_SEPARATOR, $ORS, $\, +$LIST_SEPARATOR, $", $SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $OFMT, $#, +format_page_number HANDLE EXPR, $FORMAT_PAGE_NUMBER, $%, +format_lines_per_page HANDLE EXPR, $FORMAT_LINES_PER_PAGE, $=, +format_lines_left HANDLE EXPR, $FORMAT_LINES_LEFT, $-, format_name HANDLE +EXPR, $FORMAT_NAME, $~, format_top_name HANDLE EXPR, $FORMAT_TOP_NAME, $^, +format_line_break_characters HANDLE EXPR, $FORMAT_LINE_BREAK_CHARACTERS, +$:, format_formfeed HANDLE EXPR, $FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A, +$CHILD_ERROR, $?, $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, $[, $PERL_VERSION, $], +$DEBUGGING, $^D, $SYSTEM_FD_MAX, $^F, $^H, $INPLACE_EDIT, $^I, $OSNAME, +$^O, $PERLDB, $^P, $BASETIME, $^T, $WARNING, $^W, $EXECUTABLE_NAME, $^X, +$ARGV, @ARGV, @INC, %INC, $ENV{expr}, $SIG{expr}, $^M +=back -=head2 perlform - Perl formats +=head2 perlsub - Perl subroutines + +=item SYNOPSIS =item DESCRIPTION +=over + +=item Private Variables via my() + +=item Temporary Values via local() + +=item Passing Symbol Table Entries (typeglobs) + +=item Pass by Reference + +=item Prototypes + +=item Constant Functions + +=item Overriding Builtin Functions + +=item Autoloading + +=back + +=item SEE ALSO + +=head2 perlmod - Perl modules (packages and symbol tables) + +=item DESCRIPTION =over -=item Format Variables +=item Packages + +=item Symbol Tables +=item Package Constructors and Destructors +=item Perl Classes +=item Perl Modules =back -=item NOTES +=item SEE ALSO + +=head2 perlmodlib - constructing new Perl modules and finding existing ones + +=item DESCRIPTION +=item THE PERL MODULE LIBRARY =over -=item Footers +=item Pragmatic Modules +use autouse MODULE => qw(sub1 sub2 sub3), blib, diagnostics, integer, less, +lib, locale, ops, overload, sigtrap, strict, subs, vmsish, vars -=item Accessing Formatting Internals +=item Standard Modules + +AnyDBM_File, AutoLoader, AutoSplit, Benchmark, CPAN, CPAN::FirstTime, +CPAN::Nox, Carp, Class::Struct, Config, Cwd, DB_File, Devel::SelfStubber, +DirHandle, DynaLoader, English, Env, Exporter, ExtUtils::Embed, +ExtUtils::Install, ExtUtils::Liblist, ExtUtils::MM_OS2, ExtUtils::MM_Unix, +ExtUtils::MM_VMS, ExtUtils::MakeMaker, ExtUtils::Manifest, +ExtUtils::Mkbootstrap, ExtUtils::Mksymlists, ExtUtils::testlib, Fcntl, +File::Basename, File::CheckTree, File::Compare, File::Copy, File::Find, +File::Path, File::stat, FileCache, FileHandle, FindBin, GDBM_File, +Getopt::Long, Getopt::Std, I18N::Collate, IO, IO::File, IO::Handle, +IO::Pipe, IO::Seekable, IO::Select, IO::Socket, IPC::Open2, IPC::Open3, +Math::BigFloat, Math::BigInt, Math::Complex, Math::Trig, NDBM_File, +Net::Ping, Net::hostent, Net::netent, Net::protoent, Net::servent, Opcode, +Pod::Text, POSIX, SDBM_File, Safe, Search::Dict, SelectSaver, SelfLoader, +Shell, Socket, Symbol, Sys::Hostname, Sys::Syslog, Term::Cap, +Term::Complete, Term::ReadLine, Test::Harness, Text::Abbrev, +Text::ParseWords, Text::Soundex, Text::Tabs, Text::Wrap, Tie::Hash, +Tie::RefHash, Tie::Scalar, Tie::SubstrHash, Time::Local, Time::gmtime, +Time::localtime, Time::tm, UNIVERSAL, User::grent, User::pwent + +=item Extension Modules + +=back + +=item CPAN + +Language Extensions and Documentation Tools, Development Support, Operating +System Interfaces, Networking, Device Control (modems) and InterProcess +Communication, Data Types and Data Type Utilities, Database Interfaces, +User Interfaces, Interfaces to / Emulations of Other Programming Languages, +File Names, File Systems and File Locking (see also File Handles), String +Processing, Language Text Processing, Parsing, and Searching, Option, +Argument, Parameter, and Configuration File Processing, +Internationalization and Locale, Authentication, Security, and Encryption, +World Wide Web, HTML, HTTP, CGI, MIME, Server and Daemon Utilities, +Archiving and Compression, Images, Pixmap and Bitmap Manipulation, Drawing, +and Graphing, Mail and Usenet News, Control Flow Utilities (callbacks and +exceptions etc), File Handle and Input/Output Stream Utilities, +Miscellaneous Modules, Africa, Asia, Australasia, Europe, North America, +South America + +=item Modules: Creation, Use, and Abuse + +=over + +=item Guidelines for Module Creation + +Do similar modules already exist in some form?, Try to design the new +module to be easy to extend and reuse, Some simple style guidelines, Select +what to export, Select a name for the module, Have you got it right?, +README and other Additional Files, A description of the +module/package/extension etc, A copyright notice - see below, Prerequisites +- what else you may need to have, How to build it - possible changes to +Makefile.PL etc, How to install it, Recent changes in this release, +especially incompatibilities, Changes / enhancements you plan to make in +the future, Adding a Copyright Notice, Give the module a +version/issue/release number, How to release and distribute a module, Take +care when changing a released module +=item Guidelines for Converting Perl 4 Library Scripts into Modules + +There is no requirement to convert anything, Consider the implications, +Make the most of the opportunity, The pl2pm utility will get you started, +Adds the standard Module prologue lines, Converts package specifiers from ' +to ::, Converts die(...) to croak(...), Several other minor changes +=item Guidelines for Reusing Application Code +Complete applications rarely belong in the Perl Module Library, Many +applications contain some perl code which could be reused, Break-out the +reusable code into one or more separate module files, Take the opportunity +to reconsider and redesign the interfaces, In some cases the 'application' +can then be reduced to a small =back -=item WARNING +=item NOTE + +=head2 perlform - Perl formats + +=item DESCRIPTION + +=over + +=item Format Variables + +=back + +=item NOTES + +=over +=item Footers +=item Accessing Formatting Internals +=back +=item WARNINGS -=head2 perlipc - Perl interprocess communication (signals, fifos, -pipes, safe subprocceses, sockets, and semaphores) +=head2 perllocale - Perl locale handling (internationalization and +localization) =item DESCRIPTION +=item PREPARING TO USE LOCALES -=item Signals +=item USING LOCALES +=over -=item Named Pipes +=item The use locale pragma +=item The setlocale function -=item Using open() for IPC +=item The localeconv function + +=back +=item LOCALE CATEGORIES =over -=item Safe Pipe Opens +=item Category LC_COLLATE: Collation +=item Category LC_CTYPE: Character Types -=item Bidirectional Communication +=item Category LC_NUMERIC: Numeric Formatting +=item Category LC_MONETARY: Formatting of monetary amounts +=item LC_TIME +=item Other categories =back -=item Sockets: Client/Server Communication +=item SECURITY + +B (C, C, C, C and C):, +B (with C<\l>, C<\L>, C<\u> or <\U>), +B (C):, B (C):, +B (sprintf()):, B (printf() and write()):, B (lc(), +lcfirst(), uc(), ucfirst()):, B +(localeconv(), strcoll(),strftime(), strxfrm()):, B (isalnum(), isalpha(), isdigit(),isgraph(), islower(), isprint(), +ispunct(), isspace(), isupper(), +isxdigit()): + +=item ENVIRONMENT +PERL_BADLANG, LC_ALL, LC_CTYPE, LC_COLLATE, LC_MONETARY, LC_NUMERIC, +LC_TIME, LANG + +=item NOTES =over -=item Internet TCP Clients and Servers +=item Backward compatibility +=item I18N:Collate obsolete -=item Unix-Domain TCP Clients and Servers +=item Sort speed and memory use impacts +=item write() and LC_NUMERIC -=item UDP: Message Passing +=item Freely available locale definitions + +=item I18n and l10n + +=item An imperfect standard + +=back +=item BUGS +=over +=item Broken systems =back -=item SysV IPC +=item SEE ALSO +=item HISTORY -=item WARNING +=head2 perlref - Perl references and nested data structures +=item DESCRIPTION -=item NOTES +=over + +=item Symbolic references + +=item Not-so-symbolic references + +=back + +=item WARNING + +=item SEE ALSO + +=head2 perldsc - Perl Data Structures Cookbook + +=item DESCRIPTION + +arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes, +more elaborate constructs + +=item REFERENCES + +=item COMMON MISTAKES + +=item CAVEAT ON PRECEDENCE + +=item WHY YOU SHOULD ALWAYS C + +=item DEBUGGING + +=item CODE EXAMPLES + +=item LISTS OF LISTS + +=over + +=item Declaration of a LIST OF LISTS + +=item Generation of a LIST OF LISTS + +=item Access and Printing of a LIST OF LISTS + +=back + +=item HASHES OF LISTS + +=over + +=item Declaration of a HASH OF LISTS + +=item Generation of a HASH OF LISTS + +=item Access and Printing of a HASH OF LISTS + +=back + +=item LISTS OF HASHES + +=over + +=item Declaration of a LIST OF HASHES + +=item Generation of a LIST OF HASHES + +=item Access and Printing of a LIST OF HASHES + +=back + +=item HASHES OF HASHES + +=over + +=item Declaration of a HASH OF HASHES + +=item Generation of a HASH OF HASHES + +=item Access and Printing of a HASH OF HASHES + +=back + +=item MORE ELABORATE RECORDS + +=over + +=item Declaration of MORE ELABORATE RECORDS + +=item Declaration of a HASH OF COMPLEX RECORDS + +=item Generation of a HASH OF COMPLEX RECORDS + +=back + +=item Database Ties + +=item SEE ALSO + +=item AUTHOR + +=head2 perllol, perlLoL - Manipulating Lists of Lists in Perl + +=item DESCRIPTION + +=item Declaration and Access of Lists of Lists + +=item Growing Your Own + +=item Access and Printing + +=item Slices + +=item SEE ALSO + +=item AUTHOR + +=head2 perltoot - Tom's object-oriented tutorial for perl + +=item DESCRIPTION + +=item Creating a Class + +=over + +=item Object Representation + +=item Class Interface + +=item Constructors and Instance Methods + +=item Planning for the Future: Better Constructors + +=item Destructors + +=item Other Object Methods + +=back + +=item Class Data + +=over + +=item Accessing Class Data + +=item Debugging Methods + +=item Class Destructors + +=item Documenting the Interface + +=back + +=item Aggregation + +=item Inheritance + +=over + +=item Overridden Methods + +=item Multiple Inheritance + +=item UNIVERSAL: The Root of All Objects + +=back + +=item Alternate Object Representations + +=over + +=item Arrays as Objects + +=item Closures as Objects + +=back + +=item AUTOLOAD: Proxy Methods + +=over + +=item Autoloaded Data Methods + +=item Inherited Autoloaded Data Methods + +=back + +=item Metaclassical Tools + +=over + +=item Class::Struct + +=item Data Members as Variables + +=item NOTES + +=item Object Terminology + +=back + +=item SEE ALSO + +=item COPYRIGHT + +=over + +=item Acknowledgments + +=back + +=head2 perlobj - Perl objects + +=item DESCRIPTION + +=over + +=item An Object is Simply a Reference + +=item A Class is Simply a Package + +=item A Method is Simply a Subroutine + +=item Method Invocation + +=item Default UNIVERSAL methods + +isa(CLASS), can(METHOD), VERSION( [NEED] ) + +=item Destructors + +=item WARNING + +=item Summary + +=item Two-Phased Garbage Collection + +=back + +=item SEE ALSO + +=head2 perltie - how to hide an object class in a simple variable + +=item SYNOPSIS + +=item DESCRIPTION + +=over + +=item Tying Scalars + +TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this + +=item Tying Arrays + +TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value, +DESTROY this + +=item Tying Hashes + +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, DESTROY this + +=item Tying FileHandles + +TIEHANDLE classname, LIST, PRINT this, LIST, PRINTF this, LIST, READ this +LIST, READLINE this, GETC this, DESTROY this + +=item The C Gotcha + +=back + +=item SEE ALSO + +=item BUGS + +=item AUTHOR + +=head2 perlbot - Bag'o Object Tricks (the BOT) + +=item DESCRIPTION + +=item OO SCALING TIPS + +=item INSTANCE VARIABLES + +=item SCALAR INSTANCE VARIABLES + +=item INSTANCE VARIABLE INHERITANCE + +=item OBJECT RELATIONSHIPS + +=item OVERRIDING SUPERCLASS METHODS + +=item USING RELATIONSHIP WITH SDBM + +=item THINKING OF CODE REUSE + +=item CLASS CONTEXT AND THE OBJECT + +=item INHERITING A CONSTRUCTOR + +=item DELEGATION + +=head2 perlipc - Perl interprocess communication (signals, fifos, pipes, +safe subprocesses, sockets, and semaphores) + +=item DESCRIPTION + +=item Signals + +=item Named Pipes + +=item Using open() for IPC + +=over + +=item Filehandles + +=item Background Processes + +=item Complete Dissociation of Child from Parent + +=item Safe Pipe Opens + +=item Bidirectional Communication with Another Process + +=back + +=item Sockets: Client/Server Communication + +=over + +=item Internet TCP Clients and Servers + +=item Unix-Domain TCP Clients and Servers + +=back + +=item TCP Clients with IO::Socket + +=over + +=item A Simple Client + +C, C, C + +=item A Webget Client + +=item Interactive Client with IO::Socket + +=back + +=item TCP Servers with IO::Socket + +Proto, LocalPort, Listen, Reuse + +=item UDP: Message Passing + +=item SysV IPC + +=item NOTES + +=item BUGS + +=item AUTHOR + +=item SEE ALSO + +=head2 perldebug - Perl debugging + +=item DESCRIPTION + +=item The Perl Debugger + +=over + +=item Debugger Commands + +h [command], p expr, x expr, V [pkg [vars]], X [vars], T, s [expr], n +[expr], ECRE, c [line|sub], l, l min+incr, l min-max, l line, l +subname, -, w [line], f filename, /pattern/, ?pattern?, L, S [[!]pattern], +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, O [opt[=val]] [opt"val"] [opt?].., C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, +C, C, C, C, C, C, +C, C, C, E [ command ], EE command, +E command, EE command, { [ command ], {{ command, ! number, ! +-number, ! pattern, !! cmd, H -number, q or ^D, R, |dbcmd, ||dbcmd, = +[alias value], command, m expr, m package + +=item Debugger input/output + +Prompt, Multiline commands, Stack backtrace, Listing, Frame listing + +=item Debugging compile-time statements + +=item Debugger Customization + +=item Readline Support + +=item Editor Support for Debugging + +=item The Perl Profiler + +=item Debugger support in perl + +=item Debugger Internals + +=item Other resources + +=back + +=item BUGS + +=head2 perldiag - various Perl diagnostics + +=item DESCRIPTION + +=head2 perlsec - Perl security + +=item DESCRIPTION + +=over + +=item Laundering and Detecting Tainted Data + +=item Switches On the "#!" Line + +=item Cleaning Up Your Path + +=item Security Bugs + +=item Protecting Your Programs + +=back + +=head2 perltrap - Perl traps for the unwary + +=item DESCRIPTION + +=over + +=item Awk Traps + +=item C Traps + +=item Sed Traps + +=item Shell Traps + +=item Perl Traps + +=item Perl4 to Perl5 Traps + +Discontinuance, Deprecation, and BugFix traps, Parsing Traps, Numerical +Traps, General data type traps, Context Traps - scalar, list contexts, +Precedence Traps, General Regular Expression Traps using s///, etc, +Subroutine, Signal, Sorting Traps, OS Traps, DBM Traps, Unclassified Traps + +=item Discontinuance, Deprecation, and BugFix traps + +Discontinuance, Deprecation, BugFix, Discontinuance, Discontinuance, +Discontinuance, BugFix, Discontinuance, Discontinuance, BugFix, +Discontinuance, Discontinuance, Deprecation, Discontinuance + +=item Parsing Traps + +Parsing, Parsing, Parsing + +=item Numerical Traps + +Numerical, Numerical, Numerical + +=item General data type traps + +(Arrays), (Arrays), (Hashes), (Globs), (Scalar String), (Constants), +(Scalars), (Variable Suicide) + +=item Context Traps - scalar, list contexts + +(list context), (scalar context), (scalar context), (list, builtin) + +=item Precedence Traps + +Precedence, Precedence, Precedence, Precedence, Precedence, Precedence, +Precedence + +=item General Regular Expression Traps using s///, etc. + +Regular Expression, Regular Expression, Regular Expression, Regular +Expression, Regular Expression, Regular Expression, Regular Expression, +Regular Expression, Regular Expression + +=item Subroutine, Signal, Sorting Traps + +(Signals), (Sort Subroutine), warn() won't let you specify a filehandle + +=item OS Traps + +(SysV), (SysV) + +=item Interpolation Traps + +Interpolation, Interpolation, Interpolation, Interpolation, Interpolation, +Interpolation, Interpolation, Interpolation, Interpolation + +=item DBM Traps + +DBM, DBM + +=item Unclassified Traps + +Unclassified + +=back + +=head2 perlstyle - Perl style guide + +=item DESCRIPTION + +=head2 perlpod - plain old documentation + +=item DESCRIPTION + +=item Embedding Pods in Perl Modules + +=item Common Pod Pitfalls + +=item SEE ALSO + +=item AUTHOR + +=head2 perlbook - Perl book information + +=item DESCRIPTION + +=head2 perlembed - how to embed perl in your C program + +=item DESCRIPTION + +=over + +=item PREAMBLE + +B, B, B, B, B + +=item ROADMAP + +=item Compiling your C program + +=item Adding a Perl interpreter to your C program + +=item Calling a Perl subroutine from your C program + +=item Evaluating a Perl statement from your C program + +=item Performing Perl pattern matches and substitutions from your C program + +=item Fiddling with the Perl stack from your C program + +=item Maintaining a persistent interpreter + +=item Maintaining multiple interpreter instances + +=item Using Perl modules, which themselves use C libraries, from your C +program + +=back + +=item Embedding Perl under Win32 + +=item MORAL + +=item AUTHOR + +=item COPYRIGHT + +=head2 perlapio - perl's IO abstraction interface. + +=item SYNOPSIS + +=item DESCRIPTION + +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 + +=item Co-existence with stdio + +B, B, +B, B, B, +B, B, B, +B, B, +B, B, B, +B, B + +=back + +=head2 perlxs - XS language reference manual + +=item DESCRIPTION + +=over + +=item Introduction + +=item On The Road + +=item The Anatomy of an XSUB + +=item The Argument Stack + +=item The RETVAL Variable + +=item The MODULE Keyword + +=item The PACKAGE Keyword + +=item The PREFIX Keyword + +=item The OUTPUT: Keyword + +=item The CODE: Keyword + +=item The INIT: Keyword + +=item The NO_INIT Keyword + +=item Initializing Function Parameters + +=item Default Parameter Values + +=item The PREINIT: Keyword + +=item The SCOPE: Keyword + +=item The INPUT: Keyword + +=item Variable-length Parameter Lists + +=item The PPCODE: Keyword + +=item Returning Undef And Empty Lists + +=item The REQUIRE: Keyword + +=item The CLEANUP: Keyword + +=item The BOOT: Keyword + +=item The VERSIONCHECK: Keyword + +=item The PROTOTYPES: Keyword + +=item The PROTOTYPE: Keyword + +=item The ALIAS: Keyword + +=item The INCLUDE: Keyword + +=item The CASE: Keyword + +=item The & Unary Operator + +=item Inserting Comments and C Preprocessor Directives + +=item Using XS With C++ + +=item Interface Strategy + +=item Perl Objects And C Structures + +=item The Typemap + +=back + +=item EXAMPLES + +=item XS VERSION + +=item AUTHOR + +=head2 perlxstut, perlXStut - Tutorial for XSUBs + +=item DESCRIPTION + +=over + +=item VERSION CAVEAT + +=item DYNAMIC VERSUS STATIC + +=item EXAMPLE 1 + +=item EXAMPLE 2 + +=item WHAT HAS GONE ON? + +=item WRITING GOOD TEST SCRIPTS + +=item EXAMPLE 3 + +=item WHAT'S NEW HERE? + +=item INPUT AND OUTPUT PARAMETERS + +=item THE XSUBPP COMPILER + +=item THE TYPEMAP FILE + +=item WARNING + +=item EXAMPLE 4 + +=item WHAT HAS HAPPENED HERE? + +=item SPECIFYING ARGUMENTS TO XSUBPP + +=item THE ARGUMENT STACK + +=item EXTENDING YOUR EXTENSION + +=item DOCUMENTING YOUR EXTENSION + +=item INSTALLING YOUR EXTENSION + +=item SEE ALSO + +=item Author + +=item Last Changed + +=back + +=head2 perlguts - Perl's Internal Functions + +=item DESCRIPTION + +=item Variables + +=over + +=item Datatypes + +=item What is an "IV"? + +=item Working with SVs + +=item What's Really Stored in an SV? + +=item Working with AVs + +=item Working with HVs + +=item Hash API Extensions + +=item References + +=item Blessed References and Class Objects + +=item Creating New Variables + +=item Reference Counts and Mortality + +=item Stashes and Globs + +=item Double-Typed SVs + +=item Magic Variables + +=item Assigning Magic + +=item Magic Virtual Tables + +=item Finding Magic + +=item Understanding the Magic of Tied Hashes and Arrays + +=back + +=item Subroutines + +=over + +=item XSUBs and the Argument Stack + +=item Calling Perl Routines from within C Programs + +=item Memory Allocation + +=item PerlIO + +=item Putting a C value on Perl stack + +=item Scratchpads + +=item Scratchpads and recursion + +=back + +=item Compiled code + +=over + +=item Code tree + +=item Examining the tree + +=item Compile pass 1: check routines + +=item Compile pass 1a: constant folding + +=item Compile pass 2: context propagation + +=item Compile pass 3: peephole optimization + +=back + +=item API LISTING + +AvFILL, av_clear, av_extend, av_fetch, av_len, av_make, av_pop, av_push, +av_shift, av_store, av_undef, av_unshift, CLASS, Copy, croak, CvSTASH, +DBsingle, DBsub, DBtrace, dMARK, dORIGMARK, dowarn, dSP, dXSARGS, dXSI32, +dXSI32, ENTER, EXTEND, FREETMPS, G_ARRAY, G_DISCARD, G_EVAL, GIMME, +GIMME_V, G_NOARGS, G_SCALAR, G_VOID, gv_fetchmeth, gv_fetchmethod, +gv_fetchmethod_autoload, gv_stashpv, gv_stashsv, GvSV, HEf_SVKEY, HeHASH, +HeKEY, HeKLEN, HePV, HeSVKEY, HeSVKEY_force, HeSVKEY_set, HeVAL, hv_clear, +hv_delayfree_ent, hv_delete, hv_delete_ent, hv_exists, hv_exists_ent, +hv_fetch, hv_fetch_ent, hv_free_ent, hv_iterinit, hv_iterkey, hv_iterkeysv, +hv_iternext, hv_iternextsv, hv_iterval, hv_magic, HvNAME, hv_store, +hv_store_ent, hv_undef, isALNUM, isALPHA, isDIGIT, isLOWER, isSPACE, +isUPPER, items, ix, LEAVE, MARK, mg_clear, mg_copy, mg_find, mg_free, +mg_get, mg_len, mg_magical, mg_set, Move, na, New, Newc, Newz, newAV, +newHV, newRV_inc, newRV_noinc, newSV, newSViv, newSVnv, newSVpv, newSVrv, +newSVsv, newXS, newXSproto, Nullav, Nullch, Nullcv, Nullhv, Nullsv, +ORIGMARK, perl_alloc, perl_call_argv, perl_call_method, perl_call_pv, +perl_call_sv, perl_construct, perl_destruct, perl_eval_sv, perl_eval_pv, +perl_free, perl_get_av, perl_get_cv, perl_get_hv, perl_get_sv, perl_parse, +perl_require_pv, perl_run, POPi, POPl, POPp, POPn, POPs, PUSHMARK, PUSHi, +PUSHn, PUSHp, PUSHs, PUTBACK, Renew, Renewc, RETVAL, safefree, safemalloc, +saferealloc, savepv, savepvn, SAVETMPS, SP, SPAGAIN, ST, strEQ, strGE, +strGT, strLE, strLT, strNE, strnEQ, strnNE, sv_2mortal, sv_bless, sv_catpv, +sv_catpvn, sv_catpvf, sv_catsv, sv_cmp, sv_cmp, SvCUR, SvCUR_set, sv_dec, +sv_dec, SvEND, sv_eq, SvGROW, sv_grow, sv_inc, SvIOK, SvIOK_off, SvIOK_on, +SvIOK_only, SvIOK_only, SvIOKp, sv_isa, SvIV, sv_isobject, SvIVX, SvLEN, +sv_len, sv_len, sv_magic, sv_mortalcopy, SvOK, sv_newmortal, sv_no, SvNIOK, +SvNIOK_off, SvNIOKp, SvNOK, SvNOK_off, SvNOK_on, SvNOK_only, SvNOK_only, +SvNOKp, SvNV, SvNVX, SvPOK, SvPOK_off, SvPOK_on, SvPOK_only, SvPOK_only, +SvPOKp, SvPV, SvPVX, SvREFCNT, SvREFCNT_dec, SvREFCNT_inc, SvROK, +SvROK_off, SvROK_on, SvRV, sv_setiv, sv_setnv, sv_setpv, sv_setpvn, +sv_setpvf, sv_setref_iv, sv_setref_nv, sv_setref_pv, sv_setref_pvn, +sv_setsv, SvSTASH, SVt_IV, SVt_PV, SVt_PVAV, SVt_PVCV, SVt_PVHV, SVt_PVMG, +SVt_NV, SvTRUE, SvTYPE, svtype, SvUPGRADE, sv_upgrade, sv_undef, sv_unref, +sv_usepvn, sv_yes, THIS, toLOWER, toUPPER, warn, XPUSHi, XPUSHn, XPUSHp, +XPUSHs, XS, XSRETURN, XSRETURN_EMPTY, XSRETURN_IV, XSRETURN_NO, +XSRETURN_NV, XSRETURN_PV, XSRETURN_UNDEF, XSRETURN_YES, XST_mIV, XST_mNV, +XST_mNO, XST_mPV, XST_mUNDEF, XST_mYES, XS_VERSION, XS_VERSION_BOOTCHECK, +Zero + +=item EDITOR + +=item DATE + +=head2 perlcall - Perl calling conventions from C + +=item DESCRIPTION + +An Error Handler, An Event Driven Program + +=item THE PERL_CALL FUNCTIONS + +B, B, B, B + +=item FLAG VALUES + +=over + +=item G_VOID + +=item G_SCALAR + +=item G_ARRAY + +=item G_DISCARD +=item G_NOARGS -=item BUGS +=item G_EVAL +=item G_KEEPERR -=item AUTHOR +=item Determining the Context +=back -=item SEE ALSO +=item KNOWN PROBLEMS +=item EXAMPLES +=over +=item No Parameters, Nothing returned +=item Passing Parameters -=head2 perlsec - Perl security +=item Returning a Scalar -=item DESCRIPTION +=item Returning a list of values +=item Returning a list in a scalar context +=item Returning Data from Perl via the parameter list +=item Using G_EVAL +=item Using G_KEEPERR -=head2 perltrap - Perl traps for the unwary +=item Using perl_call_sv -=item DESCRIPTION +=item Using perl_call_argv +=item Using perl_call_method -=over +=item Using GIMME_V -=item Awk Traps +=item Using Perl to dispose of temporaries +=item Strategies for storing Callback Context Information -=item C Traps +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 Alternate Stack Manipulation -=item Sed Traps +=item Creating and calling an anonymous subroutine in C +=back -=item Shell Traps +=item SEE ALSO +=item AUTHOR -=item Perl Traps +=item DATE +=head1 PRAGMA DOCUMENTATION -=item Perl4 Traps +=head2 autouse - postpone load of modules until a function is used +=item SYNOPSIS +=item DESCRIPTION +=item WARNING -=back +=item BUGS +=item AUTHOR +=item SEE ALSO +=head2 blib - Use MakeMaker's uninstalled version of a package -=head2 perlstyle - Perl style guide +=item SYNOPSIS =item DESCRIPTION +=item BUGS +=item AUTHOR +=head2 constant - Perl pragma to declare constants - -=head2 perlxs - XS language reference manual +=item SYNOPSIS =item DESCRIPTION +=item NOTES -=over +=item TECHNICAL NOTE -=item Introduction +=item BUGS +=item AUTHOR -=item On The Road +=item COPYRIGHT +=head2 diagnostics - Perl compiler pragma to force verbose warning +diagnostics -=item The Anatomy of an XSUB +=item SYNOPSIS +=item DESCRIPTION -=item The Argument Stack +=over +=item The C Pragma -=item The RETVAL Variable +=item The I Program +=back -=item The MODULE Keyword +=item EXAMPLES +=item INTERNALS -=item The PACKAGE Keyword +=item BUGS +=item AUTHOR -=item The PREFIX Keyword +=head2 integer - Perl pragma to compute arithmetic in integer instead of +double +=item SYNOPSIS -=item The OUTPUT: Keyword +=item DESCRIPTION +=head2 less - perl pragma to request less of something from the compiler -=item The CODE: Keyword +=item SYNOPSIS +=item DESCRIPTION -=item The NO_INIT Keyword +=head2 lib - manipulate @INC at compile time +=item SYNOPSIS -=item Initializing Function Parameters +=item DESCRIPTION +=over -=item Default Parameter Values +=item ADDING DIRECTORIES TO @INC +=item DELETING DIRECTORIES FROM @INC -=item Variable-length Parameter Lists +=item RESTORING ORIGINAL @INC +=back -=item The PPCODE: Keyword +=item SEE ALSO +=item AUTHOR -=item Returning Undef And Empty Lists +=head2 locale - Perl pragma to use and avoid POSIX locales for built-in +operations +=item SYNOPSIS -=item The REQUIRE: Keyword +=item DESCRIPTION +=head2 ops - Perl pragma to restrict unsafe operations when compiling -=item The CLEANUP: Keyword +=item SYNOPSIS +=item DESCRIPTION -=item The BOOT: Keyword +=item SEE ALSO +=head2 overload - Package for overloading perl operations -=item Inserting Comments and C Preprocessor Directives +=item SYNOPSIS +=item CAVEAT SCRIPTOR -=item Using XS With C++ +=item DESCRIPTION +=over -=item Interface Strategy +=item Declaration of overloaded functions +=item Calling Conventions for Binary Operations -=item Perl Objects And C Structures +FALSE, TRUE, C +=item Calling Conventions for Unary Operations -=item The Typemap +=item Overloadable Operations +I, I, I, +I, I, I, I +=item Inheritance and overloading +Strings as values of C directive, Overloading of an operation +is inherited by derived classes =back -=item EXAMPLES - +=item SPECIAL SYMBOLS FOR C -=item AUTHOR +=over +=item Last Resort +=item Fallback +C, TRUE, defined, but FALSE +=item Copy Constructor -=head2 perlxstut, perlXStut - Tutorial for XSUB's +B -=item DESCRIPTION +=back +=item MAGIC AUTOGENERATION -=item EXAMPLE 1 +I, I, +I, C, I, I, +I, I, I +=item WARNING -=item EXAMPLE 2 +=item Run-time Overloading +=item Public functions -=item WHAT HAS GONE ON? +overload::StrVal(arg), overload::Overloaded(arg), overload::Method(obj,op) +=item IMPLEMENTATION -=item EXAMPLE 3 +=item AUTHOR +=item DIAGNOSTICS -=item WHAT'S NEW HERE? +=item BUGS +=head2 sigtrap - Perl pragma to enable simple signal handling -=item INPUT AND OUTPUT PARAMETERS +=item SYNOPSIS +=item DESCRIPTION -=item THE XSUBPP COMPILER +=item OPTIONS +=over -=item THE TYPEMAP FILE +=item SIGNAL HANDLERS +B, B, B I -=item WARNING +=item SIGNAL LISTS +B, B, B -=item EXAMPLE 4 +=item OTHER +B, B, I, I -=item Author +=back +=item EXAMPLES -=item Last Changed +=head2 strict - Perl pragma to restrict unsafe constructs +=item SYNOPSIS +=item DESCRIPTION +C, C, C +=head2 subs - Perl pragma to predeclare sub names -=head2 perlguts - Perl's Internal Functions +=item SYNOPSIS =item DESCRIPTION +=head2 vars - Perl pragma to predeclare global variable names -=item Datatypes +=item SYNOPSIS +=item DESCRIPTION -=over +=head1 MODULE DOCUMENTATION -=item What is an "IV"? +=head2 AnyDBM_File - provide framework for multiple DBMs +=item SYNOPSIS -=item Working with SV's +=item DESCRIPTION +=over -=item What's Really Stored in an SV? +=item DBM Comparisons + +[0], [1], [2], [3] +=back -=item Working with AV's +=item SEE ALSO +=head2 AutoLoader - load subroutines only on demand -=item Working with HV's +=item SYNOPSIS +=item DESCRIPTION -=item References +=over +=item Subroutine Stubs -=item Blessed References and Class Objects +=item Using B's AUTOLOAD Subroutine +=item Overriding B's AUTOLOAD Subroutine +=item Package Lexicals +=item B vs. B =back -=item Creating New Variables +=item CAVEATS +=item SEE ALSO -=item XSUB's and the Argument Stack +=head2 AutoSplit - split a package for autoloading +=item SYNOPSIS -=item Mortality +=item DESCRIPTION +=item CAVEATS -=item Stashes +=item DIAGNOSTICS +=head2 Benchmark - benchmark running times of code -=item Magic +=item SYNOPSIS +=item DESCRIPTION =over -=item Assigning Magic - - -=item Magic Virtual Tables +=item Methods +new, debug -=item Finding Magic +=item Standard Exports +timeit(COUNT, CODE), timethis ( COUNT, CODE, [ TITLE, [ STYLE ]] ), +timethese ( COUNT, CODEHASHREF, [ STYLE ] ), timediff ( T1, T2 ), timestr ( +TIMEDIFF, [ STYLE, [ FORMAT ]] ) +=item Optional Exports +clearcache ( COUNT ), clearallcache ( ), disablecache ( ), enablecache ( ) =back -=item Double-Typed SV's +=item NOTES +=item INHERITANCE -=item Calling Perl Routines from within C Programs +=item CAVEATS +=item AUTHORS -=item Memory Allocation +=item MODIFICATION HISTORY +=head2 Bundle::CPAN - A bundle to play with all the other modules on CPAN -=item API LISTING +=item SYNOPSIS +=item CONTENTS -AvFILL, av_clear, av_extend, av_fetch, av_len, av_make, av_pop, -av_push, av_shift, av_store, av_undef, av_unshift, CLASS, Copy, croak, -CvSTASH, DBsingle, DBsub, dMARK, dORIGMARK, dSP, dXSARGS, ENTER, -EXTEND, FREETMPS, G_ARRAY, G_DISCARD, G_EVAL, GIMME, G_NOARGS, -G_SCALAR, gv_stashpv, gv_stashsv, GvSV, he_free, hv_clear, hv_delete, -hv_exists, hv_fetch, hv_iterinit, hv_iterkey, hv_iternext, -hv_iternextsv, hv_iterval, hv_magic, HvNAME, hv_store, hv_undef, -isALNUM, isALPHA, isDIGIT, isLOWER, isSPACE, isUPPER, items, LEAVE, -MARK, mg_clear, mg_copy, mg_find, mg_free, mg_get, mg_len, mg_magical, -mg_set, Move, na, New, Newc, Newz, newAV, newHV, newRV, newSV, newSViv, -newSVnv, newSVpv, newSVrv, newSVsv, newXS, newXSproto, Nullav, Nullch, -Nullcv, Nullhv, Nullsv, ORIGMARK, perl_alloc, perl_call_argv, -perl_call_method, perl_call_pv, perl_call_sv, perl_construct, -perl_destruct, perl_eval_sv, perl_free, perl_get_av, perl_get_cv, -perl_get_hv, perl_get_sv, perl_parse, perl_require_pv, perl_run, POPi, -POPl, POPp, POPn, POPs, +=item DESCRIPTION =item AUTHOR +=head2 CGI - Simple Common Gateway Interface Class -=item DATE +=item SYNOPSIS + +=item ABSTRACT + +=item INSTALLATION +=item DESCRIPTION +=over +=item CREATING A NEW QUERY OBJECT: +=item CREATING A NEW QUERY OBJECT FROM AN INPUT FILE -=head2 perlcall - Perl calling conventions from C +=item FETCHING A LIST OF KEYWORDS FROM THE QUERY: -=item DESCRIPTION +=item FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT: +=item FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER: -An Error Handler, An Event Driven Program +=item SETTING THE VALUE(S) OF A NAMED PARAMETER: -=item THE PERL_CALL FUNCTIONS +=item APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER: +=item IMPORTING ALL PARAMETERS INTO A NAMESPACE: -B, B, B, -B +=item DELETING A PARAMETER COMPLETELY: -=item FLAG VALUES +=item DELETING ALL PARAMETERS: +=item SAVING THE STATE OF THE FORM TO A FILE: -=over +=item CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION: -=item G_SCALAR +=item COMPATIBILITY WITH CGI-LIB.PL +=item CALLING CGI FUNCTIONS THAT TAKE MULTIPLE ARGUMENTS -=item G_ARRAY +=item CREATING THE HTTP HEADER: +=item GENERATING A REDIRECTION INSTRUCTION -=item G_DISCARD +=item CREATING THE HTML HEADER: +B, 4, 5, 6.. -=item G_NOARGS +=item ENDING THE HTML DOCUMENT: +=back -=item G_EVAL +=item CREATING FORMS +=over -=item Determining the Context +=item CREATING AN ISINDEX TAG +=item STARTING AND ENDING A FORM +B, B +=item CREATING A TEXT FIELD -=back +B -=item KNOWN PROBLEMS +=item CREATING A BIG TEXT FIELD +=item CREATING A PASSWORD FIELD -=item EXAMPLES +=item CREATING A FILE UPLOAD FIELD +B -=over +=item CREATING A POPUP MENU -=item No Parameters, Nothing returned +=item CREATING A SCROLLING LIST +B -=item Passing Parameters +=item CREATING A GROUP OF RELATED CHECKBOXES +B -=item Returning a Scalar +=item CREATING A STANDALONE CHECKBOX +B -=item Returning a list of values +=item CREATING A RADIO BUTTON GROUP +B -=item Returning a list in a scalar context +=item CREATING A SUBMIT BUTTON +B -=item Returning Data from Perl via the parameter list +=item CREATING A RESET BUTTON +=item CREATING A DEFAULT BUTTON -=item Using G_EVAL +=item CREATING A HIDDEN FIELD +B -=item Using perl_call_sv +=item CREATING A CLICKABLE IMAGE BUTTON +B, 3.The third option (-align, optional) is an alignment type, +and may be +TOP, BOTTOM or MIDDLE -=item Using perl_call_argv +=item CREATING A JAVASCRIPT ACTION BUTTON + +=back + +=item NETSCAPE 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 Using perl_call_method +=item WORKING WITH NETSCAPE 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 Using GIMME +=item LIMITED SUPPORT FOR CASCADING STYLE SHEETS +=item DEBUGGING -=item Using Perl to dispose of temporaries +=over +=item DUMPING OUT ALL THE NAME/VALUE PAIRS -=item Strategies for storing Callback Context Information +=back +=item FETCHING ENVIRONMENT VARIABLES -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 +B, B, B, B, +B, B, BReturn the script +name as a partial URL, for self-refering +scripts, B, B, B, B, B, B, B, +B -=item Alternate Stack Manipulation +=item CREATING HTML ELEMENTS +=over +=item PROVIDING ARGUMENTS TO HTML SHORTCUTS +=item Generating new HTML tags =back -=item SEE ALSO +=item IMPORTING CGI METHOD CALLS INTO YOUR NAME SPACE +B, B, B, B, B, B, +B, B -=item AUTHOR +=item USING NPH SCRIPTS +In the B statementSimply add ":nph" to the list of symbols to be +imported into your script:, By calling the B method:, By using +B<-nph> parameters in the B and B statements: -=item DATE +=item AUTHOR INFORMATION +=item CREDITS +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@csgrad1.cs.wvu.edu), 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), ...and many many more.. +=item A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT +=item BUGS -=head2 perlembed - how to embed perl in your C program +=item SEE ALSO + +=head2 CGI::Apache - Make things work with CGI.pm against Perl-Apache API + +=item SYNOPSIS =item DESCRIPTION +=item NOTE 1 -=over +=item NOTE 2 -=item PREAMBLE +=item SEE ALSO +=item AUTHOR -B, B, B, B, B +=head2 CGI::Carp, B - CGI routines for writing to the HTTPD (or +other) error log -=item ROADMAP +=item SYNOPSIS +=item DESCRIPTION -=item Compiling your C program +=item REDIRECTING ERROR MESSAGES +=item MAKING PERL ERRORS APPEAR IN THE BROWSER WINDOW -=item Adding a Perl interpreter to your C program +=item CHANGE LOG +=item AUTHORS -=item Calling a Perl subroutine from your C program +=item SEE ALSO +=head2 CGI::Fast - CGI Interface for Fast CGI -=item Evaluating a Perl statement from your C program +=item SYNOPSIS +=item DESCRIPTION -=item Performing Perl pattern matches and substitutions from your C -program +=item OTHER PIECES OF THE PUZZLE +=item WRITING FASTCGI PERL SCRIPTS +=item INSTALLING FASTCGI SCRIPTS +=item USING FASTCGI SCRIPTS AS CGI SCRIPTS -=back +=item CAVEATS -=item MORAL +=item AUTHOR INFORMATION +=item BUGS -=item AUTHOR +=item SEE ALSO +=head2 CGI::Push - Simple Interface to Server Push +=item SYNOPSIS +=item DESCRIPTION +=item USING CGI::Push -=head2 perlpod - plain old documentation +-last_page, -type, -delay, -cookie, -target, -expires -=item DESCRIPTION +=item INSTALLING CGI::Push SCRIPTS +=item CAVEATS -=item Embedding Pods in Perl Modules +=item AUTHOR INFORMATION +=item BUGS =item SEE ALSO +=head2 CGI::Switch - Try more than one constructors and return the first +object available -=item AUTHOR +=item SYNOPSIS +=item DESCRIPTION +=item SEE ALSO +=item AUTHOR +=head2 CPAN - query, download and build perl modules from CPAN sites -=head2 perlbook - Perl book information +=item SYNOPSIS =item DESCRIPTION +=over +=item Interactive Mode +Searching for authors, bundles, distribution files and modules, make, test, +install, clean modules or distributions, readme, look module or +distribution +=item CPAN::Shell -=head1 PRAGMA DOCUMENTATION +=item autobundle +=item recompile +=item The 4 Classes: Authors, Bundles, Modules, Distributions +=item ProgrammerE<39>s interface -=head2 diagnostics - Perl compiler pragma to force verbose warning -diagnostics +expand($type,@things), Programming Examples -=item SYNOPSIS +=item Cache Manager +=item Bundles -=item DESCRIPTION +=item Prerequisites +=item Debugging -=over +=item Floppy, Zip, and all that Jazz -=item The C Pragma +=back +=item CONFIGURATION -=item The I Program +o conf Escalar optionE, o conf Escalar optionE +EvalueE, o conf Elist optionE, o conf Elist optionE +[shift|pop], o conf Elist optionE [unshift|push|splice] +ElistE +=item SECURITY +=item EXPORT +=item BUGS -=back +=item AUTHOR -=item EXAMPLES +=item SEE ALSO +=head2 CPAN::FirstTime - Utility for CPAN::Config file Initialization -=item INTERNALS +=item SYNOPSIS +=item DESCRIPTION -=item BUGS +=head2 CPANox, CPAN::Nox - Wrapper around CPAN.pm without using any XS +module +=item SYNOPSIS -=item AUTHOR +=item DESCRIPTION +=item SEE ALSO +=head2 Carp, carp - warn of errors (from perspective of caller) +=item SYNOPSIS +=item DESCRIPTION -=head2 integer - Perl pragma to compute arithmetic in integer instead -of double +=head2 Class::Struct - declare struct-like datatypes as Perl classes =item SYNOPSIS - =item DESCRIPTION +=over +=item The C function +=item Element Types and Accessor Methods +Scalar (C<'$'> or C<'*$'>), Array (C<'@'> or C<'*@'>), Hash (C<'%'> or +C<'*%'>), Class (C<'Class_Name'> or C<'*Class_Name'>) -=head2 less - perl pragma to request less of something from the -compiler +=back -=item SYNOPSIS +=item EXAMPLES + +Example 1, Example 2 + +=item Author and Modification History + +=head2 Config - access Perl configuration information +=item SYNOPSIS =item DESCRIPTION +myconfig(), config_sh(), config_vars(@names) +=item EXAMPLE +=item WARNING +=item NOTE -=head2 lib - manipulate @INC at compile time +=head2 Cwd, getcwd - get pathname of current working directory =item SYNOPSIS +=item DESCRIPTION + +=head2 DB_File - Perl5 access to Berkeley DB + +=item SYNOPSIS =item DESCRIPTION +B, B, B =over -=item ADDING DIRECTORIES TO @INC +=item Interface to Berkeley DB +=item Opening a Berkeley DB Database File -=item DELETING DIRECTORIES FROM @INC +=item Default Parameters +=item In Memory Databases -=item RESTORING ORIGINAL @INC +=back +=item DB_HASH +=over +=item A Simple Example =back -=item SEE ALSO +=item DB_BTREE +=over -=item AUTHOR +=item Changing the BTREE sort order +=item Handling Duplicate Keys +=item The get_dup() Method +=item Matching Partial Keys +=back -=head2 overload - Package for overloading perl operations +=item DB_RECNO -=item SYNOPSIS +=over +=item The 'bval' Option -=item CAVEAT SCRIPTOR +=item A Simple Example +=item Extra Methods -=item DESCRIPTION +B<$X-Epush(list) ;>, B<$value = $X-Epop ;>, B<$X-Eshift>, +B<$X-Eunshift(list) ;>, B<$X-Elength> +=item Another Example -=over +=back -=item Declaration of overloaded functions +=item THE API INTERFACE +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 Calling Conventions for Binary Operations +=item HINTS AND TIPS +=over -FALSE, TRUE, C +=item Locking Databases -=item Calling Conventions for Unary Operations +=item Sharing Databases With C Applications +=item The untie() Gotcha -=item Overloadable Operations +=back +=item COMMON QUESTIONS -I, I, I, -I, I, I, I +=over +=item Why is there Perl source in my database? +=item How do I store complex data structures with DB_File? -=back +=item What does "Invalid Argument" mean? -=item SPECIAL SYMBOLS FOR C +=item What does "Bareword 'DB_File' not allowed" mean? +=back -=over +=item HISTORY -=item Last Resort +=item BUGS +=item AVAILABILITY -=item Fallback +=item SEE ALSO +=item AUTHOR -C, TRUE, defined, but FALSE +=head2 Devel::SelfStubber - generate stubs for a SelfLoading module -=item Copy Constructor +=item SYNOPSIS +=item DESCRIPTION -B +=head2 DirHandle - supply object methods for directory handles +=item SYNOPSIS +=item DESCRIPTION -=back +=head2 DynaLoader - Dynamically load C libraries into Perl code -=item MAGIC AUTOGENERATION +=item SYNOPSIS +=item DESCRIPTION -I, I, -I, C, I, -I, I, I +@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_loadflags(), dl_find_symbol(), +dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), +bootstrap() -=item WARNING +=item AUTHOR +=head2 English - use nice English (or awk) names for ugly punctuation +variables -=item Run-time Overloading +=item SYNOPSIS +=item DESCRIPTION -=item Public functions +=head2 Env - perl module that imports environment variables +=item SYNOPSIS -overload::StrVal(arg), overload::Overloaded(arg), -overload::Method(obj,op) +=item DESCRIPTION -=item IMPLEMENTATION +=item AUTHOR +=head2 Exporter - Implements default import method for modules -=item AUTHOR +=item SYNOPSIS +=item DESCRIPTION -=item DIAGNOSTICS +=over +=item Selecting What To Export -=item BUGS +=item Specialised Import Lists +=item Module Version Checking +=item Managing Unknown Symbols +=item Tag Handling Utility Functions +=back -=head2 sigtrap - Perl pragma to enable stack backtrace on unexpected -signals +=head2 ExtUtils::Command - utilities to replace common UNIX commands in +Makefiles etc. =item SYNOPSIS - =item DESCRIPTION +cat, eqtime src dst, rm_f files..., rm_f files..., touch files .., mv +source... destination, cp source... destination, chmod mode files.., mkpath +directory.., test_f file +=item BUGS +=item SEE ALSO +=item AUTHOR -=head2 strict - Perl pragma to restrict unsafe constructs +=head2 ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications =item SYNOPSIS - =item DESCRIPTION +=item @EXPORT -C, C, C +=item FUNCTIONS +xsinit(), Examples, ldopts(), Examples, perl_inc(), ccflags(), ccdlflags(), +ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules) + +=item EXAMPLES +=item SEE ALSO +=item AUTHOR -=head2 subs - Perl pragma to predeclare sub names +=head2 ExtUtils::Install - install files from here to there =item SYNOPSIS +=item DESCRIPTION + +=head2 ExtUtils::Liblist - determine libraries to use and how to use them + +=item SYNOPSIS =item DESCRIPTION +For static extensions, For dynamic extensions, For dynamic extensions + +=over + +=item EXTRALIBS +=item LDLOADLIBS and LD_RUN_PATH +=item BSLOADLIBS +=back -=head1 MODULE DOCUMENTATION +=item PORTABILITY +=over +=item VMS implementation +=item Win32 implementation -=head2 AnyDBM_File - provide framework for multiple DBMs +=back + +=item SEE ALSO + +=head2 ExtUtils::MM_OS2 - methods to override UN*X behaviour in +ExtUtils::MakeMaker =item SYNOPSIS +=item DESCRIPTION + +=head2 ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker + +=item SYNOPSIS =item DESCRIPTION +=item METHODS =over -=item DBM Comparisons +=item Preloaded methods +canonpath, catdir, catfile, curdir, rootdir, updir -[0], [1], [2], [3] +=item SelfLoaded methods + +c_o (o), cflags (o), clean (o), const_cccmd (o), const_config (o), +const_loadlibs (o), constants (o), depend (o), dir_target (o), dist (o), +dist_basics (o), dist_ci (o), dist_core (o), dist_dir (o), dist_test (o), +dlsyms (o), dynamic (o), dynamic_bs (o), dynamic_lib (o), exescan, +extliblist, file_name_is_absolute, find_perl +=item Methods to actually produce chunks of text for the Makefile +force (o), guess_name, has_link_code, init_dirscan, init_main, init_others, +install (o), installbin (o), libscan (o), linkext (o), lsdir, macro (o), +makeaperl (o), makefile (o), manifypods (o), maybe_command, +maybe_command_in_dirs, needs_linking (o), nicetext, parse_version, pasthru +(o), path, perl_script, perldepend (o), pm_to_blib, post_constants (o), +post_initialize (o), postamble (o), prefixify, processPL (o), realclean +(o), replace_manpage_separator, static (o), static_lib (o), staticmake (o), +subdir_x (o), subdirs (o), test (o), test_via_harness (o), test_via_script +(o), tool_autosplit (o), tools_other (o), tool_xsubpp (o), top_targets (o), +writedoc, xs_c (o), xs_o (o), perl_archive, export_list =back =item SEE ALSO +=head2 ExtUtils::MM_VMS - methods to override UN*X behaviour in +ExtUtils::MakeMaker + +=item SYNOPSIS + +=item DESCRIPTION +=over +=item Methods always loaded + +eliminate_macros, fixpath, catdir, catfile, wraplist, curdir (override), +rootdir (override), updir (override) + +=item SelfLoaded methods + +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_others +(override), constants (override), cflags (override), const_cccmd +(override), pm_to_blib (override), tool_autosplit (override), tool_sxubpp +(override), xsubpp_version (override), tools_other (override), dist +(override), c_o (override), xs_c (override), xs_o (override), top_targets +(override), dlsyms (override), dynamic_lib (override), dynamic_bs +(override), static_lib (override), manifypods (override), processPL +(override), installbin (override), subdir_x (override), clean (override), +realclean (override), dist_basics (override), dist_core (override), +dist_dir (override), dist_test (override), install (override), perldepend +(override), makefile (override), test (override), test_via_harness +(override), test_via_script (override), makeaperl (override), nicetext +(override) +=back -=head2 AutoLoader - load functions only on demand +=head2 ExtUtils::MM_Win32 - methods to override UN*X behaviour in +ExtUtils::MakeMaker =item SYNOPSIS - =item DESCRIPTION +catfile, constants (o), static_lib (o), dynamic_bs (o), dynamic_lib (o), +canonpath, perl_script, pm_to_blib, test_via_harness (o), tool_autosplit +(override), tools_other (o), xs_o (o), top_targets (o), manifypods (o), +dist_ci (o), dist_core (o), pasthru (o) + +=head2 ExtUtils::MakeMaker - create an extension Makefile +=item SYNOPSIS +=item DESCRIPTION +=over -=head2 AutoSplit - split a package for autoloading +=item How To Write A Makefile.PL -=item SYNOPSIS +=item Default Makefile Behaviour +=item make test -=item DESCRIPTION +=item make testdb +=item make install +=item PREFIX and LIB attribute +=item AFS users +=item Static Linking of a new Perl Binary -=head2 Benchmark - benchmark running times of code +=item Determination of Perl Library and Installation Locations -=item SYNOPSIS +=item Which architecture dependent directory? +=item Using Attributes and Parameters -=item DESCRIPTION +C, CONFIG, CONFIGURE, DEFINE, DIR, DISTNAME, DL_FUNCS, DL_VARS, +EXCLUDE_EXT, EXE_FILES, NO_VC, FIRST_MAKEFILE, FULLPERL, H, INC, +INCLUDE_EXT, INSTALLARCHLIB, INSTALLBIN, INSTALLDIRS, INSTALLMAN1DIR, +INSTALLMAN3DIR, INSTALLPRIVLIB, INSTALLSCRIPT, INSTALLSITELIB, +INSTALLSITEARCH, INST_ARCHLIB, INST_BIN, INST_EXE, INST_LIB, INST_MAN1DIR, +INST_MAN3DIR, INST_SCRIPT, LDFROM, LIBPERL_A, LIB, LIBS, LINKTYPE, +MAKEAPERL, MAKEFILE, MAN1PODS, MAN3PODS, MAP_TARGET, MYEXTLIB, NAME, +NEEDS_LINKING, NOECHO, NORECURS, OBJECT, OPTIMIZE, PERL, PERLMAINCC, +PERL_ARCHLIB, PERL_LIB, PERL_SRC, PL_FILES, PM, PMLIBDIRS, PREFIX, +PREREQ_PM, SKIP, TYPEMAPS, VERSION, VERSION_FROM, XS, XSOPT, XSPROTOARG, +XS_VERSION +=item Additional lowercase attributes -=over +clean, depend, dist, dynamic_lib, installpm, linkext, macro, realclean, +tool_autosplit -=item Methods +=item Overriding MakeMaker Methods +=item Hintsfile support -new, debug +=item Distribution Support -=item Standard Exports + make distcheck, make skipcheck, make distclean, make manifest, + make distdir, make tardist, make dist, make uutardist, make +shdist, make zipdist, make ci +=back -timeit(COUNT, CODE), timethis, timethese, timediff, timestr +=item SEE ALSO -=item Optional Exports +=item AUTHORS +=head2 ExtUtils::Manifest - utilities to write and check a MANIFEST file +=item SYNOPSIS +=item DESCRIPTION -=back +=item MANIFEST.SKIP -=item NOTES +=item EXPORT_OK +=item GLOBAL VARIABLES -=item INHERITANCE +=item DIAGNOSTICS +C I, C I, C I<$!>, +C I -=item CAVEATS +=item SEE ALSO +=item AUTHOR -=item AUTHORS +=head2 ExtUtils::Miniperl, writemain - write the C code for perlmain.c +=item SYNOPSIS -=item MODIFICATION HISTORY +=item DESCRIPTION +=item SEE ALSO +=head2 ExtUtils::Mkbootstrap - make a bootstrap file for use by DynaLoader +=item SYNOPSIS +=item DESCRIPTION -=head2 Carp, carp - warn of errors (from perspective of caller) +=head2 ExtUtils::Mksymlists - write linker options files for dynamic +extension =item SYNOPSIS - =item DESCRIPTION +NAME, DL_FUNCS, DL_VARS, FILE, FUNCLIST, DLBASE +=item AUTHOR +=item REVISION - -=head2 Config - access Perl configuration option +=head2 ExtUtils::testlib - add blib/* directories to @INC =item SYNOPSIS - =item DESCRIPTION +=head2 Fcntl - load the C Fcntl.h defines -=item EXAMPLE +=item SYNOPSIS +=item DESCRIPTION =item NOTE +=item EXPORTED SYMBOLS - - - -=head2 Cwd, getcwd - get pathname of current working directory +=head2 File::Basename, fileparse - split a pathname into pieces =item SYNOPSIS - =item DESCRIPTION +fileparse_set_fstype, fileparse +=item EXAMPLES +C, C - -=head2 DB_File - Perl5 access to Berkeley DB +=head2 File::CheckTree, validate - run many filetest checks on a tree =item SYNOPSIS +=item DESCRIPTION + +=head2 File::Compare - Compare files or filehandles + +=item SYNOPSIS =item DESCRIPTION +=item RETURN -DB_HASH, DB_BTREE, DB_RECNO +=item AUTHOR -=over +=head2 File::Copy - Copy files or filehandles -=item How does DB_File interface to Berkeley DB? +=item SYNOPSIS +=item DESCRIPTION -=item Differences with Berkeley DB +=over +=item Special behavior if C is defined (VMS and OS/2) -=item RECNO +rmscopy($from,$to[,$date_flag]) +=back -=item In Memory Databases +=item RETURN +=item AUTHOR -=item Using the Berkeley DB Interface Directly +=head2 File::DosGlob - DOS like globbing and then some +=item SYNOPSIS -get, put, del, fd, seq, sync +=item DESCRIPTION +=item EXPORTS (by request only) +=item BUGS -=back +=item AUTHOR -=item EXAMPLES +=item HISTORY +=item SEE ALSO -=over +=head2 File::Find, find - traverse a file tree -=item Using HASH +=item SYNOPSIS +=item DESCRIPTION -=item Using BTREE +=head2 File::Path - create or remove a series of directories +=item SYNOPSIS -=item Using RECNO +=item DESCRIPTION +=item AUTHORS -=item Locking Databases +=item REVISION +=head2 File::stat - by-name interface to Perl's built-in stat() functions +=item SYNOPSIS +=item DESCRIPTION -=back +=item NOTE -=item HISTORY +=item AUTHOR +=head2 FileCache - keep more files open than the system permits -=item WARNINGS +=item SYNOPSIS +=item DESCRIPTION =item BUGS +=head2 FileHandle - supply object methods for filehandles -=item AVAILABILITY +=item SYNOPSIS + +=item DESCRIPTION +$fh->print, $fh->printf, $fh->getline, $fh->getlines =item SEE ALSO +=head2 FindBin - Locate directory of original perl script -=item AUTHOR +=item SYNOPSIS +=item DESCRIPTION +=item EXPORTABLE VARIABLES +=item KNOWN BUGS +=item AUTHORS -=head2 Devel::SelfStubber - generate stubs for a SelfLoading module +=item COPYRIGHT -=item SYNOPSIS +=item REVISION +=head2 GDBM_File - Perl5 access to the gdbm library. -=item DESCRIPTION +=item SYNOPSIS +=item DESCRIPTION +=item AVAILABILITY +=item BUGS +=item SEE ALSO -=head2 DynaLoader - Dynamically load C libraries into Perl code +=head2 Getopt::Long, GetOptions - extended processing of command line +options =item SYNOPSIS - =item DESCRIPTION +EnoneE, !, =s, :s, =i, :i, =f, :f -@dl_library_path, @dl_resolve_using, @dl_require_symbols, dl_error(), -$dl_debug, dl_findfile(), dl_expandspec(), dl_load_file(), -dl_find_symbol(), dl_undef_symbols(), dl_install_xsub(), boostrap() - -=item AUTHOR +=over +=item Linkage specification +=item Aliases and abbreviations +=item Non-option call-back routine +=item Option starters -=head2 English - use nice English (or awk) names for ugly punctuation -variables +=item Return value -=item SYNOPSIS +=back +=item COMPATIBILITY -=item DESCRIPTION +=item EXAMPLES +=item CONFIGURATION OPTIONS +default, auto_abbrev, getopt_compat, require_order, permute, bundling +(default: reset), bundling_override (default: reset), ignore_case +(default: set), ignore_case_always (default: reset), pass_through (default: +reset), debug (default: reset) +=item OTHER USEFUL VARIABLES +$Getopt::Long::VERSION, $Getopt::Long::error -=head2 Env - perl module that imports environment variables +=head2 Getopt::Std, getopt - Process single-character switches with switch +clustering =item SYNOPSIS - =item DESCRIPTION +=head2 I18N::Collate - compare 8-bit scalar data according to the current +locale -=item AUTHOR - - - +=item SYNOPSIS +=item DESCRIPTION -=head2 Exporter - provide inport/export controls for Perl modules +=head2 IO - load various IO modules =item SYNOPSIS - =item DESCRIPTION +=head2 IO::File - supply object methods for filehandles -=over - -=item Module Version Checking +=item SYNOPSIS +=item DESCRIPTION +=item CONSTRUCTOR +new ([ ARGS ] ), new_tmpfile -=back +=item METHODS +open( FILENAME [,MODE [,PERMS]] ) +=item SEE ALSO +=item HISTORY -=head2 ExtUtils::Liblist - determine libraries to use and how to use -them +=head2 IO::Handle - supply object methods for I/O handles =item SYNOPSIS - =item DESCRIPTION +=item CONSTRUCTOR -For static extensions, For dynamic extensions, For dynamic extensions - -=over +new (), new_from_fd ( FD, MODE ) -=item EXTRALIBS +=item METHODS +$fh->fdopen ( FD, MODE ), $fh->opened, $fh->getline, $fh->getlines, +$fh->ungetc ( ORD ), $fh->write ( BUF, LEN [, OFFSET }\] ), $fh->flush, +$fh->error, $fh->clearerr, $fh->untaint -=item LDLOADLIBS and LD_RUN_PATH +=item NOTE +=item SEE ALSO -=item BSLOADLIBS +=item BUGS +=item HISTORY +=head2 IO::Pipe, IO::pipe - supply object methods for pipes +=item SYNOPSIS -=back +=item DESCRIPTION -=item PORTABILITY +=item CONSTRCUTOR +new ( [READER, WRITER] ) -=item SEE ALSO +=item METHODS +reader ([ARGS]), writer ([ARGS]), handles () +=item SEE ALSO +=item AUTHOR +=item COPYRIGHT -=head2 ExtUtils::MakeMaker - create an extension Makefile +=head2 IO::Seekable - supply seek based methods for I/O objects =item SYNOPSIS - =item DESCRIPTION +=item SEE ALSO -=over - -=item Hintsfile support +=item HISTORY +=head2 IO::Select - OO interface to the select system call -=item What's new in version 5 of MakeMaker +=item SYNOPSIS +=item DESCRIPTION -=item Incompatibilities between MakeMaker 5.00 and 4.23 +=item CONSTRUCTOR +new ( [ HANDLES ] ) -=item Default Makefile Behaviour +=item METHODS +add ( HANDLES ), remove ( HANDLES ), exists ( HANDLE ), handles, can_read ( +[ TIMEOUT ] ), can_write ( [ TIMEOUT ] ), has_error ( [ TIMEOUT ] ), count +(), bits(), bits(), select ( READ, WRITE, ERROR [, TIMEOUT ] ) -=item Special case make install +=item EXAMPLE +=item AUTHOR -=item PREFIX attribute +=item COPYRIGHT +=head2 IO::Socket - Object interface to socket communications -=item AFS users +=item SYNOPSIS +=item DESCRIPTION -=item Static Linking of a new Perl Binary +=item CONSTRUCTOR +new ( [ARGS] ) -=item Determination of Perl Library and Installation Locations +=item METHODS +accept([PKG]), timeout([VAL]), sockopt(OPT [, VAL]), sockdomain, socktype, +protocol -=item Useful Default Makefile Macros +=item SUB-CLASSES +=over -=item Using Attributes (and Parameters) +=item IO::Socket::INET +=item METHODS -C, CONFIG, CONFIGURE, DEFINE, DIR, DISTNAME, DL_FUNCS, DL_VARS, -EXE_FILES, FIRST_MAKEFILE, FULLPERL, H, INC, INSTALLARCHLIB, -INSTALLBIN, INSTALLMAN1DIR, INSTALLMAN3DIR, INSTALLPRIVLIB, -INST_ARCHLIB, INST_EXE, INST_LIB, INST_MAN1DIR, INST_MAN3DIR, LDFROM, -LIBPERL_A, LIBS, LINKTYPE, MAKEAPERL, MAKEFILE, MAN1PODS, MAN3PODS, -MAP_TARGET, MYEXTLIB, NAME, NEEDS_LINKING, NORECURS, OBJECT, PERL, -PERLMAINCC, PERL_ARCHLIB, PERL_LIB, PERL_SRC, PL_FILES, PM, PMLIBDIRS, -PREFIX, PREREQ, SKIP, TYPEMAPS, VERSION, XS, XSOPT, XSPROTOARG +sockaddr (), sockport (), sockhost (), peeraddr (), peerport (), peerhost +() -=item Additional lowercase attributes +=item IO::Socket::UNIX +=item METHODS -clean, dist, dynamic_lib, installpm, linkext, macro, realclean, -tool_autosplit +hostpath(), peerpath() -=item Overriding MakeMaker Methods +=back +=item SEE ALSO -=item Distribution Support +=item AUTHOR +=item COPYRIGHT - make distcheck, make skipcheck, make distclean, make - manifest, make distdir, make tardist, make dist, make - uutardist, make shdist, make ci +=head2 IO::lib::IO::File, IO::File - supply object methods for filehandles +=item SYNOPSIS +=item DESCRIPTION -=back +=item CONSTRUCTOR -=item AUTHORS +new ([ ARGS ] ), new_tmpfile +=item METHODS -=item MODIFICATION HISTORY +open( FILENAME [,MODE [,PERMS]] ) +=item SEE ALSO -=item TODO +=item HISTORY +=head2 IO::lib::IO::Handle, IO::Handle - supply object methods for I/O +handles +=item SYNOPSIS +=item DESCRIPTION +=item CONSTRUCTOR -=head2 ExtUtils::Manifest - utilities to write and check a MANIFEST -file +new (), new_from_fd ( FD, MODE ) -=item SYNOPSIS +=item METHODS +$fh->fdopen ( FD, MODE ), $fh->opened, $fh->getline, $fh->getlines, +$fh->ungetc ( ORD ), $fh->write ( BUF, LEN [, OFFSET }\] ), $fh->flush, +$fh->error, $fh->clearerr, $fh->untaint -=item DESCRIPTION +=item NOTE +=item SEE ALSO -=item MANIFEST.SKIP +=item BUGS +=item HISTORY -=item EXPORT_OK +=head2 IO::lib::IO::Pipe, IO::pipe - supply object methods for pipes +=item SYNOPSIS -=item GLOBAL VARIABLES +=item DESCRIPTION +=item CONSTRCUTOR -=item DIAGNOSTICS +new ( [READER, WRITER] ) +=item METHODS -C I, C I, C -I<$!>, C I +reader ([ARGS]), writer ([ARGS]), handles () =item SEE ALSO - =item AUTHOR +=item COPYRIGHT +=head2 IO::lib::IO::Seekable, IO::Seekable - supply seek based methods for +I/O objects +=item SYNOPSIS +=item DESCRIPTION -=head2 ExtUtils::Miniperl, writemain - write the C code for perlmain.c +=item SEE ALSO -=item SYNOPSIS +=item HISTORY +=head2 IO::lib::IO::Select, IO::Select - OO interface to the select system +call + +=item SYNOPSIS =item DESCRIPTION +=item CONSTRUCTOR -=item SEE ALSO +new ( [ HANDLES ] ) +=item METHODS +add ( HANDLES ), remove ( HANDLES ), exists ( HANDLE ), handles, can_read ( +[ TIMEOUT ] ), can_write ( [ TIMEOUT ] ), has_error ( [ TIMEOUT ] ), count +(), bits(), bits(), select ( READ, WRITE, ERROR [, TIMEOUT ] ) +=item EXAMPLE +=item AUTHOR -=head2 ExtUtils::Mkbootstrap, Mkbootstrap - make a bootstrap file for -use by DynaLoader +=item COPYRIGHT -=item SYNOPSIS +=head2 IO::lib::IO::Socket, IO::Socket - Object interface to socket +communications +=item SYNOPSIS =item DESCRIPTION +=item CONSTRUCTOR +new ( [ARGS] ) +=item METHODS +accept([PKG]), timeout([VAL]), sockopt(OPT [, VAL]), sockdomain, socktype, +protocol -=head2 Fcntl - load the C Fcntl.h defines - -=item SYNOPSIS +=item SUB-CLASSES +=over -=item DESCRIPTION +=item IO::Socket::INET +=item METHODS -=item NOTE +sockaddr (), sockport (), sockhost (), peeraddr (), peerport (), peerhost +() +=item IO::Socket::UNIX +=item METHODS +hostpath(), peerpath() +=back -=head2 File::Basename, Basename - parse file specifications +=item SEE ALSO -=item SYNOPSIS +=item AUTHOR +=item COPYRIGHT -=item DESCRIPTION +=head2 IPC::Open2, open2 - open a process for both reading and writing +=item SYNOPSIS -fileparse_set_fstype, fileparse +=item DESCRIPTION -=item EXAMPLES +=item WARNING +=item SEE ALSO -C, C +=head2 IPC::Open3, open3 - open a process for reading, writing, and error +handling +=item SYNOPSIS +=item DESCRIPTION +=item WARNING -=head2 File::CheckTree, validate - run many filetest checks on a tree +=head2 Math::BigFloat - Arbitrary length float math package =item SYNOPSIS - =item DESCRIPTION +number format, Error returns 'NaN', Division is computed to +=item BUGS +=item AUTHOR - -=head2 File::Find, find - traverse a file tree +=head2 Math::BigInt - Arbitrary size integer math package =item SYNOPSIS - =item DESCRIPTION +Canonical notation, Input, Output +=item EXAMPLES +=item BUGS +=item AUTHOR -=head2 File::Path - create or remove a series of directories +=head2 Math::Complex - complex numbers and associated mathematical +functions =item SYNOPSIS - =item DESCRIPTION +=item OPERATIONS -=item AUTHORS - +=item CREATION -=item REVISION +=item STRINGIFICATION +=item USAGE +=item ERRORS DUE TO DIVISION BY ZERO +=item BUGS +=item AUTHORS -=head2 FileHandle - supply object methods for filehandles +=head2 Math::Trig - trigonometric functions =item SYNOPSIS - =item DESCRIPTION - -$fh->print, $fh->printf, $fh->getline, $fh->getlines +=item TRIGONOMETRIC FUNCTIONS =over -=item The cacheout() Library +=item ERRORS DUE TO DIVISION BY ZERO + +=item SIMPLE (REAL) ARGUMENTS, COMPLEX RESULTS + +=back + +=item ANGLE CONVERSIONS + +=item BUGS + +=item AUTHORS + +=head2 NDBM_File - Tied access to ndbm files +=item SYNOPSIS +=item DESCRIPTION +=head2 Net::Ping - check a remote host for reachability -=back +=item SYNOPSIS -=item SEE ALSO +=item DESCRIPTION +=over -=item BUGS +=item Functions +Net::Ping->new([$proto [, $def_timeout [, $bytes]]]);, $p->ping($host [, +$timeout]);, $p->close();, pingecho($host [, $timeout]); +=back +=item WARNING +=item NOTES -=head2 Getopt::Long, GetOptions - extended getopt processing +=head2 Net::hostent - by-name interface to Perl's built-in gethost*() +functions =item SYNOPSIS - =item DESCRIPTION - =item EXAMPLES - -$autoabbrev, $getopt_compat, $option_start, $order, $ignorecase, $debug - =item NOTE +=item AUTHOR +=head2 Net::netent - by-name interface to Perl's built-in getnet*() +functions +=item SYNOPSIS +=item DESCRIPTION -=head2 Getopt::Std, getopt - Process single-character switches with -switch clustering +=item EXAMPLES -=item SYNOPSIS +=item NOTE +=item AUTHOR -=item DESCRIPTION +=head2 Net::protoent - by-name interface to Perl's built-in getproto*() +functions +=item SYNOPSIS +=item DESCRIPTION +=item NOTE +=item AUTHOR -=head2 I18N::Collate, Collate - compare 8-bit scalar data according to -the current locale +=head2 Net::servent - by-name interface to Perl's built-in getserv*() +functions =item SYNOPSIS - =item DESCRIPTION +=item EXAMPLES +=item NOTE +=item AUTHOR - -=head2 IPC::Open2, open2 - open a process for both reading and writing +=head2 ODBM_File - Tied access to odbm files =item SYNOPSIS - =item DESCRIPTION +=head2 Opcode - Disable named opcodes when compiling perl code -=item WARNING - +=item SYNOPSIS -=item SEE ALSO +=item DESCRIPTION +=item NOTE +=item WARNING +=item Operator Names and Operator Lists +an operator name (opname), an operator tag name (optag), a negated opname +or optag, an operator set (opset) -=head2 IPC::Open3, open3 - open a process for reading, writing, and -error handling +=item Opcode Functions -=item SYNOPSIS +opcodes, opset (OP, ...), opset_to_ops (OPSET), opset_to_hex (OPSET), +full_opset, empty_opset, invert_opset (OPSET), verify_opset (OPSET, ...), +define_optag (OPTAG, OPSET), opmask_add (OPSET), opmask, opdesc (OP, ...), +opdump (PAT) +=item Manipulating Opsets -=item DESCRIPTION +=item TO DO (maybe) +=item Predefined Opcode Tags +:base_core, :base_mem, :base_loop, :base_io, :base_orig, :base_math, +:default, :filesys_read, :sys_db, :browse, :filesys_open, :filesys_write, +:subprocess, :ownprocess, :others, :still_to_be_decided, :dangerous +=item SEE ALSO +=item AUTHORS -=head2 Net::Ping, pingecho - check a host for upness +=head2 Opcode::Safe, Safe - Compile and execute code in restricted +compartments =item SYNOPSIS - =item DESCRIPTION +a new namespace, an operator mask + +=item WARNING =over -=item Parameters +=item RECENT CHANGES + +=item Methods in class Safe +permit (OP, ...), permit_only (OP, ...), deny (OP, ...), deny_only (OP, +...), trap (OP, ...), untrap (OP, ...), share (NAME, ...), share_from +(PACKAGE, ARRAYREF), varglob (VARNAME), reval (STRING), rdo (FILENAME), +root (NAMESPACE), mask (MASK) -hostname, timeout +=item Some Safety Issues +Memory, CPU, Snooping, Signals, State Changes +=item AUTHOR =back -=item WARNING - +=head2 Opcode::ops, ops - Perl pragma to restrict unsafe operations when +compiling +=item SYNOPSIS +=item DESCRIPTION +=item SEE ALSO =head2 POSIX - Perl interface to IEEE Std 1003.1 =item SYNOPSIS - =item DESCRIPTION - =item NOTE - -=item CAVEATS - +=item CAVEATS =item FUNCTIONS - -_exit, abort, abs, access, acos, alarm, asctime, asin, assert, atan, -atan2, atexit, atof, atoi, atol, bsearch, calloc, ceil, chdir, chmod, -chown, clearerr, clock, close, closedir, cos, cosh, creat, ctermid, -ctime, 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, pat +_exit, abort, abs, access, acos, alarm, asctime, asin, assert, atan, atan2, +atexit, atof, atoi, atol, bsearch, calloc, ceil, chdir, chmod, chown, +clearerr, clock, close, closedir, cos, cosh, creat, ctermid, ctime, +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, +sigsuspend, sin, sinh, sleep, sprintf, sqrt, srand, sscanf, stat, strcat, +strchr, strcmp, strcoll, strcpy, strcspn, strerror, strftime, strlen, +strncat, strncmp, strncpy, stroul, strpbrk, strrchr, strspn, strstr, +strtod, strtok, strtol, strtoul, strxfrm, sysconf, system, tan, tanh, +tcdrain, tcflow, tcflush, tcgetpgrp, tcsendbreak, tcsetpgrp, time, times, +tmpfile, tmpnam, tolower, toupper, ttyname, tzname, tzset, umask, uname, +ungetc, unlink, utime, vfprintf, vprintf, vsprintf, wait, waitpid, +wcstombs, wctomb, write =item CLASSES - =over -=item FileHandle - - -new, clearerr, close, eof, error, fileno, flush, getc, getpos, gets, -new_from_fd, new_tmpfile, seek, setbuf, setpos, setvbuf, tell, ungetc - =item POSIX::SigAction - new =item POSIX::SigSet - new, addset, delset, emptyset, fillset, ismember =item POSIX::Termios - new, getattr, getcc, getcflag, getiflag, getispeed, getlflag, getoflag, getospeed, setattr, setcc, setcflag, setiflag, setispeed, setlflag, setoflag, setospeed, Baud rate values, Terminal interface values, c_cc field values, c_cflag field values, c_iflag field values, c_lflag field values, c_oflag field values - - =back =item PATHNAME CONSTANTS - Constants =item POSIX CONSTANTS - Constants =item SYSTEM CONFIGURATION - Constants =item ERRNO - Constants =item FCNTL - Constants =item FLOAT - Constants =item LIMITS - Constants =item LOCALE - Constants =item MATH - Constants =item SIGNAL - Constants =item STAT - Constants, Macros =item STDLIB - Constants =item STDIO - Constants =item TIME - Constants =item UNISTD - Constants =item WAIT - Constants, Macros =item CREATION +=head2 Pod::Html, Pod::HTML - module to convert pod files to HTML + +=item SYNOPSIS + +=item DESCRIPTION + +=item ARGUMENTS + +help, htmlroot, infile, outfile, podroot, podpath, libpods, netscape, +nonetscape, index, noindex, recurse, norecurse, title, verbose + +=item EXAMPLE + +=item AUTHOR + +=item BUGS +=item SEE ALSO +=item COPYRIGHT +=head2 Pod::Text - convert POD data to formatted ASCII text -=head2 Safe - Safe extension module for Perl +=item SYNOPSIS =item DESCRIPTION +=item AUTHOR + +=item TODO -a new namespace, an operator mask +=head2 SDBM_File - Tied access to sdbm files -=over +=item SYNOPSIS -=item Operator masks +=item DESCRIPTION +=head2 Safe - Compile and execute code in restricted compartments -=item Methods in class Safe +=item SYNOPSIS +=item DESCRIPTION + +a new namespace, an operator mask -NAMESPACE, MASK, root (NAMESPACE), mask (MASK), trap (OP, ...), untrap -(OP, ...), share (VARNAME, ...), varglob (VARNAME), reval (STRING), rdo -(FILENAME) +=item WARNING -=item Subroutines in package Safe +=over +=item RECENT CHANGES -ops_to_mask (OP, ...), mask_to_ops (MASK), opcode (OP, ...), opname -(OP, ...), fullmask, emptymask, MAXO, op_mask +=item Methods in class Safe -=item AUTHOR +permit (OP, ...), permit_only (OP, ...), deny (OP, ...), deny_only (OP, +...), trap (OP, ...), untrap (OP, ...), share (NAME, ...), share_from +(PACKAGE, ARRAYREF), varglob (VARNAME), reval (STRING), rdo (FILENAME), +root (NAMESPACE), mask (MASK) +=item Some Safety Issues +Memory, CPU, Snooping, Signals, State Changes +=item AUTHOR =back +=head2 Search::Dict, look - search for key in dictionary file +=item SYNOPSIS +=item DESCRIPTION -=head2 SelfLoader - load functions only on demand +=head2 SelectSaver - save and restore selected file handle =item SYNOPSIS - =item DESCRIPTION +=head2 SelfLoader - load functions only on demand + +=item SYNOPSIS + +=item DESCRIPTION =over =item The __DATA__ token - =item SelfLoader autoloading - =item Autoloading and package lexicals - =item SelfLoader and AutoLoader - =item __DATA__, __END__, and the FOOBAR::DATA filehandle. - =item Classes and inherited methods. - - - =back =item Multiple packages and fully qualified subroutine names +=head2 Shell - run shell commands transparently within perl +=item SYNOPSIS +=item DESCRIPTION +=item AUTHOR -=head2 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load -the C - socket.h defines and structure manipulators +=head2 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C +socket.h defines and structure manipulators =item SYNOPSIS - =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 -inet_aton HOSTNAME, inet_ntoa IP_ADDRESS, INADDR_ANY, 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 - +=head2 Symbol - manipulate Perl symbols and their names +=item SYNOPSIS +=item DESCRIPTION =head2 Sys::Hostname - Try every conceivable way to get hostname =item SYNOPSIS - =item DESCRIPTION - =item AUTHOR - - - - -=head2 Term::Cap - Perl termcap interface +=head2 Syslog, Sys::Syslog, openlog, closelog, setlogmask, syslog - Perl +interface to the UNIX syslog(3) calls =item SYNOPSIS - =item DESCRIPTION +openlog $ident, $logopt, $facility, syslog $priority, $format, @args, +setlogmask $mask_priority, closelog =item EXAMPLES +=item DEPENDENCIES +=item SEE ALSO + +=item AUTHOR + +=head2 Term::Cap - Perl termcap interface + +=item SYNOPSIS +=item DESCRIPTION +=item EXAMPLES =head2 Term::Complete - Perl word completion module =item SYNOPSIS - =item DESCRIPTION - -Attempts word completion. Cannot be changed, ^D, ^U, , +EtabE, ^D, ^U, EdelE, EbsE =item DIAGNOSTICS - =item BUGS - =item AUTHOR +=head2 Term::ReadLine - Perl interface to various C packages. If +no real package is found, substitutes stubs instead of basic functions. + +=item SYNOPSIS + +=item DESCRIPTION + +=item Minimal set of supported functions +C, C, C, C, C, $C, +C, C, Attribs, C +=item Additional supported functions +=item EXPORTS + +=item ENVIRONMENT =head2 Test::Harness - run perl standard test scripts with statistics =item SYNOPSIS - =item DESCRIPTION +=over + +=item The test script output -=item EXPORT +=back +=item EXPORT =item DIAGNOSTICS - -C, C, C +C, C, C, C, C =item SEE ALSO +=item AUTHORS =item BUGS +=head2 Text::Abbrev, abbrev - create an abbreviation table from a list +=item SYNOPSIS +=item DESCRIPTION +=item EXAMPLE -=head2 Text::Abbrev, abbrev - create an abbreviation table from a list +=head2 Text::ParseWords - parse text into an array of tokens =item SYNOPSIS - =item DESCRIPTION +=item AUTHORS -=item EXAMPLE +=head2 Text::Soundex - Implementation of the Soundex Algorithm as Described +by Knuth +=item SYNOPSIS + +=item DESCRIPTION +=item EXAMPLES +=item LIMITATIONS +=item AUTHOR -=head2 Text::Soundex - Implementation of the Soundex Algorithm as -Described by Knuth +=head2 Text::Tabs -- expand and unexpand tabs per the unix expand(1) and +unexpand(1) =item SYNOPSIS - =item DESCRIPTION +=item BUGS + +=item AUTHOR -=item EXAMPLES +=head2 Text::Wrap - line wrapping to form simple paragraphs +=item SYNOPSIS -=item LIMITATIONS +=item DESCRIPTION + +=item EXAMPLE +=item BUGS =item AUTHOR +=head2 Tie::Hash, Tie::StdHash - base class definitions for tied hashes +=item SYNOPSIS +=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 -=head2 Text::Tabs -- expand and unexpand tabs +=item CAVEATS -=item SYNOPSIS +=item MORE INFORMATION + +=head2 Tie::RefHash - use references as hash keys +=item SYNOPSIS =item DESCRIPTION +=item EXAMPLE =item AUTHOR +=item VERSION + +=item SEE ALSO + +=head2 Tie::Scalar, Tie::StdScalar - base class definitions for tied +scalars + +=item SYNOPSIS + +=item DESCRIPTION + +TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this + +=item MORE INFORMATION + +=head2 Tie::SubstrHash - Fixed-table-size, fixed-key-length hashing +=item SYNOPSIS +=item DESCRIPTION +=item CAVEATS -=head2 Text::Wrap -- wrap text into a paragraph +=head2 Time::Local - efficiently compute time from local and GMT time =item SYNOPSIS +=item DESCRIPTION + +=head2 Time::gmtime - by-name interface to Perl's built-in gmtime() +function + +=item SYNOPSIS =item DESCRIPTION +=item NOTE =item AUTHOR +=head2 Time::localtime - by-name interface to Perl's built-in localtime() +function +=item SYNOPSIS + +=item DESCRIPTION +=item NOTE +=item AUTHOR -=head2 TieHash, TieHash::Std - base class definitions for tied hashes +=head2 Time::tm - internal object used by Time::gmtime and Time::localtime =item SYNOPSIS - =item DESCRIPTION +=item AUTHOR -TIEHASH classname, LIST, STORE this, key, value, FETCH this, key, -FIRSTKEY this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, -key, CLEAR this +=head2 UNIVERSAL - base class for ALL classes (blessed references) -=item CAVEATS +=item SYNOPSIS + +=item DESCRIPTION +isa ( TYPE ), can ( METHOD ), VERSION ( [ REQUIRE ] ), isa ( VAL, TYPE ), +can ( VAL, METHOD ) -=item MORE INFORMATION +=head2 User::grent - by-name interface to Perl's built-in getgr*() +functions +=item SYNOPSIS +=item DESCRIPTION +=item NOTE +=item AUTHOR -=head2 Time::Local - efficiently compute tome from local and GMT time +=head2 User::pwent - by-name interface to Perl's built-in getpw*() +functions =item SYNOPSIS - =item DESCRIPTION +=item NOTE - +=item AUTHOR =head1 AUXILIARY DOCUMENTATION -Here should be listed all the extra program's docs, but they don't all -have man pages yet: +Here should be listed all the extra programs' documentation, but they +don't all have manual pages yet: =item a2p @@ -2774,10 +4945,8 @@ have man pages yet: =item wrapsuid - =head1 AUTHOR -Larry Wall EE, with the help of oodles of -other folks. - +Larry Wall >, with the help of oodles +of other folks.