NAME

perltoc - perl documentation table of contents

DESCRIPTION

This page provides a brief table of contents for the rest of the Perl documentation set. It is meant to be scanned quickly or grepped through to locate the proper section you're looking for.

BASIC DOCUMENTATION

perl - Practical Extraction and Report Language

SYNOPSIS

DESCRIPTION

Many usability enhancements, Simplified grammar, Lexical scoping, Arbitrarily nested data structures, Modularity and reusability, 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

ENVIRONMENT

HOME, LOGDIR, PATH, PERL5LIB, PERL5DB, PERL_DESTRUCT_LEVEL, PERLLIB

AUTHOR

FILES

SEE ALSO

DIAGNOSTICS

BUGS

NOTES

perldelta - what's new for perl5.004

DESCRIPTION

Supported Environments

Core Changes

Compilation Option: Binary Compatibility With 5.003

New Opcode Module and Revised Safe Module

Extended Fcntl Module

Internal Change: FileHandle Deprecated

Internal Change: PerlIO internal IO abstraction interface

New and Changed Built-in Variables

$^E, $^H, $^M

New and Changed Built-in Functions

delete on slices, flock, keys as an lvalue, my() in Control Structures, unpack() and pack(), use VERSION, use Module VERSION LIST, prototype(FUNCTION), $_ as Default, m//g does not trigger a pos() reset on failure, nested sub{} closures work now, formats work right on changing lexicals

New Built-in Methods

isa(CLASS), can(METHOD), VERSION( [NEED] ), class(), is_instance()

TIEHANDLE Now Supported

TIEHANDLE classname, LIST, PRINT this, LIST, READLINE this, DESTROY this, Efficiency Enhancements

Pragmata

use blib, use blib 'dir', use locale, use ops

Modules

Fcntl

Module Information Summary

IO

Math::Complex

Overridden Built-ins

Utility Changes

xsubpp

void XSUBs now default to returning nothing

Documentation Changes

perldelta, perllocale, perltoot, perlapio, perldebug, perlsec

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, Attempt to free non-existent shared string, Attempt to use reference as lvalue in substr, Unsupported function fork, Ill-formed logical name |%s| in prime_env_iter, Can't use bareword ("%s") as %s ref while "strict refs" in use, Constant subroutine %s redefined, Died, Integer overflow in hex number, Integer overflow in octal number, Name "%s::%s" used only once: possible typo, Null picture in formline, Offset outside string, Stub found while resolving method `%s' overloading `%s' in package `%s', Cannot resolve method `%s' overloading `%s' in package `s', Out of memory!, Out of memory during request for %s, Possible attempt to put comments in qw() list, Possible attempt to separate words with commas, Scalar value @%s{%s} better written as $%s{%s}, untie attempted while %d inner references still exist, Value of %s construct can be "0"; test with defined(), Variable "%s" may be unavailable, Variable "%s" will not stay shared, Warning: something's wrong, Got an error from DosAllocMem, Malformed PERLLIB_PREFIX, PERL_SH_DIR too long, Process terminated by SIG%s

BUGS

SEE ALSO

HISTORY

perldata - Perl data types

DESCRIPTION

Variable names

Context

Scalar values

Scalar value constructors

List value constructors

Typeglobs and Filehandles

perlsyn - Perl syntax

DESCRIPTION

Declarations

Simple statements

Compound statements

Loop Control

For Loops

Foreach Loops

Basic BLOCKs and Switch Statements

Goto

PODs: Embedded Documentation

Plain Old Comments (Not!)

perlop - Perl operators and precedence

SYNOPSIS

DESCRIPTION

Terms and List Operators (Leftward)

The Arrow Operator

Auto-increment and Auto-decrement

Exponentiation

Symbolic Unary Operators

Binding Operators

Multiplicative Operators

Additive Operators

Shift Operators

Named Unary Operators

Relational Operators

Equality Operators

Bitwise And

Bitwise Or and Exclusive Or

C-style Logical And

C-style Logical Or

Range Operator

Conditional Operator

Assignment Operators

Comma Operator

List Operators (Rightward)

Logical Not

Logical And

Logical or and Exclusive Or

C Operators Missing From Perl

unary &, unary *, (TYPE)

Quote and Quote-like Operators

Regexp Quote-Like Operators

?PATTERN?, m/PATTERN/gimosx, /PATTERN/gimosx, q/STRING/, 'STRING', qq/STRING/, "STRING", qx/STRING/, `STRING`, qw/STRING/, s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds, y/SEARCHLIST/REPLACEMENTLIST/cds

I/O Operators

Constant Folding

Integer Arithmetic

perlre - Perl regular expressions

DESCRIPTION

i, m, s, x

Regular Expressions

(?#text), (?:regexp), (?=regexp), (?!regexp), (?imsx)

Backtracking

Version 8 Regular Expressions

WARNING on \1 vs $1

perlrun - how to execute the Perl interpreter

SYNOPSIS

DESCRIPTION

Switches

-0[digits], -a, -c, -d, -d:foo, -Dnumber, -Dlist, -e commandline, -Fpattern, -h, -i[extension], -Idirectory, -l[octnum], -m[-]module, -M[-]module, -M[-]'module ...', -[mM][-]module=arg[,arg]..., -n, -p, -P, -s, -S, -T, -u, -U, -v, -V, -V:name, -w, -x directory

perlfunc - Perl builtin functions

DESCRIPTION

I<THERE IS NO GENERAL RULE FOR CONVERTING A LIST INTO A SCALAR!>

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

Alphabetical Listing of Perl Functions

-X FILEHANDLE, -X EXPR, -X, 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 ASSOC_ARRAY, dbmopen ASSOC,DBNAME,MODE, defined EXPR, defined, 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, 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, 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 ASSOC_ARRAY, 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 LIST, 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, 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, system LIST, 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 ASSOC_ARRAY, vec EXPR,OFFSET,BITS, wait, waitpid PID,FLAGS, wantarray, warn LIST, write FILEHANDLE, write EXPR, write, y///

perlvar - Perl predefined variables

DESCRIPTION

Predefined Names

$ARG, $_, $<digit>, $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}

perlsub - Perl subroutines

SYNOPSIS

DESCRIPTION

Private Variables via my()

Temporary Values via local()

Passing Symbol Table Entries (typeglobs)

Pass by Reference

Prototypes

Constant Functions

Overriding Builtin Functions

Autoloading

SEE ALSO

perlmod - Perl modules (packages)

DESCRIPTION

Packages

Symbol Tables

Package Constructors and Destructors

Perl Classes

Perl Modules

NOTE

THE PERL MODULE LIBRARY

Pragmatic Modules

blib, diagnostics, integer, less, lib, locale, ops, overload, sigtrap, strict, subs, vars

Standard Modules

AnyDBM_File, AutoLoader, AutoSplit, Benchmark, CPAN, CPAN::FirstTime, CPAN::Nox, Carp, Class::Template, 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, Fatal, 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, 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

Extension Modules

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

Modules: Creation, Use, and Abuse

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

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

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

perlform - Perl formats

DESCRIPTION

Format Variables

NOTES

Footers

Accessing Formatting Internals

WARNINGS

perllocale - Perl locale handling (internationalization and localization)

DESCRIPTION

PREPARING TO USE LOCALES

USING LOCALES

The use locale pragma

The setlocale function

The localeconv function

LOCALE CATEGORIES

Category LC_COLLATE: Collation

Category LC_CTYPE: Character Types

Category LC_NUMERIC: Numeric Formatting

Category LC_MONETARY: Formatting of monetary amounts

LC_TIME

Other categories

SECURITY

Comparison operators (lt, le, ge, gt and cmp):, Case-mapping interpolation (with \l, \L, \u or <\U>), Matching operator (m//):, Substitution operator (s///):, In-memory formatting function (sprintf()):, Output formatting functions (printf() and write()):, Case-mapping functions (lc(), lcfirst(), uc(), ucfirst()):, POSIX locale-dependent functions (localeconv(), strcoll(),strftime(), strxfrm()):, POSIX character class tests (isalnum(), isalpha(), isdigit(),isgraph(), islower(), isprint(), ispunct(), isspace(), isupper(), isxdigit()):

ENVIRONMENT

PERL_BADLANG, LC_ALL, LC_CTYPE, LC_COLLATE, LC_MONETARY, LC_NUMERIC, LC_TIME, LANG

NOTES

Backward compatibility

I18N:Collate obsolete

Sort speed and memory use impacts

write() and LC_NUMERIC

Freely available locale definitions

I18n and l10n

An imperfect standard

BUGS

Broken systems

SEE ALSO

HISTORY

perlref - Perl references and nested data structures

DESCRIPTION

Symbolic references

Not-so-symbolic references

WARNING

SEE ALSO

perldsc - Perl Data Structures Cookbook

DESCRIPTION

arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes, more elaborate constructs

REFERENCES

COMMON MISTAKES

CAVEAT ON PRECEDENCE

WHY YOU SHOULD ALWAYS use strict

DEBUGGING

CODE EXAMPLES

LISTS OF LISTS

Declaration of a LIST OF LISTS

Generation of a LIST OF LISTS

Access and Printing of a LIST OF LISTS

HASHES OF LISTS

Declaration of a HASH OF LISTS

Generation of a HASH OF LISTS

Access and Printing of a HASH OF LISTS

LISTS OF HASHES

Declaration of a LIST OF HASHES

Generation of a LIST OF HASHES

Access and Printing of a LIST OF HASHES

HASHES OF HASHES

Declaration of a HASH OF HASHES

Generation of a HASH OF HASHES

Access and Printing of a HASH OF HASHES

MORE ELABORATE RECORDS

Declaration of MORE ELABORATE RECORDS

Declaration of a HASH OF COMPLEX RECORDS

Generation of a HASH OF COMPLEX RECORDS

Database Ties

SEE ALSO

AUTHOR

perllol, perlLoL - Manipulating Lists of Lists in Perl

DESCRIPTION

Declaration and Access of Lists of Lists

Growing Your Own

Access and Printing

Slices

SEE ALSO

AUTHOR

perltoot - Tom's object-oriented tutorial for perl

DESCRIPTION

Creating a Class

Object Representation

Class Interface

Constructors and Instance Methods

Planning for the Future: Better Constructors

Destructors

Other Object Methods

Class Data

Accessing Class Data

Debugging Methods

Class Destructors

Documenting the Interface

Aggregation

Inheritance

Overridden Methods

Multiple Inheritance

UNIVERSAL: The Root of All Objects

Alternate Object Representations

Arrays as Objects

Closures as Objects

AUTOLOAD: Proxy Methods

Autoloaded Data Methods

Inherited Autoloaded Data Methods

Metaclassical Tools

Class::Template

Data Members as Variables

NOTES

Object Terminology

SEE ALSO

COPYRIGHT

Acknowledgments

perlobj - Perl objects

DESCRIPTION

An Object is Simply a Reference

A Class is Simply a Package

A Method is Simply a Subroutine

Method Invocation

Default UNIVERSAL methods

isa(CLASS), can(METHOD), VERSION( [NEED] ), class(), is_instance()

Destructors

WARNING

Summary

Two-Phased Garbage Collection

SEE ALSO

perltie - how to hide an object class in a simple variable

SYNOPSIS

DESCRIPTION

Tying Scalars

TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this

Tying Arrays

TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value, DESTROY this

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

Tying FileHandles

TIEHANDLE classname, LIST, PRINT this, LIST, READLINE this, DESTROY this

SEE ALSO

BUGS

AUTHOR

perlbot - Bag'o Object Tricks (the BOT)

DESCRIPTION

OO SCALING TIPS

INSTANCE VARIABLES

SCALAR INSTANCE VARIABLES

INSTANCE VARIABLE INHERITANCE

OBJECT RELATIONSHIPS

OVERRIDING SUPERCLASS METHODS

USING RELATIONSHIP WITH SDBM

THINKING OF CODE REUSE

CLASS CONTEXT AND THE OBJECT

INHERITING A CONSTRUCTOR

DELEGATION

perlipc - Perl interprocess communication (signals, fifos, pipes, safe subprocesses, sockets, and semaphores)

DESCRIPTION

Signals

Named Pipes

Using open() for IPC

Safe Pipe Opens

Bidirectional Communication

Sockets: Client/Server Communication

Internet TCP Clients and Servers

Unix-Domain TCP Clients and Servers

UDP: Message Passing

SysV IPC

WARNING

NOTES

BUGS

AUTHOR

SEE ALSO

perldebug - Perl debugging

DESCRIPTION

The Perl Debugger

Debugger Commands

h [command], p expr, x expr, V [pkg [vars]], X [vars], T, s [expr], n [expr], <CR>, 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?].., recallCommand, ShellBang, pager, tkRunning, signalLevel, warnLevel, dieLevel, AutoTrace, LineInfo, inhibit_exit, PrintRet, frame, maxTraceLen, arrayDepth, hashDepth, compactDump, veryCompact, globPrint, DumpDBFiles, DumpPackages, quote, HighBit, undefPrint, UsageOnly, TTY, noTTY, ReadLine, NonStop, < [ command ], << command, > command, >> command, { [ command ], {{ command, ! number, ! -number, ! pattern, !! cmd, H -number, q or ^D, R, |dbcmd, ||dbcmd, = [alias value], command, m expr, m package

Debugger input/output

Prompt, Multi-line commands, Stack backtrace, Listing, Frame listing

Debugging compile-time statements

Debugger Customization

Readline Support

Editor Support for Debugging

The Perl Profiler

Debugger support in perl

Debugger Internals

Other resources

BUGS

perldiag - various Perl diagnostics

DESCRIPTION

perlsec - Perl security

DESCRIPTION

Laundering and Detecting Tainted Data

Cleaning Up Your Path

Security Bugs

perltrap - Perl traps for the unwary

DESCRIPTION

Awk Traps

C Traps

Sed Traps

Shell Traps

Perl Traps

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

Discontinuance, Deprecation, and BugFix traps

Discontinuance, Deprecation, BugFix, Discontinuance, Discontinuance, Discontinuance, BugFix, Discontinuance, Discontinuance, BugFix, Discontinuance, Deprecation, Discontinuance

Parsing Traps

Parsing, Parsing, Parsing

Numerical Traps

Numerical, Numerical, Numerical

General data type traps

(Arrays), (Arrays), (Hashes), (Globs), (Scalar String), (Constants), (Scalars), (Variable Suicide)

Context Traps - scalar, list contexts

(list context), (scalar context), (scalar context), (list, builtin)

Precedence Traps

Precedence, Precedence, Precedence, Precedence, Precedence, Precedence, Precedence

General Regular Expression Traps using s///, etc.

Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression, Regular Expression

Subroutine, Signal, Sorting Traps

(Signals), (Sort Subroutine), warn() won't let you specify a filehandle

OS Traps

(SysV), (SysV)

Interpolation Traps

Interpolation, Interpolation, Interpolation, Interpolation, Interpolation, Interpolation, Interpolation, Interpolation, Interpolation

DBM Traps

DBM, DBM

Unclassified Traps

Unclassified

perlstyle - Perl style guide

DESCRIPTION

perlpod - plain old documentation

DESCRIPTION

Embedding Pods in Perl Modules

Common Pod Pitfalls

SEE ALSO

AUTHOR

perlbook - Perl book information

DESCRIPTION

perlembed - how to embed perl in your C program

DESCRIPTION

PREAMBLE

Use C from Perl?, Use a UNIX program from Perl?, Use Perl from Perl?, Use C from C?, Use Perl from C?

ROADMAP

Compiling your C program

Adding a Perl interpreter to your C program

Calling a Perl subroutine from your C program

Evaluating a Perl statement from your C program

Performing Perl pattern matches and substitutions from your C program

Fiddling with the Perl stack from your C program

Maintaining a persistent interpreter

Maintaining multiple interpreter instances

Using Perl modules, which themselves use C libraries, from your C program

MORAL

AUTHOR

perlapio - perl's IO abstraction interface.

SYNOPSIS

DESCRIPTION

PerlIO *, PerlIO_stdin(), PerlIO_stdout(), PerlIO_stderr(), PerlIO_open(path, mode), PerlIO_fdopen(fd,mode), PerlIO_printf(f,fmt,...), PerlIO_vprintf(f,fmt,a), PerlIO_stdoutf(fmt,...), PerlIO_read(f,buf,count), PerlIO_write(f,buf,count), PerlIO_close(f), PerlIO_puts(s,f), PerlIO_putc(c,f), PerlIO_ungetc(c,f), PerlIO_getc(f), PerlIO_eof(f), PerlIO_error(f), PerlIO_fileno(f), PerlIO_clearerr(f), PerlIO_flush(f), PerlIO_tell(f), PerlIO_seek(f,o,w), PerlIO_getpos(f,p), PerlIO_setpos(f,p), PerlIO_rewind(f), PerlIO_tmpfile()

Co-existence with stdio

PerlIO_importFILE(f,flags), PerlIO_exportFILE(f,flags), PerlIO_findFILE(f), PerlIO_releaseFILE(p,f), PerlIO_setlinebuf(f), PerlIO_has_cntptr(f), PerlIO_get_ptr(f), PerlIO_get_cnt(f), PerlIO_canset_cnt(f), PerlIO_fast_gets(f), PerlIO_set_ptrcnt(f,p,c), PerlIO_set_cnt(f,c), PerlIO_has_base(f), PerlIO_get_base(f), PerlIO_get_bufsiz(f)

perlxs - XS language reference manual

DESCRIPTION

Introduction

On The Road

The Anatomy of an XSUB

The Argument Stack

The RETVAL Variable

The MODULE Keyword

The PACKAGE Keyword

The PREFIX Keyword

The OUTPUT: Keyword

The CODE: Keyword

The INIT: Keyword

The NO_INIT Keyword

Initializing Function Parameters

Default Parameter Values

The PREINIT: Keyword

The SCOPE: Keyword

The INPUT: Keyword

Variable-length Parameter Lists

The PPCODE: Keyword

Returning Undef And Empty Lists

The REQUIRE: Keyword

The CLEANUP: Keyword

The BOOT: Keyword

The VERSIONCHECK: Keyword

The PROTOTYPES: Keyword

The PROTOTYPE: Keyword

The ALIAS: Keyword

The INCLUDE: Keyword

The CASE: Keyword

The & Unary Operator

Inserting Comments and C Preprocessor Directives

Using XS With C++

Interface Strategy

Perl Objects And C Structures

The Typemap

EXAMPLES

XS VERSION

AUTHOR

perlxstut, perlXStut - Tutorial for XSUBs

DESCRIPTION

VERSION CAVEAT

DYNAMIC VERSUS STATIC

EXAMPLE 1

EXAMPLE 2

WHAT HAS GONE ON?

WRITING GOOD TEST SCRIPTS

EXAMPLE 3

WHAT'S NEW HERE?

INPUT AND OUTPUT PARAMETERS

THE XSUBPP COMPILER

THE TYPEMAP FILE

WARNING

EXAMPLE 4

WHAT HAS HAPPENED HERE?

SPECIFYING ARGUMENTS TO XSUBPP

THE ARGUMENT STACK

EXTENDING YOUR EXTENSION

DOCUMENTING YOUR EXTENSION

INSTALLING YOUR EXTENSION

SEE ALSO

Author

Last Changed

perlguts - Perl's Internal Functions

DESCRIPTION

Datatypes

What is an "IV"?

Working with SV's

What's Really Stored in an SV?

Working with AV's

Working with HV's

References

Blessed References and Class Objects

Creating New Variables

Reference Counts and Mortality

Stashes and Globs

Magic

Assigning Magic

Magic Virtual Tables

Finding Magic

Double-Typed SV's

XSUB's and the Argument Stack

Calling Perl Routines from within C Programs

Memory Allocation

PerlIO

Scratchpads

Putting a C value on Perl stack

Scratchpads

Scratchpads and recursions

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, G_NOARGS, G_SCALAR, gv_fetchmeth, gv_fetchmethod, gv_stashpv, gv_stashsv, GvSV, he_delayfree, 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, 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_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_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_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

EDITOR

DATE

perlcall - Perl calling conventions from C

DESCRIPTION

An Error Handler, An Event Driven Program

THE PERL_CALL FUNCTIONS

perl_call_sv, perl_call_pv, perl_call_method, perl_call_argv

FLAG VALUES

G_SCALAR

G_ARRAY

G_DISCARD

G_NOARGS

G_EVAL

G_KEEPERR

Determining the Context

KNOWN PROBLEMS

EXAMPLES

No Parameters, Nothing returned

Passing Parameters

Returning a Scalar

Returning a list of values

Returning a list in a scalar context

Returning Data from Perl via the parameter list

Using G_EVAL

Using G_KEEPERR

Using perl_call_sv

Using perl_call_argv

Using perl_call_method

Using GIMME

Using Perl to dispose of temporaries

Strategies for storing Callback Context Information

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

Alternate Stack Manipulation

SEE ALSO

AUTHOR

DATE

PRAGMA DOCUMENTATION

blib - Use MakeMaker's uninstalled version of a package

SYNOPSIS

DESCRIPTION

BUGS

AUTHOR

diagnostics - Perl compiler pragma to force verbose warning diagnostics

SYNOPSIS

DESCRIPTION

The diagnostics Pragma

The splain Program

EXAMPLES

INTERNALS

BUGS

AUTHOR

integer - Perl pragma to compute arithmetic in integer instead of double

SYNOPSIS

DESCRIPTION

less - perl pragma to request less of something from the compiler

SYNOPSIS

DESCRIPTION

lib - manipulate @INC at compile time

SYNOPSIS

DESCRIPTION

ADDING DIRECTORIES TO @INC

DELETING DIRECTORIES FROM @INC

RESTORING ORIGINAL @INC

SEE ALSO

AUTHOR

locale - Perl pragma to use and avoid POSIX locales for built-in operations

SYNOPSIS

DESCRIPTION

ops - Perl pragma to restrict unsafe operations when compiling

SYNOPSIS

DESCRIPTION

SEE ALSO

overload - Package for overloading perl operations

SYNOPSIS

CAVEAT SCRIPTOR

DESCRIPTION

Declaration of overloaded functions

Calling Conventions for Binary Operations

FALSE, TRUE, undef

Calling Conventions for Unary Operations

Overloadable Operations

Arithmetic operations, Comparison operations, Bit operations, Increment and decrement, Transcendental functions, Boolean, string and numeric conversion, Special

Inheritance and overloading

Strings as values of use overload directive, Overloading of an operation is inherited by derived classes

SPECIAL SYMBOLS FOR use overload

Last Resort

Fallback

undef, TRUE, defined, but FALSE

Copy Constructor

Example

MAGIC AUTOGENERATION

Assignment forms of arithmetic operations, Conversion operations, Increment and decrement, abs($a), Unary minus, Negation, Concatenation, Comparison operations, Copy operator

WARNING

Run-time Overloading

Public functions

overload::StrVal(arg), overload::Overloaded(arg), overload::Method(obj,op)

IMPLEMENTATION

AUTHOR

DIAGNOSTICS

BUGS

sigtrap - Perl pragma to enable simple signal handling

SYNOPSIS

DESCRIPTION

OPTIONS

SIGNAL HANDLERS

stack-trace, die, handler your-handler

SIGNAL LISTS

normal-signals, error-signals, old-interface-signals

OTHER

untrapped, any, signal, number

EXAMPLES

strict - Perl pragma to restrict unsafe constructs

SYNOPSIS

DESCRIPTION

strict refs, strict vars, strict subs

subs - Perl pragma to predeclare sub names

SYNOPSIS

DESCRIPTION

vars - Perl pragma to predeclare global variable names

SYNOPSIS

DESCRIPTION

MODULE DOCUMENTATION

AnyDBM_File - provide framework for multiple DBMs

SYNOPSIS

DESCRIPTION

DBM Comparisons

[0], [1], [2], [3]

SEE ALSO

AutoLoader - load functions only on demand

SYNOPSIS

DESCRIPTION

__END__

Loading Stubs

Package Lexicals

AutoLoader vs. SelfLoader

CAVEAT

AutoSplit - split a package for autoloading

SYNOPSIS

DESCRIPTION

CAVEATS

DIAGNOSTICS

Benchmark - benchmark running times of code

SYNOPSIS

DESCRIPTION

Methods

new, debug

Standard Exports

timeit(COUNT, CODE), timethis, timethese, timediff, timestr

Optional Exports

NOTES

INHERITANCE

CAVEATS

AUTHORS

MODIFICATION HISTORY

CPAN - query, download and build perl modules from CPAN sites

SYNOPSIS

DESCRIPTION

Interactive Mode

Searching for authors, bundles, distribution files and modules, make, test, install, clean modules or distributions, readme, look module or distribution

CPAN::Shell

autobundle

recompile

Programmer's interface

Cache Manager

Bundles

Prerequisites

Debugging

Floppy, Zip, and all that Jazz

CONFIGURATION

o conf <scalar option>, o conf <scalar option> <value>, o conf <list option>, o conf <list option> [shift|pop], o conf <list option> [unshift|push|splice] <list>

SECURITY

EXPORT

BUGS

AUTHOR

SEE ALSO

CPAN::FirstTime - Utility for CPAN::Config file Initialization

SYNOPSIS

DESCRIPTION

CPANox, CPAN::Nox - Wrapper around CPAN.pm without using any XS module

SYNOPSIS

DESCRIPTION

SEE ALSO

Carp, carp - warn of errors (from perspective of caller)

SYNOPSIS

DESCRIPTION

Class::Template - struct/member template builder

SYNOPSIS

DESCRIPTION

EXAMPLES

Example 1, Example 2

NOTES

Config - access Perl configuration information

SYNOPSIS

DESCRIPTION

myconfig(), config_sh(), config_vars(@names)

EXAMPLE

WARNING

NOTE

Cwd, getcwd - get pathname of current working directory

SYNOPSIS

DESCRIPTION

DB_File - Perl5 access to Berkeley DB

SYNOPSIS

DESCRIPTION

DB_HASH, DB_BTREE, DB_RECNO

How does DB_File interface to Berkeley DB?

Opening a Berkeley DB Database File

Default Parameters

In Memory Databases

DB_HASH

A Simple Example.

DB_BTREE

Changing the BTREE sort order

Handling duplicate keys

The get_dup method.

Matching Partial Keys

DB_RECNO

The bval option

A Simple Example

Extra Methods

$X->push(list) ;, $value = $X->pop ;, $X->shift, $X->unshift(list) ;, $X->length

Another Example

THE API INTERFACE

$status = $X->get($key, $value [, $flags]) ;, $status = $X->put($key, $value [, $flags]) ;, $status = $X->del($key [, $flags]) ;, $status = $X->fd ;, $status = $X->seq($key, $value, $flags) ;, $status = $X->sync([$flags]) ;

HINTS AND TIPS

Locking Databases

Sharing databases with C applications

COMMON QUESTIONS

Why is there Perl source in my database?

How do I store complex data structures with DB_File?

What does "Invalid Argument" mean?

What does "Bareword 'DB_File' not allowed" mean?

HISTORY

BUGS

AVAILABILITY

SEE ALSO

AUTHOR

Devel::SelfStubber - generate stubs for a SelfLoading module

SYNOPSIS

DESCRIPTION

DirHandle - supply object methods for directory handles

SYNOPSIS

DESCRIPTION

DynaLoader - Dynamically load C libraries into Perl code

SYNOPSIS

DESCRIPTION

@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()

AUTHOR

English - use nice English (or awk) names for ugly punctuation variables

SYNOPSIS

DESCRIPTION

Env - perl module that imports environment variables

SYNOPSIS

DESCRIPTION

AUTHOR

Exporter - Implements default import method for modules

SYNOPSIS

DESCRIPTION

Selecting What To Export

Specialised Import Lists

Module Version Checking

Managing Unknown Symbols

Tag Handling Utility Functions

ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications

SYNOPSIS

DESCRIPTION

@EXPORT

FUNCTIONS

xsinit(), Examples, ldopts(), Examples, perl_inc(), ccflags(), ccdlflags(), ccopts(), xsi_header(), xsi_protos(@modules), xsi_body(@modules)

EXAMPLES

SEE ALSO

AUTHOR

ExtUtils::Install - install files from here to there

SYNOPSIS

DESCRIPTION

ExtUtils::Liblist - determine libraries to use and how to use them

SYNOPSIS

DESCRIPTION

For static extensions, For dynamic extensions, For dynamic extensions

EXTRALIBS

LDLOADLIBS and LD_RUN_PATH

BSLOADLIBS

PORTABILITY

VMS implementation

SEE ALSO

ExtUtils::MM_OS2 - methods to override UN*X behaviour in ExtUtils::MakeMaker

SYNOPSIS

DESCRIPTION

ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker

SYNOPSIS

DESCRIPTION

METHODS

Preloaded methods

canonpath, catdir, catfile, curdir, rootdir, updir

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

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)

SEE ALSO

ExtUtils::MM_VMS - methods to override UN*X behaviour in ExtUtils::MakeMaker

SYNOPSIS

DESCRIPTION

Methods always loaded

eliminate_macros, fixpath, catdir, catfile, wraplist, curdir (override), rootdir (override), updir (override)

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)

ExtUtils::MakeMaker - create an extension Makefile

SYNOPSIS

DESCRIPTION

How To Write A Makefile.PL

Default Makefile Behaviour

make test

make testdb

make install

PREFIX and LIB attribute

AFS users

Static Linking of a new Perl Binary

Determination of Perl Library and Installation Locations

Which architecture dependent directory?

Using Attributes and Parameters

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

Additional lowercase attributes

clean, depend, dist, dynamic_lib, installpm, linkext, macro, realclean, tool_autosplit

Overriding MakeMaker Methods

Hintsfile support

Distribution Support

 make distcheck,    make skipcheck,	 make distclean,    make manifest, 
make distdir,    make tardist,    make dist,	  make uutardist,    make
shdist,    make zipdist,    make ci

SEE ALSO

AUTHORS

ExtUtils::Manifest - utilities to write and check a MANIFEST file

SYNOPSIS

DESCRIPTION

MANIFEST.SKIP

EXPORT_OK

GLOBAL VARIABLES

DIAGNOSTICS

Not in MANIFEST: file, No such file: file, MANIFEST: $!, Added to MANIFEST: file

SEE ALSO

AUTHOR

ExtUtils::Miniperl, writemain - write the C code for perlmain.c

SYNOPSIS

DESCRIPTION

SEE ALSO

ExtUtils::Mkbootstrap - make a bootstrap file for use by DynaLoader

SYNOPSIS

DESCRIPTION

ExtUtils::Mksymlists - write linker options files for dynamic extension

SYNOPSIS

DESCRIPTION

NAME, DL_FUNCS, DL_VARS, FILE, FUNCLIST, DLBASE

AUTHOR

REVISION

ExtUtils::testlib - add blib/* directories to @INC

SYNOPSIS

DESCRIPTION

Fatal - replace functions with equivalents which succeed or die

SYNOPSIS

DESCRIPTION

AUTHOR

Fcntl - load the C Fcntl.h defines

SYNOPSIS

DESCRIPTION

NOTE

EXPORTED SYMBOLS

File::Basename, fileparse - split a pathname into pieces

SYNOPSIS

DESCRIPTION

fileparse_set_fstype, fileparse

EXAMPLES

basename, dirname

File::CheckTree, validate - run many filetest checks on a tree

SYNOPSIS

DESCRIPTION

File::Compare - Compare files or filehandles

SYNOPSIS

DESCRIPTION

RETURN

AUTHOR

File::Copy - Copy files or filehandles

SYNOPSIS

DESCRIPTION

Special behavior if syscopy is defined (VMS and OS/2)

rmscopy($from,$to[,$date_flag])

RETURN

AUTHOR

File::Find, find - traverse a file tree

SYNOPSIS

DESCRIPTION

File::Path - create or remove a series of directories

SYNOPSIS

DESCRIPTION

AUTHORS

REVISION

File::stat - by-name interface to Perl's built-in stat() functions

SYNOPSIS

DESCRIPTION

NOTE

AUTHOR

FileCache - keep more files open than the system permits

SYNOPSIS

DESCRIPTION

BUGS

FileHandle - supply object methods for filehandles

SYNOPSIS

DESCRIPTION

$fh->print, $fh->printf, $fh->getline, $fh->getlines

SEE ALSO

FindBin - Locate directory of original perl script

SYNOPSIS

DESCRIPTION

EXPORTABLE VARIABLES

KNOWN BUGS

AUTHORS

COPYRIGHT

REVISION

GDBM_File - Perl5 access to the gdbm library.

SYNOPSIS

DESCRIPTION

AVAILABILITY

BUGS

SEE ALSO

Getopt::Long, GetOptions - extended processing of command line options

SYNOPSIS

DESCRIPTION

<none>, !, =s, :s, =i, :i, =f, :f

Linkage specification

Aliases and abbreviations

Non-option call-back routine

Option starters

Return value

COMPATIBILITY

EXAMPLES

CONFIGURATION VARIABLES

$Getopt::Long::autoabbrev, $Getopt::Long::getopt_compat, $Getopt::Long::order, $Getopt::Long::bundling, $Getopt::Long::ignorecase, $Getopt::Long::passthrough, $Getopt::Long::VERSION, $Getopt::Long::error, $Getopt::Long::debug

Getopt::Std, getopt - Process single-character switches with switch clustering

SYNOPSIS

DESCRIPTION

I18N::Collate - compare 8-bit scalar data according to the current locale

SYNOPSIS

DESCRIPTION

IO - load various IO modules

SYNOPSIS

DESCRIPTION

IO::File - supply object methods for filehandles

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new ([ ARGS ] )

METHODS

open( FILENAME [,MODE [,PERMS]] )

SEE ALSO

HISTORY

IO::Handle - supply object methods for I/O handles

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new (), new_from_fd ( FD, MODE )

METHODS

$fh->getline, $fh->getlines, $fh->fdopen ( FD, MODE ), $fh->write ( BUF, LEN [, OFFSET }\] ), $fh->opened, $fh->untaint

NOTE

SEE ALSO

BUGS

HISTORY

IO::Pipe, IO::pipe - supply object methods for pipes

SYNOPSIS

DESCRIPTION

CONSTRCUTOR

new ( [READER, WRITER] )

METHODS

reader ([ARGS]), writer ([ARGS]), handles ()

SEE ALSO

AUTHOR

COPYRIGHT

IO::Seekable - supply seek based methods for I/O objects

SYNOPSIS

DESCRIPTION

SEE ALSO

HISTORY

IO::Select - OO interface to the select system call

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new ( [ HANDLES ] )

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 ] )

EXAMPLE

AUTHOR

COPYRIGHT

IO::Socket - Object interface to socket communications

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new ( [ARGS] )

METHODS

accept([PKG]), timeout([VAL]), sockopt(OPT [, VAL]), sockdomain, socktype, protocol

SUB-CLASSES

IO::Socket::INET

METHODS

sockaddr (), sockport (), sockhost (), peeraddr (), peerport (), peerhost ()

IO::Socket::UNIX

METHODS

hostpath(), peerpath()

SEE ALSO

AUTHOR

COPYRIGHT

IO::lib::IO::File, IO::File - supply object methods for filehandles

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new ([ ARGS ] )

METHODS

open( FILENAME [,MODE [,PERMS]] )

SEE ALSO

HISTORY

IO::lib::IO::Handle, IO::Handle - supply object methods for I/O handles

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new (), new_from_fd ( FD, MODE )

METHODS

$fh->getline, $fh->getlines, $fh->fdopen ( FD, MODE ), $fh->write ( BUF, LEN [, OFFSET }\] ), $fh->opened, $fh->untaint

NOTE

SEE ALSO

BUGS

HISTORY

IO::lib::IO::Pipe, IO::pipe - supply object methods for pipes

SYNOPSIS

DESCRIPTION

CONSTRCUTOR

new ( [READER, WRITER] )

METHODS

reader ([ARGS]), writer ([ARGS]), handles ()

SEE ALSO

AUTHOR

COPYRIGHT

IO::lib::IO::Seekable, IO::Seekable - supply seek based methods for I/O objects

SYNOPSIS

DESCRIPTION

SEE ALSO

HISTORY

IO::lib::IO::Select, IO::Select - OO interface to the select system call

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new ( [ HANDLES ] )

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 ] )

EXAMPLE

AUTHOR

COPYRIGHT

IO::lib::IO::Socket, IO::Socket - Object interface to socket communications

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new ( [ARGS] )

METHODS

accept([PKG]), timeout([VAL]), sockopt(OPT [, VAL]), sockdomain, socktype, protocol

SUB-CLASSES

IO::Socket::INET

METHODS

sockaddr (), sockport (), sockhost (), peeraddr (), peerport (), peerhost ()

IO::Socket::UNIX

METHODS

hostpath(), peerpath()

SEE ALSO

AUTHOR

COPYRIGHT

IPC::Open2, open2 - open a process for both reading and writing

SYNOPSIS

DESCRIPTION

WARNING

SEE ALSO

IPC::Open3, open3 - open a process for reading, writing, and error handling

SYNOPSIS

DESCRIPTION

WARNING

Math::BigFloat - Arbitrary length float math package

SYNOPSIS

DESCRIPTION

number format, Error returns 'NaN', Division is computed to

BUGS

AUTHOR

Math::BigInt - Arbitrary size integer math package

SYNOPSIS

DESCRIPTION

Canonical notation, Input, Output

EXAMPLES

BUGS

AUTHOR

Math::Complex - complex numbers and associated mathematical functions

SYNOPSIS

DESCRIPTION

OPERATIONS

CREATION

STRINGIFICATION

USAGE

BUGS

AUTHOR

NDBM_File - Tied access to ndbm files

SYNOPSIS

DESCRIPTION

Net::Ping - check a remote host for reachability

SYNOPSIS

DESCRIPTION

Functions

Net::Ping->new([$proto [, $def_timeout [, $bytes]]]);, $p->ping($host [, $timeout]);, $p->close();, pingecho($host [, $timeout]);

WARNING

NOTES

Net::hostent - by-name interface to Perl's built-in gethost*() functions

SYNOPSIS

DESCRIPTION

EXAMPLES

NOTE

AUTHOR

Net::netent - by-name interface to Perl's built-in getnet*() functions

SYNOPSIS

DESCRIPTION

EXAMPLES

NOTE

AUTHOR

Net::protoent - by-name interface to Perl's built-in getproto*() functions

SYNOPSIS

DESCRIPTION

NOTE

AUTHOR

Net::servent - by-name interface to Perl's built-in getserv*() functions

SYNOPSIS

DESCRIPTION

EXAMPLES

NOTE

AUTHOR

ODBM_File - Tied access to odbm files

SYNOPSIS

DESCRIPTION

Opcode - Disable named opcodes when compiling perl code

SYNOPSIS

DESCRIPTION

NOTE

WARNING

Operator Names and Operator Lists

an operator name (opname), an operator tag name (optag), a negated opname or optag, an operator set (opset)

Opcode Functions

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)

Manipulating Opsets

TO DO (maybe)

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

SEE ALSO

AUTHORS

Opcode::Safe, Safe - Compile and execute code in restricted compartments

SYNOPSIS

DESCRIPTION

a new namespace, an operator mask

WARNING

RECENT CHANGES

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)

Some Safety Issues

Memory, CPU, Snooping, Signals, State Changes

AUTHOR

Opcode::ops, ops - Perl pragma to restrict unsafe operations when compiling

SYNOPSIS

DESCRIPTION

SEE ALSO

POSIX - Perl interface to IEEE Std 1003.1

SYNOPSIS

DESCRIPTION

NOTE

CAVEATS

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, 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

CLASSES

POSIX::SigAction

new

POSIX::SigSet

new, addset, delset, emptyset, fillset, ismember

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

PATHNAME CONSTANTS

Constants

POSIX CONSTANTS

Constants

SYSTEM CONFIGURATION

Constants

ERRNO

Constants

FCNTL

Constants

FLOAT

Constants

LIMITS

Constants

LOCALE

Constants

MATH

Constants

SIGNAL

Constants

STAT

Constants, Macros

STDLIB

Constants

STDIO

Constants

TIME

Constants

UNISTD

Constants

WAIT

Constants, Macros

CREATION

Pod::Text - convert POD data to formatted ASCII text

SYNOPSIS

DESCRIPTION

AUTHOR

TODO

SDBM_File - Tied access to sdbm files

SYNOPSIS

DESCRIPTION

Safe - Compile and execute code in restricted compartments

SYNOPSIS

DESCRIPTION

a new namespace, an operator mask

WARNING

RECENT CHANGES

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)

Some Safety Issues

Memory, CPU, Snooping, Signals, State Changes

AUTHOR

Search::Dict, look - search for key in dictionary file

SYNOPSIS

DESCRIPTION

SelectSaver - save and restore selected file handle

SYNOPSIS

DESCRIPTION

SelfLoader - load functions only on demand

SYNOPSIS

DESCRIPTION

The __DATA__ token

SelfLoader autoloading

Autoloading and package lexicals

SelfLoader and AutoLoader

__DATA__, __END__, and the FOOBAR::DATA filehandle.

Classes and inherited methods.

Multiple packages and fully qualified subroutine names

Shell - run shell commands transparently within perl

SYNOPSIS

DESCRIPTION

AUTHOR

Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C socket.h defines and structure manipulators

SYNOPSIS

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

Symbol - manipulate Perl symbols and their names

SYNOPSIS

DESCRIPTION

Sys::Hostname - Try every conceivable way to get hostname

SYNOPSIS

DESCRIPTION

AUTHOR

Syslog, Sys::Syslog, openlog, closelog, setlogmask, syslog - Perl interface to the UNIX syslog(3) calls

SYNOPSIS

DESCRIPTION

openlog $ident, $logopt, $facility, syslog $priority, $format, @args, setlogmask $mask_priority, closelog

EXAMPLES

DEPENDENCIES

SEE ALSO

AUTHOR

Term::Cap - Perl termcap interface

SYNOPSIS

DESCRIPTION

EXAMPLES

Term::Complete - Perl word completion module

SYNOPSIS

DESCRIPTION

<tab>Attempts word completion. Cannot be changed, ^D, ^U, <del>, <bs>

DIAGNOSTICS

BUGS

AUTHOR

Term::ReadLine - Perl interface to various readline packages. If no real package is found, substitutes stubs instead of basic functions.

SYNOPSIS

DESCRIPTION

Minimal set of supported functions

ReadLine, new, readline, addhistory, IN, $OUT, MinLine, findConsole, Features

EXPORTS

Test::Harness - run perl standard test scripts with statistics

SYNOPSIS

DESCRIPTION

The test script output

EXPORT

DIAGNOSTICS

All tests successful.\nFiles=%d, Tests=%d, %s, FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay., Test returned status %d (wstat %d), Failed 1 test, %.2f%% okay. %s, Failed %d/%d tests, %.2f%% okay. %s

SEE ALSO

AUTHORS

BUGS

Text::Abbrev, abbrev - create an abbreviation table from a list

SYNOPSIS

DESCRIPTION

EXAMPLE

Text::ParseWords - parse text into an array of tokens

SYNOPSIS

DESCRIPTION

AUTHORS

Text::Soundex - Implementation of the Soundex Algorithm as Described by Knuth

SYNOPSIS

DESCRIPTION

EXAMPLES

LIMITATIONS

AUTHOR

Text::Tabs -- expand and unexpand tabs per the unix expand(1) and unexpand(1)

SYNOPSIS

DESCRIPTION

BUGS

AUTHOR

Text::Wrap - line wrapping to form simple paragraphs

SYNOPSIS

DESCRIPTION

EXAMPLE

AUTHOR

Tie::Hash, Tie::StdHash - base class definitions for tied hashes

SYNOPSIS

DESCRIPTION

TIEHASH classname, LIST, STORE this, key, value, FETCH this, key, FIRSTKEY this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, key, CLEAR this

CAVEATS

MORE INFORMATION

Tie::RefHash - use references as hash keys

SYNOPSIS

DESCRIPTION

EXAMPLE

AUTHOR

VERSION

SEE ALSO

Tie::Scalar, Tie::StdScalar - base class definitions for tied scalars

SYNOPSIS

DESCRIPTION

TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this

MORE INFORMATION

Tie::SubstrHash - Fixed-table-size, fixed-key-length hashing

SYNOPSIS

DESCRIPTION

CAVEATS

Time::Local - efficiently compute time from local and GMT time

SYNOPSIS

DESCRIPTION

Time::gmtime - by-name interface to Perl's built-in gmtime() function

SYNOPSIS

DESCRIPTION

NOTE

AUTHOR

Time::localtime - by-name interface to Perl's built-in localtime() function

SYNOPSIS

DESCRIPTION

NOTE

AUTHOR

Time::tm - internal object used by Time::gmtime and Time::localtime

SYNOPSIS

DESCRIPTION

AUTHOR

UNIVERSAL - base class for ALL classes (blessed references)

SYNOPSIS

DESCRIPTION

isa ( TYPE ), can ( METHOD ), VERSION ( [ REQUIRE ] ), isa ( REF, TYPE )

User::grent - by-name interface to Perl's built-in getgr*() functions

SYNOPSIS

DESCRIPTION

NOTE

AUTHOR

User::pwent - by-name interface to Perl's built-in getpw*() functions

SYNOPSIS

DESCRIPTION

NOTE

AUTHOR

AUXILIARY DOCUMENTATION

Here should be listed all the extra programs' documentation, but they don't all have manual pages yet:

a2p

s2p

find2perl

h2ph

c2ph

h2xs

xsubpp

pod2man

wrapsuid

AUTHOR

Larry Wall <larry@wall.org>, with the help of oodles of other folks.

cpanm lib

perl -MCPAN -e shell
install lib