Linux Manpages Online - man.cx manual pages

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 - The Perl 5 language interpreter
SYNOPSIS
GETTING HELP

Overview
Tutorials
Reference Manual
Internals and C Language Interface
Miscellaneous
Language-Specific
Platform-Specific
Stubs for Deleted Documents

DESCRIPTION
AVAILABILITY
ENVIRONMENT
AUTHOR
FILES
SEE ALSO
DIAGNOSTICS
BUGS
NOTES

perlintro -- a brief introduction and overview of Perl
DESCRIPTION

What is Perl?
Running Perl programs
Safety net
Basic syntax overview
Perl variable types

Scalars, Arrays, Hashes

Variable scoping
Conditional and looping constructs

if, while, for, foreach

Builtin operators and functions

Arithmetic, Numeric comparison, String comparison, Boolean logic, Miscellaneous

Files and I/O
Regular expressions

Simple matching, Simple substitution, More complex regular expressions, Parentheses for capturing, Other regexp features

Writing subroutines
OO Perl
Using Perl modules

AUTHOR

perlrun - how to execute the Perl interpreter
SYNOPSIS
DESCRIPTION

#! and quoting on non-Unix systems

OS/2, MS-DOS, Win95/NT, VMS

Location of Perl
Command Switches

-0[octal/hexadecimal] , -a , -C [number/list] , -c , -d , -dt, -d:MOD[=bar,baz] , -dt:MOD[=bar,baz], -Dletters , -Dnumber, -e commandline , -E commandline , -f
, -Fpattern , -h , -i[extension] , -Idirectory , -l[octnum] , -m[-]module , -M[-]module, -M[-]’module ...’, -[mM][-]module=arg[,arg]..., -n , -p , -s , -S , -t , -T , -u , -U , -v , -V , -V:configvar, -w , -W , -X , -x , -xdirectory

ENVIRONMENT

HOME , LOGDIR , PATH , PERL5LIB , PERL5OPT , PERLIO , :crlf , :perlio , :stdio , :unix , :win32 , PERLIO_DEBUG , PERLLIB , PERL5DB , PERL5DB_THREADED , PERL5SHELL (specific to the Win32 port) , PERL_ALLOW_NON_IFS_LSP (specific to the Win32 port) , PERL_DEBUG_MSTATS , PERL_DESTRUCT_LEVEL , PERL_DL_NONLAZY , PERL_ENCODING , PERL_HASH_SEED , PERL_PERTURB_KEYS , PERL_HASH_SEED_DEBUG , PERL_MEM_LOG , PERL_ROOT (specific to the VMS port) , PERL_SIGNALS , PERL_UNICODE , PERL_USE_UNSAFE_INC , SYS$LOGIN (specific to the VMS port) , PERL_INTERNAL_RAND_SEED

ORDER OF APPLICATION

-I, -M, the PERL5LIB environment variable, combinations of -I, -M and PERL5LIB, the PERL5OPT environment variable, Other complications, arch and version subdirs, sitecustomize.pl

perlreftut - Mark’s very short tutorial about references
DESCRIPTION
Who Needs Complicated Data Structures?
The Solution
Syntax

Making References
Using References
An Example
Arrow Rule

Solution
The Rest
Summary
Credits

Distribution Conditions

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
ARRAYS OF ARRAYS

Declaration of an ARRAY OF ARRAYS
Generation of an ARRAY OF ARRAYS
Access and Printing of an ARRAY OF ARRAYS

HASHES OF ARRAYS

Declaration of a HASH OF ARRAYS
Generation of a HASH OF ARRAYS
Access and Printing of a HASH OF ARRAYS

ARRAYS OF HASHES

Declaration of an ARRAY OF HASHES
Generation of an ARRAY OF HASHES
Access and Printing of an ARRAY 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 - Manipulating Arrays of Arrays in Perl
DESCRIPTION

Declaration and Access of Arrays of Arrays
Growing Your Own
Access and Printing
Slices

SEE ALSO
AUTHOR

perlrequick - Perl regular expressions quick start
DESCRIPTION
The Guide

Simple word matching
Using character classes
Matching this or that
Grouping things and hierarchical matching
Extracting matches
Matching repetitions
More matching
Search and replace
The split operator
"use re 'strict'"

BUGS
SEE ALSO
AUTHOR AND COPYRIGHT

Acknowledgments

perlretut - Perl regular expressions tutorial
DESCRIPTION
Part 1: The basics

Simple word matching
Using character classes
Matching this or that
Grouping things and hierarchical matching

	0. Start with the first letter in the string `'a'`, 1. Try the first alternative in the first group `'abd'`, 2.				Match `'a'` followed by `'b'`. So far so good, 3. `'d'` in the regexp doesn’t match `'c'` in the string - a dead end. So backtrack two characters and pick the second alternative in the first group `'abc'`, 4.
					Match `'a'` followed by `'b'` followed by `'c'`. We are on a roll and have satisfied the first group. Set `$1` to `'abc'`, 5 Move on to the second group and pick the first alternative `'df'`, 6 Match the `'d'`, 7. `'f'` in the regexp doesn’t match `'e'` in the string, so a dead end. Backtrack one character and pick the second alternative in the second group `'d'`, 8.

'd' matches. The second grouping is satisfied, so set $2 to 'd', 9. We are at the end of the regexp, so we are done! We have matched 'abcd' out of the string "abcde"

Extracting matches
Backreferences
Relative backreferences
Named backreferences
Alternative capture group numbering
Position information
Non-capturing groupings
Matching repetitions

	0. Start with the first letter in the string `'t'`, 1.					The first quantifier `'.*'` starts out by matching the whole string "`"the cat in the hat"`", 2. `'a'` in the regexp element `'at'` doesn’t match the end of the string. Backtrack one character, 3. `'a'` in the regexp element `'at'` still doesn’t match the last letter of the string `'t'`, so backtrack one more character, 4.
					Now we can match the `'a'` and the `'t'`, 5. Move on to the third element `'.'`. Since we are at the end of the string and `'.'` can match 0 times, assign it the empty string, 6. We are done!

Possessive quantifiers
Building a regexp
Using regular expressions in Perl

Part 2: Power tools

More on characters, strings, and character classes
Compiling and saving regular expressions
Composing regular expressions at runtime
Embedding comments and modifiers in a regular expression
Looking ahead and looking behind
Using independent subexpressions to prevent backtracking
Conditional expressions
Defining named patterns
Recursive patterns
A bit of magic: executing Perl code in a regular expression
Backtracking control verbs
Pragmas and debugging

SEE ALSO

perlop - Perl operators and precedence
DESCRIPTION

Operator Precedence and Associativity
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
Class Instance Operator
Smartmatch Operator

1. Empty hashes or arrays match, 2. That is, each element smartmatches the element of the same index in the other array.[3], 3. If a circular reference is found, fall back to referential equality, 4. Either an actual number, or a string that looks like one

Bitwise And
Bitwise Or and Exclusive Or
C-style Logical And
C-style Logical Or
Logical Defined-Or
Range Operators
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

[1], [2], [3], [4], [5], [6], [7], [8]

Regexp Quote-Like Operators

"qr/STRING/msixpodualn" , "m/PATTERN/msixpodualngc"

, "/PATTERN/msixpodualngc", The empty pattern "//", Matching in list context, "\G assertion", "m?PATTERN?msixpodualngc"
, "s/PATTERN/REPLACEMENT/msixpodualngcer"

Quote-Like Operators

"q/STRING/" , 'STRING', "qq/STRING/" , "STRING", "qx/STRING/" , "`STRING`", "qw/STRING/" , "tr/SEARCHLIST/REPLACEMENTLIST/cdsr"
, "y/SEARCHLIST/REPLACEMENTLIST/cdsr", "<<EOF" , Double Quotes, Single Quotes, Backticks, Indented Here-docs

Gory details of parsing quoted constructs

Finding the end, Interpolation , "<<'EOF'", "m''", the pattern of "s'''", '', "q//", "tr'''", "y'''", the replacement of "s'''", "tr///", "y///", "", "``", "qq//", "qx//", "<file*glob>", "<<"EOF"", the replacement of "s///", "RE" in "m?RE?", "/RE/", "m/RE/", "s/RE/foo/",, parsing regular expressions , Optimization of regular expressions

I/O Operators
Constant Folding
No-ops
Bitwise String Operators
Integer Arithmetic
Floating-point Arithmetic
Bigger Numbers

perlsub - Perl subroutines
SYNOPSIS
DESCRIPTION

documented later in this document, documented in perlmod, documented in perlobj, documented in perltie, documented in PerlIO::via, documented in perlfunc, documented in UNIVERSAL , documented in perldebguts, undocumented, used internally by the overload feature
Signatures
Private Variables via my()
Persistent Private Variables
Temporary Values via local()
Lvalue subroutines
Lexical Subroutines
Passing Symbol Table Entries (typeglobs)
When to Still Use local()
Pass by Reference
Prototypes
Constant Functions
Overriding Built-in Functions
Autoloading
Subroutine Attributes

SEE ALSO

perlfunc - Perl builtin functions
DESCRIPTION

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-orientation
, Low-level socket functions , System V interprocess communication functions
, Fetching user and group info
, Fetching network info , Time-related functions , Non-function keywords

Portability
Alphabetical Listing of Perl Functions

-X FILEHANDLE

, -X EXPR, -X DIRHANDLE, -X, abs VALUE , abs, accept NEWSOCKET,GENERICSOCKET , alarm SECONDS , alarm, atan2 Y,X , bind SOCKET,NAME , binmode FILEHANDLE, LAYER
, binmode FILEHANDLE, bless REF,CLASSNAME , bless REF, break, caller EXPR , caller, chdir EXPR , chdir FILEHANDLE, chdir DIRHANDLE, chdir, chmod LIST , chomp VARIABLE , chomp( LIST ), chomp, chop VARIABLE , chop( LIST ), chop, chown LIST
, chr NUMBER , chr, chroot FILENAME , chroot, close FILEHANDLE , close, closedir DIRHANDLE , connect SOCKET,NAME , continue BLOCK , continue, cos EXPR
, cos, crypt PLAINTEXT,SALT

, dbmclose HASH , dbmopen HASH,DBNAME,MASK , defined EXPR
, defined, delete EXPR , die LIST
, do BLOCK , do EXPR , dump LABEL , dump EXPR, dump, each HASH , each ARRAY , eof FILEHANDLE , eof (), eof, eval EXPR

, eval BLOCK, eval, String eval, Under the "unicode_eval" feature, Outside the "unicode_eval" feature, Block eval, evalbytes EXPR , evalbytes, exec LIST , exec PROGRAM LIST, exists EXPR , exit EXPR
, exit, exp EXPR
, exp, fc EXPR
, fc, fcntl FILEHANDLE,FUNCTION,SCALAR , __FILE__ , fileno FILEHANDLE , fileno DIRHANDLE, 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
, gmtime, goto LABEL , goto EXPR, goto &NAME, grep BLOCK LIST , grep EXPR,LIST, hex EXPR
, hex, import LIST , index STR,SUBSTR,POSITION , index STR,SUBSTR, int EXPR , int, ioctl FILEHANDLE,FUNCTION,SCALAR , join EXPR,LIST , keys HASH
, keys ARRAY, kill SIGNAL, LIST, kill SIGNAL , last LABEL , last EXPR, last, lc EXPR , lc, If "use bytes" is in effect:, Otherwise, if "use locale" for "LC_CTYPE" is in effect:, Otherwise, If EXPR has the UTF8 flag set:, Otherwise, if "use feature 'unicode_strings'" or "use locale ':not_characters'" is in effect:, Otherwise:, lcfirst EXPR , lcfirst, length EXPR , length, __LINE__ , link OLDFILE,NEWFILE , listen SOCKET,QUEUESIZE , local EXPR , localtime EXPR , localtime, lock THING , log EXPR , log, lstat FILEHANDLE , lstat EXPR, lstat DIRHANDLE, lstat, m//, map BLOCK LIST , map EXPR,LIST, mkdir FILENAME,MODE
, mkdir FILENAME, mkdir, msgctl ID,CMD,ARG , msgget KEY,FLAGS , msgrcv ID,VAR,SIZE,TYPE,FLAGS , msgsnd ID,MSG,FLAGS , my VARLIST , my TYPE VARLIST, my VARLIST : ATTRS, my TYPE VARLIST : ATTRS, next LABEL , next EXPR, next, no MODULE VERSION LIST , no MODULE VERSION, no MODULE LIST, no MODULE, no VERSION, oct EXPR , oct, open FILEHANDLE,MODE,EXPR , open FILEHANDLE,MODE,EXPR,LIST, open FILEHANDLE,MODE,REFERENCE, open FILEHANDLE,EXPR, open FILEHANDLE, Working with files, Simple examples, About filehandles, About modes, Checking the return value, Specifying I/O layers in MODE, Using "undef" for temporary files, Opening a filehandle into an in-memory scalar, Opening a filehandle into a command, Duping filehandles, Legacy usage, Specifying mode and filename as a single argument, Calling "open" with one argument via global variables, Assigning a filehandle to a bareword, Other considerations, Automatic filehandle closure, Automatic pipe flushing, Direct versus by-reference assignment of filehandles, Whitespace and special characters in the filename argument, Invoking C-style "open", Portability issues, opendir DIRHANDLE,EXPR , ord EXPR , ord, our VARLIST , our TYPE VARLIST, our VARLIST : ATTRS, our TYPE VARLIST : ATTRS, pack TEMPLATE,LIST , package NAMESPACE, package NAMESPACE VERSION
, package NAMESPACE BLOCK, package NAMESPACE VERSION BLOCK , __PACKAGE__ , pipe READHANDLE,WRITEHANDLE , pop ARRAY , pop, pos SCALAR , pos, print FILEHANDLE LIST , print FILEHANDLE, print LIST, print, printf FILEHANDLE FORMAT, LIST , printf FILEHANDLE, printf FORMAT, LIST, printf, prototype FUNCTION , prototype, push ARRAY,LIST , q/STRING/, qq/STRING/, qw/STRING/, qx/STRING/, qr/STRING/, quotemeta EXPR , quotemeta, rand EXPR , rand, read FILEHANDLE,SCALAR,LENGTH,OFFSET , read FILEHANDLE,SCALAR,LENGTH, readdir DIRHANDLE , readline EXPR, readline , readlink EXPR , readlink, readpipe EXPR, readpipe , recv SOCKET,SCALAR,LENGTH,FLAGS , redo LABEL , redo EXPR, redo, ref EXPR , ref, rename OLDNAME,NEWNAME , require VERSION , require EXPR, require, reset EXPR , reset, return EXPR , return, reverse LIST , rewinddir DIRHANDLE , rindex STR,SUBSTR,POSITION , rindex STR,SUBSTR, rmdir FILENAME , rmdir, s///, say FILEHANDLE LIST , say FILEHANDLE, say LIST, say, scalar EXPR , seek FILEHANDLE,POSITION,WHENCE , seekdir DIRHANDLE,POS , select FILEHANDLE , select, select RBITS,WBITS,EBITS,TIMEOUT , semctl ID,SEMNUM,CMD,ARG , semget KEY,NSEMS,FLAGS , semop KEY,OPSTRING , send SOCKET,MSG,FLAGS,TO , send SOCKET,MSG,FLAGS, setpgrp PID,PGRP
, setpriority WHICH,WHO,PRIORITY
, setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL , shift ARRAY , shift, shmctl ID,CMD,ARG , shmget KEY,SIZE,FLAGS , shmread ID,VAR,POS,SIZE , shmwrite ID,STRING,POS,SIZE, shutdown SOCKET,HOW , sin EXPR , sin, sleep EXPR , sleep, socket SOCKET,DOMAIN,TYPE,PROTOCOL , socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL , sort SUBNAME LIST , sort BLOCK LIST, sort LIST, splice ARRAY,OFFSET,LENGTH,LIST , splice ARRAY,OFFSET,LENGTH, splice ARRAY,OFFSET, splice ARRAY, split /PATTERN/,EXPR,LIMIT , split /PATTERN/,EXPR, split /PATTERN/, split, sprintf FORMAT, LIST , format parameter index, flags, vector flag, (minimum) width, precision, or maximum width , size, order of arguments, sqrt EXPR , sqrt, srand EXPR , srand, stat FILEHANDLE
, stat EXPR, stat DIRHANDLE, stat, state VARLIST , state TYPE VARLIST, state VARLIST : ATTRS, state TYPE VARLIST : ATTRS, study SCALAR , study, sub NAME BLOCK , sub NAME ( PROTO ) BLOCK, sub NAME : ATTRS BLOCK, sub NAME ( PROTO ) : ATTRS BLOCK, __SUB__ , substr EXPR,OFFSET,LENGTH,REPLACEMENT
, substr EXPR,OFFSET,LENGTH, substr EXPR,OFFSET, symlink OLDFILE,NEWFILE , syscall NUMBER, LIST , sysopen FILEHANDLE,FILENAME,MODE , sysopen FILEHANDLE,FILENAME,MODE,PERMS, sysread FILEHANDLE,SCALAR,LENGTH,OFFSET , sysread FILEHANDLE,SCALAR,LENGTH, sysseek FILEHANDLE,POSITION,WHENCE , system LIST , system PROGRAM LIST, syswrite FILEHANDLE,SCALAR,LENGTH,OFFSET , syswrite FILEHANDLE,SCALAR,LENGTH, syswrite FILEHANDLE,SCALAR, tell FILEHANDLE , tell, telldir DIRHANDLE , tie VARIABLE,CLASSNAME,LIST , tied VARIABLE , time , times , tr///, truncate FILEHANDLE,LENGTH , truncate EXPR,LENGTH, uc EXPR , uc, ucfirst EXPR , ucfirst, umask EXPR , umask, undef EXPR , undef, unlink LIST
, unlink, unpack TEMPLATE,EXPR , unpack TEMPLATE, unshift ARRAY,LIST , untie VARIABLE , use Module VERSION LIST , use Module VERSION, use Module LIST, use Module, use VERSION, utime LIST , values HASH , values ARRAY, vec EXPR,OFFSET,BITS , wait , waitpid PID,FLAGS , wantarray , warn LIST
, write FILEHANDLE , write EXPR, write, y///

Non-function Keywords by Cross-reference

__DATA__, __END__, BEGIN, CHECK, END, INIT, UNITCHECK, DESTROY, and, cmp, eq, ge, gt, le, lt, ne, not, or, x, xor, AUTOLOAD, else, elsif, for, foreach, if, unless, until, while, elseif, default, given, when

perlopentut - simple recipes for opening files and pipes in Perl
DESCRIPTION

OK , HANDLE , MODE , PATHNAME

Opening Text Files

Opening Text Files for Reading
Opening Text Files for Writing

Opening Binary Files
Opening Pipes

Opening a pipe for reading
Opening a pipe for writing
Expressing the command as a list

SEE ALSO
AUTHOR

perlpodspec - Plain Old Documentation: format specification and notes
DESCRIPTION
Pod Definitions
Pod Commands

"=head1", "=head2", "=head3", "=head4", "=pod", "=cut", "=over", "=item", "=back", "=begin formatname", "=begin formatname parameter", "=end formatname", "=for formatname text...", "=encoding encodingname"

Pod Formatting Codes

"I<text>" -- italic text, "B<text>" -- bold text, "C<code>" -- code text, "F<filename>" -- style for filenames, "X<topic name>" -- an index entry, "Z<>" -- a null (zero-effect) formatting code, "L<name>" -- a hyperlink, "E<escape>" -- a character escape, "S<text>" -- text contains non-breaking spaces

Notes on Implementing Pod Processors
About L<...> Codes

First:, Second:, Third:, Fourth:, Fifth:, Sixth:

About =over...=back Regions
About Data Paragraphs and "=begin/=end" Regions
SEE ALSO
AUTHOR

perlpodstyle - Perl POD style guide
DESCRIPTION

NAME, SYNOPSIS, DESCRIPTION, OPTIONS, RETURN VALUE, ERRORS, DIAGNOSTICS, EXAMPLES, ENVIRONMENT, FILES, CAVEATS, BUGS, RESTRICTIONS, NOTES, AUTHOR, HISTORY, COPYRIGHT AND LICENSE, SEE ALSO

AUTHOR
COPYRIGHT AND LICENSE
SEE ALSO

perldiag - various Perl diagnostics
DESCRIPTION
SEE ALSO

perldeprecation - list Perl deprecations
DESCRIPTION

Perl 5.34
Perl 5.32
Perl 5.30
Perl 5.28
Perl 5.26
Perl 5.24
Perl 5.16

SEE ALSO

perllexwarn - Perl Lexical Warnings
DESCRIPTION

perldebug - Perl debugging
DESCRIPTION
The Perl Debugger

Calling the Debugger

perl -d program_name, perl -d -e 0, perl -d:ptkdb program_name, perl -dt threaded_program_name

Debugger Commands

h , h [command], h h, p expr , x [maxdepth] expr , V [pkg [vars]] , X [vars] , y [level [vars]] , T , s [expr] , n [expr] , r , < CR >, c [line|sub] , l , l min+incr, l min-max, l line, l subname, - , v [line] , . , f filename , /pattern/, ?pattern?, L [abw] , S [[!]regex] , t [n] , t [n] expr , b , b [line] [condition] , b [file]:[line] [condition] , b subname [condition] , b postpone subname [condition] , b load filename
, b compile subname , B line , B *
, disable [file]:[line]
, disable [line]
, enable [file]:[line]
, enable [line]
, a [line] command , A line , A * , w expr , W expr , W * , o , o booloption ... , o anyoption? ... , o option=value ... , < ? , < [ command ] , < * , << command , > ? , > command , > * , >> command , { ? , { [ command ], { * , {{ command , ! number , ! -number , ! pattern , !! cmd , source file , H -number , q or ^D , R , |dbcmd , ||dbcmd , command, m expr , M , man [manpage]

Configurable Options

"recallCommand", "ShellBang" , "pager" , "tkRunning" , "signalLevel", "warnLevel", "dieLevel"
, "AutoTrace" , "LineInfo" , "inhibit_exit" , "PrintRet" , "ornaments" , "frame" , "maxTraceLen" , "windowSize" , "arrayDepth", "hashDepth" , "dumpDepth" , "compactDump", "veryCompact" , "globPrint" , "DumpDBFiles" , "DumpPackages" , "DumpReused" , "quote", "HighBit", "undefPrint"
, "UsageOnly" , "HistFile" , "HistSize" , "TTY" , "noTTY" , "ReadLine" , "NonStop"

Debugger Input/Output

Prompt, Multiline commands, Stack backtrace , Line Listing Format, Frame listing

Debugging Compile-Time Statements
Debugger Customization
Readline Support / History in the Debugger
Editor Support for Debugging
The Perl Profiler

Debugging Regular Expressions
Debugging Memory Usage
SEE ALSO
BUGS

perlvar - Perl predefined variables
DESCRIPTION

The Syntax of Variable Names

SPECIAL VARIABLES

General Variables

$ARG, $_ , @ARG, @_ , $LIST_SEPARATOR, $" , $PROCESS_ID, $PID, $$ , $PROGRAM_NAME, $0 , $REAL_GROUP_ID, $GID, $(
, $EFFECTIVE_GROUP_ID, $EGID, $) , $REAL_USER_ID, $UID, $< , $EFFECTIVE_USER_ID, $EUID, $> , $SUBSCRIPT_SEPARATOR, $SUBSEP, $; , $a, $b , %ENV , $OLD_PERL_VERSION, $] , $SYSTEM_FD_MAX, $^F
, @F , @INC , %INC , $INPLACE_EDIT, $^I , @ISA , $^M , $OSNAME, $^O , %SIG , $BASETIME, $^T , $PERL_VERSION, $^V , ${^WIN32_SLOPPY_STAT} , $EXECUTABLE_NAME, $^X

Variables related to regular expressions

$<digits> ($1, $2, ...) , @{^CAPTURE}
, $MATCH, $& , ${^MATCH} , $PREMATCH, $’ , ${^PREMATCH} , $POSTMATCH, $’
, ${^POSTMATCH} , $LAST_PAREN_MATCH, $+ , $LAST_SUBMATCH_RESULT, $^N , @LAST_MATCH_END, @+ , %{^CAPTURE}, %LAST_PAREN_MATCH, %+
, @LAST_MATCH_START, @- , "$`" is the same as "substr($var, 0, $-[0])", $& is the same as "substr($var, $-[0], $+[0] - $-[0])", "$'" is the same as "substr($var, $+[0])", $1 is the same as "substr($var, $-[1], $+[1] - $-[1])", $2 is the same as "substr($var, $-[2], $+[2] - $-[2])", $3 is the same as "substr($var, $-[3], $+[3] - $-[3])", %{^CAPTURE_ALL} , %- , $LAST_REGEXP_CODE_RESULT, $^R , ${^RE_COMPILE_RECURSION_LIMIT} , ${^RE_DEBUG_FLAGS} , ${^RE_TRIE_MAXBUF}

Variables related to filehandles

$ARGV , @ARGV , ARGV , ARGVOUT , IO::Handle->output_field_separator( EXPR ), $OUTPUT_FIELD_SEPARATOR, $OFS, $, , HANDLE- >input_line_number( EXPR ), $INPUT_LINE_NUMBER, $NR, $. , IO::Handle->input_record_separator( EXPR ), $INPUT_RECORD_SEPARATOR, $RS, $/ , IO::Handle->output_record_separator( EXPR ), $OUTPUT_RECORD_SEPARATOR, $ORS, $\ , HANDLE- >autoflush( EXPR ), $OUTPUT_AUTOFLUSH, $| , ${^LAST_FH} , $ACCUMULATOR, $^A , IO::Handle->format_formfeed( EXPR ), $FORMAT_FORMFEED, $^L , HANDLE- >format_page_number( EXPR ), $FORMAT_PAGE_NUMBER, $% , HANDLE- >format_lines_left( EXPR ), $FORMAT_LINES_LEFT, $- , IO::Handle->format_line_break_characters EXPR, $FORMAT_LINE_BREAK_CHARACTERS, $: , HANDLE- >format_lines_per_page( EXPR ), $FORMAT_LINES_PER_PAGE, $= , HANDLE- >format_top_name( EXPR ), $FORMAT_TOP_NAME, $^ , HANDLE- >format_name( EXPR ), $FORMAT_NAME, $~

Error Variables

${^CHILD_ERROR_NATIVE} , $EXTENDED_OS_ERROR, $^E
, $EXCEPTIONS_BEING_CAUGHT, $^S , $WARNING, $^W , ${^WARNING_BITS} , $OS_ERROR, $ERRNO, $! , %OS_ERROR, %ERRNO, %! , $CHILD_ERROR, $? , $EVAL_ERROR, $@

Variables related to the interpreter state

$COMPILING, $^C , $DEBUGGING, $^D , ${^ENCODING} , ${^GLOBAL_PHASE} , CONSTRUCT, START, CHECK, INIT, RUN, END, DESTRUCT, $^H , %^H , ${^OPEN} , $PERLDB, $^P , 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x100, 0x200, 0x400, 0x800, 0x1000, ${^TAINT} , ${^SAFE_LOCALES} , ${^UNICODE} , ${^UTF8CACHE} , ${^UTF8LOCALE}

Deprecated and removed variables

$# , $* , $[

perlre - Perl regular expressions
DESCRIPTION

The Basics
Modifiers

"m" , "s" , "i" , "x" and "xx" , "p" , "a", "d", "l", and "u"
, "n" , Other Modifiers

Regular Expressions

[1], [2], [3], [4], [5], [6], [7], [8]

Quoting metacharacters
Extended Patterns

"(?#text)" , "(?adlupimnsx-imnsx)", "(?^alupimnsx)" , "(?:pattern)" , "(?adluimnsx-imnsx:pattern)", "(?^aluimnsx:pattern)" , "(?|pattern)" , Lookaround Assertions , "(?=pattern)", "(*pla:pattern)", "(*positive_lookahead:pattern)"
, "(?!pattern)", "(*nla:pattern)", "(*negative_lookahead:pattern)"
, "(?<=pattern)", "\K", "(*plb:pattern)", "(*positive_lookbehind:pattern)"

, "(?<!pattern)", "(*nlb:pattern)", "(*negative_lookbehind:pattern)"
, "(?<NAME>pattern)", "(?'NAME'pattern)"
, "\k<NAME>", "\k'NAME'", "(?{ code })" , "(??{ code })" , "(?PARNO)" "(?-PARNO)" "(?+PARNO)" "(?R)" "(?0)"

, "(?&NAME)" , "(?(condition)yes-pattern|no-pattern)" , "(?(condition)yes-pattern)", an integer in parentheses, a lookahead/lookbehind/evaluate zero-width assertion;, a name in angle brackets or single quotes, the special symbol "(R)", "(1)" "(2)" .., "(<NAME>)" "('NAME')", "(?=...)" "(?!...)" "(?<=...)" "(?<!...)", "(?{ CODE })", "(R)", "(R1)" "(R2)" .., "(R&NAME)", "(DEFINE)", "(?>pattern)", "(*atomic:pattern)"

, "(?[ ])"

Backtracking
Script Runs
Special Backtracking Control Verbs

Verbs, "(*PRUNE)" "(*PRUNE:NAME)" , "(*SKIP)" "(*SKIP:NAME)" , "(*MARK:NAME)" "(*:NAME)"
, "(*THEN)" "(*THEN:NAME)", "(*COMMIT)" "(*COMMIT:arg)" , "(*FAIL)" "(*F)" "(*FAIL:arg)" , "(*ACCEPT)" "(*ACCEPT:arg)"

Warning on "\1" Instead of $1
Repeated Patterns Matching a Zero-length Substring
Combining RE Pieces

"ST", "S|T", "S{REPEAT_COUNT}", "S{min,max}", "S{min,max}?", "S?", "S*", "S+", "S??", "S*?", "S+?", "(?>S)", "(?=S)", "(?<=S)", "(?!S)", "(?<!S)", "(??{ EXPR })", "(?PARNO)", "(?(condition)yes-pattern|no-pattern)"

Creating Custom RE Engines
Embedded Code Execution Frequency
PCRE/Python Support

"(?P<NAME>pattern)", "(?P=NAME)", "(?P>NAME)"

BUGS
SEE ALSO

perlrebackslash - Perl Regular Expression Backslash Sequences and Escapes
DESCRIPTION

The backslash

[1]

All the sequences and escapes
Character Escapes

[1], [2]

Modifiers
Character classes
Referencing
Assertions

\A, \z, \Z, \G, \b{}, \b, \B{}, \B, "\b{gcb}" or "\b{g}", "\b{lb}", "\b{sb}", "\b{wb}"

Misc

\K, \N, \R , \X

perlrecharclass - Perl Regular Expression Character Classes
DESCRIPTION

The dot
Backslash sequences

If the "/a" modifier is in effect .., otherwise .., For code points above 255 .., For code points below 256 .., if locale rules are in effect .., if, instead, Unicode rules are in effect .., otherwise .., If the "/a" modifier is in effect .., otherwise .., For code points above 255 .., For code points below 256 .., if locale rules are in effect .., if, instead, Unicode rules are in effect .., otherwise .., [1], [2]

Bracketed Character Classes

[1], [2], [3], [4], [5], [6], [7], If the "/a" modifier, is in effect .., otherwise .., For code points above 255 .., For code points below 256 .., if locale rules are in effect .., "word", "ascii", "blank", if, instead, Unicode rules are in effect .., otherwise ..

perlreref - Perl Regular Expressions Reference
DESCRIPTION

OPERATORS
SYNTAX
ESCAPE SEQUENCES
CHARACTER CLASSES
ANCHORS
QUANTIFIERS
EXTENDED CONSTRUCTS
VARIABLES
FUNCTIONS
TERMINOLOGY

AUTHOR
SEE ALSO
THANKS

perlref - Perl references and nested data structures
NOTE
DESCRIPTION

Making References
Using References
Circular References
Symbolic references
Not-so-symbolic references
Pseudo-hashes: Using an array as a hash
Function Templates

WARNING: Don’t use references as hash keys

Postfix Dereference Syntax
Postfix Reference Slicing
Assigning to References

Declaring a Reference to a Variable
SEE ALSO

perlform - Perl formats
DESCRIPTION

Text Fields
Numeric Fields
The Field @* for Variable-Width Multi-Line Text
The Field ^* for Variable-Width One-line-at-a-time Text
Specifying Values
Using Fill Mode
Suppressing Lines Where All Fields Are Void
Repeating Format Lines
Top of Form Processing
Format Variables

NOTES

Footers
Accessing Formatting Internals

WARNINGS

perlobj - Perl object reference
DESCRIPTION

An Object is Simply a Data Structure
A Class is Simply a Package
A Method is Simply a Subroutine
Method Invocation
Inheritance
Writing Constructors
Attributes
An Aside About Smarter and Safer Code
Method Call Variations
Invoking Class Methods
"bless", "blessed", and "ref"
The UNIVERSAL Class

isa($class) , DOES ($role) , can($method) , VERSION ($need)

AUTOLOAD
Destructors
Non-Hash Objects
Inside-Out objects
Pseudo-hashes

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 , UNTIE this , DESTROY this

Tying Arrays

TIEARRAY classname, LIST , FETCH this, index , STORE this, index, value , FETCHSIZE this , STORESIZE this, count , EXTEND this, count , EXISTS this, key , DELETE this, key , CLEAR this , PUSH this, LIST
, POP this , SHIFT this , UNSHIFT this, LIST , SPLICE this, offset, length, LIST , UNTIE this , DESTROY this

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 , SCALAR this , UNTIE this , DESTROY this

Tying FileHandles

TIEHANDLE classname, LIST , WRITE this, LIST , PRINT this, LIST , PRINTF this, LIST , READ this, LIST , READLINE this , GETC this , EOF this , CLOSE this , UNTIE this , DESTROY this

UNTIE this
The "untie" Gotcha

SEE ALSO
AUTHOR

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

Handling the SIGHUP Signal in Daemons
Deferred Signals (Safe Signals)

Long-running opcodes, Interrupting IO, Restartable system calls, Signals as "faults", Signals triggered by operating system state

Named Pipes
Using open() for IPC

Filehandles
Background Processes
Complete Dissociation of Child from Parent
Safe Pipe Opens
Avoiding Pipe Deadlocks
Bidirectional Communication with Another Process
Bidirectional Communication with Yourself

Sockets: Client/Server Communication

Internet Line Terminators
Internet TCP Clients and Servers
Unix-Domain TCP Clients and Servers

TCP Clients with IO::Socket

A Simple Client

"Proto", "PeerAddr", "PeerPort"

A Webget Client
Interactive Client with IO::Socket

TCP Servers with IO::Socket

Proto, LocalPort, Listen, Reuse

UDP: Message Passing
SysV IPC
NOTES
BUGS
AUTHOR
SEE ALSO

perlfork - Perl’s fork() emulation
SYNOPSIS
DESCRIPTION

Behavior of other Perl features in forked pseudo-processes

$$ or $PROCESS_ID, %ENV, chdir() and all other builtins that accept filenames, wait() and waitpid(), kill(), exec(), exit(), Open handles to files, directories and network sockets

Resource limits
Killing the parent process
Lifetime of the parent process and pseudo-processes

CAVEATS AND LIMITATIONS

BEGIN blocks, Open filehandles, Open directory handles, Forking pipe open() not yet implemented, Global state maintained by XSUBs, Interpreter embedded in larger application, Thread-safety of extensions

PORTABILITY CAVEATS
BUGS
AUTHOR
SEE ALSO

perlnumber - semantics of numbers and numeric operations in Perl
SYNOPSIS
DESCRIPTION
Storing numbers
Numeric operators and numeric conversions
Flavors of Perl numeric operations

Arithmetic operators, ++, Arithmetic operators during "use integer", Other mathematical operators, Bitwise operators, Bitwise operators during "use integer", Operators which expect an integer, Operators which expect a string

AUTHOR
SEE ALSO

perlthrtut - Tutorial on threads in Perl
DESCRIPTION
What Is A Thread Anyway?
Threaded Program Models

Boss/Worker
Work Crew
Pipeline

What kind of threads are Perl threads?
Thread-Safe Modules
Thread Basics

Basic Thread Support
A Note about the Examples
Creating Threads
Waiting For A Thread To Exit
Ignoring A Thread
Process and Thread Termination

Threads And Data

Shared And Unshared Data
Thread Pitfalls: Races

Synchronization and control

Controlling access: lock()
A Thread Pitfall: Deadlocks
Queues: Passing Data Around
Semaphores: Synchronizing Data Access
Basic semaphores
Advanced Semaphores
Waiting for a Condition
Giving up control

General Thread Utility Routines

What Thread Am I In?
Thread IDs
Are These Threads The Same?
What Threads Are Running?

A Complete Example
Different implementations of threads
Performance considerations
Process-scope Changes
Thread-Safety of System Libraries
Conclusion
SEE ALSO
Bibliography

Introductory Texts
OS-Related References
Other References

Acknowledgements
AUTHOR
Copyrights

perlport - Writing portable Perl
DESCRIPTION

Not all Perl programs have to be portable, Nearly all of Perl already is portable

ISSUES

Newlines
Numbers endianness and Width
Files and Filesystems
System Interaction
Command names versus file pathnames
Networking
Interprocess Communication ( IPC )
External Subroutines ( XS )
Standard Modules
Time and Date
Character sets and character encoding
Internationalisation
System Resources
Security
Style

CPAN Testers
PLATFORMS

Unix
DOS and Derivatives

	VMS
	VOS

EBCDIC Platforms
Acorn RISC OS
Other perls

FUNCTION IMPLEMENTATIONS

Alphabetical Listing of Perl Functions

-X, alarm, atan2, binmode, chmod, chown, chroot, crypt, dbmclose, dbmopen, dump, exec, exit, fcntl, flock, fork, getlogin, getpgrp, getppid, getpriority, getpwnam, getgrnam, getnetbyname, getpwuid, getgrgid, getnetbyaddr, getprotobynumber, getpwent, getgrent, gethostbyname, gethostent, getnetent, getprotoent, getservent, seekdir, sethostent, setnetent, setprotoent, setservent, endpwent, endgrent, endhostent, endnetent, endprotoent, endservent, getsockopt, glob, gmtime, ioctl, kill, link, localtime, lstat, msgctl, msgget, msgsnd, msgrcv, open, readlink, rename, rewinddir, select, semctl, semget, semop, setgrent, setpgrp, setpriority, setpwent, setsockopt, shmctl, shmget, shmread, shmwrite, sleep, socketpair, stat, symlink, syscall, sysopen, system, telldir, times, truncate, umask, utime, wait, waitpid

Supported Platforms

Linux (x86, ARM, IA64 ), HP-UX, AIX, Win32, Windows 2000, Windows XP, Windows Server 2003, Windows Vista, Windows Server 2008, Windows 7, Cygwin, Solaris (x86, SPARC ), OpenVMS, Alpha (7.2 and later), I64 (8.2 and later), Symbian, NetBSD, FreeBSD, Debian GNU/kFreeBSD, Haiku, Irix (6.5. What else?), OpenBSD, Dragonfly BSD, Midnight BSD, QNX Neutrino RTOS (6.5.0), MirOS BSD, Stratus OpenVOS (17.0 or later), time_t issues that may or may not be fixed, Symbian (Series 60 v3, 3.2 and 5 - what else?), Stratus VOS / OpenVOS, AIX, Android, FreeMINT

EOL Platforms

(Perl 5.20)

AT&T 3b1

(Perl 5.14)

Windows 95, Windows 98, Windows ME, Windows NT4

(Perl 5.12)

Atari MiNT, Apollo Domain/OS, Apple Mac OS 8/9, Tenon Machten

Supported Platforms (Perl 5.8)
SEE ALSO
AUTHORS / CONTRIBUTORS

perllocale - Perl locale handling (internationalization and localization)
DESCRIPTION
WHAT IS A LOCALE

Category "LC_NUMERIC": Numeric formatting, Category "LC_MONETARY": Formatting of monetary amounts, Category "LC_TIME": Date/Time formatting, Category "LC_MESSAGES": Error and other messages, Category "LC_COLLATE": Collation, Category "LC_CTYPE": Character Types, Other categories

PREPARING TO USE LOCALES
USING LOCALES

The "use locale" pragma

Not within the scope of "use locale", Lingering effects of "use locale", Under ""use locale";"

The setlocale function
Multi-threaded operation
Finding locales
LOCALE PROBLEMS
Testing for broken locales
Temporarily fixing locale problems
Permanently fixing locale problems
Permanently fixing your system’s locale configuration
Fixing system locale configuration
The localeconv function
I18N::Langinfo

LOCALE CATEGORIES

Category "LC_COLLATE": Collation: Text Comparisons and Sorting
Category "LC_CTYPE": Character Types
Category "LC_NUMERIC": Numeric Formatting
Category "LC_MONETARY": Formatting of monetary amounts
Category "LC_TIME": Respresentation of time
Other categories

SECURITY
ENVIRONMENT

PERL_SKIP_LOCALE_INIT, PERL_BADLANG, DPKG_RUNNING_VERSION, "LC_ALL", "LANGUAGE", "LC_CTYPE", "LC_COLLATE", "LC_MONETARY", "LC_NUMERIC", "LC_TIME", "LANG"
Examples

NOTES

String "eval" and "LC_NUMERIC"
Backward compatibility
I18N:Collate obsolete
Sort speed and memory use impacts
Freely available locale definitions
I18n and l10n
An imperfect standard

Unicode and UTF-8
BUGS

Collation of strings containing embedded "NUL" characters
Multi-threaded
Broken systems

SEE ALSO
HISTORY

perluniintro - Perl Unicode introduction
DESCRIPTION

Unicode
Perl’s Unicode Support
Perl’s Unicode Model
Unicode and EBCDIC
Creating Unicode
Handling Unicode
Legacy Encodings
Unicode I/O
Displaying Unicode As Text
Special Cases
Advanced Topics
Miscellaneous
Questions With Answers
Hexadecimal Notation
Further Resources

UNICODE IN OLDER PERLS
SEE ALSO
ACKNOWLEDGMENTS
AUTHOR, COPYRIGHT, AND LICENSE

perlunicode - Unicode support in Perl
DESCRIPTION

Important Caveats

Safest if you "use feature 'unicode_strings'", Input and Output Layers, You must convert your non-ASCII, non-UTF-8 Perl scripts to be UTF-8, "use utf8" still needed to enable UTF-8 in scripts, UTF-16 scripts autodetected

Byte and Character Semantics
ASCII Rules versus Unicode Rules

When the string has been upgraded to UTF-8, There are additional methods for regular expression patterns

Extended Grapheme Clusters (Logical characters)
Unicode Character Properties

"\p{All}", "\p{Alnum}", "\p{Any}", "\p{ASCII}", "\p{Assigned}", "\p{Blank}", "\p{Decomposition_Type: Non_Canonical}" (Short: "\p{Dt=NonCanon}"), "\p{Graph}", "\p{HorizSpace}", "\p{In=*}", "\p{PerlSpace}", "\p{PerlWord}", "\p{Posix...}", "\p{Present_In: *}" (Short: "\p{In=*}"), "\p{Print}", "\p{SpacePerl}", "\p{Title}" and "\p{Titlecase}", "\p{Unicode}", "\p{VertSpace}", "\p{Word}", "\p{XPosix...}"

Comparison of "\N{...}" and "\p{name=...}"

[1], [2], [3], [4], [5]

Wildcards in Property Values
User-Defined Character Properties
User-Defined Case Mappings (for serious hackers only)
Character Encodings for Input and Output
Unicode Regular Expression Support Level

[1] "\N{U+...}" and "\x{...}", [2] "\p{...}" "\P{...}". This requirement is for a minimal list of properties. Perl supports these. See R2.7 for other properties, [3] Perl has "\d" "\D" "\s" "\S" "\w" "\W" "\X" "[:prop:]" "[:^prop:]", plus all the properties specified by <https://www.unicode.org/reports/tr18/#Compatibility_Properties>;. These are described above in "Other Properties", [4], Regular expression lookahead, [5] "\b" "\B" meet most, but not all, the details of this requirement, but "\b{wb}" and "\B{wb}" do, as well as the stricter R2.3, [6], [7], [8] UTF-8/UTF-EBDDIC used in Perl allows not only "U+10000" to "U+10FFFF" but also beyond "U+10FFFF", [9] Unicode has rewritten this portion of UTS#18 to say that getting canonical equivalence (see UAX#15 "Unicode Normalization Forms" <https://www.unicode.org/reports/tr15>;) is basically to be done at the programmer level. Use NFD to write both your regular expressions and text to match them against (you can use Unicode::Normalize), [10] Perl has "\X" and "\b{gcb}". Unicode has retracted their "Grapheme Cluster Mode", and recently added string properties, which Perl does not yet support, [11] see UAX#29 "Unicode Text Segmentation" <https://www.unicode.org/reports/tr29>;,, [12] see "Wildcards in Property Values" above, [13] Perl supports all the properties in the Unicode Character Database ( UCD ). It does not yet support the listed properties that come from other Unicode sources, [14] The only optional property that Perl supports is Named Sequence. None of these properties are in the UCD

Unicode Encodings
Noncharacter code points
Beyond Unicode code points
Security Implications of Unicode
Unicode in Perl on EBCDIC
Locales
When Unicode Does Not Happen
The "Unicode Bug"
Forcing Unicode in Perl (Or Unforcing Unicode in Perl)
Using Unicode in XS
Hacking Perl to work on earlier Unicode versions (for very serious
hackers only)
Porting code from perl-5.6.X

BUGS

Interaction with Extensions
Speed

SEE ALSO

perlunicook - cookbookish examples of handling Unicode in Perl
DESCRIPTION
EXAMPLES

℞ 0: Standard preamble
℞ 1: Generic Unicode-savvy filter
℞ 2: Fine-tuning Unicode warnings
℞ 3: Declare source in utf8 for identifiers and literals
℞ 4: Characters and their numbers
℞ 5: Unicode literals by character number
℞ 6: Get character name by number
℞ 7: Get character number by name
℞ 8: Unicode named characters
℞ 9: Unicode named sequences
℞ 10: Custom named characters
℞ 11: Names of CJK codepoints
℞ 12: Explicit encode/decode
℞ 13: Decode program arguments as utf8
℞ 14: Decode program arguments as locale encoding
℞ 15: Declare STD{ IN,OUT,ERR } to be utf8
℞ 16: Declare STD{ IN,OUT,ERR } to be in locale encoding
℞ 17: Make file I/O default to utf8
℞ 18: Make all I/O and args default to utf8
℞ 19: Open file with specific encoding
℞ 20: Unicode casing
℞ 21: Unicode case-insensitive comparisons
℞ 22: Match Unicode linebreak sequence in regex
℞ 23: Get character category
℞ 24: Disabling Unicode-awareness in builtin charclasses
℞ 25: Match Unicode properties in regex with \p, \P
℞ 26: Custom character properties
℞ 27: Unicode normalization
℞ 28: Convert non-ASCII Unicode numerics
℞ 29: Match Unicode grapheme cluster in regex
℞ 30: Extract by grapheme instead of by codepoint (regex)
℞ 31: Extract by grapheme instead of by codepoint (substr)
℞ 32: Reverse string by grapheme
℞ 33: String length in graphemes
℞ 34: Unicode column-width for printing
℞ 35: Unicode collation
℞ 36: Case- and accent-insensitive Unicode sort
℞ 37: Unicode locale collation
℞ 38: Making "cmp" work on text instead of codepoints
℞ 39: Case- and accent-insensitive comparisons
℞ 40: Case- and accent-insensitive locale comparisons
℞ 41: Unicode linebreaking
℞ 42: Unicode text in DBM hashes, the tedious way
℞ 43: Unicode text in DBM hashes, the easy way
℞ 44: PROGRAM: Demo of Unicode collation and printing

SEE ALSO

§3.13 Default Case Algorithms, page 113; §4.2 Case, pages 120–122; Case Mappings, page 166–172, especially Caseless Matching starting on page 170, UAX #44: Unicode Character Database, UTS #18: Unicode Regular Expressions, UAX #15: Unicode Normalization Forms, UTS #10: Unicode Collation Algorithm, UAX #29: Unicode Text Segmentation, UAX #14: Unicode Line Breaking Algorithm, UAX #11: East Asian Width

AUTHOR
COPYRIGHT AND LICENCE
REVISION HISTORY

perlunifaq - Perl Unicode FAQ
Q and A

perlunitut isn’t really a Unicode tutorial, is it?
What character encodings does Perl support?
Which version of perl should I use?
What about binary data, like images?
When should I decode or encode?
What if I don’t decode?
What if I don’t encode?
Is there a way to automatically decode or encode?
What if I don’t know which encoding was used?
Can I use Unicode in my Perl sources?
Data::Dumper doesn’t restore the UTF8 flag; is it broken?
Why do regex character classes sometimes match only in the ASCII
range?
Why do some characters not uppercase or lowercase correctly?
How can I determine if a string is a text string or a binary
string?
How do I convert from encoding FOO to encoding BAR ?
What are "decode_utf8" and "encode_utf8"?
What is a "wide character"?

INTERNALS

What is "the UTF8 flag"?
What about the "use bytes" pragma?
What about the "use encoding" pragma?
What is the difference between ":encoding" and ":utf8"?
What’s the difference between "UTF-8" and "utf8"?
I lost track; what encoding is the internal format really?

AUTHOR
SEE ALSO

perluniprops - Index of Unicode Version 13.0.0 character properties in Perl
DESCRIPTION
Properties accessible through "\p{}" and "\P{}"

Single form ("\p{name}") tighter rules:, white space adjacent to a non-word character, underscores separating digits in numbers, Compound form ("\p{name=value}" or "\p{name:value}") tighter rules:, Stabilized, Deprecated, Obsolete, Discouraged, * is a wild-card, (\d+) in the info column gives the number of Unicode code points matched by this property, D means this is deprecated, O means this is obsolete, S means this is stabilized, T means tighter (stricter) name matching applies, X means use of this form is discouraged, and may not be stable
Legal "\p{}" and "\P{}" constructs that match no characters

\p{Canonical_Combining_Class=Attached_Below_Left}, \p{Canonical_Combining_Class=CCC133}, \p{Grapheme_Cluster_Break=E_Base}, \p{Grapheme_Cluster_Break=E_Base_GAZ}, \p{Grapheme_Cluster_Break=E_Modifier}, \p{Grapheme_Cluster_Break=Glue_After_Zwj}, \p{Word_Break=E_Base}, \p{Word_Break=E_Base_GAZ}, \p{Word_Break=E_Modifier}, \p{Word_Break=Glue_After_Zwj}

Properties accessible through Unicode::UCD
Properties accessible through other means
Unicode character properties that are NOT accepted by Perl

Expands_On_NFC ( XO_NFC ), Expands_On_NFD ( XO_NFD ), Expands_On_NFKC ( XO_NFKC ), Expands_On_NFKD ( XO_NFKD ), Grapheme_Link (Gr_Link), Jamo_Short_Name ( JSN ), Other_Alphabetic (OAlpha), Other_Default_Ignorable_Code_Point ( ODI ), Other_Grapheme_Extend (OGr_Ext), Other_ID_Continue ( OIDC ), Other_ID_Start ( OIDS ), Other_Lowercase (OLower), Other_Math (OMath), Other_Uppercase (OUpper), Script=Katakana_Or_Hiragana (sc=Hrkt), Script_Extensions=Katakana_Or_Hiragana (scx=Hrkt)

Other information in the Unicode data base

auxiliary/GraphemeBreakTest.html, auxiliary/LineBreakTest.html, auxiliary/SentenceBreakTest.html, auxiliary/WordBreakTest.html, BidiCharacterTest.txt, BidiTest.txt, NormTest.txt, CJKRadicals.txt, emoji/ReadMe.txt, ReadMe.txt, EmojiSources.txt, extracted/DName.txt, Index.txt, NamedSqProv.txt, NamesList.html, NamesList.txt, NormalizationCorrections.txt, NushuSources.txt, StandardizedVariants.html, StandardizedVariants.txt, TangutSources.txt, USourceData.txt, USourceGlyphs.pdf

SEE ALSO

perlunitut - Perl Unicode Tutorial
DESCRIPTION

Definitions
Your new toolkit
I/O flow (the actual 5 minute tutorial)

SUMMARY
Q and A (or FAQ )
ACKNOWLEDGEMENTS
AUTHOR
SEE ALSO

perlebcdic - Considerations for running Perl on EBCDIC platforms
DESCRIPTION
COMMON CHARACTER CODE SETS

ASCII
ISO 8859
Latin 1 ( ISO 8859-1 )
EBCDIC

0037, 1047, POSIX-BC

Unicode code points versus EBCDIC code points
Unicode and UTF
Using Encode

SINGLE OCTET TABLES

recipe 0, recipe 1, recipe 2, recipe 3, recipe 4, recipe 5, recipe 6
Table in hex, sorted in 1047 order

IDENTIFYING CHARACTER CODE SETS
CONVERSIONS

"utf8::unicode_to_native()" and "utf8::native_to_unicode()"
tr///
iconv
C RTL

OPERATOR DIFFERENCES
FUNCTION DIFFERENCES

"chr()", "ord()", "pack()", "print()", "printf()", "sort()", "sprintf()", "unpack()"

REGULAR EXPRESSION DIFFERENCES
SOCKETS
SORTING

Ignore ASCII vs. EBCDIC sort differences.
Use a sort helper function
MONO CASE then sort data (for non-digits, non-underscore)
Perform sorting on one type of platform only.

TRANSFORMATION FORMATS

URL decoding and encoding
uu encoding and decoding
Quoted-Printable encoding and decoding
Caesarean ciphers

Hashing order and checksums
I18N AND L10N
MULTI-OCTET CHARACTER SETS
OS ISSUES

OS/400

PASE, IFS access

OS/390, z/OS

"sigaction", "chcp", dataset access, "iconv", locales

POSIX-BC?

BUGS
SEE ALSO
REFERENCES
HISTORY
AUTHOR

perlsec - Perl security
DESCRIPTION
SECURITY VULNERABILITY CONTACT INFORMATION
SECURITY MECHANISMS AND CONCERNS

Taint mode
Laundering and Detecting Tainted Data
Switches On the "#!" Line
Taint mode and @INC
Cleaning Up Your Path
Shebang Race Condition
Protecting Your Programs
Unicode
Algorithmic Complexity Attacks

Hash Seed Randomization, Hash Traversal Randomization, Bucket Order Perturbance, New Default Hash Function, Alternative Hash Functions

Using Sudo

SEE ALSO

perlmod - Perl modules (packages and symbol tables)
DESCRIPTION

Is this the document you were after?

This doc, perlnewmod, perlmodstyle

Packages
Symbol Tables
BEGIN, UNITCHECK, CHECK, INIT and END
Perl Classes
Perl Modules
Making your module threadsafe

SEE ALSO

perlmodlib - constructing new Perl modules and finding existing ones
THE PERL MODULE LIBRARY

Pragmatic Modules

attributes, autodie, autodie::exception, autodie::exception::system, autodie::hints, autodie::skip, autouse, base, bigint, bignum, bigrat, blib, bytes, charnames, constant, deprecate, diagnostics, encoding, encoding::warnings, experimental, feature, fields, filetest, if, integer, less, lib, locale, mro, ok, open, ops, overload, overloading, parent, re, sigtrap, sort, strict, subs, threads, threads::shared, utf8, vars, version, vmsish, warnings, warnings::register

Standard Modules

Amiga::ARexx, Amiga::Exec, AnyDBM_File, App::Cpan, App::Prove, App::Prove::State, App::Prove::State::Result, App::Prove::State::Result::Test, Archive::Tar, Archive::Tar::File, Attribute::Handlers, AutoLoader, AutoSplit, B, B::Concise, B::Deparse, B::Op_private, B::Showlex, B::Terse, B::Xref, Benchmark, "IO::Socket::IP", "Socket", CORE, CPAN, CPAN::API::HOWTO, CPAN::Debug, CPAN::Distroprefs, CPAN::FirstTime, CPAN::HandleConfig, CPAN::Kwalify, CPAN::Meta, CPAN::Meta::Converter, CPAN::Meta::Feature, CPAN::Meta::History, CPAN::Meta::History::Meta_1_0, CPAN::Meta::History::Meta_1_1, CPAN::Meta::History::Meta_1_2, CPAN::Meta::History::Meta_1_3, CPAN::Meta::History::Meta_1_4, CPAN::Meta::Merge, CPAN::Meta::Prereqs, CPAN::Meta::Requirements, CPAN::Meta::Spec, CPAN::Meta::Validator, CPAN::Meta::YAML, CPAN::Nox, CPAN::Plugin, CPAN::Plugin::Specfile, CPAN::Queue, CPAN::Tarzip, CPAN::Version, Carp, Class::Struct, Compress::Raw::Bzip2, Compress::Raw::Zlib, Compress::Zlib, Config, Config::Extensions, Config::Perl::V, Cwd, DB, DBM_Filter, DBM_Filter::compress, DBM_Filter::encode, DBM_Filter::int32, DBM_Filter::null, DBM_Filter::utf8, DB_File, Data::Dumper, Devel::PPPort, Devel::Peek, Devel::SelfStubber, Digest, Digest::MD5, Digest::SHA, Digest::base, Digest::file, DirHandle, Dumpvalue, DynaLoader, Encode, Encode::Alias, Encode::Byte, Encode::CJKConstants, Encode::CN, Encode::CN::HZ, Encode::Config, Encode::EBCDIC, Encode::Encoder, Encode::Encoding, Encode::GSM0338, Encode::Guess, Encode::JP, Encode::JP::H2Z, Encode::JP::JIS7, Encode::KR, Encode::KR::2022_KR, Encode::MIME::Header, Encode::MIME::Name, Encode::PerlIO, Encode::Supported, Encode::Symbol, Encode::TW, Encode::Unicode, Encode::Unicode::UTF7, English, Env, Errno, Exporter, Exporter::Heavy, ExtUtils::CBuilder, ExtUtils::CBuilder::Platform::Windows, ExtUtils::Command, ExtUtils::Command::MM, ExtUtils::Constant, ExtUtils::Constant::Base, ExtUtils::Constant::Utils, ExtUtils::Constant::XS, ExtUtils::Embed, ExtUtils::Install, ExtUtils::Installed, ExtUtils::Liblist, ExtUtils::MM, ExtUtils::MM_AIX, ExtUtils::MM_Any, ExtUtils::MM_BeOS, ExtUtils::MM_Cygwin, ExtUtils::MM_DOS, ExtUtils::MM_Darwin, ExtUtils::MM_MacOS, ExtUtils::MM_NW5, ExtUtils::MM_OS2, ExtUtils::MM_QNX, ExtUtils::MM_UWIN, ExtUtils::MM_Unix, ExtUtils::MM_VMS, ExtUtils::MM_VOS, ExtUtils::MM_Win32, ExtUtils::MM_Win95, ExtUtils::MY, ExtUtils::MakeMaker, ExtUtils::MakeMaker::Config, ExtUtils::MakeMaker::FAQ, ExtUtils::MakeMaker::Locale, ExtUtils::MakeMaker::Tutorial, ExtUtils::Manifest, ExtUtils::Miniperl, ExtUtils::Mkbootstrap, ExtUtils::Mksymlists, ExtUtils::Packlist, ExtUtils::ParseXS, ExtUtils::ParseXS::Constants, ExtUtils::ParseXS::Eval, ExtUtils::ParseXS::Utilities, ExtUtils::Typemaps, ExtUtils::Typemaps::Cmd, ExtUtils::Typemaps::InputMap, ExtUtils::Typemaps::OutputMap, ExtUtils::Typemaps::Type, ExtUtils::XSSymSet, ExtUtils::testlib, Fatal, Fcntl, File::Basename, File::Compare, File::Copy, File::DosGlob, File::Fetch, File::Find, File::Glob, File::GlobMapper, File::Path, File::Spec, File::Spec::AmigaOS, File::Spec::Cygwin, File::Spec::Epoc, File::Spec::Functions, File::Spec::Mac, File::Spec::OS2, File::Spec::Unix, File::Spec::VMS, File::Spec::Win32, File::Temp, File::stat, FileCache, FileHandle, Filter::Simple, Filter::Util::Call, FindBin, GDBM_File, Getopt::Long, Getopt::Std, HTTP::Tiny, Hash::Util, Hash::Util::FieldHash, I18N::Collate, I18N::LangTags, I18N::LangTags::Detect, I18N::LangTags::List, I18N::Langinfo, IO, IO::Compress::Base, IO::Compress::Bzip2, IO::Compress::Deflate, IO::Compress::FAQ, IO::Compress::Gzip, IO::Compress::RawDeflate, IO::Compress::Zip, IO::Dir, IO::File, IO::Handle, IO::Pipe, IO::Poll, IO::Seekable, IO::Select, IO::Socket, IO::Socket::INET, IO::Socket::UNIX, IO::Uncompress::AnyInflate, IO::Uncompress::AnyUncompress, IO::Uncompress::Base, IO::Uncompress::Bunzip2, IO::Uncompress::Gunzip, IO::Uncompress::Inflate, IO::Uncompress::RawInflate, IO::Uncompress::Unzip, IO::Zlib, IPC::Cmd, IPC::Msg, IPC::Open2, IPC::Open3, IPC::Semaphore, IPC::SharedMem, IPC::SysV, Internals, JSON::PP, JSON::PP::Boolean, List::Util, List::Util::XS, Locale::Maketext, Locale::Maketext::Cookbook, Locale::Maketext::Guts, Locale::Maketext::GutsLoader, Locale::Maketext::Simple, Locale::Maketext::TPJ13, MIME::Base64, MIME::QuotedPrint, Math::BigFloat, Math::BigInt, Math::BigInt::Calc, Math::BigInt::FastCalc, Math::BigInt::Lib, Math::BigRat, Math::Complex, Math::Trig, Memoize, Memoize::AnyDBM_File, Memoize::Expire, Memoize::ExpireFile, Memoize::ExpireTest, Memoize::NDBM_File, Memoize::SDBM_File, Memoize::Storable, Module::CoreList, Module::CoreList::Utils, Module::Load, Module::Load::Conditional, Module::Loaded, Module::Metadata, NDBM_File, NEXT, Net::Cmd, Net::Config, Net::Domain, Net::FTP, Net::FTP::dataconn, Net::NNTP, Net::Netrc, Net::POP3, Net::Ping, Net::SMTP, Net::Time, Net::hostent, Net::libnetFAQ, Net::netent, Net::protoent, Net::servent, O, ODBM_File, Opcode, POSIX, Params::Check, Parse::CPAN::Meta, Perl::OSType, PerlIO, PerlIO::encoding, PerlIO::mmap, PerlIO::scalar, PerlIO::via, PerlIO::via::QuotedPrint, Pod::Checker, Pod::Escapes, Pod::Functions, Pod::Html, Pod::Man, Pod::ParseLink, Pod::Perldoc, Pod::Perldoc::BaseTo, Pod::Perldoc::GetOptsOO, Pod::Perldoc::ToANSI, Pod::Perldoc::ToChecker, Pod::Perldoc::ToMan, Pod::Perldoc::ToNroff, Pod::Perldoc::ToPod, Pod::Perldoc::ToRtf, Pod::Perldoc::ToTerm, Pod::Perldoc::ToText, Pod::Perldoc::ToTk, Pod::Perldoc::ToXml, Pod::Simple, Pod::Simple::Checker, Pod::Simple::Debug, Pod::Simple::DumpAsText, Pod::Simple::DumpAsXML, Pod::Simple::HTML, Pod::Simple::HTMLBatch, Pod::Simple::JustPod, Pod::Simple::LinkSection, Pod::Simple::Methody, Pod::Simple::PullParser, Pod::Simple::PullParserEndToken, Pod::Simple::PullParserStartToken, Pod::Simple::PullParserTextToken, Pod::Simple::PullParserToken, Pod::Simple::RTF, Pod::Simple::Search, Pod::Simple::SimpleTree, Pod::Simple::Subclassing, Pod::Simple::Text, Pod::Simple::TextContent, Pod::Simple::XHTML, Pod::Simple::XMLOutStream, Pod::Text, Pod::Text::Color, Pod::Text::Overstrike, Pod::Text::Termcap, Pod::Usage, SDBM_File, Safe, Scalar::Util, Search::Dict, SelectSaver, SelfLoader, Storable, Sub::Util, Symbol, Sys::Hostname, Sys::Syslog, Sys::Syslog::Win32, TAP::Base, TAP::Formatter::Base, TAP::Formatter::Color, TAP::Formatter::Console, TAP::Formatter::Console::ParallelSession, TAP::Formatter::Console::Session, TAP::Formatter::File, TAP::Formatter::File::Session, TAP::Formatter::Session, TAP::Harness, TAP::Harness::Env, TAP::Object, TAP::Parser, TAP::Parser::Aggregator, TAP::Parser::Grammar, TAP::Parser::Iterator, TAP::Parser::Iterator::Array, TAP::Parser::Iterator::Process, TAP::Parser::Iterator::Stream, TAP::Parser::IteratorFactory, TAP::Parser::Multiplexer, TAP::Parser::Result, TAP::Parser::Result::Bailout, TAP::Parser::Result::Comment, TAP::Parser::Result::Plan, TAP::Parser::Result::Pragma, TAP::Parser::Result::Test, TAP::Parser::Result::Unknown, TAP::Parser::Result::Version, TAP::Parser::Result::YAML, TAP::Parser::ResultFactory, TAP::Parser::Scheduler, TAP::Parser::Scheduler::Job, TAP::Parser::Scheduler::Spinner, TAP::Parser::Source, TAP::Parser::SourceHandler, TAP::Parser::SourceHandler::Executable, TAP::Parser::SourceHandler::File, TAP::Parser::SourceHandler::Handle, TAP::Parser::SourceHandler::Perl, TAP::Parser::SourceHandler::RawTAP, TAP::Parser::YAMLish::Reader, TAP::Parser::YAMLish::Writer, Term::ANSIColor, Term::Cap, Term::Complete, Term::ReadLine, Test, Test2, Test2::API, Test2::API::Breakage, Test2::API::Context, Test2::API::Instance, Test2::API::Stack, Test2::Event, Test2::Event::Bail, Test2::Event::Diag, Test2::Event::Encoding, Test2::Event::Exception, Test2::Event::Fail, Test2::Event::Generic, Test2::Event::Note, Test2::Event::Ok, Test2::Event::Pass, Test2::Event::Plan, Test2::Event::Skip, Test2::Event::Subtest, Test2::Event::TAP::Version, Test2::Event::V2, Test2::Event::Waiting, Test2::EventFacet, Test2::EventFacet::About, Test2::EventFacet::Amnesty, Test2::EventFacet::Assert, Test2::EventFacet::Control, Test2::EventFacet::Error, Test2::EventFacet::Hub, Test2::EventFacet::Info, Test2::EventFacet::Info::Table, Test2::EventFacet::Meta, Test2::EventFacet::Parent, Test2::EventFacet::Plan, Test2::EventFacet::Render, Test2::EventFacet::Trace, Test2::Formatter, Test2::Formatter::TAP, Test2::Hub, Test2::Hub::Interceptor, Test2::Hub::Interceptor::Terminator, Test2::Hub::Subtest, Test2::IPC, Test2::IPC::Driver, Test2::IPC::Driver::Files, Test2::Tools::Tiny, Test2::Transition, Test2::Util, Test2::Util::ExternalMeta, Test2::Util::Facets2Legacy, Test2::Util::HashBase, Test2::Util::Trace, Test::Builder, Test::Builder::Formatter, Test::Builder::IO::Scalar, Test::Builder::Module, Test::Builder::Tester, Test::Builder::Tester::Color, Test::Builder::TodoDiag, Test::Harness, Test::Harness::Beyond, Test::More, Test::Simple, Test::Tester, Test::Tester::Capture, Test::Tester::CaptureRunner, Test::Tutorial, Test::use::ok, Text::Abbrev, Text::Balanced, Text::ParseWords, Text::Tabs, Text::Wrap, Thread, Thread::Queue, Thread::Semaphore, Tie::Array, Tie::File, Tie::Handle, Tie::Hash, Tie::Hash::NamedCapture, Tie::Memoize, Tie::RefHash, Tie::Scalar, Tie::StdHandle, Tie::SubstrHash, Time::HiRes, Time::Local, Time::Piece, Time::Seconds, Time::gmtime, Time::localtime, Time::tm, UNIVERSAL, Unicode::Collate, Unicode::Collate::CJK::Big5, Unicode::Collate::CJK::GB2312, Unicode::Collate::CJK::JISX0208, Unicode::Collate::CJK::Korean, Unicode::Collate::CJK::Pinyin, Unicode::Collate::CJK::Stroke, Unicode::Collate::CJK::Zhuyin, Unicode::Collate::Locale, Unicode::Normalize, Unicode::UCD, User::grent, User::pwent, VMS::DCLsym, VMS::Filespec, VMS::Stdio, Win32, Win32API::File, Win32CORE, XS::APItest, XS::Typemap, XSLoader, autodie::Scope::Guard, autodie::Scope::GuardStack, autodie::Util, version::Internals

Extension Modules

CPAN

Africa

South Africa, Uganda, Zimbabwe

Asia

Bangladesh, China, India, Indonesia, Iran, Israel, Japan, Kazakhstan, Philippines, Qatar, Republic of Korea, Singapore, Taiwan, Turkey, Viet Nam

Europe

Austria, Belarus, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Czech Republic, Denmark, Finland, France, Germany, Greece, Hungary, Ireland, Italy, Latvia, Lithuania, Moldova, Netherlands, Norway, Poland, Portugal, Romania, Russian Federation, Serbia, Slovakia, Slovenia, Spain, Sweden, Switzerland, Ukraine, United Kingdom

North America

Canada, Costa Rica, Mexico, United States, Alabama, Arizona, California, Idaho, Illinois, Indiana, Kansas, Massachusetts, Michigan, New Hampshire, New Jersey, New York, North Carolina, Oregon, Pennsylvania, South Carolina, Texas, Utah, Virginia, Washington, Wisconsin

Oceania

Australia, New Caledonia, New Zealand

South America

Argentina, Brazil, Chile

RSYNC Mirrors

Modules: Creation, Use, and Abuse

Guidelines for Module Creation
Guidelines for Converting Perl 4 Library Scripts into Modules
Guidelines for Reusing Application Code

NOTE

perlmodstyle - Perl module style guide
INTRODUCTION
QUICK CHECKLIST

Before you start
The API
Stability
Documentation
Release considerations

BEFORE YOU START WRITING A MODULE

Has it been done before?
Do one thing and do it well
What’s in a name?
Get feedback before publishing

DESIGNING AND WRITING YOUR MODULE

To OO or not to OO ?
Designing your API

Write simple routines to do simple things, Separate functionality from output, Provide sensible shortcuts and defaults, Naming conventions, Parameter passing

Strictness and warnings
Backwards compatibility
Error handling and messages

DOCUMENTING YOUR MODULE

POD

README, INSTALL, release notes, changelogs

perl Makefile.PL, make, make test, make install, perl Build.PL, perl Build, perl Build test, perl Build install

RELEASE CONSIDERATIONS

Version numbering
Pre-requisites
Testing
Packaging
Licensing

COMMON PITFALLS

Reinventing the wheel
Trying to do too much
Inappropriate documentation

SEE ALSO

perlstyle, perlnewmod, perlpod, podchecker, Packaging Tools, Testing tools, <https://pause.perl.org/>;, Any good book on software engineering

AUTHOR

perlmodinstall - Installing CPAN Modules
DESCRIPTION

PREAMBLE

DECOMPRESS the file, UNPACK the file into a directory, BUILD the module (sometimes unnecessary), INSTALL the module

PORTABILITY

HEY

AUTHOR
COPYRIGHT

perlnewmod - preparing a new module for distribution
DESCRIPTION

Warning
What should I make into a module?
Step-by-step: Preparing the ground

Look around, Check it’s new, Discuss the need, Choose a name, Check again

Step-by-step: Making the module

Start with module-starter or h2xs, Use strict and warnings, Use Carp, Use Exporter - wisely!, Use plain old documentation, Write tests, Write the README , Write Changes

Step-by-step: Distributing your module

Get a CPAN user ID, "perl Makefile.PL; make test; make distcheck; make dist", Upload the tarball, Fix bugs!

AUTHOR
SEE ALSO

perlpragma - how to write a user pragma
DESCRIPTION
A basic example
Key naming
Implementation details

perlutil - utilities packaged with the Perl distribution
DESCRIPTION
LIST OF UTILITIES

Documentation

perldoc, pod2man and pod2text, pod2html, pod2usage, podchecker, splain, "roffitall"

Converters
Administration

libnetcfg, perlivp

Development

perlbug, perlthanks, h2ph, h2xs, enc2xs, xsubpp, prove, corelist

General tools

piconv, ptar, ptardiff, ptargrep, shasum, zipdetails

Installation

cpan, instmodsh

SEE ALSO

perlfilter - Source Filters
DESCRIPTION
CONCEPTS
USING FILTERS
WRITING A SOURCE FILTER
WRITING A SOURCE FILTER IN C

Decryption Filters

CREATING A SOURCE FILTER AS A SEPARATE EXECUTABLE
WRITING A SOURCE FILTER IN PERL
USING CONTEXT: THE DEBUG FILTER
CONCLUSION
LIMITATIONS
THINGS TO LOOK OUT FOR

Some Filters Clobber the "DATA" Handle

REQUIREMENTS
AUTHOR
Copyrights

perldtrace - Perl’s support for DTrace
SYNOPSIS
DESCRIPTION
HISTORY
PROBES

sub-entry( SUBNAME, FILE, LINE, PACKAGE ), sub-return( SUBNAME, FILE, LINE, PACKAGE ), phase-change( NEWPHASE, OLDPHASE ), op-entry( OPNAME ), loading-file( FILENAME ), loaded-file( FILENAME )

EXAMPLES

Most frequently called functions, Trace function calls, Function calls during interpreter cleanup, System calls at compile time, Perl functions that execute the most opcodes

REFERENCES

DTrace Dynamic Tracing Guide, DTrace: Dynamic Tracing in Oracle Solaris, Mac OS X and FreeBSD

SEE ALSO

Devel::DTrace::Provider

AUTHORS

perlglossary - Perl Glossary
VERSION
DESCRIPTION

	A		accessor methods, actual arguments, address operator, algorithm, alias, alphabetic, alternatives, anonymous, application, architecture, argument, ARGV, arithmetical operator, array, array context, Artistic License, ASCII, assertion, assignment, assignment operator, associative array, associativity, asynchronous, atom, atomic operation, attribute, autogeneration, autoincrement, autoload, autosplit, autovivification, AV, awk
	B		backreference, backtracking, backward compatibility, bareword, base class, big-endian, binary, binary operator, bind, bit, bit shift, bit string, bless, block, BLOCK, block buffering, Boolean, Boolean context, breakpoint, broadcast, BSD, bucket, buffer, built-in, bundle, byte, bytecode
	C		C, cache, callback, call by reference, call by value, canonical, capture variables, capturing, cargo cult, case, casefolding, casemapping, character, character class, character property, circumfix operator, class, class method, client, closure, cluster, CODE, code generator, codepoint, code subpattern, collating sequence, co-maintainer, combining character, command, command buffering, command-line arguments, command name, comment, compilation unit, compile, compile phase, compiler, compile time, composer, concatenation, conditional, connection, construct, constructor, context, continuation, core dump, CPAN, C preprocessor, cracker, currently selected output channel, current package, current working directory, CV
	D		dangling statement, datagram, data structure, data type, DBM, declaration, declarator, decrement, default, defined, delimiter, dereference, derived class, descriptor, destroy, destructor, device, directive, directory, directory handle, discipline, dispatch, distribution, dual-lived, dweomer, dwimmer, dynamic scoping
	E		eclectic, element, embedding, empty subclass test, encapsulation, endian, en passant, environment, environment variable, EOF, errno, error, escape sequence, exception, exception handling, exec, executable file, execute, execute bit, exit status, exploit, export, expression, extension
	F		false, FAQ, fatal error, feeping creaturism, field, FIFO, file, file descriptor, fileglob, filehandle, filename, filesystem, file test operator, filter, first-come, flag, floating point, flush, FMTEYEWTK, foldcase, fork, formal arguments, format, freely available, freely redistributable, freeware, function, funny character
	G		garbage collection, GID, glob, global, global destruction, glue language, granularity, grapheme, greedy, grep, group, GV
	H		hacker, handler, hard reference, hash, hash table, header file, here document, hexadecimal, home directory, host, hubris, HV
	I		identifier, impatience, implementation, import, increment, indexing, indirect filehandle, indirection, indirect object, indirect object slot, infix, inheritance, instance, instance data, instance method, instance variable, integer, interface, interpolation, interpreter, invocant, invocation, I/O, IO, I/O layer, IPA, IP, IPC, is-a, iteration, iterator, IV
	J		JAPH
	K		key, keyword
	L		label, laziness, leftmost longest, left shift, lexeme, lexer, lexical analysis, lexical scoping, lexical variable, library, LIFO, line, linebreak, line buffering, line number, link, LIST, list, list context, list operator, list value, literal, little-endian, local, logical operator, lookahead, lookbehind, loop, loop control statement, loop label, lowercase, lvaluable, lvalue, lvalue modifier
	M		magic, magical increment, magical variables, Makefile, man, manpage, matching, member data, memory, metacharacter, metasymbol, method, method resolution order, minicpan, minimalism, mode, modifier, module, modulus, mojibake, monger, mortal, mro, multidimensional array, multiple inheritance
	N		named pipe, namespace, NaN, network address, newline, NFS, normalization, null character, null list, null string, numeric context, numification, NV, nybble
	O		object, octal, offset, one-liner, open source software, operand, operating system, operator, operator overloading, options, ordinal, overloading, overriding, owner
	P		package, pad, parameter, parent class, parse tree, parsing, patch, PATH, pathname, pattern, pattern matching, PAUSE, Perl mongers, permission bits, Pern, pipe, pipeline, platform, pod, pod command, pointer, polymorphism, port, portable, porter, possessive, POSIX, postfix, pp, pragma, precedence, prefix, preprocessing, primary maintainer, procedure, process, program, program generator, progressive matching, property, protocol, prototype, pseudofunction, pseudohash, pseudoliteral, public domain, pumpkin, pumpking, PV
	Q		qualified, quantifier
	R		race condition, readable, reaping, record, recursion, reference, referent, regex, regular expression, regular expression modifier, regular file, relational operator, reserved words, return value, RFC, right shift, role, root, RTFM, run phase, runtime, runtime pattern, RV, rvalue
	S		sandbox, scalar, scalar context, scalar literal, scalar value, scalar variable, scope, scratchpad, script, script kiddie, sed, semaphore, separator, serialization, server, service, setgid, setuid, shared memory, shebang, shell, side effects, sigil, signal, signal handler, single inheritance, slice, slurp, socket, soft reference, source filter, stack, standard, standard error, standard input, standard I/O, Standard Library, standard output, statement, statement modifier, static, static method, static scoping, static variable, stat structure, status, STDERR, STDIN, STDIO, STDOUT, stream, string, string context, stringification, struct, structure, subclass, subpattern, subroutine, subscript, substitution, substring, superclass, superuser, SV, switch, switch cluster, switch statement, symbol, symbolic debugger, symbolic link, symbolic reference, symbol table, synchronous, syntactic sugar, syntax, syntax tree, syscall
	T		taint checks, tainted, taint mode, TCP, term, terminator, ternary, text, thread, tie, titlecase, TMTOWTDI, token, tokener, tokenizing, toolbox approach, topic, transliterate, trigger, trinary, troff, true, truncating, type, type casting, typedef, typed lexical, typeglob, typemap
	U		UDP, UID, umask, unary operator, Unicode, Unix, uppercase
	V		value, variable, variable interpolation, variadic, vector, virtual, void context, v-string
	W		warning, watch expression, weak reference, whitespace, word, working directory, wrapper, WYSIWYG
	X		XS, XSUB
	Y		yacc
	Z		zero width, zombie

AUTHOR AND COPYRIGHT

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
Execution of END blocks
$0 assignments
Maintaining multiple interpreter instances
Using Perl modules, which themselves use C libraries, from your C
program
Using embedded Perl with POSIX locales

Hiding Perl_
MORAL
AUTHOR
COPYRIGHT

perldebguts - Guts of Perl debugging
DESCRIPTION
Debugger Internals

Writing Your Own Debugger

Frame Listing Output Examples
Debugging Regular Expressions

Compile-time Output

"anchored" STRING "at" POS , "floating" STRING "at" POS1..POS2 , "matching floating/anchored", "minlen", "stclass" TYPE , "noscan", "isall", "GPOS", "plus", "implicit", "with eval", "anchored(TYPE)"

Types of Nodes
Run-time Output

Debugging Perl Memory Usage

Using $ENV{PERL_DEBUG_MSTATS}

"buckets SMALLEST(APPROX)..GREATEST(APPROX)", Free/Used, "Total sbrk(): SBRKed/SBRKs:CONTINUOUS", "pad: 0", "heads: 2192", "chain: 0", "tail: 6144"

SEE ALSO

perlxstut - Tutorial for writing XSUBs
DESCRIPTION
SPECIAL NOTES

make
Version caveat
Dynamic Loading versus Static Loading
Threads and PERL_NO_GET_CONTEXT

TUTORIAL

EXAMPLE 1
EXAMPLE 2
What has gone on?
Writing good test scripts
EXAMPLE 3
What’s new here?
Input and Output Parameters
The XSUBPP Program
The TYPEMAP file
Warning about Output Arguments
EXAMPLE 4
What has happened here?
Anatomy of .xs file
Getting the fat out of XSUBs
More about XSUB arguments
The Argument Stack
Extending your Extension
Documenting your Extension
Installing your Extension
EXAMPLE 5
New Things in this Example
EXAMPLE 6
New Things in this Example
EXAMPLE 7 (Coming Soon)
EXAMPLE 8 (Coming Soon)
EXAMPLE 9 Passing open files to XSes
Troubleshooting these Examples

SEE ALSO

perlguts - Introduction to the Perl API
DESCRIPTION
Variables

Datatypes
What is an " IV" ?
Working with SVs
Offsets
What’s Really Stored in an SV ?
Working with AVs
Working with HVs
Hash API Extensions
AVs, HVs and undefined values
References
Blessed References and Class Objects
Creating New Variables

GV_ADDMULTI, GV_ADDWARN

Reference Counts and Mortality
Stashes and Globs
Double-Typed SVs
Read-Only Values
Copy on Write
Magic Variables
Assigning Magic
Magic Virtual Tables
Finding Magic
Understanding the Magic of Tied Hashes and Arrays
Localizing changes

"SAVEINT(int i)", "SAVEIV(IV i)", "SAVEI32(I32 i)", "SAVELONG(long i)", SAVESPTR(s), SAVEPPTR(p), "SAVEFREESV(SV *sv)", "SAVEMORTALIZESV(SV *sv)", "SAVEFREEOP(OP *op)", SAVEFREEPV(p), "SAVECLEARSV(SV *sv)", "SAVEDELETE(HV *hv, char *key, I32 length)", "SAVEDESTRUCTOR(DESTRUCTORFUNC_NOCONTEXT_t f, void *p)", "SAVEDESTRUCTOR_X(DESTRUCTORFUNC_t f, void *p)", "SAVESTACK_POS()", "SV* save_scalar(GV *gv)", "AV* save_ary(GV *gv)", "HV* save_hash(GV *gv)", "void save_item(SV *item)", "void save_list(SV **sarg, I32 maxsarg)", "SV* save_svref(SV **sptr)", "void save_aptr(AV **aptr)", "void save_hptr(HV **hptr)"

Subroutines

XSUBs and the Argument Stack
Autoloading with XSUBs
Calling Perl Routines from within C Programs
Putting a C value on Perl stack
Scratchpads
Scratchpads and recursion

Memory Allocation

Allocation
Reallocation
Moving

PerlIO
Compiled code

Code tree
Examining the tree
Compile pass 1: check routines
Compile pass 1a: constant folding
Compile pass 2: context propagation
Compile pass 3: peephole optimization
Pluggable runops
Compile-time scope hooks

"void bhk_start(pTHX_ int full)", "void bhk_pre_end(pTHX_ OP **o)", "void bhk_post_end(pTHX_ OP **o)", "void bhk_eval(pTHX_ OP *const o)"

Examining internal data structures with the "dump" functions
How multiple interpreters and concurrency are supported

Background and PERL_IMPLICIT_CONTEXT
So what happened to dTHR?
How do I use all this in extensions?
Should I do anything special if I call perl from multiple threads?
Future Plans and PERL_IMPLICIT_SYS

Internal Functions

Formatted Printing of IVs, UVs, and NVs
Formatted Printing of SVs
Formatted Printing of Strings
Formatted Printing of "Size_t" and "SSize_t"
Pointer-To-Integer and Integer-To-Pointer
Exception Handling
Source Documentation
Backwards compatibility

Unicode Support

What is Unicode, anyway?
How can I recognise a UTF-8 string?
How does UTF-8 represent Unicode characters?
How does Perl store UTF-8 strings?
How do I convert a string to UTF-8 ?
How do I compare strings?
Is there anything else I need to know?

Custom Operators

xop_name, xop_desc, xop_class, OA_BASEOP, OA_UNOP, OA_BINOP, OA_LOGOP, OA_LISTOP, OA_PMOP, OA_SVOP, OA_PADOP, OA_PVOP_OR_SVOP, OA_LOOP, OA_COP, xop_peep

Stacks

Value Stack
Mark Stack
Temporaries Stack
Save Stack
Scope Stack

Dynamic Scope and the Context Stack

Introduction to the context stack
Pushing contexts
Popping contexts
Redoing contexts

Slab-based operator allocation
AUTHORS
SEE ALSO

perlcall - Perl calling conventions from C
DESCRIPTION

An Error Handler, An Event-Driven Program

THE CALL_ FUNCTIONS

call_sv, call_pv, call_method, call_argv

FLAG VALUES

G_VOID
G_SCALAR
G_ARRAY
G_DISCARD
G_NOARGS
G_EVAL
G_KEEPERR
Determining the Context

EXAMPLES

No Parameters, Nothing Returned
Passing Parameters
Returning a Scalar
Returning a List of Values
Returning a List in Scalar Context
Returning Data from Perl via the Parameter List
Using G_EVAL
Using G_KEEPERR
Using call_sv
Using call_argv
Using call_method
Using GIMME_V
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
Creating and Calling an Anonymous Subroutine in C

LIGHTWEIGHT CALLBACKS
SEE ALSO
AUTHOR
DATE

perlmroapi - Perl method resolution plugin interface
DESCRIPTION

resolve, name, length, kflags, hash

Callbacks
Caching
Examples
AUTHORS

perlreapi - Perl regular expression plugin interface
DESCRIPTION
Callbacks

comp

"/m" - RXf_PMf_MULTILINE, "/s" - RXf_PMf_SINGLELINE, "/i" - RXf_PMf_FOLD, "/x" - RXf_PMf_EXTENDED, "/p" - RXf_PMf_KEEPCOPY, Character set, RXf_SPLIT, RXf_SKIPWHITE, RXf_START_ONLY, RXf_WHITE, RXf_NULL, RXf_NO_INPLACE_SUBST

exec

rx, sv, strbeg, strend, stringarg, minend, data, flags

intuit
checkstr
free
Numbered capture callbacks
Named capture callbacks
qr_package
dupe
op_comp

The REGEXP structure

"engine"
"mother_re"
"extflags"
"minlen" "minlenret"
"gofs"
"substrs"
"nparens", "lastparen", and "lastcloseparen"
"intflags"
"pprivate"
"offs"
"precomp" "prelen"
"paren_names"
"substrs"
"subbeg" "sublen" "saved_copy" "suboffset" "subcoffset"
"wrapped" "wraplen"
"seen_evals"
"refcnt"

HISTORY
AUTHORS
LICENSE

perlreguts - Description of the Perl regular expression engine.
DESCRIPTION
OVERVIEW

A quick note on terms
What is a regular expression engine?
Structure of a Regexp Program

"regnode_1", "regnode_2", "regnode_string", "regnode_charclass", "regnode_charclass_posixl"

Process Overview

A. Compilation, 1. Parsing, 2. Peep-hole optimisation and analysis, B. Execution, 3. Start position and no-match optimisations, 4. Program execution
Compilation

anchored fixed strings, floating fixed strings, minimum and maximum length requirements, start class, Beginning/End of line positions

Execution

MISCELLANEOUS

Unicode and Localisation Support
Base Structures

"offsets", "regstclass", "data", "program"

SEE ALSO

perlandroid - Perl under Android
SYNOPSIS
DESCRIPTION
Cross-compilation

Get the Android Native Development Kit ( NDK )
Determine the architecture you’ll be cross-compiling for
Set up a standalone toolchain
adb or ssh?
Configure and beyond

Native Builds

CCTools
Termux

AUTHOR

perlbs2000 - building and installing Perl for BS2000.
SYNOPSIS
DESCRIPTION

gzip on BS2000
bison on BS2000
Unpacking Perl Distribution on BS2000
Compiling Perl on BS2000
Testing Perl on BS2000
Installing Perl on BS2000
Using Perl in the Posix-Shell of BS2000
Using Perl in "native" BS2000
Floating point anomalies on BS2000
Using PerlIO and different encodings on ASCII and EBCDIC partitions

AUTHORS
SEE ALSO

Mailing list

HISTORY

perlcygwin - Perl for Cygwin
SYNOPSIS
PREREQUISITES FOR COMPILING PERL ON CYGWIN

Cygwin = GNU+Cygnus+Windows (Don’t leave UNIX without it)
Cygwin Configuration

"PATH", nroff

CONFIGURE PERL ON CYGWIN

Stripping Perl Binaries on Cygwin
Optional Libraries for Perl on Cygwin

"-lcrypt", "-lgdbm_compat" ("use GDBM_File"), "-ldb" ("use DB_File"), "cygserver" ("use IPC::SysV"), "-lutil"

Configure-time Options for Perl on Cygwin

"-Uusedl", "-Dusemymalloc", "-Uuseperlio", "-Dusemultiplicity", "-Uuse64bitint", "-Duselongdouble", "-Uuseithreads", "-Duselargefiles", "-Dmksymlinks"

Suspicious Warnings on Cygwin

Win9x and "d_eofnblk", Compiler/Preprocessor defines

MAKE ON CYGWIN
TEST ON CYGWIN

File Permissions on Cygwin
NDBM_File and ODBM_File do not work on FAT filesystems
"fork()" failures in io_* tests

Specific features of the Cygwin port

Script Portability on Cygwin

Pathnames, Text/Binary, PerlIO, .exe, Cygwin vs. Windows process ids, Cygwin vs. Windows errors, rebase errors on fork or system, "chown()", Miscellaneous

Prebuilt methods:

"Cwd::cwd", "Cygwin::pid_to_winpid", "Cygwin::winpid_to_pid", "Cygwin::win_to_posix_path", "Cygwin::posix_to_win_path", "Cygwin::mount_table()", "Cygwin::mount_flags", "Cygwin::is_binmount", "Cygwin::sync_winenv"

INSTALL PERL ON CYGWIN
MANIFEST ON CYGWIN

Documentation, Build, Configure, Make, Install, Tests, Compiled Perl Source, Compiled Module Source, Perl Modules/Scripts, Perl Module Tests

BUGS ON CYGWIN
AUTHORS
HISTORY

perldos - Perl under DOS, W31, W95.
SYNOPSIS
DESCRIPTION

Prerequisites for Compiling Perl on DOS

DJGPP, Pthreads

Shortcomings of Perl under DOS
Building Perl on DOS
Testing Perl on DOS
Installation of Perl on DOS

BUILDING AND INSTALLING MODULES ON DOS

Building Prerequisites for Perl on DOS
Unpacking CPAN Modules on DOS
Building Non-XS Modules on DOS
Building XS Modules on DOS

AUTHOR
SEE ALSO

perlfreebsd - Perl version 5 on FreeBSD systems
DESCRIPTION

FreeBSD core dumps from readdir_r with ithreads
$^X doesn’t always contain a full path in FreeBSD

AUTHOR

perlhaiku - Perl version 5.10+ on Haiku
DESCRIPTION
BUILD AND INSTALL
KNOWN PROBLEMS
CONTACT

perlhpux - Perl version 5 on Hewlett-Packard Unix (HP-UX) systems
DESCRIPTION

Using perl as shipped with HP-UX
Using perl from HP ’s porting centre
Other prebuilt perl binaries
Compiling Perl 5 on HP-UX
PA-RISC
PA-RISC 1.0
PA-RISC 1.1
PA-RISC 2.0
Portability Between PA-RISC Versions
Itanium Processor Family ( IPF ) and HP-UX
Itanium, Itanium 2 & Madison 6
HP-UX versions
Building Dynamic Extensions on HP-UX
The HP ANSI C Compiler
The GNU C Compiler
Using Large Files with Perl on HP-UX
Threaded Perl on HP-UX
64-bit Perl on HP-UX
Oracle on HP-UX
GDBM and Threads on HP-UX
NFS filesystems and utime(2) on HP-UX
HP-UX Kernel Parameters (maxdsiz) for Compiling Perl

nss_delete core dump from op/pwent or op/grent
error: pasting ")" and "l" does not give a valid preprocessing token
Redeclaration of "sendpath" with a different storage class specifier
Miscellaneous
AUTHOR

perlhurd - Perl version 5 on Hurd
DESCRIPTION

Known Problems with Perl on Hurd

AUTHOR

perlirix - Perl version 5 on Irix systems
DESCRIPTION

Building 32-bit Perl in Irix
Building 64-bit Perl in Irix
About Compiler Versions of Irix
Linker Problems in Irix
Malloc in Irix
Building with threads in Irix
Irix 5.3

AUTHOR

perllinux - Perl version 5 on Linux systems
DESCRIPTION

Deploying Perl on Linux
Experimental Support for Sun Studio Compilers for Linux OS

AUTHOR

perlmacos - Perl under Mac OS (Classic)
SYNOPSIS
DESCRIPTION
AUTHOR

perlmacosx - Perl under Mac OS X
SYNOPSIS
DESCRIPTION

Installation Prefix
SDK support
Universal Binary support
64-bit PPC support
libperl and Prebinding
Updating Apple’s Perl
Known problems
Cocoa

Starting From Scratch
AUTHOR
DATE

perlnetware - Perl for NetWare
DESCRIPTION
BUILD

Tools & SDK
Setup

SetNWBld.bat, Buildtype.bat

Make
Interpreter
Extensions

INSTALL
BUILD NEW EXTENSIONS
ACKNOWLEDGEMENTS
AUTHORS
DATE

perlopenbsd - Perl version 5 on OpenBSD systems
DESCRIPTION

OpenBSD core dumps from getprotobyname_r and getservbyname_r with
ithreads

AUTHOR

perlos2 - Perl under OS/2, DOS, Win0.3*, Win0.95 and WinNT.
SYNOPSIS
DESCRIPTION

Target
Other OSes
Prerequisites

EMX, RSX, HPFS, pdksh

Starting Perl programs under OS/2 (and DOS and...)
Starting OS/2 (and DOS ) programs under Perl

Frequently asked questions

"It does not work"
I cannot run external programs
I cannot embed perl into my program, or use perl.dll from my
program.

Is your program EMX-compiled with "-Zmt -Zcrtdll"?, Did you use ExtUtils::Embed?

"``" and pipe-"open" do not work under DOS.
Cannot start "find.exe "pattern" file"

INSTALLATION

Automatic binary installation

"PERL_BADLANG", "PERL_BADFREE", Config.pm

Manual binary installation

Perl VIO and PM executables (dynamically linked), Perl_ VIO executable (statically linked), Executables for Perl utilities, Main Perl library, Additional Perl modules, Tools to compile Perl modules, Manpages for Perl and utilities, Manpages for Perl modules, Source for Perl documentation, Perl manual in .INF format, Pdksh

Warning

Accessing documentation

OS/2 .INF file
Plain text
Manpages
HTML
GNU "info" files
PDF files
"LaTeX" docs

BUILD

The short story
Prerequisites
Getting perl source
Application of the patches
Hand-editing
Making
Testing

A lot of "bad free", Process terminated by SIGTERM/SIGINT, op/fs.t, 18, 25, op/stat.t

Installing the built perl
"a.out"-style build

Building a binary distribution
Building custom .EXE files

Making executables with a custom collection of statically loaded
extensions
Making executables with a custom search-paths

Build FAQ

Some "/" became "\" in pdksh.
'errno' - unresolved external
Problems with tr or sed
Some problem (forget which ;-)
Library ... not found
Segfault in make
op/sprintf test failure

Specific (mis)features of OS/2 port

"setpriority", "getpriority"
"system()"
"extproc" on the first line
Additional modules:
Prebuilt methods:

"File::Copy::syscopy", "DynaLoader::mod2fname", "Cwd::current_drive()",

	`"Cwd::sys_chdir(name)"`, `"Cwd::change_drive(name)"`, `"Cwd::sys_is_absolute(name)"`,			`"Cwd::sys_is_rooted(name)"`, `"Cwd::sys_is_relative(name)"`,
				`"Cwd::sys_cwd(name)"`, `"Cwd::sys_abspath(name, dir)"`, `"Cwd::extLibpath([type])"`, `"Cwd::extLibpath_set( path [, type ] )"`, `"OS2::Error(do_harderror,do_exception)"`, `"OS2::Errors2Drive(drive)"`, OS2::SysInfo(), OS2::BootDrive(), `"OS2::MorphPM(serve)"`, `"OS2::UnMorphPM(serve)"`, `"OS2::Serve_Messages(force)"`, `"OS2::Process_Messages(force [, cnt])"`, `"OS2::_control87(new,mask)"`, OS2::get_control87(), `"OS2::set_control87_em(new=MCW_EM,mask=MCW_EM)"`, `"OS2::DLLname([how [, \&xsub]])"`

Prebuilt variables:

$OS2::emx_rev, $OS2::emx_env, $OS2::os_ver, $OS2::is_aout, $OS2::can_fork, $OS2::nsyserror

Misfeatures
Modifications

"popen", "tmpnam", "tmpfile", "ctermid", "stat", "mkdir", "rmdir", "flock"

Identifying DLLs
Centralized management of resources

"HAB", "HMQ", Treating errors reported by OS/2 API, "CheckOSError(expr)", "CheckWinError(expr)", "SaveWinError(expr)", "SaveCroakWinError(expr,die,name1,name2)", "WinError_2_Perl_rc", "FillWinError", "FillOSError(rc)", Loading DLLs and ordinals in DLLs

Perl flavors

perl.exe
perl_.exe
perl__.exe
perl___.exe
Why strange names?
Why dynamic linking?
Why chimera build?

ENVIRONMENT

"PERLLIB_PREFIX"
"PERL_BADLANG"
"PERL_BADFREE"
"PERL_SH_DIR"
"USE_PERL_FLOCK"
"TMP" or "TEMP"

Evolution

Text-mode filehandles
Priorities
DLL name mangling: pre 5.6.2
DLL name mangling: 5.6.2 and beyond

Global DLLs, specific DLLs, "BEGINLIBPATH" and "ENDLIBPATH", . from "LIBPATH"

DLL forwarder generation
Threading
Calls to external programs
Memory allocation
Threads

"COND_WAIT", os2.c

BUGS
AUTHOR
SEE ALSO

perlos390 - building and installing Perl for OS/390 and z/OS
SYNOPSIS
DESCRIPTION

Tools
Unpacking Perl distribution on OS/390
Setup and utilities for Perl on OS/390
Configure Perl on OS/390
Build, Test, Install Perl on OS/390
Build Anomalies with Perl on OS/390
Testing Anomalies with Perl on OS/390
Installation Anomalies with Perl on OS/390
Usage Hints for Perl on OS/390
Floating Point Anomalies with Perl on OS/390
Modules and Extensions for Perl on OS/390

AUTHORS
SEE ALSO

Mailing list for Perl on OS/390

HISTORY

perlos400 - Perl version 5 on OS/400
DESCRIPTION

Compiling Perl for OS/400 PASE
Installing Perl in OS/400 PASE
Using Perl in OS/400 PASE
Known Problems
Perl on ILE

AUTHORS

perlplan9 - Plan 9-specific documentation for Perl
DESCRIPTION

Invoking Perl
What’s in Plan 9 Perl
What’s not in Plan 9 Perl
Perl5 Functions not currently supported in Plan 9 Perl
Signals in Plan 9 Perl

COMPILING AND INSTALLING PERL ON PLAN 9

Installing Perl Documentation on Plan 9

BUGS
Revision date
AUTHOR

perlqnx - Perl version 5 on QNX
DESCRIPTION

Required Software for Compiling Perl on QNX4

/bin/sh, ar, nm, cpp, make

Outstanding Issues with Perl on QNX4
QNX auxiliary files

qnx/ar, qnx/cpp

Outstanding issues with perl under QNX6
Cross-compilation

AUTHOR

perlriscos - Perl version 5 for RISC OS
DESCRIPTION
BUILD
AUTHOR

perlsolaris - Perl version 5 on Solaris systems
DESCRIPTION

Solaris Version Numbers.

RESOURCES

Solaris FAQ, Precompiled Binaries, Solaris Documentation

SETTING UP

File Extraction Problems on Solaris.
Compiler and Related Tools on Solaris.
Environment for Compiling perl on Solaris

RUN CONFIGURE.

64-bit perl on Solaris.
Threads in perl on Solaris.
Malloc Issues with perl on Solaris.

MAKE PROBLEMS.

Dynamic Loading Problems With GNU as and GNU ld, ld.so.1: ./perl: fatal: relocation error:, dlopen: stub interception failed, #error "No DATAMODEL_NATIVE specified", sh: ar: not found

MAKE TEST

op/stat.t test 4 in Solaris
nss_delete core dump from op/pwent or op/grent

CROSS-COMPILATION
PREBUILT BINARIES OF PERL FOR SOLARIS.
RUNTIME ISSUES FOR PERL ON SOLARIS.

Limits on Numbers of Open Files on Solaris.

SOLARIS-SPECIFIC MODULES.
SOLARIS-SPECIFIC PROBLEMS WITH MODULES.

Proc::ProcessTable on Solaris
BSD::Resource on Solaris
Net::SSLeay on Solaris

SunOS 4.x
AUTHOR

perlsymbian - Perl version 5 on Symbian OS
DESCRIPTION

Compiling Perl on Symbian
Compilation problems
PerlApp
sisify.pl
Using Perl in Symbian

TO DO
WARNING
NOTE
AUTHOR
COPYRIGHT
LICENSE
HISTORY

perlsynology - Perl 5 on Synology DSM systems
DESCRIPTION

Setting up the build environment
Compiling Perl 5
Known problems

Error message "No error definitions found", ext/DynaLoader/t/DynaLoader.t

Smoke testing Perl 5
Adding libraries

REVISION
AUTHOR

perltru64 - Perl version 5 on Tru64 (formerly known as Digital UNIX formerly known as DEC OSF/1 ) systems
DESCRIPTION

Compiling Perl 5 on Tru64
Using Large Files with Perl on Tru64
Threaded Perl on Tru64
Long Doubles on Tru64
DB_File tests failing on Tru64
64-bit Perl on Tru64
Warnings about floating-point overflow when compiling Perl on Tru64

Testing Perl on Tru64
ext/ODBM_File/odbm Test Failing With Static Builds
Perl Fails Because Of Unresolved Symbol sockatmark
read_cur_obj_info: bad file magic number
AUTHOR

perlvms - VMS-specific documentation for Perl
DESCRIPTION
Installation
Organization of Perl Images

Core Images
Perl Extensions
Installing static extensions
Installing dynamic extensions

File specifications

Syntax
Filename Case
Symbolic Links
Wildcard expansion
Pipes

PERL5LIB and PERLLIB
The Perl Forked Debugger
PERL_VMS_EXCEPTION_DEBUG
Command line

I/O redirection and backgrounding
Command line switches

-i, -S, -u

Perl functions

File tests, backticks, binmode FILEHANDLE, crypt PLAINTEXT, USER, die, dump, exec LIST, fork, getpwent, getpwnam, getpwuid, gmtime, kill, qx//, select (system call), stat EXPR, system LIST, time, times, unlink LIST, utime LIST, waitpid PID,FLAGS

Perl variables

%ENV, CRTL_ENV, CLISYM_[ LOCAL ], Any other string, $!, $^E, $?, $|

Standard modules with VMS-specific differences

SDBM_File

Revision date
AUTHOR

perlvos - Perl for Stratus OpenVOS
SYNOPSIS
BUILDING PERL FOR OPENVOS
INSTALLING PERL IN OPENVOS
USING PERL IN OPENVOS

Restrictions of Perl on OpenVOS

TEST STATUS
SUPPORT STATUS
AUTHOR
LAST UPDATE

perlwin32 - Perl under Windows
SYNOPSIS
DESCRIPTION

<http://mingw.org>;, <http://mingw-w64.org>;
Setting Up Perl on Windows

Make, Command Shell, Microsoft Visual C ++ , Microsoft Visual C ++ 2008-2019 Express/Community Edition, Microsoft Visual C ++ 2005 Express Edition, Microsoft Visual C ++ Toolkit 2003, Microsoft Platform SDK 64-bit Compiler, GCC, Intel C ++ Compiler

Building
Testing Perl on Windows
Installation of Perl on Windows
Usage Hints for Perl on Windows

Environment Variables, File Globbing, Using perl from the command line, Building Extensions, Command-line Wildcard Expansion, Notes on 64-bit Windows

Running Perl Scripts
Miscellaneous Things

BUGS AND CAVEATS
ACKNOWLEDGEMENTS
AUTHORS

Gary Ng <71564.1743 [AT] CompuServe.COM>, Gurusamy Sarathy <gsar [AT] activestate.com>, Nick Ing-Simmons <nick [AT] ing-simmons.net>, Jan Dubois <jand [AT] activestate.com>, Steve Hay <steve.m.hay [AT] googlemail.com>

SEE ALSO
HISTORY

perlboot - Links to information on object-oriented programming in Perl
DESCRIPTION

perlbot - Links to information on object-oriented programming in Perl
DESCRIPTION

perlrepository - Links to current information on the Perl source repository
DESCRIPTION

perltodo - Link to the Perl to-do list
DESCRIPTION

perltooc - Links to information on object-oriented programming in Perl
DESCRIPTION

perltoot - Links to information on object-oriented programming in Perl
DESCRIPTION

PRAGMA DOCUMENTATION

attributes - get/set subroutine or variable attributes
SYNOPSIS
DESCRIPTION

What "import" does
Built-in Attributes

lvalue, method, prototype(..), const, shared

Available Subroutines

get, reftype

Package-specific Attribute Handling

FETCH_ type_ATTRIBUTES, MODIFY_ type_ATTRIBUTES

Syntax of Attribute Lists

EXPORTS

Default exports
Available exports
Export tags defined

EXAMPLES
MORE EXAMPLES
SEE ALSO

autodie - Replace functions with ones that succeed or die with lexical scope
SYNOPSIS
DESCRIPTION
EXCEPTIONS
CATEGORIES
FUNCTION SPECIFIC NOTES

print
flock
system/exec

GOTCHAS
DIAGNOSTICS

:void cannot be used with lexical scope, No user hints defined for %s

Tips and Tricks

Importing autodie into another namespace than "caller"

BUGS

autodie and string eval
REPORTING BUGS

FEEDBACK
AUTHOR
LICENSE
SEE ALSO
ACKNOWLEDGEMENTS

autodie::Scope::Guard - Wrapper class for calling subs at end of scope
SYNOPSIS
DESCRIPTION

Methods

AUTHOR
LICENSE

autodie::Scope::GuardStack - Hook stack for managing scopes via %^H
SYNOPSIS
DESCRIPTION

Methods

AUTHOR
LICENSE

autodie::Util - Internal Utility subroutines for autodie and Fatal
SYNOPSIS
DESCRIPTION

Methods

AUTHOR
LICENSE

autodie::exception - Exceptions from autodying functions.
SYNOPSIS
DESCRIPTION

Common Methods

Advanced methods
SEE ALSO
LICENSE
AUTHOR

autodie::exception::system - Exceptions from autodying system().
SYNOPSIS
DESCRIPTION
stringify
LICENSE
AUTHOR

autodie::hints - Provide hints about user subroutines to autodie
SYNOPSIS
DESCRIPTION

Introduction
What are hints?
Example hints

Manually setting hints from within your program
Adding hints to your module
Insisting on hints
Diagnostics

Attempts to set_hints_for unidentifiable subroutine, fail hints cannot be provided with either scalar or list hints for %s, %s hint missing for %s

ACKNOWLEDGEMENTS
AUTHOR
LICENSE
SEE ALSO

autodie::skip - Skip a package when throwing autodie exceptions
SYNPOSIS
DESCRIPTION
AUTHOR
LICENSE
SEE ALSO

autouse - postpone load of modules until a function is used
SYNOPSIS
DESCRIPTION
WARNING
AUTHOR
SEE ALSO

base - Establish an ISA relationship with base classes at compile time
SYNOPSIS
DESCRIPTION
DIAGNOSTICS

Base class package "%s" is empty, Class ’Foo’ tried to inherit from itself

HISTORY
CAVEATS
SEE ALSO

bigint - Transparent BigInteger support for Perl
SYNOPSIS
DESCRIPTION

use integer vs. use bigint
Options

a or accuracy, p or precision, t or trace, hex, oct, l, lib, try or only, v or version

Math Library
Internal Format
Sign
Method calls
Methods

inf(), NaN(), e, PI, bexp(), bpi(), upgrade(), in_effect()

CAVEATS

Operator vs literal overloading, ranges, in_effect(), hex()/oct()

MODULES USED
EXAMPLES
BUGS
SUPPORT
LICENSE
SEE ALSO
AUTHORS

bignum - Transparent BigNumber support for Perl
SYNOPSIS
DESCRIPTION

Options

a or accuracy, p or precision, t or trace, l or lib, hex, oct, v or version

Methods
Caveats

inf(), NaN(), e, PI (), bexp(), bpi(), upgrade(), in_effect()

Math Library
INTERNAL FORMAT
SIGN

CAVEATS

Operator vs literal overloading, in_effect(), hex()/oct()

MODULES USED
EXAMPLES
BUGS
SUPPORT

RT: CPAN ’s request tracker, AnnoCPAN: Annotated CPAN documentation, CPAN Ratings, Search CPAN, CPAN Testers Matrix

LICENSE
SEE ALSO
AUTHORS

bigrat - Transparent BigNumber/BigRational support for Perl
SYNOPSIS
DESCRIPTION

Modules Used
Math Library
Sign
Methods

inf(), NaN(), e, PI, bexp(), bpi(), upgrade(), in_effect()

MATH LIBRARY
Caveat
Options

a or accuracy, p or precision, t or trace, l or lib, hex, oct, v or version

CAVEATS

Operator vs literal overloading, in_effect(), hex()/oct()

EXAMPLES
BUGS
SUPPORT
LICENSE
SEE ALSO
AUTHORS

blib - Use MakeMaker’s uninstalled version of a package
SYNOPSIS
DESCRIPTION
BUGS
AUTHOR

bytes - Perl pragma to expose the individual bytes of characters
NOTICE
SYNOPSIS
DESCRIPTION
LIMITATIONS
SEE ALSO

charnames - access to Unicode character names and named character sequences; also define character names
SYNOPSIS
DESCRIPTION
LOOSE MATCHES
ALIASES
CUSTOM ALIASES
charnames::string_vianame(name)
charnames::vianame(name)
charnames::viacode(code)
CUSTOM TRANSLATORS
BUGS

constant - Perl pragma to declare constants
SYNOPSIS
DESCRIPTION
NOTES

List constants
Defining multiple constants at once
Magic constants

TECHNICAL NOTES
CAVEATS
SEE ALSO
BUGS
AUTHORS
COPYRIGHT & LICENSE

deprecate - Perl pragma for deprecating the inclusion of a module in core
SYNOPSIS
DESCRIPTION

Important Caveat

EXPORT
SEE ALSO
AUTHOR
COPYRIGHT AND LICENSE

diagnostics, splain - produce verbose warning diagnostics
SYNOPSIS
DESCRIPTION

The "diagnostics" Pragma
The splain Program

EXAMPLES
INTERNALS
BUGS
AUTHOR

encoding - allows you to write your script in non-ASCII and non-UTF-8
WARNING
SYNOPSIS
DESCRIPTION

"use encoding ['ENCNAME'] ;", "use encoding ENCNAME, Filter=>1;", "no encoding;"

OPTIONS

Setting "STDIN" and/or "STDOUT" individually
The ":locale" sub-pragma

CAVEATS

SIDE EFFECTS
DO NOT MIX MULTIPLE ENCODINGS
Prior to Perl v5.22
Prior to Encode version 1.87
Prior to Perl v5.8.1

"NON-EUC" doublebyte encodings, "tr///", Legend of characters above

EXAMPLE - Greekperl
BUGS

Thread safety, Can’t be used by more than one module in a single program, Other modules using "STDIN" and "STDOUT" get the encoded stream, literals in regex that are longer than 127 bytes, EBCDIC, "format", See also " CAVEATS"

HISTORY
SEE ALSO

encoding::warnings - Warn on implicit encoding conversions
VERSION
NOTICE
SYNOPSIS
DESCRIPTION

Overview of the problem
Detecting the problem
Solving the problem

Upgrade both sides to unicode-strings, Downgrade both sides to byte-strings, Specify the encoding for implicit byte-string upgrading, PerlIO layers for STDIN and STDOUT , Literal conversions, Implicit upgrading for byte-strings

CAVEATS
SEE ALSO
AUTHORS
COPYRIGHT

experimental - Experimental features made easy
VERSION
SYNOPSIS
DESCRIPTION

"array_base" - allow the use of $[ to change the starting index of @array, "autoderef" - allow push, each, keys, and other built-ins on references, "bitwise" - allow the new stringwise bit operators, "const_attr" - allow the :const attribute on subs, "lexical_topic" - allow the use of lexical $_ via "my $_", "lexical_subs" - allow the use of lexical subroutines, "postderef" - allow the use of postfix dereferencing expressions, including in interpolating strings, "re_strict" - enables strict mode in regular expressions, "refaliasing" - allow aliasing via "\$x = \$y", "regex_sets" - allow extended bracketed character classes in regexps, "signatures" - allow subroutine signatures (for named arguments), "smartmatch" - allow the use of "~~", "switch" - allow the use of "~~", given, and when, "win32_perlio" - allows the use of the :win32 IO layer
Ordering matters
Disclaimer

SEE ALSO

filetest - Perl pragma to control the filetest permission operators
SYNOPSIS
DESCRIPTION

Consider this carefully
The "access" sub-pragma
Limitation with regard to "_"

if - "use" a Perl module if a condition holds
SYNOPSIS
DESCRIPTION

"use if"
"no if"

BUGS
SEE ALSO
AUTHOR
COPYRIGHT AND LICENCE

integer - Perl pragma to use integer arithmetic instead of floating point
SYNOPSIS
DESCRIPTION

less - perl pragma to request less of something
SYNOPSIS
DESCRIPTION
FOR MODULE AUTHORS

"BOOLEAN = less->of( FEATURE )"
"FEATURES = less->of()"

CAVEATS

This probably does nothing, This works only on 5.10+

lib - manipulate @INC at compile time
SYNOPSIS
DESCRIPTION

Adding directories to @INC
Deleting directories from @INC
Restoring original @INC

CAVEATS
NOTES
SEE ALSO
AUTHOR
COPYRIGHT AND LICENSE

locale - Perl pragma to use or avoid POSIX locales for built-in operations
WARNING
SYNOPSIS
DESCRIPTION

mro - Method Resolution Order
SYNOPSIS
DESCRIPTION
OVERVIEW
The C3 MRO

What is C3?
How does C3 work

Functions

mro::get_linear_isa($classname[, $type])
mro::set_mro ($classname, $type)
mro::get_mro($classname)
mro::get_isarev($classname)
mro::is_universal($classname)
mro::invalidate_all_method_caches()
mro::method_changed_in($classname)
mro::get_pkg_gen($classname)
next::method
next::can
maybe::next::method

SEE ALSO

The original Dylan paper

"/citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.19.3910&rep=rep1 &type=pdf" in http:

Python 2.3 MRO

<https://www.python.org/download/releases/2.3/mro/>;

Class::C3

AUTHOR

ok - Alternative to Test::More::use_ok
SYNOPSIS
DESCRIPTION
CC0 1.0 Universal

open - perl pragma to set default PerlIO layers for input and output
SYNOPSIS
DESCRIPTION
IMPLEMENTATION DETAILS
SEE ALSO

ops - Perl pragma to restrict unsafe operations when compiling
SYNOPSIS
DESCRIPTION
SEE ALSO

overload - Package for overloading Perl operations
SYNOPSIS
DESCRIPTION

Fundamentals
Overloadable Operations

"not", "neg", "++", "--", Assignments, Non-mutators with a mutator variant, "int", String, numeric, boolean, and regexp conversions, Iteration, File tests, Matching, Dereferencing, Special

Magic Autogeneration
Special Keys for "use overload"

defined, but FALSE, "undef", TRUE

How Perl Chooses an Operator Implementation
Losing Overloading
Inheritance and Overloading

Method names in the "use overload" directive, Overloading of an operation is inherited by derived classes

Run-time Overloading
Public Functions

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

Overloading Constants

integer, float, binary, q, qr

IMPLEMENTATION
COOKBOOK

Two-face Scalars
Two-face References
Symbolic Calculator
Really Symbolic Calculator

AUTHOR
SEE ALSO
DIAGNOSTICS

Odd number of arguments for overload::constant, ’%s’ is not an overloadable type, ’%s’ is not a code reference, overload arg ’%s’ is invalid

BUGS AND PITFALLS

overloading - perl pragma to lexically control overloading
SYNOPSIS
DESCRIPTION

"no overloading", "no overloading @ops", "use overloading", "use overloading @ops"

parent - Establish an ISA relationship with base classes at compile time
SYNOPSIS
DESCRIPTION
HISTORY
CAVEATS
SEE ALSO

base, parent::versioned

AUTHORS AND CONTRIBUTORS
MAINTAINER
LICENSE

re - Perl pragma to alter regular expression behaviour
SYNOPSIS
DESCRIPTION

’taint’ mode
’eval’ mode
’strict’ mode
’/flags’ mode
’debug’ mode
’Debug’ mode

Compile related options, COMPILE, PARSE, OPTIMISE, TRIEC, DUMP, FLAGS, TEST, Execute related options, EXECUTE, MATCH, TRIEE, INTUIT, Extra debugging options, EXTRA, BUFFERS, TRIEM, STATE, STACK, GPOS, OPTIMISEM, OFFSETS, OFFSETSDBG, DUMP_PRE_OPTIMIZE, WILDCARD, Other useful flags, ALL, All, MORE, More

Exportable Functions

is_regexp($ref), regexp_pattern($ref), regmust($ref), regname($name,$all), regnames($all), regnames_count()

SEE ALSO

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

sort - perl pragma to control sort() behaviour
SYNOPSIS
DESCRIPTION
CAVEATS

strict - Perl pragma to restrict unsafe constructs
SYNOPSIS
DESCRIPTION

"strict refs", "strict vars", "strict subs"

HISTORY

subs - Perl pragma to predeclare subroutine names
SYNOPSIS
DESCRIPTION

threads - Perl interpreter-based threads
VERSION
WARNING
SYNOPSIS
DESCRIPTION

$thr = threads->create( FUNCTION, ARGS ), $thr->join(), $thr->detach(), threads->detach(), threads->self(), $thr->tid(), threads->tid(), "$thr", threads->object($tid), threads->yield(), threads->list(), threads->list(threads::all), threads->list(threads::running), threads->list(threads::joinable), $thr1->equal($thr2), async BLOCK ;, $thr->error(), $thr->_handle(), threads->_handle()

EXITING A THREAD

threads->exit(), threads->exit(status), die(), exit(status), use threads ’exit’ => ’threads_only’, threads->create({’exit’ => ’thread_only’}, ...), $thr->set_thread_exit_only(boolean), threads->set_thread_exit_only(boolean)

THREAD STATE

$thr->is_running(), $thr->is_joinable(), $thr->is_detached(), threads->is_detached()

THREAD CONTEXT

Explicit context
Implicit context
$thr->wantarray()
threads->wantarray()

THREAD STACK SIZE

threads->get_stack_size();, $size = $thr->get_stack_size();, $old_size = threads->set_stack_size($new_size);, use threads (’stack_size’ => VALUE );, $ENV{’ PERL5_ITHREADS_STACK_SIZE ’}, threads->create({’stack_size’ => VALUE }, FUNCTION, ARGS ), $thr2 = $thr1->create( FUNCTION, ARGS )

THREAD SIGNALLING

$thr->kill(’ SIG... ’);

WARNINGS

Perl exited with active threads:, Thread creation failed: pthread_create returned #, Thread # terminated abnormally: .., Using minimum thread stack size of #, Thread creation failed: pthread_attr_setstacksize( SIZE ) returned 22

ERRORS

This Perl not built to support threads, Cannot change stack size of an existing thread, Cannot signal threads without safe signals, Unrecognized signal name: ..

BUGS AND LIMITATIONS

Thread-safe modules, Using non-thread-safe modules, Memory consumption, Current working directory, Locales, Environment variables, Catching signals, Parent-child threads, Unsafe signals, Perl has been built with "PERL_OLD_SIGNALS" (see "perl -V"), The environment variable "PERL_SIGNALS" is set to "unsafe" (see " PERL_SIGNALS" in perlrun), The module Perl::Unsafe::Signals is used, Identity of objects returned from threads, Returning blessed objects from threads, END blocks in threads, Open directory handles, Detached threads and global destruction, Perl Bugs and the CPAN Version of threads

REQUIREMENTS
SEE ALSO
AUTHOR
LICENSE
ACKNOWLEDGEMENTS

threads::shared - Perl extension for sharing data structures between threads
VERSION
SYNOPSIS
DESCRIPTION
EXPORT
FUNCTIONS

share VARIABLE, shared_clone REF, is_shared VARIABLE, lock VARIABLE, cond_wait VARIABLE, cond_wait CONDVAR, LOCKVAR, cond_timedwait VARIABLE, ABS_TIMEOUT, cond_timedwait CONDVAR, ABS_TIMEOUT, LOCKVAR, cond_signal VARIABLE, cond_broadcast VARIABLE

OBJECTS
NOTES
WARNINGS

cond_broadcast() called on unlocked variable, cond_signal() called on unlocked variable

BUGS AND LIMITATIONS
SEE ALSO
AUTHOR
LICENSE

utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code
SYNOPSIS
DESCRIPTION

Utility functions

"$num_octets = utf8::upgrade($string)", "$success = utf8::downgrade($string[, $fail_ok])", "utf8::encode($string)", "$success = utf8::decode($string)", "$unicode = utf8::native_to_unicode($code_point)", "$native = utf8::unicode_to_native($code_point)", "$flag = utf8::is_utf8($string)", "$flag = utf8::valid($string)"

BUGS
SEE ALSO

vars - Perl pragma to predeclare global variable names
SYNOPSIS
DESCRIPTION

version - Perl extension for Version Objects
SYNOPSIS
DESCRIPTION
TYPES OF VERSION OBJECTS

Decimal Versions, Dotted Decimal Versions

DECLARING VERSIONS

How to convert a module from decimal to dotted-decimal
How to "declare()" a dotted-decimal version

PARSING AND COMPARING VERSIONS

How to "parse()" a version
How to check for a legal version string

"is_lax()", "is_strict()"

How to compare version objects

OBJECT METHODS

is_alpha()
is_qv()
normal()
numify()
stringify()

EXPORTED FUNCTIONS

qv()
is_lax()
is_strict()

AUTHOR
SEE ALSO

version::Internals - Perl extension for Version Objects
DESCRIPTION
WHAT IS A VERSION ?

Decimal versions, Dotted-Decimal versions
Decimal Versions
Dotted-Decimal Versions
Alpha Versions
Regular Expressions for Version Parsing

$version::LAX, $version::STRICT, v1.234.5

IMPLEMENTATION DETAILS

Equivalence between Decimal and Dotted-Decimal Versions
Quoting Rules
What about v-strings?
Version Object Internals

original, qv, alpha, version

Replacement UNIVERSAL::VERSION

USAGE DETAILS

Using modules that use version.pm

Decimal versions always work, Dotted-Decimal version work sometimes

Object Methods

new(), qv(), Normal Form, Numification, Stringification, Comparison operators, Logical Operators

AUTHOR
SEE ALSO

vmsish - Perl pragma to control VMS-specific language features
SYNOPSIS
DESCRIPTION

"vmsish status", "vmsish exit", "vmsish time", "vmsish hushed"

warnings - Perl pragma to control optional warnings
SYNOPSIS
DESCRIPTION

Default Warnings and Optional Warnings
What’s wrong with -w and $^W
Controlling Warnings from the Command Line

-w , -W , -X

Backward Compatibility
Category Hierarchy
Fatal Warnings
Reporting Warnings from a Module

FUNCTIONS

use warnings::register, warnings::enabled(), warnings::enabled($category), warnings::enabled($object), warnings::enabled_at_level($category, $level), warnings::fatal_enabled(), warnings::fatal_enabled($category), warnings::fatal_enabled($object), warnings::fatal_enabled_at_level($category, $level), warnings::warn($message), warnings::warn($category, $message), warnings::warn($object, $message), warnings::warn_at_level($category, $level, $message), warnings::warnif($message), warnings::warnif($category, $message), warnings::warnif($object, $message), warnings::warnif_at_level($category, $level, $message), warnings::register_categories(@names)

warnings::register - warnings import function
SYNOPSIS
DESCRIPTION

MODULE DOCUMENTATION

AnyDBM_File - provide framework for multiple DBMs
SYNOPSIS
DESCRIPTION

DBM Comparisons

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

SEE ALSO

App::Cpan - easily interact with CPAN from the command line
SYNOPSIS
DESCRIPTION

Options

-a, -A module [ module ... ], -c module, -C module [ module ... ], -D module [ module ... ], -f, -F, -g module [ module ... ], -G module [ module ... ], -h, -i module [ module ... ], -I, -j Config.pm, -J, -l, -L author [ author ... ], -m, -M mirror1,mirror2,.., -n, -O, -p, -P, -r, -s, -t module [ module ... ], -T, -u, -v, -V, -w, -x module [ module ... ], -X

Examples
Environment variables

NONINTERACTIVE_TESTING, PERL_MM_USE_DEFAULT, CPAN_OPTS, CPANSCRIPT_LOGLEVEL, GIT_COMMAND

Methods

run()
EXIT VALUES
TO DO
BUGS
SEE ALSO
SOURCE AVAILABILITY
CREDITS
AUTHOR
COPYRIGHT

App::Prove - Implements the "prove" command.
VERSION
DESCRIPTION
SYNOPSIS
METHODS

Class Methods

Attributes

"archive", "argv", "backwards", "blib", "color", "directives", "dry", "exec", "extensions", "failures", "comments", "formatter", "harness", "ignore_exit", "includes", "jobs", "lib", "merge", "modules", "parse", "plugins", "quiet", "really_quiet", "recurse", "rules", "show_count", "show_help", "show_man", "show_version", "shuffle", "state", "state_class", "taint_fail", "taint_warn", "test_args", "timer", "verbose", "warnings_fail", "warnings_warn", "tapversion", "trap"

PLUGINS

Sample Plugin

SEE ALSO

App::Prove::State - State storage for the "prove" command.
VERSION
DESCRIPTION
SYNOPSIS
METHODS

Class Methods

"store", "extensions" (optional), "result_class" (optional)

"result_class"
"extensions"
"results"
"commit"
Instance Methods

"last", "failed", "passed", "all", "hot", "todo", "slow", "fast", "new", "old", "save"

App::Prove::State::Result - Individual test suite results.
VERSION
DESCRIPTION
SYNOPSIS
METHODS

Class Methods

"state_version"
"test_class"

App::Prove::State::Result::Test - Individual test results.
VERSION
DESCRIPTION
SYNOPSIS
METHODS

Class Methods

Instance Methods

Archive::Tar - module for manipulations of tar archives
SYNOPSIS
DESCRIPTION
Object Methods

Archive::Tar->new( [$file, $compressed] )

$tar->read ( $filename|$handle, [$compressed, {opt => ’val’}] )

limit, filter, md5, extract

$tar->contains_file( $filename )
$tar->extract( [@filenames] )
$tar->extract_file( $file, [$extract_path] )
$tar->list_files( [\@properties] )
$tar->get_files( [@filenames] )
$tar->get_content( $file )
$tar->replace_content( $file, $content )
$tar->rename( $file, $new_name )
$tar->chmod( $file, $mode )
$tar->chown( $file, $uname [, $gname] )
$tar->remove (@filenamelist)
$tar->clear
$tar->write ( [$file, $compressed, $prefix] )
$tar->add_files( @filenamelist )
$tar->add_data ( $filename, $data, [$opthashref] )

FILE, HARDLINK, SYMLINK, CHARDEV, BLOCKDEV, DIR, FIFO, SOCKET

$tar->error( [$BOOL] )
$tar->setcwd( $cwd );
Class Methods

Archive::Tar->create_archive($file, $compressed, @filelist)

Archive::Tar->iter( $filename, [ $compressed, {opt => $val} ] )
Archive::Tar->list_archive($file, $compressed, [\@properties])
Archive::Tar->extract_archive($file, $compressed)
$bool = Archive::Tar->has_io_string
$bool = Archive::Tar->has_perlio
$bool = Archive::Tar->has_zlib_support
$bool = Archive::Tar->has_bzip2_support
$bool = Archive::Tar->has_xz_support
Archive::Tar->can_handle_compressed_files
GLOBAL VARIABLES

$Archive::Tar::FOLLOW_SYMLINK
$Archive::Tar::CHOWN
$Archive::Tar::CHMOD
$Archive::Tar::SAME_PERMISSIONS
$Archive::Tar::DO_NOT_USE_PREFIX
$Archive::Tar::DEBUG
$Archive::Tar::WARN
$Archive::Tar::error
$Archive::Tar::INSECURE_EXTRACT_MODE
$Archive::Tar::HAS_PERLIO
$Archive::Tar::HAS_IO_STRING
$Archive::Tar::ZERO_PAD_NUMBERS
Tuning the way RESOLVE_SYMLINK will works

FAQ

What’s the minimum perl version required to run Archive::Tar?, Isn’t Archive::Tar slow?, Isn’t Archive::Tar heavier on memory than /bin/tar?, Can you lazy-load data instead?, How much memory will an X kb tar file need?, What do you do with unsupported filetypes in an archive?, I’m using WinZip, or some other non-POSIX client, and files are not being extracted properly!, How do I extract only files that have property X from an archive?, How do I access .tar.Z files?, How do I handle Unicode strings?

CAVEATS
TODO

Check if passed in handles are open for read/write, Allow archives to be passed in as string, Facilitate processing an opened filehandle of a compressed archive

SEE ALSO

The GNU tar specification, The PAX format specification, A comparison of GNU and POSIX tar standards; "http://www.delorie.com/gnu/docs/tar/tar_114.html";, GNU tar intends to switch to POSIX compatibility, A Comparison between various tar implementations

AUTHOR
ACKNOWLEDGEMENTS
COPYRIGHT

Archive::Tar::File - a subclass for in-memory extracted file from Archive::Tar
SYNOPSIS
DESCRIPTION

Accessors

name, mode, uid, gid, size, mtime, chksum, type, linkname, magic, version, uname, gname, devmajor, devminor, prefix, raw

Methods

Archive::Tar::File->new( file => $path )
Archive::Tar::File->new( data => $path, $data, $opt )
Archive::Tar::File->new( chunk => $chunk )

$bool = $file->extract( [ $alternative_name ] )
$path = $file->full_path
$bool = $file->validate
$bool = $file->has_content
$content = $file->get_content
$cref = $file->get_content_by_ref
$bool = $file->replace_content( $content )
$bool = $file->rename( $new_name )
$bool = $file->chmod $mode)
$bool = $file->chown( $user [, $group])
Convenience methods

$file->is_file, $file->is_dir, $file->is_hardlink, $file->is_symlink, $file->is_chardev, $file->is_blockdev, $file->is_fifo, $file->is_socket, $file->is_longlink, $file->is_label, $file->is_unknown

Attribute::Handlers - Simpler definition of attribute handlers
VERSION
SYNOPSIS
DESCRIPTION

[0], [1], [2], [3], [4], [5], [6], [7]
Typed lexicals
Type-specific attribute handlers
Non-interpretive attribute handlers
Phase-specific attribute handlers
Attributes as "tie" interfaces

EXAMPLES
UTILITY FUNCTIONS

findsym

DIAGNOSTICS

"Bad attribute type: ATTR(%s)", "Attribute handler %s doesn't handle %s attributes", "Declaration of %s attribute in package %s may clash with future reserved word", "Can't have two ATTR specifiers on one subroutine", "Can't autotie a %s", "Internal error: %s symbol went missing", "Won't be able to apply END handler"

AUTHOR
BUGS
COPYRIGHT AND LICENSE

AutoLoader - load subroutines only on demand
SYNOPSIS
DESCRIPTION

Subroutine Stubs
Using AutoLoader’s AUTOLOAD Subroutine
Overriding AutoLoader’s AUTOLOAD Subroutine
Package Lexicals
Not Using AutoLoader
AutoLoader vs. SelfLoader
Forcing AutoLoader to Load a Function

CAVEATS
SEE ALSO
AUTHOR
COPYRIGHT AND LICENSE

AutoSplit - split a package for autoloading
SYNOPSIS
DESCRIPTION

$keep, $check, $modtime
Multiple packages

DIAGNOSTICS
AUTHOR
COPYRIGHT AND LICENSE

B - The Perl Compiler Backend
SYNOPSIS
DESCRIPTION
OVERVIEW
Utility Functions

Functions Returning "B::SV", "B::AV", "B::HV", and "B::CV" objects

sv_undef, sv_yes, sv_no, svref_2object( SVREF ), amagic_generation, init_av, check_av, unitcheck_av, begin_av, end_av, comppadlist, regex_padav, main_cv

Functions for Examining the Symbol Table

walksymtable( SYMREF, METHOD, RECURSE, PREFIX )

Functions Returning "B::OP" objects or for walking op trees

main_root, main_start, walkoptree( OP, METHOD ), walkoptree_debug( DEBUG )

Miscellaneous Utility Functions

ppname( OPNUM ), hash( STR ), cast_I32(I), minus_c, cstring( STR ), perlstring( STR ), safename( STR ), class( OBJ ), threadsv_names

Exported utility variables

@optype, @specialsv_name

OVERVIEW OF CLASSES

SV-RELATED CLASSES
B::SV Methods

REFCNT, FLAGS, object_2svref

B::IV Methods

IV, IVX, UVX, int_value, needs64bits, packiv

B::NV Methods

NV, NVX, COP_SEQ_RANGE_LOW, COP_SEQ_RANGE_HIGH

B::RV Methods

B::PV Methods

PV, RV, PVX, CUR, LEN

B::PVMG Methods

MAGIC, SvSTASH

B::MAGIC Methods

MOREMAGIC, precomp, PRIVATE, TYPE, FLAGS, OBJ, PTR, REGEX

B::PVLV Methods

TARGOFF, TARGLEN, TYPE, TARG

B::BM Methods

USEFUL, PREVIOUS, RARE, TABLE

B::REGEXP Methods

REGEX, precomp, qr_anoncv, compflags

B::GV Methods

is_empty, NAME, SAFENAME, STASH, SV, IO, FORM, AV, HV, EGV, CV, CVGEN, LINE, FILE, FILEGV, GvREFCNT, FLAGS, GPFLAGS

B::IO Methods

LINES, PAGE, PAGE_LEN, LINES_LEFT, TOP_NAME, TOP_GV, FMT_NAME, FMT_GV, BOTTOM_NAME, BOTTOM_GV, SUBPROCESS, IoTYPE, IoFLAGS, IsSTD

B::AV Methods

FILL, MAX, ARRAY, ARRAYelt

B::CV Methods

STASH, START, ROOT, GV, FILE, DEPTH, PADLIST, OUTSIDE, OUTSIDE_SEQ, XSUB, XSUBANY, CvFLAGS, const_sv, NAME_HEK

B::HV Methods

FILL, MAX, KEYS, RITER, NAME, ARRAY

OP-RELATED CLASSES
B::OP Methods

next, sibling, parent, name, ppaddr, desc, targ, type, opt, flags, private, spare

B::UNOP Method

first

B::UNOP_AUX Methods (since 5.22)

aux_list(cv), string(cv)

B::BINOP Method

last

B::LOGOP Method

other

B::LISTOP Method

children

B::PMOP Methods

pmreplroot, pmreplstart, pmflags, precomp, pmoffset, code_list, pmregexp

B::SVOP Methods

sv, gv

B::PADOP Method

padix

B::PVOP Method

B::LOOP Methods

redoop, nextop, lastop

B::COP Methods

label, stash, stashpv, stashoff (threaded only), file, cop_seq, line, warnings, io, hints, hints_hash

B::METHOP Methods (Since Perl 5.22)

first, meth_sv

PAD-RELATED CLASSES
B::PADLIST Methods

MAX, ARRAY, ARRAYelt, NAMES, REFCNT, id, outid

B::PADNAMELIST Methods

MAX, ARRAY, ARRAYelt, REFCNT

B::PADNAME Methods

PV, PVX, LEN, REFCNT, FLAGS, TYPE, SvSTASH, OURSTASH, PROTOCV, COP_SEQ_RANGE_LOW, COP_SEQ_RANGE_HIGH, PARENT_PAD_INDEX, PARENT_FAKELEX_FLAGS

$B::overlay

AUTHOR

B::Concise - Walk Perl syntax tree, printing concise info about ops
SYNOPSIS
DESCRIPTION
EXAMPLE
OPTIONS

Options for Opcode Ordering

-basic, -exec, -tree

Options for Line-Style

-concise, -terse, -linenoise, -debug, -env

Options for tree-specific formatting

-compact, -loose, -vt, -ascii

Options controlling sequence numbering

-basen, -bigendian, -littleendian

Other options

-src, -stash="somepackage", -main, -nomain, -nobanner, -banner, -banneris => subref

Option Stickiness

ABBREVIATIONS

OP class abbreviations
OP flags abbreviations

FORMATTING SPECIFICATIONS

Special Patterns

(x(exec_text;basic_text)x), (*(text)*), (*(text1;text2)*), (?(text1#varText2)?), ~

# Variables

#var, #varN, #Var, #addr, #arg, #class, #classsym, #coplabel, #exname, #extarg, #firstaddr, #flags, #flagval, #hints, #hintsval, #hyphseq, #label, #lastaddr, #name, #NAME, #next, #nextaddr, #noise, #private, #privval, #seq, #opt, #sibaddr, #svaddr, #svclass, #svval, #targ, #targarg, #targarglife, #typenum

One-Liner Command tips

perl -MO=Concise,bar foo.pl, perl -MDigest::MD5=md5 -MO=Concise,md5 -e1, perl -MPOSIX -MO=Concise,_POSIX_ARG_MAX -e1, perl -MPOSIX -MO=Concise,a -e ’print _POSIX_SAVED_IDS’, perl -MPOSIX -MO=Concise,a -e ’sub a{_POSIX_SAVED_IDS}’, perl -MB::Concise -e ’B::Concise::compile("-exec","-src", \%B::Concise::)->()’

Using B::Concise outside of the O framework

Example: Altering Concise Renderings
set_style()
set_style_standard($name)
add_style ()
add_callback ()
Running B::Concise::compile()
B::Concise::reset_sequence()
Errors

AUTHOR

B::Deparse - Perl compiler backend to produce perl code
SYNOPSIS
DESCRIPTION
OPTIONS

-d, -f FILE , -l, -p, -P, -q, -s LETTERS , C, i NUMBER , T, v STRING ., -x LEVEL

USING B::Deparse AS A MODULE

Synopsis
Description

new

ambient_pragmas

strict, $[, bytes, utf8, integer, re, warnings, hint_bits, warning_bits, %^H

coderef2text

BUGS
AUTHOR

B::Op_private - OP op_private flag definitions
SYNOPSIS
DESCRIPTION

%bits
%defines
%labels
%ops_using

B::Showlex - Show lexical variables used in functions or files
SYNOPSIS
DESCRIPTION
EXAMPLES

OPTIONS

SEE ALSO
HISTORY

March 14, 2003 (Pi day), May 8, 2003, November 13, 2003, November 16, 2003, December 9, 2003, December 15, 2003, July 26, 2005, August 23, 2005

CPAN::Meta::History::Meta_1_3 - Version 1.3 metadata specification for META .yml
PREFACE
SYNOPSIS
DESCRIPTION
FORMAT
TERMINOLOGY

distribution, module

HEADER
FIELDS

meta-spec
name
version
abstract
author
license

apache, artistic, bsd, gpl, lgpl, mit, mozilla, open_source, perl, restrictive, unrestricted

distribution_type
requires
recommends
build_requires
conflicts
dynamic_config
private
provides
no_index
keywords
resources

homepage, license, bugtracker

generated_by

VERSION SPECIFICATIONS
SEE ALSO
HISTORY

March 14, 2003 (Pi day), May 8, 2003, November 13, 2003, November 16, 2003, December 9, 2003, December 15, 2003, July 26, 2005, August 23, 2005

CPAN::Meta::History::Meta_1_4 - Version 1.4 metadata specification for META .yml
PREFACE
SYNOPSIS
DESCRIPTION
FORMAT
TERMINOLOGY

distribution, module

HEADER
FIELDS

meta-spec
name
version
abstract
author
license

apache, artistic, bsd, gpl, lgpl, mit, mozilla, open_source, perl, restrictive, unrestricted

distribution_type
requires
recommends
build_requires
configure_requires
conflicts
dynamic_config
private
provides
no_index
keywords
resources

homepage, license, bugtracker

generated_by

VERSION SPECIFICATIONS
SEE ALSO
HISTORY

March 14, 2003 (Pi day), May 8, 2003, November 13, 2003, November 16, 2003, December 9, 2003, December 15, 2003, July 26, 2005, August 23, 2005, June 12, 2007

CPAN::Meta::Merge - Merging CPAN Meta fragments
VERSION
SYNOPSIS
DESCRIPTION
METHODS

new

merge(@fragments)

MERGE STRATEGIES

identical, set_addition, uniq_map, improvise

AUTHORS
COPYRIGHT AND LICENSE

CPAN::Meta::Prereqs - a set of distribution prerequisites by phase and type
VERSION
DESCRIPTION
METHODS

new

requirements_for
phases
types_in
with_merged_prereqs
merged_requirements
as_string_hash
is_finalized
finalize
clone

BUGS
AUTHORS
COPYRIGHT AND LICENSE

CPAN::Meta::Requirements - a set of version requirements for a CPAN dist
VERSION
SYNOPSIS
DESCRIPTION
METHODS

new

add_minimum
add_maximum
add_exclusion
exact_version
add_requirements
accepts_module
clear_requirement
requirements_for_module
structured_requirements_for_module
required_modules
clone
is_simple
is_finalized
finalize
as_string_hash
add_string_requirement

>= 1.3, <= 1.3, != 1.3, > 1.3, < 1.3, >= 1.3, != 1.5, <= 2.0

from_string_hash

SUPPORT

Bugs / Feature Requests
Source Code

AUTHORS
CONTRIBUTORS
COPYRIGHT AND LICENSE

CPAN::Meta::Spec - specification for CPAN distribution metadata
VERSION
SYNOPSIS
DESCRIPTION
TERMINOLOGY

distribution, module, package, consumer, producer, must, should, may, etc

DATA TYPES

Boolean
String
List

Map

License String

URL

Version
Version Range

STRUCTURE

REQUIRED FIELDS

version, url, stable, testing, unstable

OPTIONAL FIELDS

file, directory, package, namespace, description, prereqs, file, version, homepage, license, bugtracker, repository

DEPRECATED FIELDS

VERSION NUMBERS

Version Formats

Decimal versions, Dotted-integer versions

Version Ranges

PREREQUISITES

Prereq Spec

configure, build, test, runtime, develop, requires, recommends, suggests, conflicts

Merging and Resolving Prerequisites

SERIALIZATION
NOTES FOR IMPLEMENTORS

Extracting Version Numbers from Perl Modules
Comparing Version Numbers
Prerequisites for dynamically configured distributions
Indexing distributions a la PAUSE

SEE ALSO
HISTORY
AUTHORS
COPYRIGHT AND LICENSE

CPAN::Meta::Validator - validate CPAN distribution metadata structures
VERSION
SYNOPSIS
DESCRIPTION
METHODS

new

is_valid
errors
Check Methods
Validator Methods

BUGS
AUTHORS
COPYRIGHT AND LICENSE

CPAN::Meta::YAML - Read and write a subset of YAML for CPAN Meta files
VERSION
SYNOPSIS
DESCRIPTION
SUPPORT
SEE ALSO
AUTHORS
COPYRIGHT AND LICENSE
SYNOPSIS
DESCRIPTION

new( LOCAL_FILE_NAME )

continents()

countries( [ CONTINENTS ] )

mirrors( [ COUNTRIES ] )

get_mirrors_by_countries( [ COUNTRIES ] )

get_mirrors_by_continents( [ CONTINENTS ] )

get_countries_by_continents( [ CONTINENTS ] )

default_mirror

best_mirrors

get_n_random_mirrors_by_continents( N, [ CONTINENTS ] )

get_mirrors_timings( MIRROR_LIST, SEEN, CALLBACK, %ARGS );

find_best_continents( HASH_REF );
AUTHOR
LICENSE

CPAN::Nox - Wrapper around CPAN .pm without using any XS module
SYNOPSIS
DESCRIPTION
LICENSE
SEE ALSO

CPAN::Plugin - Base class for CPAN shell extensions
SYNOPSIS
DESCRIPTION

Alpha Status
How Plugins work?

METHODS

plugin_requires
distribution_object
distribution
distribution_info
build_dir
is_xs

AUTHOR

CPAN::Plugin::Specfile - Proof of concept implementation of a trivial CPAN::Plugin
SYNOPSIS
DESCRIPTION

OPTIONS

AUTHOR

CPAN::Queue - internal queue support for CPAN .pm
LICENSE

CPAN::Tarzip - internal handling of tar archives for CPAN .pm
LICENSE

CPAN::Version - utility functions to compare CPAN versions
SYNOPSIS
DESCRIPTION
LICENSE

Carp - alternative warn and die for modules
SYNOPSIS
DESCRIPTION

Forcing a Stack Trace
Stack Trace formatting

GLOBAL VARIABLES

$Carp::MaxEvalLen
$Carp::MaxArgLen
$Carp::MaxArgNums
$Carp::Verbose
$Carp::RefArgFormatter
@CARP_NOT
%Carp::Internal
%Carp::CarpInternal
$Carp::CarpLevel

BUGS
SEE ALSO
CONTRIBUTING
AUTHOR
COPYRIGHT
LICENSE

Class::Struct - declare struct-like datatypes as Perl classes
SYNOPSIS
DESCRIPTION

The "struct()" function
Class Creation at Compile Time
Element Types and Accessor Methods

Scalar ('$' or '*$'), Array ('@' or '*@'), Hash ('%' or '*%'), Class ('Class_Name' or '*Class_Name')

Initializing with "new"

EXAMPLES

Example 1, Example 2, Example 3

Author and Modification History

Compress::Raw::Bzip2 - Low-Level Interface to bzip2 compression library
SYNOPSIS
DESCRIPTION
Compression

($z, $status) = new Compress::Raw::Bzip2 $appendOutput,
$blockSize100k, $workfactor;

$appendOutput, $blockSize100k, $workfactor

$status = $bz->bzdeflate($input, $output);
$status = $bz->bzflush($output);
$status = $bz->bzclose($output);
Example

Uncompression

($z, $status) = new Compress::Raw::Bunzip2 $appendOutput,
$consumeInput, $small, $verbosity, $limitOutput;

$appendOutput, $consumeInput, $small, $limitOutput, $verbosity

$status = $z->bzinflate($input, $output);

Misc

my $version = Compress::Raw::Bzip2::bzlibversion();

Constants
SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

Compress::Raw::Zlib - Low-Level Interface to zlib compression library
SYNOPSIS
DESCRIPTION
Compress::Raw::Zlib::Deflate

($d, $status) = new Compress::Raw::Zlib::Deflate( [ OPT ] )

-Level, -Method, -WindowBits, -MemLevel, -Strategy, -Dictionary, -Bufsize, -AppendOutput, -CRC32, -ADLER32

$status = $d->deflate($input, $output)
$status = $d->flush($output [, $flush_type])
$status = $d->deflateReset()
$status = $d->deflateParams([ OPT ])

-Level, -Strategy, -BufSize

$status = $d->deflateTune($good_length, $max_lazy, $nice_length,
$max_chain)
$d->dict_adler()
$d->crc32()
$d->adler32()
$d->msg()
$d->total_in()
$d->total_out()
$d->get_Strategy()
$d->get_Level()
$d->get_BufSize()
Example

Compress::Raw::Zlib::Inflate

($i, $status) = new Compress::Raw::Zlib::Inflate( [ OPT ] )

-WindowBits, -Bufsize, -Dictionary, -AppendOutput, -CRC32, -ADLER32, -ConsumeInput, -LimitOutput

$status = $i->inflate($input, $output [,$eof])
$status = $i->inflateSync($input)
$status = $i->inflateReset()
$i->dict_adler()
$i->crc32()
$i->adler32()
$i->msg()
$i->total_in()
$i->total_out()
$d->get_BufSize()
Examples

CHECKSUM FUNCTIONS
Misc

my $version = Compress::Raw::Zlib::zlib_version();
my $flags = Compress::Raw::Zlib::zlibCompileFlags();

The LimitOutput option.
ACCESSING ZIP FILES

FAQ

Compatibility with Unix compress/uncompress.

Accessing .tar.Z files
Zlib Library Version Support

CONSTANTS
SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

Compress::Zlib - Interface to zlib compression library
SYNOPSIS
DESCRIPTION

Notes for users of Compress::Zlib version 1

GZIP INTERFACE

$gz = gzopen($filename, $mode), $gz = gzopen($filehandle, $mode), $bytesread = $gz->gzread($buffer [, $size]) ;, $bytesread = $gz->gzreadline($line) ;, $byteswritten = $gz->gzwrite($buffer) ;, $status = $gz->gzflush($flush_type) ;, $offset = $gz->gztell() ;, $status = $gz->gzseek($offset, $whence) ;, $gz->gzclose, $gz->gzsetparams($level, $strategy, $level, $strategy, $gz->gzerror, $gzerrno
Examples
Compress::Zlib::memGzip
Compress::Zlib::memGunzip

COMPRESS/UNCOMPRESS

$dest = compress($source [, $level] ) ;, $dest = uncompress($source) ;

Deflate Interface

($d, $status) = deflateInit( [ OPT ] )

-Level, -Method, -WindowBits, -MemLevel, -Strategy, -Dictionary, -Bufsize

($out, $status) = $d->deflate($buffer)
($out, $status) = $d->flush() =head2 ($out, $status) =
$d->flush($flush_type)
$status = $d->deflateParams([ OPT ])

-Level, -Strategy

$d->dict_adler()
$d->msg()
$d->total_in()
$d->total_out()
Example

Inflate Interface

($i, $status) = inflateInit()

-WindowBits, -Bufsize, -Dictionary

($out, $status) = $i->inflate($buffer)
$status = $i->inflateSync($buffer)
$i->dict_adler()
$i->msg()
$i->total_in()
$i->total_out()
Example

CHECKSUM FUNCTIONS
Misc

my $version = Compress::Zlib::zlib_version();

CONSTANTS
SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

Config, =for comment Generated by configpm. Any changes made here will be lost!
SYNOPSIS
DESCRIPTION

myconfig(), config_sh(), config_re($regex), config_vars(@names), bincompat_options(), non_bincompat_options(), compile_date(), local_patches(), header_files()

EXAMPLE
WARNING
GLOSSARY

	_		`"_a"`, `"_exe"`, `"_o"`
	a		`"afs"`, `"afsroot"`, `"alignbytes"`, `"aphostname"`, `"api_revision"`, `"api_subversion"`, `"api_version"`, `"api_versionstring"`, `"ar"`, `"archlib"`, `"archlibexp"`, `"archname"`, `"archname64"`, `"archobjs"`, `"asctime_r_proto"`, `"awk"`
	b		`"baserev"`, `"bash"`, `"bin"`, `"bin_ELF"`, `"binexp"`, `"bison"`, `"byacc"`, `"byteorder"`
	c		`"c"`, `"castflags"`, `"cat"`, `"cc"`, `"cccdlflags"`, `"ccdlflags"`, `"ccflags"`, `"ccflags_uselargefiles"`, `"ccname"`, `"ccsymbols"`, `"ccversion"`, `"cf_by"`, `"cf_email"`, `"cf_time"`, `"charbits"`, `"charsize"`, `"chgrp"`, `"chmod"`, `"chown"`, `"clocktype"`, `"comm"`, `"compress"`, `"config_arg0"`, `"config_argc"`, `"config_args"`, `"contains"`, `"cp"`, `"cpio"`, `"cpp"`, `"cpp_stuff"`, `"cppccsymbols"`, `"cppflags"`, `"cpplast"`, `"cppminus"`, `"cpprun"`, `"cppstdin"`, `"cppsymbols"`, `"crypt_r_proto"`, `"cryptlib"`, `"csh"`, `"ctermid_r_proto"`, `"ctime_r_proto"`
	d		`"d__fwalk"`, `"d_accept4"`, `"d_access"`, `"d_accessx"`, `"d_acosh"`, `"d_aintl"`, `"d_alarm"`, `"d_archlib"`, `"d_asctime64"`, `"d_asctime_r"`, `"d_asinh"`, `"d_atanh"`, `"d_atolf"`, `"d_atoll"`, `"d_attribute_deprecated"`, `"d_attribute_format"`, `"d_attribute_malloc"`, `"d_attribute_nonnull"`, `"d_attribute_noreturn"`, `"d_attribute_pure"`, `"d_attribute_unused"`, `"d_attribute_warn_unused_result"`, `"d_backtrace"`, `"d_bsd"`, `"d_bsdgetpgrp"`, `"d_bsdsetpgrp"`, `"d_builtin_add_overflow"`, `"d_builtin_choose_expr"`, `"d_builtin_expect"`, `"d_builtin_mul_overflow"`, `"d_builtin_sub_overflow"`, `"d_c99_variadic_macros"`, `"d_casti32"`, `"d_castneg"`, `"d_cbrt"`, `"d_chown"`, `"d_chroot"`, `"d_chsize"`, `"d_class"`, `"d_clearenv"`, `"d_closedir"`, `"d_cmsghdr_s"`, `"d_copysign"`, `"d_copysignl"`, `"d_cplusplus"`, `"d_crypt"`, `"d_crypt_r"`, `"d_csh"`, `"d_ctermid"`, `"d_ctermid_r"`, `"d_ctime64"`, `"d_ctime_r"`, `"d_cuserid"`, `"d_dbminitproto"`, `"d_difftime"`, `"d_difftime64"`, `"d_dir_dd_fd"`, `"d_dirfd"`, `"d_dirnamlen"`, `"d_dladdr"`, `"d_dlerror"`, `"d_dlopen"`, `"d_dlsymun"`, `"d_dosuid"`, `"d_double_has_inf"`, `"d_double_has_nan"`, `"d_double_has_negative_zero"`, `"d_double_has_subnormals"`, `"d_double_style_cray"`, `"d_double_style_ibm"`, `"d_double_style_ieee"`, `"d_double_style_vax"`, `"d_drand48_r"`, `"d_drand48proto"`, `"d_dup2"`, `"d_dup3"`, `"d_duplocale"`, `"d_eaccess"`, `"d_endgrent"`, `"d_endgrent_r"`, `"d_endhent"`, `"d_endhostent_r"`, `"d_endnent"`, `"d_endnetent_r"`, `"d_endpent"`, `"d_endprotoent_r"`, `"d_endpwent"`, `"d_endpwent_r"`, `"d_endsent"`, `"d_endservent_r"`, `"d_eofnblk"`, `"d_erf"`, `"d_erfc"`, `"d_eunice"`, `"d_exp2"`, `"d_expm1"`, `"d_faststdio"`, `"d_fchdir"`, `"d_fchmod"`, `"d_fchmodat"`, `"d_fchown"`, `"d_fcntl"`, `"d_fcntl_can_lock"`, `"d_fd_macros"`, `"d_fd_set"`, `"d_fdclose"`, `"d_fdim"`, `"d_fds_bits"`, `"d_fegetround"`, `"d_fgetpos"`, `"d_finite"`, `"d_finitel"`, `"d_flexfnam"`, `"d_flock"`, `"d_flockproto"`, `"d_fma"`, `"d_fmax"`, `"d_fmin"`, `"d_fork"`, `"d_fp_class"`, `"d_fp_classify"`, `"d_fp_classl"`, `"d_fpathconf"`, `"d_fpclass"`, `"d_fpclassify"`, `"d_fpclassl"`, `"d_fpgetround"`, `"d_fpos64_t"`, `"d_freelocale"`, `"d_frexpl"`, `"d_fs_data_s"`, `"d_fseeko"`, `"d_fsetpos"`, `"d_fstatfs"`, `"d_fstatvfs"`, `"d_fsync"`, `"d_ftello"`, `"d_ftime"`, `"d_futimes"`, `"d_gai_strerror"`, `"d_Gconvert"`, `"d_gdbm_ndbm_h_uses_prototypes"`, `"d_gdbmndbm_h_uses_prototypes"`, `"d_getaddrinfo"`, `"d_getcwd"`, `"d_getespwnam"`, `"d_getfsstat"`, `"d_getgrent"`, `"d_getgrent_r"`, `"d_getgrgid_r"`, `"d_getgrnam_r"`, `"d_getgrps"`, `"d_gethbyaddr"`, `"d_gethbyname"`, `"d_gethent"`, `"d_gethname"`, `"d_gethostbyaddr_r"`, `"d_gethostbyname_r"`, `"d_gethostent_r"`, `"d_gethostprotos"`, `"d_getitimer"`, `"d_getlogin"`, `"d_getlogin_r"`, `"d_getmnt"`, `"d_getmntent"`, `"d_getnameinfo"`, `"d_getnbyaddr"`, `"d_getnbyname"`, `"d_getnent"`, `"d_getnetbyaddr_r"`, `"d_getnetbyname_r"`, `"d_getnetent_r"`, `"d_getnetprotos"`, `"d_getpagsz"`, `"d_getpbyname"`, `"d_getpbynumber"`, `"d_getpent"`, `"d_getpgid"`, `"d_getpgrp"`, `"d_getpgrp2"`, `"d_getppid"`, `"d_getprior"`, `"d_getprotobyname_r"`, `"d_getprotobynumber_r"`, `"d_getprotoent_r"`, `"d_getprotoprotos"`, `"d_getprpwnam"`, `"d_getpwent"`, `"d_getpwent_r"`, `"d_getpwnam_r"`, `"d_getpwuid_r"`, `"d_getsbyname"`, `"d_getsbyport"`, `"d_getsent"`, `"d_getservbyname_r"`, `"d_getservbyport_r"`, `"d_getservent_r"`, `"d_getservprotos"`, `"d_getspnam"`, `"d_getspnam_r"`, `"d_gettimeod"`, `"d_gmtime64"`, `"d_gmtime_r"`, `"d_gnulibc"`, `"d_grpasswd"`, `"d_has_C_UTF8"`, `"d_hasmntopt"`, `"d_htonl"`, `"d_hypot"`, `"d_ilogb"`, `"d_ilogbl"`, `"d_inc_version_list"`, `"d_inetaton"`, `"d_inetntop"`, `"d_inetpton"`, `"d_int64_t"`, `"d_ip_mreq"`, `"d_ip_mreq_source"`, `"d_ipv6_mreq"`, `"d_ipv6_mreq_source"`, `"d_isascii"`, `"d_isblank"`, `"d_isfinite"`, `"d_isfinitel"`, `"d_isinf"`, `"d_isinfl"`, `"d_isless"`, `"d_isnan"`, `"d_isnanl"`, `"d_isnormal"`, `"d_j0"`, `"d_j0l"`, `"d_killpg"`, `"d_lc_monetary_2008"`, `"d_lchown"`, `"d_ldbl_dig"`, `"d_ldexpl"`, `"d_lgamma"`, `"d_lgamma_r"`, `"d_libm_lib_version"`, `"d_libname_unique"`, `"d_link"`, `"d_linkat"`, `"d_llrint"`, `"d_llrintl"`, `"d_llround"`, `"d_llroundl"`, `"d_localeconv_l"`, `"d_localtime64"`, `"d_localtime_r"`, `"d_localtime_r_needs_tzset"`, `"d_locconv"`, `"d_lockf"`, `"d_log1p"`, `"d_log2"`, `"d_logb"`, `"d_long_double_style_ieee"`, `"d_long_double_style_ieee_doubledouble"`, `"d_long_double_style_ieee_extended"`, `"d_long_double_style_ieee_std"`, `"d_long_double_style_vax"`, `"d_longdbl"`, `"d_longlong"`, `"d_lrint"`, `"d_lrintl"`, `"d_lround"`, `"d_lroundl"`, `"d_lseekproto"`, `"d_lstat"`, `"d_madvise"`, `"d_malloc_good_size"`, `"d_malloc_size"`, `"d_mblen"`, `"d_mbrlen"`, `"d_mbrtowc"`, `"d_mbstowcs"`, `"d_mbtowc"`, `"d_memmem"`, `"d_memrchr"`, `"d_mkdir"`, `"d_mkdtemp"`, `"d_mkfifo"`, `"d_mkostemp"`, `"d_mkstemp"`, `"d_mkstemps"`, `"d_mktime"`, `"d_mktime64"`, `"d_mmap"`, `"d_modfl"`, `"d_modflproto"`, `"d_mprotect"`, `"d_msg"`, `"d_msg_ctrunc"`, `"d_msg_dontroute"`, `"d_msg_oob"`, `"d_msg_peek"`, `"d_msg_proxy"`, `"d_msgctl"`, `"d_msgget"`, `"d_msghdr_s"`, `"d_msgrcv"`, `"d_msgsnd"`, `"d_msync"`, `"d_munmap"`, `"d_mymalloc"`, `"d_nan"`, `"d_nanosleep"`, `"d_ndbm"`, `"d_ndbm_h_uses_prototypes"`, `"d_nearbyint"`, `"d_newlocale"`, `"d_nextafter"`, `"d_nexttoward"`, `"d_nice"`, `"d_nl_langinfo"`, `"d_nv_preserves_uv"`, `"d_nv_zero_is_allbits_zero"`, `"d_off64_t"`, `"d_old_pthread_create_joinable"`, `"d_oldpthreads"`, `"d_oldsock"`, `"d_open3"`, `"d_openat"`, `"d_pathconf"`, `"d_pause"`, `"d_perl_otherlibdirs"`, `"d_phostname"`, `"d_pipe"`, `"d_pipe2"`, `"d_poll"`, `"d_portable"`, `"d_prctl"`, `"d_prctl_set_name"`, `"d_PRId64"`, `"d_PRIeldbl"`, `"d_PRIEUldbl"`, `"d_PRIfldbl"`, `"d_PRIFUldbl"`, `"d_PRIgldbl"`, `"d_PRIGUldbl"`, `"d_PRIi64"`, `"d_printf_format_null"`, `"d_PRIo64"`, `"d_PRIu64"`, `"d_PRIx64"`, `"d_PRIXU64"`, `"d_procselfexe"`, `"d_pseudofork"`, `"d_pthread_atfork"`, `"d_pthread_attr_setscope"`, `"d_pthread_yield"`, `"d_ptrdiff_t"`, `"d_pwage"`, `"d_pwchange"`, `"d_pwclass"`, `"d_pwcomment"`, `"d_pwexpire"`, `"d_pwgecos"`, `"d_pwpasswd"`, `"d_pwquota"`, `"d_qgcvt"`, `"d_quad"`, `"d_querylocale"`, `"d_random_r"`, `"d_re_comp"`, `"d_readdir"`, `"d_readdir64_r"`, `"d_readdir_r"`, `"d_readlink"`, `"d_readv"`, `"d_recvmsg"`, `"d_regcmp"`, `"d_regcomp"`, `"d_remainder"`, `"d_remquo"`, `"d_rename"`, `"d_renameat"`, `"d_rewinddir"`, `"d_rint"`, `"d_rmdir"`, `"d_round"`, `"d_sbrkproto"`, `"d_scalbn"`, `"d_scalbnl"`, `"d_sched_yield"`, `"d_scm_rights"`, `"d_SCNfldbl"`, `"d_seekdir"`, `"d_select"`, `"d_sem"`, `"d_semctl"`, `"d_semctl_semid_ds"`, `"d_semctl_semun"`, `"d_semget"`, `"d_semop"`, `"d_sendmsg"`, `"d_setegid"`, `"d_seteuid"`, `"d_setgrent"`, `"d_setgrent_r"`, `"d_setgrps"`, `"d_sethent"`, `"d_sethostent_r"`, `"d_setitimer"`, `"d_setlinebuf"`, `"d_setlocale"`, `"d_setlocale_accepts_any_locale_name"`, `"d_setlocale_r"`, `"d_setnent"`, `"d_setnetent_r"`, `"d_setpent"`, `"d_setpgid"`, `"d_setpgrp"`, `"d_setpgrp2"`, `"d_setprior"`, `"d_setproctitle"`, `"d_setprotoent_r"`, `"d_setpwent"`, `"d_setpwent_r"`, `"d_setregid"`, `"d_setresgid"`, `"d_setresuid"`, `"d_setreuid"`, `"d_setrgid"`, `"d_setruid"`, `"d_setsent"`, `"d_setservent_r"`, `"d_setsid"`, `"d_setvbuf"`, `"d_shm"`, `"d_shmat"`, `"d_shmatprototype"`, `"d_shmctl"`, `"d_shmdt"`, `"d_shmget"`, `"d_sigaction"`, `"d_siginfo_si_addr"`, `"d_siginfo_si_band"`, `"d_siginfo_si_errno"`, `"d_siginfo_si_fd"`, `"d_siginfo_si_pid"`, `"d_siginfo_si_status"`, `"d_siginfo_si_uid"`, `"d_siginfo_si_value"`, `"d_signbit"`, `"d_sigprocmask"`, `"d_sigsetjmp"`, `"d_sin6_scope_id"`, `"d_sitearch"`, `"d_snprintf"`, `"d_sockaddr_in6"`, `"d_sockaddr_sa_len"`, `"d_sockatmark"`, `"d_sockatmarkproto"`, `"d_socket"`, `"d_socklen_t"`, `"d_sockpair"`, `"d_socks5_init"`, `"d_sqrtl"`, `"d_srand48_r"`, `"d_srandom_r"`, `"d_sresgproto"`, `"d_sresuproto"`, `"d_stat"`, `"d_statblks"`, `"d_statfs_f_flags"`, `"d_statfs_s"`, `"d_static_inline"`, `"d_statvfs"`, `"d_stdio_cnt_lval"`, `"d_stdio_ptr_lval"`, `"d_stdio_ptr_lval_nochange_cnt"`, `"d_stdio_ptr_lval_sets_cnt"`, `"d_stdio_stream_array"`, `"d_stdiobase"`, `"d_stdstdio"`, `"d_strcoll"`, `"d_strerror_l"`, `"d_strerror_r"`, `"d_strftime"`, `"d_strlcat"`, `"d_strlcpy"`, `"d_strnlen"`, `"d_strtod"`, `"d_strtod_l"`, `"d_strtol"`, `"d_strtold"`, `"d_strtold_l"`, `"d_strtoll"`, `"d_strtoq"`, `"d_strtoul"`, `"d_strtoull"`, `"d_strtouq"`, `"d_strxfrm"`, `"d_suidsafe"`, `"d_symlink"`, `"d_syscall"`, `"d_syscallproto"`, `"d_sysconf"`, `"d_sysernlst"`, `"d_syserrlst"`, `"d_system"`, `"d_tcgetpgrp"`, `"d_tcsetpgrp"`, `"d_telldir"`, `"d_telldirproto"`, `"d_tgamma"`, `"d_thread_safe_nl_langinfo_l"`, `"d_time"`, `"d_timegm"`, `"d_times"`, `"d_tm_tm_gmtoff"`, `"d_tm_tm_zone"`, `"d_tmpnam_r"`, `"d_towlower"`, `"d_towupper"`, `"d_trunc"`, `"d_truncate"`, `"d_truncl"`, `"d_ttyname_r"`, `"d_tzname"`, `"d_u32align"`, `"d_ualarm"`, `"d_umask"`, `"d_uname"`, `"d_union_semun"`, `"d_unlinkat"`, `"d_unordered"`, `"d_unsetenv"`, `"d_uselocale"`, `"d_usleep"`, `"d_usleepproto"`, `"d_ustat"`, `"d_vendorarch"`, `"d_vendorbin"`, `"d_vendorlib"`, `"d_vendorscript"`, `"d_vfork"`, `"d_void_closedir"`, `"d_voidsig"`, `"d_voidtty"`, `"d_vsnprintf"`, `"d_wait4"`, `"d_waitpid"`, `"d_wcscmp"`, `"d_wcstombs"`, `"d_wcsxfrm"`, `"d_wctomb"`, `"d_writev"`, `"d_xenix"`, `"date"`, `"db_hashtype"`, `"db_prefixtype"`, `"db_version_major"`, `"db_version_minor"`, `"db_version_patch"`, `"default_inc_excludes_dot"`, `"direntrytype"`, `"dlext"`, `"dlsrc"`, `"doubleinfbytes"`, `"doublekind"`, `"doublemantbits"`, `"doublenanbytes"`, `"doublesize"`, `"drand01"`, `"drand48_r_proto"`, `"dtrace"`, `"dtraceobject"`, `"dtracexnolibs"`, `"dynamic_ext"`
	e		`"eagain"`, `"ebcdic"`, `"echo"`, `"egrep"`, `"emacs"`, `"endgrent_r_proto"`, `"endhostent_r_proto"`, `"endnetent_r_proto"`, `"endprotoent_r_proto"`, `"endpwent_r_proto"`, `"endservent_r_proto"`, `"eunicefix"`, `"exe_ext"`, `"expr"`, `"extensions"`, `"extern_C"`, `"extras"`
	f		`"fflushall"`, `"fflushNULL"`, `"find"`, `"firstmakefile"`, `"flex"`, `"fpossize"`, `"fpostype"`, `"freetype"`, `"from"`, `"full_ar"`, `"full_csh"`, `"full_sed"`
	g		`"gccansipedantic"`, `"gccosandvers"`, `"gccversion"`, `"getgrent_r_proto"`, `"getgrgid_r_proto"`, `"getgrnam_r_proto"`, `"gethostbyaddr_r_proto"`, `"gethostbyname_r_proto"`, `"gethostent_r_proto"`, `"getlogin_r_proto"`, `"getnetbyaddr_r_proto"`, `"getnetbyname_r_proto"`, `"getnetent_r_proto"`, `"getprotobyname_r_proto"`, `"getprotobynumber_r_proto"`, `"getprotoent_r_proto"`, `"getpwent_r_proto"`, `"getpwnam_r_proto"`, `"getpwuid_r_proto"`, `"getservbyname_r_proto"`, `"getservbyport_r_proto"`, `"getservent_r_proto"`, `"getspnam_r_proto"`, `"gidformat"`, `"gidsign"`, `"gidsize"`, `"gidtype"`, `"glibpth"`, `"gmake"`, `"gmtime_r_proto"`, `"gnulibc_version"`, `"grep"`, `"groupcat"`, `"groupstype"`, `"gzip"`
	h		`"h_fcntl"`, `"h_sysfile"`, `"hint"`, `"hostcat"`, `"hostgenerate"`, `"hostosname"`, `"hostperl"`, `"html1dir"`, `"html1direxp"`, `"html3dir"`, `"html3direxp"`
	i		`"i16size"`, `"i16type"`, `"i32size"`, `"i32type"`, `"i64size"`, `"i64type"`, `"i8size"`, `"i8type"`, `"i_arpainet"`, `"i_bfd"`, `"i_bsdioctl"`, `"i_crypt"`, `"i_db"`, `"i_dbm"`, `"i_dirent"`, `"i_dlfcn"`, `"i_execinfo"`, `"i_fcntl"`, `"i_fenv"`, `"i_fp"`, `"i_fp_class"`, `"i_gdbm"`, `"i_gdbm_ndbm"`, `"i_gdbmndbm"`, `"i_grp"`, `"i_ieeefp"`, `"i_inttypes"`, `"i_langinfo"`, `"i_libutil"`, `"i_locale"`, `"i_machcthr"`, `"i_malloc"`, `"i_mallocmalloc"`, `"i_mntent"`, `"i_ndbm"`, `"i_netdb"`, `"i_neterrno"`, `"i_netinettcp"`, `"i_niin"`, `"i_poll"`, `"i_prot"`, `"i_pthread"`, `"i_pwd"`, `"i_quadmath"`, `"i_rpcsvcdbm"`, `"i_sgtty"`, `"i_shadow"`, `"i_socks"`, `"i_stdbool"`, `"i_stdint"`, `"i_stdlib"`, `"i_sunmath"`, `"i_sysaccess"`, `"i_sysdir"`, `"i_sysfile"`, `"i_sysfilio"`, `"i_sysin"`, `"i_sysioctl"`, `"i_syslog"`, `"i_sysmman"`, `"i_sysmode"`, `"i_sysmount"`, `"i_sysndir"`, `"i_sysparam"`, `"i_syspoll"`, `"i_sysresrc"`, `"i_syssecrt"`, `"i_sysselct"`, `"i_syssockio"`, `"i_sysstat"`, `"i_sysstatfs"`, `"i_sysstatvfs"`, `"i_systime"`, `"i_systimek"`, `"i_systimes"`, `"i_systypes"`, `"i_sysuio"`, `"i_sysun"`, `"i_sysutsname"`, `"i_sysvfs"`, `"i_syswait"`, `"i_termio"`, `"i_termios"`, `"i_time"`, `"i_unistd"`, `"i_ustat"`, `"i_utime"`, `"i_vfork"`, `"i_wchar"`, `"i_wctype"`, `"i_xlocale"`, `"ignore_versioned_solibs"`, `"inc_version_list"`, `"inc_version_list_init"`, `"incpath"`, `"incpth"`, `"inews"`, `"initialinstalllocation"`, `"installarchlib"`, `"installbin"`, `"installhtml1dir"`, `"installhtml3dir"`, `"installman1dir"`, `"installman3dir"`, `"installprefix"`, `"installprefixexp"`, `"installprivlib"`, `"installscript"`, `"installsitearch"`, `"installsitebin"`, `"installsitehtml1dir"`, `"installsitehtml3dir"`, `"installsitelib"`, `"installsiteman1dir"`, `"installsiteman3dir"`, `"installsitescript"`, `"installstyle"`, `"installusrbinperl"`, `"installvendorarch"`, `"installvendorbin"`, `"installvendorhtml1dir"`, `"installvendorhtml3dir"`, `"installvendorlib"`, `"installvendorman1dir"`, `"installvendorman3dir"`, `"installvendorscript"`, `"intsize"`, `"issymlink"`, `"ivdformat"`, `"ivsize"`, `"ivtype"`
	k		`"known_extensions"`, `"ksh"`
	l		`"ld"`, `"ld_can_script"`, `"lddlflags"`, `"ldflags"`, `"ldflags_uselargefiles"`, `"ldlibpthname"`, `"less"`, `"lib_ext"`, `"libc"`, `"libperl"`, `"libpth"`, `"libs"`, `"libsdirs"`, `"libsfiles"`, `"libsfound"`, `"libspath"`, `"libswanted"`, `"libswanted_uselargefiles"`, `"line"`, `"lint"`, `"lkflags"`, `"ln"`, `"lns"`, `"localtime_r_proto"`, `"locincpth"`, `"loclibpth"`, `"longdblinfbytes"`, `"longdblkind"`, `"longdblmantbits"`, `"longdblnanbytes"`, `"longdblsize"`, `"longlongsize"`, `"longsize"`, `"lp"`, `"lpr"`, `"ls"`, `"lseeksize"`, `"lseektype"`
	m		`"mail"`, `"mailx"`, `"make"`, `"make_set_make"`, `"mallocobj"`, `"mallocsrc"`, `"malloctype"`, `"man1dir"`, `"man1direxp"`, `"man1ext"`, `"man3dir"`, `"man3direxp"`, `"man3ext"`, `"mips_type"`, `"mistrustnm"`, `"mkdir"`, `"mmaptype"`, `"modetype"`, `"more"`, `"multiarch"`, `"mv"`, `"myarchname"`, `"mydomain"`, `"myhostname"`, `"myuname"`
	n		`"n"`, `"need_va_copy"`, `"netdb_hlen_type"`, `"netdb_host_type"`, `"netdb_name_type"`, `"netdb_net_type"`, `"nm"`, `"nm_opt"`, `"nm_so_opt"`, `"nonxs_ext"`, `"nroff"`, `"nv_overflows_integers_at"`, `"nv_preserves_uv_bits"`, `"nveformat"`, `"nvEUformat"`, `"nvfformat"`, `"nvFUformat"`, `"nvgformat"`, `"nvGUformat"`, `"nvmantbits"`, `"nvsize"`, `"nvtype"`
	o		`"o_nonblock"`, `"obj_ext"`, `"old_pthread_create_joinable"`, `"optimize"`, `"orderlib"`, `"osname"`, `"osvers"`, `"otherlibdirs"`
	p		`"package"`, `"pager"`, `"passcat"`, `"patchlevel"`, `"path_sep"`, `"perl"`, `"perl5"`
	P		`"PERL_API_REVISION"`, `"PERL_API_SUBVERSION"`, `"PERL_API_VERSION"`, `"PERL_CONFIG_SH"`, `"PERL_PATCHLEVEL"`, `"perl_patchlevel"`, `"PERL_REVISION"`, `"perl_static_inline"`, `"PERL_SUBVERSION"`, `"PERL_VERSION"`, `"perladmin"`, `"perllibs"`, `"perlpath"`, `"pg"`, `"phostname"`, `"pidtype"`, `"plibpth"`, `"pmake"`, `"pr"`, `"prefix"`, `"prefixexp"`, `"privlib"`, `"privlibexp"`, `"procselfexe"`, `"ptrsize"`
	q		`"quadkind"`, `"quadtype"`
	r		`"randbits"`, `"randfunc"`, `"random_r_proto"`, `"randseedtype"`, `"ranlib"`, `"rd_nodata"`, `"readdir64_r_proto"`, `"readdir_r_proto"`, `"revision"`, `"rm"`, `"rm_try"`, `"rmail"`, `"run"`, `"runnm"`
	s		`"sched_yield"`, `"scriptdir"`, `"scriptdirexp"`, `"sed"`, `"seedfunc"`, `"selectminbits"`, `"selecttype"`, `"sendmail"`, `"setgrent_r_proto"`, `"sethostent_r_proto"`, `"setlocale_r_proto"`, `"setnetent_r_proto"`, `"setprotoent_r_proto"`, `"setpwent_r_proto"`, `"setservent_r_proto"`, `"sGMTIME_max"`, `"sGMTIME_min"`, `"sh"`, `"shar"`, `"sharpbang"`, `"shmattype"`, `"shortsize"`, `"shrpenv"`, `"shsharp"`, `"sig_count"`, `"sig_name"`, `"sig_name_init"`, `"sig_num"`, `"sig_num_init"`, `"sig_size"`, `"signal_t"`, `"sitearch"`, `"sitearchexp"`, `"sitebin"`, `"sitebinexp"`, `"sitehtml1dir"`, `"sitehtml1direxp"`, `"sitehtml3dir"`, `"sitehtml3direxp"`, `"sitelib"`, `"sitelib_stem"`, `"sitelibexp"`, `"siteman1dir"`, `"siteman1direxp"`, `"siteman3dir"`, `"siteman3direxp"`, `"siteprefix"`, `"siteprefixexp"`, `"sitescript"`, `"sitescriptexp"`, `"sizesize"`, `"sizetype"`, `"sleep"`, `"sLOCALTIME_max"`, `"sLOCALTIME_min"`, `"smail"`, `"so"`, `"sockethdr"`, `"socketlib"`, `"socksizetype"`, `"sort"`, `"spackage"`, `"spitshell"`, `"sPRId64"`, `"sPRIeldbl"`, `"sPRIEUldbl"`, `"sPRIfldbl"`, `"sPRIFUldbl"`, `"sPRIgldbl"`, `"sPRIGUldbl"`, `"sPRIi64"`, `"sPRIo64"`, `"sPRIu64"`, `"sPRIx64"`, `"sPRIXU64"`, `"srand48_r_proto"`, `"srandom_r_proto"`, `"src"`, `"sSCNfldbl"`, `"ssizetype"`, `"st_ino_sign"`, `"st_ino_size"`, `"startperl"`, `"startsh"`, `"static_ext"`, `"stdchar"`, `"stdio_base"`, `"stdio_bufsiz"`, `"stdio_cnt"`, `"stdio_filbuf"`, `"stdio_ptr"`, `"stdio_stream_array"`, `"strerror_r_proto"`, `"submit"`, `"subversion"`, `"sysman"`, `"sysroot"`
	t		`"tail"`, `"tar"`, `"targetarch"`, `"targetdir"`, `"targetenv"`, `"targethost"`, `"targetmkdir"`, `"targetport"`, `"targetsh"`, `"tbl"`, `"tee"`, `"test"`, `"timeincl"`, `"timetype"`, `"tmpnam_r_proto"`, `"to"`, `"touch"`, `"tr"`, `"trnl"`, `"troff"`, `"ttyname_r_proto"`
	u		`"u16size"`, `"u16type"`, `"u32size"`, `"u32type"`, `"u64size"`, `"u64type"`, `"u8size"`, `"u8type"`, `"uidformat"`, `"uidsign"`, `"uidsize"`, `"uidtype"`, `"uname"`, `"uniq"`, `"uquadtype"`, `"use5005threads"`, `"use64bitall"`, `"use64bitint"`, `"usecbacktrace"`, `"usecrosscompile"`, `"usedevel"`, `"usedl"`, `"usedtrace"`, `"usefaststdio"`, `"useithreads"`, `"usekernprocpathname"`, `"uselanginfo"`, `"uselargefiles"`, `"uselongdouble"`, `"usemallocwrap"`, `"usemorebits"`, `"usemultiplicity"`, `"usemymalloc"`, `"usenm"`, `"usensgetexecutablepath"`, `"useopcode"`, `"useperlio"`, `"useposix"`, `"usequadmath"`, `"usereentrant"`, `"userelocatableinc"`, `"useshrplib"`, `"usesitecustomize"`, `"usesocks"`, `"usethreads"`, `"usevendorprefix"`, `"useversionedarchname"`, `"usevfork"`, `"usrinc"`, `"uuname"`, `"uvoformat"`, `"uvsize"`, `"uvtype"`, `"uvuformat"`, `"uvxformat"`, `"uvXUformat"`
	v		`"vendorarch"`, `"vendorarchexp"`, `"vendorbin"`, `"vendorbinexp"`, `"vendorhtml1dir"`, `"vendorhtml1direxp"`, `"vendorhtml3dir"`, `"vendorhtml3direxp"`, `"vendorlib"`, `"vendorlib_stem"`, `"vendorlibexp"`, `"vendorman1dir"`, `"vendorman1direxp"`, `"vendorman3dir"`, `"vendorman3direxp"`, `"vendorprefix"`, `"vendorprefixexp"`, `"vendorscript"`, `"vendorscriptexp"`, `"version"`, `"version_patchlevel_string"`, `"versiononly"`, `"vi"`
	x		`"xlibpth"`
	y		`"yacc"`, `"yaccflags"`
	z		`"zcat"`, `"zip"`

GIT DATA
NOTE

Config::Extensions - hash lookup of which core extensions were built.
SYNOPSIS
DESCRIPTION

dynamic, nonxs, static

AUTHOR

Config::Perl::V - Structured data retrieval of perl -V output
SYNOPSIS
DESCRIPTION

$conf = myconfig ()
$conf = plv2hash ($text [, ...])
$info = summary ([$conf])
$md5 = signature ([$conf])
The hash structure

build, osname, stamp, options, derived, patches, environment, config, inc

REASONING
BUGS
TODO
AUTHOR
COPYRIGHT AND LICENSE

Cwd - get pathname of current working directory
SYNOPSIS
DESCRIPTION

getcwd and friends

getcwd, cwd, fastcwd, fastgetcwd, getdcwd

abs_path and friends

abs_path, realpath, fast_abs_path

$ENV{ PWD }

NOTES
AUTHOR
COPYRIGHT
SEE ALSO

DB - programmatic interface to the Perl debugging API
SYNOPSIS
DESCRIPTION

Global Variables

 $DB::sub,  %DB::sub,  $DB::single,  $DB::signal,  $DB::trace,  @DB::args,
@DB::dbline,  %DB::dbline,  $DB::package,  $DB::filename,  $DB::subname,
$DB::lineno

API Methods

CLIENT- >register(), CLIENT- >evalcode( STRING ), CLIENT- >skippkg(’D::hide’), CLIENT- >run(), CLIENT- >step(), CLIENT- >next(), CLIENT- >done()

Client Callback Methods

CLIENT- >init(), CLIENT- >prestop([ STRING ]), CLIENT- >stop(), CLIENT- >idle(), CLIENT- >poststop([ STRING ]), CLIENT- >evalcode( STRING ), CLIENT- >cleanup(), CLIENT- >output( LIST )

BUGS
AUTHOR

DBM_Filter -- Filter DBM keys/values
SYNOPSIS
DESCRIPTION
What is a DBM Filter?

So what’s new?

METHODS

$db->Filter_Push() / $db->Filter_Key_Push() /
$db->Filter_Value_Push()

Filter_Push, Filter_Key_Push, Filter_Value_Push

$db->Filter_Pop()
$db->Filtered()

Writing a Filter

Immediate Filters
Canned Filters

"name", params

Filters Included

utf8, encode, compress, int32, null

NOTES

Maintain Round Trip Integrity
Don’t mix filtered & non-filtered data in the same database file.

EXAMPLE
SEE ALSO
AUTHOR

DBM_Filter::compress - filter for DBM_Filter
SYNOPSIS
DESCRIPTION
SEE ALSO
AUTHOR

DBM_Filter::encode - filter for DBM_Filter
SYNOPSIS
DESCRIPTION
SEE ALSO
AUTHOR

DBM_Filter::int32 - filter for DBM_Filter
SYNOPSIS
DESCRIPTION
SEE ALSO
AUTHOR

DBM_Filter::null - filter for DBM_Filter
SYNOPSIS
DESCRIPTION
SEE ALSO
AUTHOR

DBM_Filter::utf8 - filter for DBM_Filter
SYNOPSIS
DESCRIPTION
SEE ALSO
AUTHOR

DB_File - Perl5 access to Berkeley DB version 1.x
SYNOPSIS
DESCRIPTION

DB_HASH , DB_BTREE , DB_RECNO
Using DB_File with Berkeley DB version 2 or greater
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
The find_dup() Method
The del_dup() Method
Matching Partial Keys

DB_RECNO

The ’bval’ Option
A Simple Example
Extra RECNO Methods

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

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

DBM FILTERS

DBM Filter Low-level API

filter_store_key, filter_store_value, filter_fetch_key, filter_fetch_value

The Filter
An Example -- the NULL termination problem.
Another Example -- Key is a C int.

HINTS AND TIPS

Locking: The Trouble with fd
Safe ways to lock a database

Tie::DB_Lock, Tie::DB_LockFile, DB_File::Lock

Sharing Databases With C Applications
The untie() Gotcha

COMMON QUESTIONS

Why is there Perl source in my database?
How do I store complex data structures with DB_File?
What does "wide character in subroutine entry" mean?
What does "Invalid Argument" mean?
What does "Bareword ’DB_File’ not allowed" mean?

REFERENCES
HISTORY
BUGS
SUPPORT
AVAILABILITY
COPYRIGHT
SEE ALSO
AUTHOR

Data::Dumper - stringified perl data structures, suitable for both printing and "eval"
SYNOPSIS
DESCRIPTION

Methods

PACKAGE ->new( ARRAYREF [, ARRAYREF ]), $OBJ->Dump or PACKAGE ->Dump( ARRAYREF [, ARRAYREF ]), $OBJ->Seen([ HASHREF ]), $OBJ->Values([ ARRAYREF ]), $OBJ->Names([ ARRAYREF ]), $OBJ->Reset

Functions

Dumper( LIST )

Configuration Variables or Methods
Exports

Dumper

EXAMPLES
BUGS

NOTE

AUTHOR
VERSION
SEE ALSO

Devel::PPPort - Perl/Pollution/Portability
SYNOPSIS
Start using Devel::PPPort for XS projects
DESCRIPTION

Why use ppport.h?
How to use ppport.h
Running ppport.h

FUNCTIONS

WriteFile
GetFileContents

COMPATIBILITY

Provided Perl compatibility API
Supported Perl API, sorted by version

perl 5.31.5, perl 5.31.4, perl 5.31.3, perl 5.29.10, perl 5.29.9, perl 5.27.9, perl 5.27.8, perl 5.27.7, perl 5.27.6, perl 5.27.4, perl 5.27.3, perl 5.27.2, perl 5.27.1, perl 5.25.10, perl 5.25.9, perl 5.25.8, perl 5.25.7, perl 5.25.6, perl 5.25.5, perl 5.25.3, perl 5.25.1, perl 5.23.8, perl 5.23.2, perl 5.23.0, perl 5.21.10, perl 5.21.9, perl 5.21.8, perl 5.21.7, perl 5.21.6, perl 5.21.5, perl 5.21.4, perl 5.21.2, perl 5.21.1, perl 5.19.10, perl 5.19.9, perl 5.19.7, perl 5.19.5, perl 5.19.4, perl 5.19.3, perl 5.19.2, perl 5.19.1, perl 5.18.0, perl 5.17.11, perl 5.17.8, perl 5.17.7, perl 5.17.6, perl 5.17.5, perl 5.17.4, perl 5.17.2, perl 5.17.1, perl 5.16.0, perl 5.15.8, perl 5.15.6, perl 5.15.4, perl 5.15.3, perl 5.15.2, perl 5.15.1, perl 5.13.10, perl 5.13.9, perl 5.13.8, perl 5.13.7, perl 5.13.6, perl 5.13.5, perl 5.13.4, perl 5.13.3, perl 5.13.2, perl 5.13.1, perl 5.11.5, perl 5.11.4, perl 5.11.2, perl 5.11.1, perl 5.11.0, perl 5.10.1, perl 5.10.0, perl 5.9.5, perl 5.9.4, perl 5.9.3, perl 5.9.2, perl 5.9.1, perl 5.9.0, perl 5.8.9, perl 5.8.8, perl 5.8.3, perl 5.8.1, perl 5.8.0, perl 5.7.3, perl 5.7.2, perl 5.7.1, perl 5.6.1, perl 5.6.0, perl 5.005_03, perl 5.005, perl 5.004_05, perl 5.004, perl 5.003_07 (at least), Backported version unknown

BUGS
AUTHORS
COPYRIGHT
SEE ALSO

Devel::Peek - A data debugging tool for the XS programmer
SYNOPSIS
DESCRIPTION

Runtime debugging
Memory footprint debugging

EXAMPLES

A simple scalar string
A simple scalar number
A simple scalar with an extra reference
A reference to a simple scalar
A reference to an array
A reference to a hash
Dumping a large array or hash
A reference to an SV which holds a C pointer
A reference to a subroutine

EXPORTS
BUGS
AUTHOR
SEE ALSO

Devel::SelfStubber - generate stubs for a SelfLoading module
SYNOPSIS
DESCRIPTION

Digest - Modules that calculate message digests
SYNOPSIS
DESCRIPTION

binary, hex, base64

OO INTERFACE

$ctx = Digest-> XXX ($arg,...), $ctx = Digest->new( XXX => $arg,...), $ctx = Digest::XXX->new($arg,...), $other_ctx = $ctx->clone, $ctx->reset, $ctx->add( $data ), $ctx->add( $chunk1, $chunk2, ... ), $ctx->addfile( $io_handle ), $ctx->add_bits( $data, $nbits ), $ctx->add_bits( $bitstring ), $ctx->digest, $ctx->hexdigest, $ctx->b64digest

Digest speed
SEE ALSO
AUTHOR

Digest::MD5 - Perl interface to the MD5 Algorithm
SYNOPSIS
DESCRIPTION
FUNCTIONS

md5($data,...), md5_hex($data,...), md5_base64($data,...)

METHODS

$md5 = Digest::MD5->new, $md5->reset, $md5->clone, $md5->add($data,...), $md5->addfile($io_handle), $md5->add_bits($data, $nbits), $md5->add_bits($bitstring), $md5->digest, $md5->hexdigest, $md5->b64digest, @ctx = $md5->context, $md5->context(@ctx)

EXAMPLES
SEE ALSO
COPYRIGHT
AUTHORS

Digest::SHA - Perl extension for SHA-1/224/256/384/512
SYNOPSIS
SYNOPSIS (HMAC-SHA)
ABSTRACT
DESCRIPTION
UNICODE AND SIDE EFFECTS
NIST STATEMENT ON SHA-1
PADDING OF BASE64 DIGESTS
EXPORT
EXPORTABLE FUNCTIONS

sha1($data, ...), sha224($data, ...), sha256($data, ...), sha384($data, ...), sha512($data, ...), sha512224($data, ...), sha512256($data, ...), sha1_hex($data, ...), sha224_hex($data, ...), sha256_hex($data, ...), sha384_hex($data, ...), sha512_hex($data, ...), sha512224_hex($data, ...), sha512256_hex($data, ...), sha1_base64($data, ...), sha224_base64($data, ...), sha256_base64($data, ...), sha384_base64($data, ...), sha512_base64($data, ...), sha512224_base64($data, ...), sha512256_base64($data, ...), new($alg), reset($alg), hashsize, algorithm, clone, add($data, ...), add_bits($data, $nbits), add_bits($bits), addfile(*FILE), addfile($filename [, $mode]), getstate, putstate($str), dump($filename), load($filename), digest, hexdigest, b64digest, hmac_sha1($data, $key), hmac_sha224($data, $key), hmac_sha256($data, $key), hmac_sha384($data, $key), hmac_sha512($data, $key), hmac_sha512224($data, $key), hmac_sha512256($data, $key), hmac_sha1_hex($data, $key), hmac_sha224_hex($data, $key), hmac_sha256_hex($data, $key), hmac_sha384_hex($data, $key), hmac_sha512_hex($data, $key), hmac_sha512224_hex($data, $key), hmac_sha512256_hex($data, $key), hmac_sha1_base64($data, $key), hmac_sha224_base64($data, $key), hmac_sha256_base64($data, $key), hmac_sha384_base64($data, $key), hmac_sha512_base64($data, $key), hmac_sha512224_base64($data, $key), hmac_sha512256_base64($data, $key)

SEE ALSO
AUTHOR
ACKNOWLEDGMENTS
COPYRIGHT AND LICENSE

Digest::base - Digest base class
SYNOPSIS
DESCRIPTION
SEE ALSO

Digest::file - Calculate digests of files
SYNOPSIS
DESCRIPTION

digest_file( $file, $algorithm, [$arg,...] ), digest_file_hex( $file, $algorithm, [$arg,...] ), digest_file_base64( $file, $algorithm, [$arg,...] )

SEE ALSO

DirHandle - (obsolete) supply object methods for directory handles
SYNOPSIS
DESCRIPTION

Dumpvalue - provides screen dump of Perl data.
SYNOPSIS
DESCRIPTION

Creation

"arrayDepth", "hashDepth", "compactDump", "veryCompact", "globPrint", "dumpDBFiles", "dumpPackages", "dumpReused", "tick", "quoteHighBit", "printUndef", "usageOnly", unctrl, subdump, bareStringify, quoteHighBit, stopDbSignal

Methods

dumpValue, dumpValues, stringify, dumpvars, set_quote, set_unctrl, compactDump, veryCompact, set, get

DynaLoader - Dynamically load C libraries into Perl code
SYNOPSIS
DESCRIPTION

@dl_library_path, @dl_resolve_using, @dl_require_symbols, @dl_librefs, @dl_modules, @dl_shared_objects, dl_error(), $dl_debug, $dl_dlext, dl_findfile(), dl_expandspec(), dl_load_file(), dl_unload_file(), dl_load_flags(), dl_find_symbol(), dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), bootstrap()

AUTHOR

Encode - character encodings in Perl
SYNOPSIS

Table of Contents

Encode::Alias - Alias definitions to encodings, Encode::Encoding - Encode Implementation Base Class, Encode::Supported - List of Supported Encodings, Encode::CN - Simplified Chinese Encodings, Encode::JP - Japanese Encodings, Encode::KR - Korean Encodings, Encode::TW - Traditional Chinese Encodings

DESCRIPTION

TERMINOLOGY

THE PERL ENCODING API

Basic methods
Listing available encodings
Defining Aliases
Finding IANA Character Set Registry names

Encoding via PerlIO
Handling Malformed Data

List of CHECK values

perlqq mode ( CHECK = Encode::FB_PERLQQ), HTML charref mode ( CHECK = Encode::FB_HTMLCREF), XML charref mode ( CHECK = Encode::FB_XMLCREF)

coderef for CHECK

Defining Encodings
The UTF8 flag

Goal #1:, Goal #2:, Goal #3:, Goal #4:
Messing with Perl’s Internals

UTF-8 vs. utf8 vs. UTF8
SEE ALSO
MAINTAINER
COPYRIGHT

Encode::Alias - alias definitions to encodings
SYNOPSIS
DESCRIPTION

As a simple string, As a qr// compiled regular expression, e.g.:, As a code reference, e.g.:
Alias overloading

SEE ALSO

Encode::Byte - Single Byte Encodings
SYNOPSIS
ABSTRACT
DESCRIPTION
SEE ALSO

Encode::CJKConstants -- Internally used by Encode::??::ISO_2022_*
Encode::CN - China-based Chinese Encodings
SYNOPSIS
DESCRIPTION
NOTES
BUGS
SEE ALSO

Encode::CN::HZ -- internally used by Encode::CN
Encode::Config -- internally used by Encode
Encode::EBCDIC - EBCDIC Encodings
SYNOPSIS
ABSTRACT
DESCRIPTION
SEE ALSO

Encode::Encoder -- Object Oriented Encoder
SYNOPSIS
ABSTRACT
Description

Predefined Methods

$e = Encode::Encoder->new([$data, $encoding]);, encoder(), $e->data([$data]), $e->encoding([$encoding]), $e->bytes([$encoding])

Example: base64 transcoder
Operator Overloading

SEE ALSO

Encode::Encoding - Encode Implementation Base Class
SYNOPSIS
DESCRIPTION

Methods you should implement

->encode($string [,$check]), ->decode($octets [,$check]), ->cat_decode($destination, $octets, $offset, $terminator [,$check])

Other methods defined in Encode::Encodings

->name, ->mime_name, ->renew, ->renewed, ->perlio_ok(), ->needs_lines()

Example: Encode::ROT13

Why the heck Encode API is different?

Compiled Encodings

SEE ALSO

Scheme 1, Scheme 2, Other Schemes

Encode::GSM0338 -- ESTI GSM 03.38 Encoding
SYNOPSIS
DESCRIPTION
NOTES
BUGS
SEE ALSO

Encode::Guess -- Guesses encoding from data
SYNOPSIS
ABSTRACT
DESCRIPTION

Encode::Guess->set_suspects, Encode::Guess->add_suspects, Encode::decode("Guess" ...), Encode::Guess->guess($data), guess_encoding($data, [, list of suspects])

CAVEATS
TO DO
SEE ALSO

Encode::JP - Japanese Encodings
SYNOPSIS
ABSTRACT
DESCRIPTION
Note on ISO-2022-JP (-1)?
BUGS
SEE ALSO

Encode::JP::H2Z -- internally used by Encode::JP::2022_JP*
Encode::JP::JIS7 -- internally used by Encode::JP
Encode::KR - Korean Encodings
SYNOPSIS
DESCRIPTION
BUGS
SEE ALSO

Encode::KR::2022_KR -- internally used by Encode::KR
Encode::MIME::Header -- MIME encoding for an unstructured email header
SYNOPSIS
ABSTRACT
DESCRIPTION
BUGS
AUTHORS
SEE ALSO

Encode::MIME::Name, Encode::MIME::NAME -- internally used by Encode
SEE ALSO

Encode::PerlIO -- a detailed document on Encode and PerlIO
Overview
How does it work?
Line Buffering

How can I tell whether my encoding fully supports PerlIO ?

SEE ALSO

Encode::Supported -- Encodings supported by Encode
DESCRIPTION

Encoding Names

Supported Encodings

Built-in Encodings
Encode::Unicode -- other Unicode encodings
Encode::Byte -- Extended ASCII

ISO-8859 and corresponding vendor mappings, KOI8 - De Facto Standard for the Cyrillic world

gsm0338 - Hentai Latin 1

gsm0338 support before 2.19

CJK: Chinese, Japanese, Korean (Multibyte)

Encode::CN -- Continental China, Encode::JP -- Japan, Encode::KR -- Korea, Encode::TW -- Taiwan, Encode::HanExtra -- More Chinese via CPAN, Encode::JIS2K -- JIS X 0213 encodings via CPAN

Miscellaneous encodings

Encode::EBCDIC, Encode::Symbols, Encode::MIME::Header, Encode::Guess

Unsupported encodings

  ISO-2022-JP-2 [RFC1554], ISO-2022-CN [RFC1922], Various HP-UX encodings,
Cyrillic encoding ISO-IR-111, ISO-8859-8-1 [Hebrew], ISIRI 3342, Iran
System, ISIRI 2900 [Farsi], Thai encoding TCVN, Vietnamese encodings VPS,
Various Mac encodings, (Mac) Indic encodings

Encoding vs. Charset -- terminology
Encoding Classification (by Anton Tagunov and Dan Kogai)

Microsoft-related naming mess

KS_C_5601-1987, GB2312, Big5, Shift_JIS

Glossary

character repertoire, coded character set ( CCS ), character encoding scheme ( CES ), charset (in MIME context), EUC, ISO-2022, UCS, UCS-2, Unicode, UTF, UTF-16

SEE ALSO

ExtUtils::MM - OS adjusted ExtUtils::MakeMaker subclass
SYNOPSIS
DESCRIPTION

ExtUtils::MM_AIX - AIX specific subclass of ExtUtils::MM_Unix
SYNOPSIS
DESCRIPTION

Overridden methods

AUTHOR
SEE ALSO

ExtUtils::MM_Any - Platform-agnostic MM methods
SYNOPSIS
DESCRIPTION
METHODS

Cross-platform helper methods

Targets
Init methods
Tools
File::Spec wrappers
Misc
AUTHOR

ExtUtils::MM_BeOS - methods to override UN*X behaviour in ExtUtils::MakeMaker
SYNOPSIS
DESCRIPTION

os_flavor

init_linker

ExtUtils::MM_Cygwin - methods to override UN*X behaviour in ExtUtils::MakeMaker
SYNOPSIS
DESCRIPTION

os_flavor

cflags

replace_manpage_separator

init_linker

maybe_command

dynamic_lib

install

ExtUtils::MM_DOS - DOS specific subclass of ExtUtils::MM_Unix
SYNOPSIS
DESCRIPTION

Overridden methods

os_flavor

replace_manpage_separator

xs_static_lib_is_xs
AUTHOR
SEE ALSO

ExtUtils::MM_Darwin - special behaviors for OS X
SYNOPSIS
DESCRIPTION

Overridden Methods

ExtUtils::MM_MacOS - once produced Makefiles for MacOS Classic
SYNOPSIS
DESCRIPTION

ExtUtils::MM_NW5 - methods to override UN*X behaviour in ExtUtils::MakeMaker
SYNOPSIS
DESCRIPTION

os_flavor

init_platform, platform_constants

static_lib_pure_cmd

xs_static_lib_is_xs

dynamic_lib

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

init_dist

init_linker

os_flavor

xs_static_lib_is_xs

ExtUtils::MM_QNX - QNX specific subclass of ExtUtils::MM_Unix
SYNOPSIS
DESCRIPTION

Overridden methods

AUTHOR
SEE ALSO

ExtUtils::MM_UWIN - U/WIN specific subclass of ExtUtils::MM_Unix
SYNOPSIS
DESCRIPTION

Overridden methods

os_flavor

replace_manpage_separator
AUTHOR
SEE ALSO

ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker
SYNOPSIS
DESCRIPTION
METHODS
Methods

os_flavor

c_o (o)

xs_obj_opt

dbgoutflag

cflags (o)

const_cccmd (o)

const_config (o)

const_loadlibs (o)

constants (o)

depend (o)

init_DEST

init_dist

dist (o)

dist_basics (o)

dist_ci (o)

dist_core (o)

dist_target

tardist_target

zipdist_target

tarfile_target

zipfile_target

uutardist_target

shdist_target

dlsyms (o)

dynamic_bs (o)

dynamic_lib (o)

xs_dynamic_lib_macros

xs_make_dynamic_lib

exescan

extliblist

find_perl

fixin

force (o)

guess_name

has_link_code

init_dirscan

init_MANPODS

init_MAN1PODS

init_MAN3PODS

init_PM

init_DIRFILESEP

init_main

init_tools

init_linker

init_lib2arch

init_PERL

init_platform, platform_constants

init_PERM

init_xs

install (o)

installbin (o)

linkext (o)

lsdir

macro (o)

makeaperl (o)

xs_static_lib_is_xs (o)

makefile (o)

maybe_command

needs_linking (o)

parse_abstract

parse_version

pasthru (o)

perl_script

perldepend (o)

pm_to_blib

ppd

prefixify

processPL (o)

specify_shell

quote_paren

replace_manpage_separator

oneliner

quote_literal

escape_newlines

max_exec_len

static (o)

xs_make_static_lib

static_lib_closures

static_lib_fixtures

static_lib_pure_cmd

staticmake (o)

subdir_x (o)

subdirs (o)

test (o)

test_via_harness (override)

test_via_script (override)

tool_xsubpp (o)

all_target

top_targets (o)

writedoc

xs_c (o)

xs_cpp (o)

xs_o (o)
SEE ALSO

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

Methods always loaded

wraplist

Methods

guess_name (override)

find_perl (override)

_fixin_replace_shebang (override)

maybe_command (override)

pasthru (override)

pm_to_blib (override)

perl_script (override)

replace_manpage_separator

init_DEST

init_DIRFILESEP

init_main (override)

init_tools (override)

init_platform (override)

platform_constants

init_VERSION (override)

constants (override)

special_targets

cflags (override)

const_cccmd (override)

tools_other (override)

init_dist (override)

c_o (override)

xs_c (override)

xs_o (override)

_xsbuild_replace_macro (override)

_xsbuild_value (override)

dlsyms (override)

xs_obj_opt

dynamic_lib (override)

xs_make_static_lib (override)

static_lib_pure_cmd (override)

xs_static_lib_is_xs

extra_clean_files

zipfile_target, tarfile_target, shdist_target

install (override)

perldepend (override)

makeaperl (override)

maketext_filter (override)

prefixify (override)

oneliner

echo

quote_literal

escape_dollarsigns

escape_all_dollarsigns

escape_newlines

max_exec_len

init_linker

catdir (override), catfile (override)

eliminate_macros

fixpath

os_flavor

is_make_type (override)

make_type (override)
AUTHOR

ExtUtils::MM_VOS - VOS specific subclass of ExtUtils::MM_Unix
SYNOPSIS
DESCRIPTION

Overridden methods

AUTHOR
SEE ALSO

ExtUtils::MM_Win32 - methods to override UN*X behaviour in ExtUtils::MakeMaker
SYNOPSIS
DESCRIPTION
Overridden methods

dlsyms

xs_dlsyms_ext

replace_manpage_separator

maybe_command

init_DIRFILESEP

init_tools

init_others

init_platform, platform_constants

specify_shell

constants

special_targets

static_lib_pure_cmd

dynamic_lib

extra_clean_files

init_linker

perl_script

quote_dep

xs_obj_opt

pasthru

arch_check (override)

oneliner

max_exec_len

os_flavor

dbgoutflag

cflags

make_type

ExtUtils::MM_Win95 - method to customize MakeMaker for Win9X
SYNOPSIS
DESCRIPTION

Overridden methods

max_exec_len

os_flavor
AUTHOR

ExtUtils::MY - ExtUtils::MakeMaker subclass for customization
SYNOPSIS
DESCRIPTION

ExtUtils::MakeMaker - Create a module Makefile
SYNOPSIS
DESCRIPTION

How To Write A Makefile.PL
Default Makefile Behaviour
make test
make testdb
make install
INSTALL_BASE
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

ABSTRACT, ABSTRACT_FROM, AUTHOR, BINARY_LOCATION, BUILD_REQUIRES, C, CCFLAGS, CONFIG, CONFIGURE, CONFIGURE_REQUIRES, DEFINE, DESTDIR, DIR, DISTNAME, DISTVNAME, DLEXT, DL_FUNCS, DL_VARS, EXCLUDE_EXT, EXE_FILES, FIRST_MAKEFILE, FULLPERL, FULLPERLRUN, FULLPERLRUNINST, FUNCLIST, H, IMPORTS, INC, INCLUDE_EXT, INSTALLARCHLIB, INSTALLBIN, INSTALLDIRS, INSTALLMAN1DIR, INSTALLMAN3DIR, INSTALLPRIVLIB, INSTALLSCRIPT, INSTALLSITEARCH, INSTALLSITEBIN, INSTALLSITELIB, INSTALLSITEMAN1DIR, INSTALLSITEMAN3DIR, INSTALLSITESCRIPT, INSTALLVENDORARCH, INSTALLVENDORBIN, INSTALLVENDORLIB, INSTALLVENDORMAN1DIR, INSTALLVENDORMAN3DIR, INSTALLVENDORSCRIPT, INST_ARCHLIB, INST_BIN, INST_LIB, INST_MAN1DIR, INST_MAN3DIR, INST_SCRIPT, LD, LDDLFLAGS, LDFROM, LIB, LIBPERL_A, LIBS, LICENSE, LINKTYPE, MAGICXS, MAKE, MAKEAPERL, MAKEFILE_OLD, MAN1PODS, MAN3PODS, MAP_TARGET, META_ADD, META_MERGE, MIN_PERL_VERSION, MYEXTLIB, NAME, NEEDS_LINKING, NOECHO, NORECURS, NO_META, NO_MYMETA, NO_PACKLIST, NO_PERLLOCAL, NO_VC, OBJECT, OPTIMIZE, PERL, PERL_CORE, PERLMAINCC, PERL_ARCHLIB, PERL_LIB, PERL_MALLOC_OK, PERLPREFIX, PERLRUN, PERLRUNINST, PERL_SRC, PERM_DIR, PERM_RW, PERM_RWX, PL_FILES, PM, PMLIBDIRS, PM_FILTER, POLLUTE, PPM_INSTALL_EXEC, PPM_INSTALL_SCRIPT, PPM_UNINSTALL_EXEC, PPM_UNINSTALL_SCRIPT, PREFIX, PREREQ_FATAL, PREREQ_PM, PREREQ_PRINT, PRINT_PREREQ, SITEPREFIX, SIGN, SKIP, TEST_REQUIRES, TYPEMAPS, VENDORPREFIX, VERBINST, VERSION, VERSION_FROM, VERSION_SYM, XS, XSBUILD, XSMULTI, XSOPT, XSPROTOARG, XS_VERSION

Additional lowercase attributes

clean, depend, dist, dynamic_lib, linkext, macro, postamble, realclean, test, tool_autosplit

Overriding MakeMaker Methods
The End Of Cargo Cult Programming

"MAN3PODS => ' '"

Hintsfile support
Distribution Support

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

Module Meta-Data ( META and MYMETA )
Disabling an extension
Other Handy Functions

prompt, os_unsupported

Supported versions of Perl

ENVIRONMENT

PERL_MM_OPT, PERL_MM_USE_DEFAULT, PERL_CORE

SEE ALSO
AUTHOR

ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker
SYNOPSIS
DESCRIPTION

The Mantra
The Layout

Makefile.PL, MANIFEST, lib/, t/, Changes, README, INSTALL, MANIFEST.SKIP, bin/

SEE ALSO

ExtUtils::Manifest - Utilities to write and check a MANIFEST file
VERSION
SYNOPSIS
DESCRIPTION
FUNCTIONS

mkmanifest

manifind
manicheck
filecheck
fullcheck
skipcheck
maniread
maniskip
manicopy
maniadd
MANIFEST
MANIFEST.SKIP

#!include_default, #!include /Path/to/another/manifest.skip

EXPORT_OK
GLOBAL VARIABLES
DIAGNOSTICS

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

ENVIRONMENT

PERL_MM_MANIFEST_DEBUG

SEE ALSO
AUTHOR
COPYRIGHT

File::Spec::AmigaOS - File::Spec for AmigaOS
SYNOPSIS
DESCRIPTION
METHODS

tmpdir

file_name_is_absolute

File::Spec::Cygwin - methods for Cygwin file specs
SYNOPSIS
DESCRIPTION

canonpath

file_name_is_absolute

tmpdir (override)

case_tolerant
COPYRIGHT

File::Spec::Epoc - methods for Epoc file specs
SYNOPSIS
DESCRIPTION

canonpath()
AUTHOR
COPYRIGHT
SEE ALSO

File::Spec::Functions - portably perform operations on file names
SYNOPSIS
DESCRIPTION

Exports

File::Spec::Mac - File::Spec for Mac OS (Classic)
SYNOPSIS
DESCRIPTION
METHODS

canonpath

catdir()

catfile

curdir

devnull

rootdir

tmpdir

updir

file_name_is_absolute

path

splitpath

splitdir

catpath

abs2rel

rel2abs
AUTHORS
COPYRIGHT
SEE ALSO

File::Spec::OS2 - methods for OS/2 file specs
SYNOPSIS
DESCRIPTION

tmpdir, splitpath

File::Spec::Unix - File::Spec for Unix, base for other File::Spec modules
SYNOPSIS
DESCRIPTION
METHODS

canonpath()

catdir()

catfile

curdir

devnull

rootdir

tmpdir

updir

no_upwards

case_tolerant

file_name_is_absolute

path

join

splitpath

splitdir

catpath()

abs2rel

rel2abs()
COPYRIGHT
SEE ALSO

File::Spec::VMS - methods for VMS file specs
SYNOPSIS
DESCRIPTION

canonpath (override)

catdir (override)

catfile (override)

curdir (override)

devnull (override)

rootdir (override)

tmpdir (override)

updir (override)

case_tolerant (override)

path (override)

file_name_is_absolute (override)

splitpath (override)

splitdir (override)

catpath (override)

abs2rel (override)

rel2abs (override)
COPYRIGHT
SEE ALSO

File::Spec::Win32 - methods for Win32 file specs
SYNOPSIS
DESCRIPTION

devnull

tmpdir

case_tolerant

file_name_is_absolute

catfile

canonpath

splitpath

splitdir

catpath
Note For File::Spec::Win32 Maintainers
COPYRIGHT
SEE ALSO

File::Temp - return name and handle of a temporary file safely
VERSION
SYNOPSIS
DESCRIPTION
PORTABILITY
OBJECT-ORIENTED INTERFACE

new, newdir, filename, dirname, unlink_on_destroy, DESTROY

FUNCTIONS

tempfile, tempdir

MKTEMP FUNCTIONS

mkstemp, mkstemps, mkdtemp, mktemp

POSIX FUNCTIONS

tmpnam, tmpfile

ADDITIONAL FUNCTIONS

tempnam

UTILITY FUNCTIONS

unlink0, cmpstat, unlink1, cleanup

PACKAGE VARIABLES

safe_level, STANDARD, MEDIUM, HIGH, TopSystemUID, $KEEP_ALL, $DEBUG

WARNING

Temporary files and NFS
Forking
Directory removal
Taint mode
BINMODE

HISTORY
SEE ALSO
SUPPORT
AUTHOR
CONTRIBUTORS
COPYRIGHT AND LICENSE

File::stat - by-name interface to Perl’s built-in stat() functions
SYNOPSIS
DESCRIPTION
BUGS
ERRORS

-%s is not implemented on a File::stat object

WARNINGS

File::stat ignores use filetest ’access’, File::stat ignores VMS ACLs

NOTE
AUTHOR

FileCache - keep more files open than the system permits
SYNOPSIS
DESCRIPTION

cacheout EXPR, cacheout MODE, EXPR

CAVEATS
BUGS

FileHandle - supply object methods for filehandles
SYNOPSIS
DESCRIPTION

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

SEE ALSO

Filter::Simple - Simplified source filtering
SYNOPSIS
DESCRIPTION

The Problem
A Solution
Disabling or changing <no> behaviour
All-in-one interface
Filtering only specific components of source code

"code", "code_no_comments", "executable", "executable_no_comments", "quotelike", "string", "regex", "all"

Filtering only the code parts of source code
Using Filter::Simple with an explicit "import" subroutine
Using Filter::Simple and Exporter together
How it works

AUTHOR
CONTACT
COPYRIGHT AND LICENSE

Filter::Util::Call - Perl Source Filter Utility Module
SYNOPSIS
DESCRIPTION

use Filter::Util::Call
import()
filter_add()
filter() and anonymous sub

$_, $status, filter_read and filter_read_exact, filter_del, real_import, unimport()

LIMITATIONS

__DATA__ is ignored, Max. codesize limited to 32-bit

EXAMPLES

Example 1: A simple filter.
Example 2: Using the context
Example 3: Using the context within the filter
Example 4: Using filter_del

Filter::Simple
AUTHOR
DATE
LICENSE

FindBin - Locate directory of original perl script
SYNOPSIS
DESCRIPTION
EXPORTABLE VARIABLES
KNOWN ISSUES
AUTHORS
COPYRIGHT

GDBM_File - Perl5 access to the gdbm library.
SYNOPSIS
DESCRIPTION
AVAILABILITY
SECURITY AND PORTABILITY
BUGS
SEE ALSO

Getopt::Long - Extended processing of command line options
SYNOPSIS
DESCRIPTION
Command Line Options, an Introduction
Getting Started with Getopt::Long

Simple options
A little bit less simple options
Mixing command line option with other arguments
Options with values
Options with multiple values
Options with hash values
User-defined subroutines to handle options
Options with multiple names
Case and abbreviations
Summary of Option Specifications

!, +, s, i, o, f, : type [ desttype ], : number [ desttype ], : + [ desttype ]

Advanced Possibilities

Object oriented interface
Thread Safety
Documentation and help texts
Parsing options from an arbitrary array
Parsing options from an arbitrary string
Storing options values in a hash
Bundling
The lonesome dash
Argument callback

Configuring Getopt::Long

default, posix_default, auto_abbrev, getopt_compat, gnu_compat, gnu_getopt, require_order, permute, bundling (default: disabled), bundling_override (default: disabled), ignore_case (default: enabled), ignore_case_always (default: disabled), auto_version (default:disabled), auto_help (default:disabled), pass_through (default: disabled), prefix, prefix_pattern, long_prefix_pattern, debug (default: disabled)

Exportable Methods

VersionMessage, "-message", "-msg", "-exitval", "-output", HelpMessage

Return values and Errors
Legacy

Default destinations
Alternative option starters
Configuration variables

Tips and Techniques

Pushing multiple values in a hash option

Troubleshooting

GetOptions does not return a false result when an option is not
supplied
GetOptions does not split the command line correctly
Undefined subroutine &main::GetOptions called
How do I put a "-?" option into a Getopt::Long?

AUTHOR
COPYRIGHT AND DISCLAIMER

Getopt::Std - Process single-character switches with switch clustering
SYNOPSIS
DESCRIPTION
"--help" and "--version"

HTTP::Tiny - A small, simple, correct HTTP/1.1 client
VERSION
SYNOPSIS
DESCRIPTION
METHODS

new

get|head|put|post|delete
post_form
mirror
request
www_form_urlencode
can_ssl
connected

SSL SUPPORT
PROXY SUPPORT
LIMITATIONS
SEE ALSO
SUPPORT

Bugs / Feature Requests
Source Code

AUTHORS
CONTRIBUTORS
COPYRIGHT AND LICENSE

Hash::Util - A selection of general-utility hash subroutines
SYNOPSIS
DESCRIPTION

Restricted hashes

lock_keys, unlock_keys

lock_keys_plus

lock_value, unlock_value

lock_hash, unlock_hash

lock_hash_recurse, unlock_hash_recurse

hashref_locked, hash_locked

hashref_unlocked, hash_unlocked

legal_keys, hidden_keys, all_keys, hash_seed, hash_value, bucket_info, bucket_stats, bucket_array

bucket_stats_formatted

hv_store, hash_traversal_mask, bucket_ratio, used_buckets, num_buckets
Operating on references to hashes.

lock_ref_keys, unlock_ref_keys, lock_ref_keys_plus, lock_ref_value, unlock_ref_value, lock_hashref, unlock_hashref, lock_hashref_recurse, unlock_hashref_recurse, hash_ref_unlocked, legal_ref_keys, hidden_ref_keys

CAVEATS
BUGS
AUTHOR
SEE ALSO

Hash::Util::FieldHash - Support for Inside-Out Classes
SYNOPSIS
FUNCTIONS

id, id_2obj, register, idhash, idhashes, fieldhash, fieldhashes

DESCRIPTION

The Inside-out Technique
Problems of Inside-out
Solutions
More Problems
The Generic Object
How to use Field Hashes
Garbage-Collected Hashes

EXAMPLES

"init()", "first()", "last()", "name()", "Name_hash", "Name_id", "Name_idhash", "Name_id_reg", "Name_idhash_reg", "Name_fieldhash"
Example 1
Example 2

GUTS

The "PERL_MAGIC_uvar" interface for hashes
Weakrefs call uvar magic
How field hashes work
Internal function Hash::Util::FieldHash::_fieldhash

AUTHOR
COPYRIGHT AND LICENSE

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

I18N::LangTags - functions for dealing with RFC3066-style language tags
SYNOPSIS
DESCRIPTION

the function is_language_tag($lang1)

the function extract_language_tags($whatever)

the function same_language_tag($lang1, $lang2)

the function similarity_language_tag($lang1, $lang2)

the function is_dialect_of($lang1, $lang2)

the function super_languages($lang1)

the function locale2language_tag($locale_identifier)

the function encode_language_tag($lang1)

the function alternate_language_tags($lang1)

the function @langs = panic_languages(@accept_languages)

the function implicate_supers( ...languages... ), the function implicate_supers_strictly( ...languages... )
ABOUT LOWERCASING
ABOUT UNICODE PLAINTEXT LANGUAGE TAGS
SEE ALSO
COPYRIGHT
AUTHOR

I18N::LangTags::Detect - detect the user’s language preferences
SYNOPSIS
DESCRIPTION
FUNCTIONS
ENVIRONMENT
SEE ALSO
COPYRIGHT
AUTHOR

I18N::LangTags::List -- tags and names for human languages
SYNOPSIS
DESCRIPTION
ABOUT LANGUAGE TAGS
LIST OF LANGUAGES

{ab} : Abkhazian, {ace} : Achinese, {ach} : Acoli, {ada} : Adangme, {ady} : Adyghe, {aa} : Afar, {afh} : Afrihili, {af} : Afrikaans, [{afa} : Afro-Asiatic (Other)], {ak} : Akan, {akk} : Akkadian, {sq} : Albanian, {ale} : Aleut, [{alg} : Algonquian languages], [{tut} : Altaic (Other)], {am} : Amharic, {i-ami} : Ami, [{apa} : Apache languages], {ar} : Arabic, {arc} : Aramaic, {arp} : Arapaho, {arn} : Araucanian, {arw} : Arawak, {hy} : Armenian, {an} : Aragonese, [{art} : Artificial (Other)], {ast} : Asturian, {as} : Assamese, [{ath} : Athapascan languages], [{aus} : Australian languages], [{map} : Austronesian (Other)], {av} : Avaric, {ae} : Avestan, {awa} : Awadhi, {ay} : Aymara, {az} : Azerbaijani, {ban} : Balinese, [{bat} : Baltic (Other)], {bal} : Baluchi, {bm} : Bambara, [{bai} : Bamileke languages], {bad} : Banda, [{bnt} : Bantu (Other)], {bas} : Basa, {ba} : Bashkir, {eu} : Basque, {btk} : Batak (Indonesia), {bej} : Beja, {be} : Belarusian, {bem} : Bemba, {bn} : Bengali, [{ber} : Berber (Other)], {bho} : Bhojpuri, {bh} : Bihari, {bik} : Bikol, {bin} : Bini, {bi} : Bislama, {bs} : Bosnian, {bra} : Braj, {br} : Breton, {bug} : Buginese, {bg} : Bulgarian, {i-bnn} : Bunun, {bua} : Buriat, {my} : Burmese, {cad} : Caddo, {car} : Carib, {ca} : Catalan, [{cau} : Caucasian (Other)], {ceb} : Cebuano, [{cel} : Celtic (Other)], [{cai} : Central American Indian (Other)], {chg} : Chagatai, [{cmc} : Chamic languages], {ch} : Chamorro, {ce} : Chechen, {chr} : Cherokee, {chy} : Cheyenne, {chb} : Chibcha, {ny} : Chichewa, {zh} : Chinese, {chn} : Chinook Jargon, {chp} : Chipewyan, {cho} : Choctaw, {cu} : Church Slavic, {chk} : Chuukese, {cv} : Chuvash, {cop} : Coptic, {kw} : Cornish, {co} : Corsican, {cr} : Cree, {mus} : Creek, [{cpe} : English-based Creoles and pidgins (Other)], [{cpf} : French-based Creoles and pidgins (Other)], [{cpp} : Portuguese-based Creoles and pidgins (Other)], [{crp} : Creoles and pidgins (Other)], {hr} : Croatian, [{cus} : Cushitic (Other)], {cs} : Czech, {dak} : Dakota, {da} : Danish, {dar} : Dargwa, {day} : Dayak, {i-default} : Default (Fallthru) Language, {del} : Delaware, {din} : Dinka, {dv} : Divehi, {doi} : Dogri, {dgr} : Dogrib, [{dra} : Dravidian (Other)], {dua} : Duala, {nl} : Dutch, {dum} : Middle Dutch (ca.1050-1350), {dyu} : Dyula, {dz} : Dzongkha, {efi} : Efik, {egy} : Ancient Egyptian, {eka} : Ekajuk, {elx} : Elamite, {en} : English, {enm} : Old English (1100-1500), {ang} : Old English (ca.450-1100), {i-enochian} : Enochian (Artificial), {myv} : Erzya, {eo} : Esperanto, {et} : Estonian, {ee} : Ewe, {ewo} : Ewondo, {fan} : Fang, {fat} : Fanti, {fo} : Faroese, {fj} : Fijian, {fi} : Finnish, [{fiu} : Finno-Ugrian (Other)], {fon} : Fon, {fr} : French, {frm} : Middle French (ca.1400-1600), {fro} : Old French (842-ca.1400), {fy} : Frisian, {fur} : Friulian, {ff} : Fulah, {gaa} : Ga, {gd} : Scots Gaelic, {gl} : Gallegan, {lg} : Ganda, {gay} : Gayo, {gba} : Gbaya, {gez} : Geez, {ka} : Georgian, {de} : German, {gmh} : Middle High German (ca.1050-1500), {goh} : Old High German (ca.750-1050), [{gem} : Germanic (Other)], {gil} : Gilbertese, {gon} : Gondi, {gor} : Gorontalo, {got} : Gothic, {grb} : Grebo, {grc} : Ancient Greek, {el} : Modern Greek, {gn} : Guarani, {gu} : Gujarati, {gwi} : Gwich’in, {hai} : Haida, {ht} : Haitian, {ha} : Hausa, {haw} : Hawaiian, {he} : Hebrew, {hz} : Herero, {hil} : Hiligaynon, {him} : Himachali, {hi} : Hindi, {ho} : Hiri Motu, {hit} : Hittite, {hmn} : Hmong, {hu} : Hungarian, {hup} : Hupa, {iba} : Iban, {is} : Icelandic, {io} : Ido, {ig} : Igbo, {ijo} : Ijo, {ilo} : Iloko, [{inc} : Indic (Other)], [{ine} : Indo-European (Other)], {id} : Indonesian, {inh} : Ingush, {ia} : Interlingua (International Auxiliary Language Association), {ie} : Interlingue, {iu} : Inuktitut, {ik} : Inupiaq, [{ira} : Iranian (Other)], {ga} : Irish, {mga} : Middle Irish (900-1200), {sga} : Old Irish (to 900), [{iro} : Iroquoian languages], {it} : Italian, {ja} : Japanese, {jv} : Javanese, {jrb} : Judeo-Arabic, {jpr} : Judeo-Persian, {kbd} : Kabardian, {kab} : Kabyle, {kac} : Kachin, {kl} : Kalaallisut, {xal} : Kalmyk, {kam} : Kamba, {kn} : Kannada, {kr} : Kanuri, {krc} : Karachay-Balkar, {kaa} : Kara-Kalpak, {kar} : Karen, {ks} : Kashmiri, {csb} : Kashubian, {kaw} : Kawi, {kk} : Kazakh, {kha} : Khasi, {km} : Khmer, [{khi} : Khoisan (Other)], {kho} : Khotanese, {ki} : Kikuyu, {kmb} : Kimbundu, {rw} : Kinyarwanda, {ky} : Kirghiz, {i-klingon} : Klingon, {kv} : Komi, {kg} : Kongo, {kok} : Konkani, {ko} : Korean, {kos} : Kosraean, {kpe} : Kpelle, {kro} : Kru, {kj} : Kuanyama, {kum} : Kumyk, {ku} : Kurdish, {kru} : Kurukh, {kut} : Kutenai, {lad} : Ladino, {lah} : Lahnda, {lam} : Lamba, {lo} : Lao, {la} : Latin, {lv} : Latvian, {lb} : Letzeburgesch, {lez} : Lezghian, {li} : Limburgish, {ln} : Lingala, {lt} : Lithuanian, {nds} : Low German, {art-lojban} : Lojban (Artificial), {loz} : Lozi, {lu} : Luba-Katanga, {lua} : Luba-Lulua, {lui} : Luiseno, {lun} : Lunda, {luo} : Luo (Kenya and Tanzania), {lus} : Lushai, {mk} : Macedonian, {mad} : Madurese, {mag} : Magahi, {mai} : Maithili, {mak} : Makasar, {mg} : Malagasy, {ms} : Malay, {ml} : Malayalam, {mt} : Maltese, {mnc} : Manchu, {mdr} : Mandar, {man} : Mandingo, {mni} : Manipuri, [{mno} : Manobo languages], {gv} : Manx, {mi} : Maori, {mr} : Marathi, {chm} : Mari, {mh} : Marshall, {mwr} : Marwari, {mas} : Masai, [{myn} : Mayan languages], {men} : Mende, {mic} : Micmac, {min} : Minangkabau, {i-mingo} : Mingo, [{mis} : Miscellaneous languages], {moh} : Mohawk, {mdf} : Moksha, {mo} : Moldavian, [{mkh} : Mon-Khmer (Other)], {lol} : Mongo, {mn} : Mongolian, {mos} : Mossi, [{mul} : Multiple languages], [{mun} : Munda languages], {nah} : Nahuatl, {nap} : Neapolitan, {na} : Nauru, {nv} : Navajo, {nd} : North Ndebele, {nr} : South Ndebele, {ng} : Ndonga, {ne} : Nepali, {new} : Newari, {nia} : Nias, [{nic} : Niger-Kordofanian (Other)], [{ssa} : Nilo-Saharan (Other)], {niu} : Niuean, {nog} : Nogai, {non} : Old Norse, [{nai} : North American Indian], {no} : Norwegian, {nb} : Norwegian Bokmal, {nn} : Norwegian Nynorsk, [{nub} : Nubian languages], {nym} : Nyamwezi, {nyn} : Nyankole, {nyo} : Nyoro, {nzi} : Nzima, {oc} : Occitan (post 1500), {oj} : Ojibwa, {or} : Oriya, {om} : Oromo, {osa} : Osage, {os} : Ossetian; Ossetic, [{oto} : Otomian languages], {pal} : Pahlavi, {i-pwn} : Paiwan, {pau} : Palauan, {pi} : Pali, {pam} : Pampanga, {pag} : Pangasinan, {pa} : Panjabi, {pap} : Papiamento, [{paa} : Papuan (Other)], {fa} : Persian, {peo} : Old Persian (ca.600-400 B.C.), [{phi} : Philippine (Other)], {phn} : Phoenician, {pon} : Pohnpeian, {pl} : Polish, {pt} : Portuguese, [{pra} : Prakrit languages], {pro} : Old Provencal (to 1500), {ps} : Pushto, {qu} : Quechua, {rm} : Raeto-Romance, {raj} : Rajasthani, {rap} : Rapanui, {rar} : Rarotongan, [{qaa - qtz} : Reserved for local use.], [{roa} : Romance (Other)], {ro} : Romanian, {rom} : Romany, {rn} : Rundi, {ru} : Russian, [{sal} : Salishan languages], {sam} : Samaritan Aramaic, {se} : Northern Sami, {sma} : Southern Sami, {smn} : Inari Sami, {smj} : Lule Sami, {sms} : Skolt Sami, [{smi} : Sami languages (Other)], {sm} : Samoan, {sad} : Sandawe, {sg} : Sango, {sa} : Sanskrit, {sat} : Santali, {sc} : Sardinian, {sas} : Sasak, {sco} : Scots, {sel} : Selkup, [{sem} : Semitic (Other)], {sr} : Serbian, {srr} : Serer, {shn} : Shan, {sn} : Shona, {sid} : Sidamo, {sgn-...} : Sign Languages, {bla} : Siksika, {sd} : Sindhi, {si} : Sinhalese, [{sit} : Sino-Tibetan (Other)], [{sio} : Siouan languages], {den} : Slave (Athapascan), [{sla} : Slavic (Other)], {sk} : Slovak, {sl} : Slovenian, {sog} : Sogdian, {so} : Somali, {son} : Songhai, {snk} : Soninke, {wen} : Sorbian languages, {nso} : Northern Sotho, {st} : Southern Sotho, [{sai} : South American Indian (Other)], {es} : Spanish, {suk} : Sukuma, {sux} : Sumerian, {su} : Sundanese, {sus} : Susu, {sw} : Swahili, {ss} : Swati, {sv} : Swedish, {syr} : Syriac, {tl} : Tagalog, {ty} : Tahitian, [{tai} : Tai (Other)], {tg} : Tajik, {tmh} : Tamashek, {ta} : Tamil, {i-tao} : Tao, {tt} : Tatar, {i-tay} : Tayal, {te} : Telugu, {ter} : Tereno, {tet} : Tetum, {th} : Thai, {bo} : Tibetan, {tig} : Tigre, {ti} : Tigrinya, {tem} : Timne, {tiv} : Tiv, {tli} : Tlingit, {tpi} : Tok Pisin, {tkl} : Tokelau, {tog} : Tonga (Nyasa), {to} : Tonga (Tonga Islands), {tsi} : Tsimshian, {ts} : Tsonga, {i-tsu} : Tsou, {tn} : Tswana, {tum} : Tumbuka, [{tup} : Tupi languages], {tr} : Turkish, {ota} : Ottoman Turkish (1500-1928), {crh} : Crimean Turkish, {tk} : Turkmen, {tvl} : Tuvalu, {tyv} : Tuvinian, {tw} : Twi, {udm} : Udmurt, {uga} : Ugaritic, {ug} : Uighur, {uk} : Ukrainian, {umb} : Umbundu, {und} : Undetermined, {ur} : Urdu, {uz} : Uzbek, {vai} : Vai, {ve} : Venda, {vi} : Vietnamese, {vo} : Volapuk, {vot} : Votic, [{wak} : Wakashan languages], {wa} : Walloon, {wal} : Walamo, {war} : Waray, {was} : Washo, {cy} : Welsh, {wo} : Wolof, {x-...} : Unregistered (Semi-Private Use), {xh} : Xhosa, {sah} : Yakut, {yao} : Yao, {yap} : Yapese, {ii} : Sichuan Yi, {yi} : Yiddish, {yo} : Yoruba, [{ypk} : Yupik languages], {znd} : Zande, [{zap} : Zapotec], {zen} : Zenaga, {za} : Zhuang, {zu} : Zulu, {zun} : Zuni

SEE ALSO
COPYRIGHT AND DISCLAIMER
AUTHOR

I18N::Langinfo - query locale information
SYNOPSIS
DESCRIPTION

For systems without "nl_langinfo"

"ERA", "CODESET", "YESEXPR", "YESSTR", "NOEXPR", "NOSTR", "D_FMT", "T_FMT", "D_T_FMT", "CRNCYSTR", "ALT_DIGITS", "ERA_D_FMT", "ERA_T_FMT", "ERA_D_T_FMT", "T_FMT_AMPM"

EXPORT

BUGS
SEE ALSO
AUTHOR
COPYRIGHT AND LICENSE

IO - load various IO modules
SYNOPSIS
DESCRIPTION
DEPRECATED

IO::Compress::Base - Base Class for IO::Compress modules
SYNOPSIS
DESCRIPTION
SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Compress::Bzip2 - Write bzip2 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

bzip2 $input_filename_or_reference => $output_filename_or_reference
[, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeIn => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "BlockSize100K => number", "WorkFactor => number", "Strict => 0|1"

Examples

Methods

print
printf
syswrite
write
flush
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
newStream([ OPTS ])

Importing

:all

EXAMPLES

Apache::GZip Revisited
Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Compress::Deflate - Write RFC 1950 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

deflate $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeIn => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "Merge => 0|1", -Level, -Strategy, "Strict => 0|1"

Examples

Methods

print
printf
syswrite
write
flush
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
newStream([ OPTS ])
deflateParams

Importing

:all, :constants, :flush, :level, :strategy

EXAMPLES

Apache::GZip Revisited
Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Compress::FAQ -- Frequently Asked Questions about IO::Compress
DESCRIPTION
GENERAL

Compatibility with Unix compress/uncompress.
Accessing .tar.Z files
How do I recompress using a different compression?

ZIP

What Compression Types do IO::Compress::Zip & IO::Uncompress::Unzip

support?

Store (method 0), Deflate (method 8), Bzip2 (method 12), Lzma (method 14)

Can I Read/Write Zip files larger the 4 Gig?
Can I write more that 64K entries is a Zip files?
Zip Resources

GZIP

Gzip Resources
Dealing with concatenated gzip files
Reading bgzip files with IO::Uncompress::Gunzip

ZLIB

Zlib Resources

Bzip2

Bzip2 Resources
Dealing with Concatenated bzip2 files
Interoperating with Pbzip2

HTTP & NETWORK

Apache::GZip Revisited
Compressed files and Net::FTP

MISC

Using "InputLength" to uncompress data embedded in a larger
file/buffer.

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Compress::Gzip - Write RFC 1952 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

gzip $input_filename_or_reference => $output_filename_or_reference
[, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeIn => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "Merge => 0|1", -Level, -Strategy, "Minimal => 0|1", "Comment => $comment", "Name => $string", "Time => $number", "TextFlag => 0|1", "HeaderCRC => 0|1", "OS_Code => $value", "ExtraField => $data", "ExtraFlags => $value", "Strict => 0|1"

Examples

Methods

print
printf
syswrite
write
flush
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
newStream([ OPTS ])
deflateParams

Importing

:all, :constants, :flush, :level, :strategy

EXAMPLES

Apache::GZip Revisited
Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Compress::RawDeflate - Write RFC 1951 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

rawdeflate $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeIn => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "Merge => 0|1", -Level, -Strategy, "Strict => 0|1"

Examples

Methods

print
printf
syswrite
write
flush
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
newStream([ OPTS ])
deflateParams

Importing

:all, :constants, :flush, :level, :strategy

EXAMPLES

Apache::GZip Revisited
Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Compress::Zip - Write zip files/buffers
SYNOPSIS
DESCRIPTION

To use Bzip2 compression, the module "IO::Compress::Bzip2" must be installed, To use LZMA compression, the module "IO::Compress::Lzma" must be installed

Functional Interface

zip $input_filename_or_reference => $output_filename_or_reference
[, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeIn => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "Name => $string", If the $input parameter is not a filename, the archive member name will be an empty string, "CanonicalName => 0|1", "FilterName => sub { ... }", "Efs => 0|1", "Minimal => 1|0", "Stream => 0|1", "Zip64 => 0|1", -Level, -Strategy, "BlockSize100K => number", "WorkFactor => number", "Preset => number", "Extreme => 0|1", "Time => $number", "ExtAttr => $attr", "exTime => [$atime, $mtime, $ctime]", "exUnix2 => [$uid, $gid]", "exUnixN => [$uid, $gid]", "Comment => $comment", "ZipComment => $comment", "Method => $method", "TextFlag => 0|1", "ExtraFieldLocal => $data", "ExtraFieldCentral => $data", "Strict => 0|1"

Examples

Methods

print
printf
syswrite
write
flush
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
newStream([ OPTS ])
deflateParams

Importing

:all, :constants, :flush, :level, :strategy, :zip_method

EXAMPLES

Apache::GZip Revisited
Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Dir - supply object methods for directory handles
SYNOPSIS
DESCRIPTION

new ( [ DIRNAME ] ), open ( DIRNAME ), read (), seek ( POS ), tell (), rewind (), close (), tie %hash, ’IO::Dir’, DIRNAME [, OPTIONS ]

SEE ALSO
AUTHOR
COPYRIGHT

IO::File - supply object methods for filehandles
SYNOPSIS
DESCRIPTION
CONSTRUCTOR

new ( FILENAME [,MODE [,PERMS]] ), new_tmpfile

METHODS

open( FILENAME [,MODE [,PERMS]] ), open( FILENAME, IOLAYERS ), binmode( [ LAYER ] )

NOTE
SEE ALSO
HISTORY

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

new (), new_from_fd ( FD, MODE )

METHODS

$io->fdopen ( FD, MODE ), $io->opened, $io->getline, $io->getlines, $io->ungetc ( ORD ), $io->write ( BUF, LEN [, OFFSET ] ), $io->error, $io->clearerr, $io->sync, $io->flush, $io->printflush ( ARGS ), $io->blocking ( [ BOOL ] ), $io->untaint

NOTE
SEE ALSO
BUGS
HISTORY

IO::Pipe - supply object methods for pipes
SYNOPSIS
DESCRIPTION
CONSTRUCTOR

new ( [ READER, WRITER ] )

METHODS

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

SEE ALSO
AUTHOR
COPYRIGHT

IO::Poll - Object interface to system poll call
SYNOPSIS
DESCRIPTION
METHODS

mask ( IO [, EVENT_MASK ] ), poll ( [ TIMEOUT ] ), events ( IO ), remove ( IO ), handles( [ EVENT_MASK ] )

SEE ALSO
AUTHOR
COPYRIGHT

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

$io->getpos, $io->setpos, $io->seek ( POS, WHENCE ), WHENCE=0 ( SEEK_SET ), WHENCE=1 ( SEEK_CUR ), WHENCE=2 ( SEEK_END ), $io->sysseek( POS, WHENCE ), $io->tell

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_exception ( [ TIMEOUT ] ), count (), bits(), select ( READ, WRITE, EXCEPTION [, TIMEOUT ] )

EXAMPLE
AUTHOR
COPYRIGHT

IO::Socket - Object interface to socket communications
SYNOPSIS
DESCRIPTION
CONSTRUCTOR ARGUMENTS

Blocking
Domain
Listen
Timeout
Type

CONSTRUCTORS

new

METHODS

accept
atmark
autoflush
bind
connected
getsockopt
listen
peername
protocol
recv
send
setsockopt
shutdown
sockdomain
socket
socketpair
sockname
sockopt
socktype
timeout

EXAMPLES
LIMITATIONS
SEE ALSO
AUTHOR
COPYRIGHT

IO::Socket::INET - Object interface for AF_INET domain sockets
SYNOPSIS
DESCRIPTION
CONSTRUCTOR

new ( [ ARGS ] )
METHODS

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

SEE ALSO
AUTHOR
COPYRIGHT

IO::Socket::IP, "IO::Socket::IP" - Family-neutral IP socket supporting both IPv4 and IPv6
SYNOPSIS
DESCRIPTION
REPLACING "IO::Socket" DEFAULT BEHAVIOUR
CONSTRUCTORS
$sock = IO::Socket::IP->new( %args )

PeerHost => STRING, PeerService => STRING, PeerAddr => STRING, PeerPort => STRING, PeerAddrInfo => ARRAY, LocalHost => STRING, LocalService => STRING, LocalAddr => STRING, LocalPort => STRING, LocalAddrInfo => ARRAY, Family => INT, Type => INT, Proto => STRING or INT, GetAddrInfoFlags => INT, Listen => INT, ReuseAddr => BOOL, ReusePort => BOOL, Broadcast => BOOL, Sockopts => ARRAY, V6Only => BOOL, MultiHomed, Blocking => BOOL, Timeout => NUM

$sock = IO::Socket::IP->new( $peeraddr )
METHODS
( $host, $service ) = $sock->sockhost_service( $numeric )
$addr = $sock->sockhost
$port = $sock->sockport
$host = $sock->sockhostname
$service = $sock->sockservice
$addr = $sock->sockaddr
( $host, $service ) = $sock->peerhost_service( $numeric )
$addr = $sock->peerhost
$port = $sock->peerport
$host = $sock->peerhostname
$service = $sock->peerservice
$addr = $peer->peeraddr
$inet = $sock->as_inet
NON-BLOCKING
"PeerHost" AND "LocalHost" PARSING

( $host, $port ) = IO::Socket::IP->split_addr( $addr )

$addr = IO::Socket::IP->join_addr( $host, $port )
"IO::Socket::INET" INCOMPATIBILITES
TODO
AUTHOR

IO::Socket::UNIX - Object interface for AF_UNIX domain sockets
SYNOPSIS
DESCRIPTION
CONSTRUCTOR

new ( [ ARGS ] )

METHODS

hostpath(), peerpath()

SEE ALSO
AUTHOR
COPYRIGHT

IO::Uncompress::AnyInflate - Uncompress zlib-based (zip, gzip) file/buffer
SYNOPSIS
DESCRIPTION

RFC 1950, RFC 1951 (optionally), gzip ( RFC 1952 ), zip

Functional Interface

anyinflate $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "MultiStream => 0|1", "Prime => $string", "Transparent => 0|1", "BlockSize => $num", "InputLength => $size", "Append => 0|1", "Strict => 0|1", "RawInflate => 0|1", "ParseExtra => 0|1" If the gzip FEXTRA header field is present and this option is set, it will force the module to check that it conforms to the sub-field structure as defined in RFC 1952

Examples

Methods

read
read
getline
getc
ungetc
inflateSync
getHeaderInfo
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES

Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::AnyUncompress - Uncompress gzip, zip, bzip2, xz, lzma, lzip, lzf or lzop file/buffer
SYNOPSIS
DESCRIPTION

RFC 1950, RFC 1951 (optionally), gzip ( RFC 1952 ), zip, bzip2, lzop, lzf, lzma, lzip, xz

Functional Interface

anyuncompress $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

Examples

Methods

read
read
getline
getc
ungetc
getHeaderInfo
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES
SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::Base - Base Class for IO::Uncompress modules
SYNOPSIS
DESCRIPTION
SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::Bunzip2 - Read bzip2 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

bunzip2 $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

Examples

Methods

read
read
getline
getc
ungetc
getHeaderInfo
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES

Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::Gunzip - Read RFC 1952 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

gunzip $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

"AutoClose => 0|1", "MultiStream => 0|1", "Prime => $string", "Transparent => 0|1", "BlockSize => $num", "InputLength => $size", "Append => 0|1", "Strict => 0|1", "ParseExtra => 0|1" If the gzip FEXTRA header field is present and this option is set, it will force the module to check that it conforms to the sub-field structure as defined in RFC 1952

Examples

Methods

read
read
getline
getc
ungetc
inflateSync
getHeaderInfo

Name, Comment

tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES

Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::Inflate - Read RFC 1950 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

inflate $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

Examples

Methods

read
read
getline
getc
ungetc
inflateSync
getHeaderInfo
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES

Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::RawInflate - Read RFC 1951 files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

rawinflate $input_filename_or_reference =>
$output_filename_or_reference [, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

Examples

Methods

read
read
getline
getc
ungetc
inflateSync
getHeaderInfo
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES

Working with Net::FTP

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Uncompress::Unzip - Read zip files/buffers
SYNOPSIS
DESCRIPTION
Functional Interface

unzip $input_filename_or_reference => $output_filename_or_reference
[, OPTS ]

A filename, A filehandle, A scalar reference, An array reference, An Input FileGlob string, A filename, A filehandle, A scalar reference, An Array Reference, An Output FileGlob

Notes
Optional Parameters

"AutoClose => 0|1", "BinModeOut => 0|1", "Append => 0|1", A Buffer, A Filename, A Filehandle, "MultiStream => 0|1", "TrailingData => $scalar"

Examples

OO Interface

Constructor

A filename, A filehandle, A scalar reference

Constructor Options

Examples

Methods

read
read
getline
getc
ungetc
inflateSync
getHeaderInfo
tell

eof

seek
binmode
opened
autoflush
input_line_number
fileno
close
nextStream
trailingData

Importing

:all

EXAMPLES

Working with Net::FTP
Walking through a zip file
Unzipping a complete zip file to disk

SUPPORT
SEE ALSO
AUTHOR
MODIFICATION HISTORY
COPYRIGHT AND LICENSE

IO::Zlib - IO:: style interface to Compress::Zlib
SYNOPSIS
DESCRIPTION
CONSTRUCTOR

new ( [ ARGS ] )

OBJECT METHODS

open ( FILENAME, MODE ), opened, close, getc, getline, getlines, print ( ARGS... ), read ( BUF, NBYTES, [ OFFSET ] ), eof, seek ( OFFSET, WHENCE ), tell, setpos ( POS ), getpos ( POS )

USING THE EXTERNAL GZIP
CLASS METHODS

has_Compress_Zlib, gzip_external, gzip_used, gzip_read_open, gzip_write_open

DIAGNOSTICS

IO::Zlib::getlines: must be called in list context, IO::Zlib::gzopen_external: mode ’...’ is illegal, IO::Zlib::import: ’...’ is illegal, IO::Zlib::import: ’:gzip_external’ requires an argument, IO::Zlib::import: ’gzip_read_open’ requires an argument, IO::Zlib::import: ’gzip_read’ ’...’ is illegal, IO::Zlib::import: ’gzip_write_open’ requires an argument, IO::Zlib::import: ’gzip_write_open’ ’...’ is illegal, IO::Zlib::import: no Compress::Zlib and no external gzip, IO::Zlib::open: needs a filename, IO::Zlib::READ: NBYTES must be specified, IO::Zlib::WRITE: too long LENGTH

SEE ALSO
AUTHORS
COPYRIGHT

IPC::Open2 - open a process for both reading and writing using open2()
SYNOPSIS
DESCRIPTION
WARNING
SEE ALSO

IPC::Open3 - open a process for reading, writing, and error handling using open3()
SYNOPSIS
DESCRIPTION
See Also

IPC::Open2, IPC::Run

WARNING

IPC::Semaphore - SysV Semaphore IPC object class
SYNOPSIS
DESCRIPTION
METHODS

new ( KEY , NSEMS , FLAGS ), getall, getncnt ( SEM ), getpid ( SEM ), getval ( SEM ), getzcnt ( SEM ), id, op ( OPLIST ), remove, set ( STAT ), set ( NAME => VALUE [, NAME => VALUE ... ] ), setall ( VALUES ), setval ( N , VALUE ), stat

SEE ALSO
AUTHORS
COPYRIGHT

IPC::SharedMem - SysV Shared Memory IPC object class
SYNOPSIS
DESCRIPTION
METHODS

new ( KEY , SIZE , FLAGS ), id, read ( POS, SIZE ), write ( STRING, POS, SIZE ), remove, is_removed, stat, attach ( [ FLAG ] ), detach, addr

SEE ALSO
AUTHORS
COPYRIGHT

IPC::SysV - System V IPC constants and system calls
SYNOPSIS
DESCRIPTION

ftok( PATH ), ftok( PATH, ID ), shmat( ID, ADDR, FLAG ), shmdt( ADDR ), memread( ADDR, VAR, POS, SIZE ), memwrite( ADDR, STRING, POS, SIZE )

SEE ALSO
AUTHORS
COPYRIGHT

Internals - Reserved special namespace for internals related functions
SYNOPSIS
DESCRIPTION

FUNCTIONS

SvREFCNT( THING [, $value]), SvREADONLY( THING, [, $value]), hv_clear_placeholders(%hash)

AUTHOR
SEE ALSO

JSON::PP - JSON::XS compatible pure-Perl module.
SYNOPSIS
VERSION
DESCRIPTION
FUNCTIONAL INTERFACE

encode_json
decode_json
JSON::PP::is_bool

OBJECT-ORIENTED INTERFACE

new

ascii
latin1
utf8
pretty
indent
space_before
space_after
relaxed

list items can have an end-comma, shell-style ’#’-comments, C-style multiple-line ’/* */’-comments ( JSON::PP only), C ++ -style one-line ’//’-comments ( JSON::PP only), literal ASCII TAB characters in strings

canonical
allow_nonref
allow_unknown
allow_blessed
convert_blessed
allow_tags
boolean_values
filter_json_object
filter_json_single_key_object
shrink
max_depth
max_size
encode
decode
decode_prefix

FLAGS FOR JSON::PP ONLY

allow_singlequote
allow_barekey
allow_bignum
loose
escape_slash
indent_length
sort_by

INCREMENTAL PARSING

incr_parse
incr_text
incr_skip
incr_reset

MAPPING

JSON -> PERL

object, array, string, number, true, false, null, shell-style comments ("# text"), tagged values ("(tag)value")

PERL -> JSON

hash references, array references, other references, JSON::PP::true, JSON::PP::false, JSON::PP::null, blessed objects, simple scalars

OBJECT SERIALISATION

1. "allow_tags" is enabled and the object has a "FREEZE" method, 2. "convert_blessed" is enabled and the object has a "TO_JSON" method, 3. "allow_bignum" is enabled and the object is a "Math::BigInt" or "Math::BigFloat", 4. "allow_blessed" is enabled, 5. none of the above

ENCODING/CODESET FLAG NOTES

"utf8" flag disabled, "utf8" flag enabled, "latin1" or "ascii" flags enabled

BUGS
SEE ALSO
AUTHOR
CURRENT MAINTAINER
COPYRIGHT AND LICENSE

JSON::PP::Boolean - dummy module providing JSON::PP::Boolean
SYNOPSIS
DESCRIPTION
AUTHOR
LICENSE

List::Util - A selection of general-utility list subroutines
SYNOPSIS
DESCRIPTION
LIST-REDUCTION FUNCTIONS
reduce
reductions

	any
	all

none
notall
first

max

maxstr

min

minstr
product

sum

sum0
KEY/VALUE PAIR LIST FUNCTIONS
pairs
unpairs
pairkeys
pairvalues
pairgrep
pairfirst
pairmap
OTHER FUNCTIONS
shuffle
sample
uniq
uniqint
uniqnum
uniqstr
head
tail
CONFIGURATION VARIABLES

$RAND

KNOWN BUGS

RT #95409
uniqnum() on oversized bignums

SUGGESTED ADDITIONS
SEE ALSO
COPYRIGHT

List::Util::XS - Indicate if List::Util was compiled with a C compiler
SYNOPSIS
DESCRIPTION
SEE ALSO
COPYRIGHT

Locale::Maketext - framework for localization
SYNOPSIS
DESCRIPTION
QUICK OVERVIEW
METHODS

Construction Methods
The "maketext" Method

$lh->fail_with or $lh->fail_with( PARAM ), $lh->failure_handler_auto, $lh->blacklist(@list), $lh->whitelist(@list)

Utility Methods

$language->quant($number, $singular), $language->quant($number, $singular, $plural), $language->quant($number, $singular, $plural, $negative), $language->numf($number), $language->numerate($number, $singular, $plural, $negative), $language->sprintf($format, @items), $language->language_tag(), $language->encoding()

Language Handle Attributes and Internals

LANGUAGE CLASS HIERARCHIES
ENTRIES IN EACH LEXICON
BRACKET NOTATION
BRACKET NOTATION SECURITY
AUTO LEXICONS
READONLY LEXICONS
CONTROLLING LOOKUP FAILURE
HOW TO USE MAKETEXT
SEE ALSO
COPYRIGHT AND DISCLAIMER
AUTHOR

Locale::Maketext::Cookbook - recipes for using Locale::Maketext
INTRODUCTION
ONESIDED LEXICONS
DECIMAL PLACES IN NUMBER FORMATTING

Locale::Maketext::Guts - Deprecated module to load Locale::Maketext utf8 code
SYNOPSIS
DESCRIPTION

Locale::Maketext::GutsLoader - Deprecated module to load Locale::Maketext utf8 code
SYNOPSIS
DESCRIPTION

Locale::Maketext::Simple - Simple interface to Locale::Maketext::Lexicon
VERSION
SYNOPSIS
DESCRIPTION
OPTIONS

Class
Path
Style
Export
Subclass
Decode
Encoding

ACKNOWLEDGMENTS
SEE ALSO
AUTHORS
COPYRIGHT

The " MIT" License

Locale::Maketext::TPJ13 -- article about software localization
SYNOPSIS
DESCRIPTION
Localization and Perl: gettext breaks, Maketext fixes

A Localization Horror Story: It Could Happen To You
The Linguistic View
Breaking gettext
Replacing gettext
Buzzwords: Abstraction and Encapsulation
Buzzword: Isomorphism
Buzzword: Inheritance
Buzzword: Concision
The Devil in the Details
The Proof in the Pudding: Localizing Web Sites
References

MIME::Base64 - Encoding and decoding of base64 strings
SYNOPSIS
DESCRIPTION

encode_base64( $bytes ), encode_base64( $bytes, $eol );, decode_base64( $str ), encode_base64url( $bytes ), decode_base64url( $str ), encoded_base64_length( $bytes ), encoded_base64_length( $bytes, $eol ), decoded_base64_length( $str )

EXAMPLES
COPYRIGHT
SEE ALSO

MIME::QuotedPrint - Encoding and decoding of quoted-printable strings
SYNOPSIS
DESCRIPTION

encode_qp( $str), encode_qp( $str, $eol), encode_qp( $str, $eol, $binmode ), decode_qp( $str )

Math::BigFloat - Arbitrary size floating point math package
SYNOPSIS
DESCRIPTION

Input
Output

METHODS

Configuration methods

accuracy(), precision()

Constructor methods

from_hex(), from_oct(), from_bin(), from_ieee754(), bpi()

Arithmetic methods

bmuladd(), bdiv(), bmod(), bexp(), bnok(), bsin(), bcos(), batan(), batan2(), as_float(), to_ieee754()

ACCURACY AND PRECISION
Rounding

bfround ( +$scale ), bfround ( -$scale ), bfround ( 0 ), bround ( +$scale ), bround ( -$scale ) and bround ( 0 )

Autocreating constants

Math library
Using Math::BigInt::Lite

EXPORTS
CAVEATS

stringify, bstr(), brsft(), Modifying and =, precision() vs. accuracy()

BUGS
SUPPORT

RT: CPAN ’s request tracker, AnnoCPAN: Annotated CPAN documentation, CPAN Ratings, MetaCPAN, CPAN Testers Matrix, The Bignum mailing list, Post to mailing list, View mailing list, Subscribe/Unsubscribe

LICENSE
SEE ALSO
AUTHORS

Math::BigInt - Arbitrary size integer/float math package
SYNOPSIS
DESCRIPTION

Input
Output

METHODS

Configuration methods

accuracy(), precision(), div_scale(), round_mode(), upgrade(), downgrade(), modify(), config()

Constructor methods

new(), from_hex(), from_oct(), from_bin(), from_bytes(), from_base(), bzero(), bone(), binf(), bnan(), bpi(), copy(), as_int(), as_number()

Boolean methods

is_zero(), is_one( [ SIGN ]), is_finite(), is_inf( [ SIGN ] ), is_nan(), is_positive(), is_pos(), is_negative(), is_neg(), is_non_positive(), is_non_negative(), is_odd(), is_even(), is_int()

Comparison methods

bcmp(), bacmp(), beq(), bne(), blt(), ble(), bgt(), bge()

Arithmetic methods

bneg(), babs(), bsgn(), bnorm(), binc(), bdec(), badd(), bsub(), bmul(), bmuladd(), bdiv(), btdiv(), bmod(), btmod(), bmodinv(), bmodpow(), bpow(), blog(), bexp(), bnok(), buparrow(), uparrow(), backermann(), ackermann(), bsin(), bcos(), batan(), batan2(), bsqrt(), broot(), bfac(), bdfac(), bfib(), blucas(), brsft(), blsft()

Bitwise methods

band(), bior(), bxor(), bnot()

Rounding methods

round(), bround(), bfround(), bfloor(), bceil(), bint()

Other mathematical methods

bgcd(), blcm()

Object property methods

sign(), digit(), digitsum(), bdigitsum(), length(), mantissa(), exponent(), parts(), sparts(), nparts(), eparts(), dparts()

String conversion methods

bstr(), bsstr(), bnstr(), bestr(), bdstr(), to_hex(), to_bin(), to_oct(), to_bytes(), to_base(), as_hex(), as_bin(), as_oct(), as_bytes()

Other conversion methods

numify()

ACCURACY and PRECISION

Precision P
Accuracy A
Fallback F
Rounding mode R

’trunc’, ’even’, ’odd’, ’+inf’, ’-inf’, ’zero’, ’common’, Precision, Accuracy (significant digits), Setting/Accessing, Creating numbers, Usage, Precedence, Overriding globals, Local settings, Rounding, Default values, Remarks

Infinity and Not a Number

oct()/hex()

INTERNALS

MATH LIBRARY
SIGN

EXAMPLES
Autocreating constants
PERFORMANCE

Alternative math libraries

SUBCLASSING

Subclassing Math::BigInt

UPGRADING

Auto-upgrade

EXPORTS
CAVEATS

Comparing numbers as strings, int(), Modifying and =, Overloading -$x, Mixing different object types

BUGS
SUPPORT

LICENSE
SEE ALSO
AUTHORS

Math::BigInt::Calc - Pure Perl module to support Math::BigInt
SYNOPSIS
DESCRIPTION
SEE ALSO

Math::BigInt::FastCalc - Math::BigInt::Calc with some XS for more speed
SYNOPSIS
DESCRIPTION
STORAGE
METHODS
BUGS
SUPPORT

RT: CPAN ’s request tracker, AnnoCPAN: Annotated CPAN documentation, CPAN Ratings, Search CPAN, CPAN Testers Matrix, The Bignum mailing list, Post to mailing list, View mailing list, Subscribe/Unsubscribe

LICENSE
AUTHORS
SEE ALSO

Math::BigInt::Lib - virtual parent class for Math::BigInt libraries
SYNOPSIS
DESCRIPTION

General Notes

CLASS- >api_version(), CLASS- >_new( STR ), CLASS- >_zero(), CLASS- >_one(), CLASS- >_two(), CLASS- >_ten(), CLASS- >_from_bin( STR ), CLASS- >_from_oct( STR ), CLASS- >_from_hex( STR ), CLASS- >_from_bytes( STR ), CLASS- >_from_base( STR, BASE, COLLSEQ ), CLASS- >_add( OBJ1, OBJ2 ), CLASS- >_mul( OBJ1, OBJ2 ), CLASS- >_div( OBJ1, OBJ2 ), CLASS- >_sub( OBJ1, OBJ2, FLAG ), CLASS- >_sub( OBJ1, OBJ2 ), CLASS- >_dec( OBJ ), CLASS- >_inc( OBJ ), CLASS- >_mod( OBJ1, OBJ2 ), CLASS- >_sqrt( OBJ ), CLASS- >_root( OBJ, N ), CLASS- >_fac( OBJ ), CLASS- >_dfac( OBJ ), CLASS- >_pow( OBJ1, OBJ2 ), CLASS- >_modinv( OBJ1, OBJ2 ), CLASS- >_modpow( OBJ1, OBJ2, OBJ3 ), CLASS- >_rsft( OBJ, N, B ), CLASS- >_lsft( OBJ, N, B ), CLASS- >_log_int( OBJ, B ), CLASS- >_gcd( OBJ1, OBJ2 ), CLASS- >_lcm( OBJ1, OBJ2 ), CLASS- >_fib( OBJ ), CLASS- >_lucas( OBJ ), CLASS- >_and( OBJ1, OBJ2 ), CLASS- >_or( OBJ1, OBJ2 ), CLASS- >_xor( OBJ1, OBJ2 ), CLASS- >_sand( OBJ1, OBJ2, SIGN1, SIGN2 ), CLASS- >_sor( OBJ1, OBJ2, SIGN1, SIGN2 ), CLASS- >_sxor( OBJ1, OBJ2, SIGN1, SIGN2 ), CLASS- >_is_zero( OBJ ), CLASS- >_is_one( OBJ ), CLASS- >_is_two( OBJ ), CLASS- >_is_ten( OBJ ), CLASS- >_is_even( OBJ ), CLASS- >_is_odd( OBJ ), CLASS- >_acmp( OBJ1, OBJ2 ), CLASS- >_str( OBJ ), CLASS- >_to_bin( OBJ ), CLASS- >_to_oct( OBJ ), CLASS- >_to_hex( OBJ ), CLASS- >_to_bytes( OBJ ), CLASS- >_to_base( OBJ, BASE, COLLSEQ ), CLASS- >_as_bin( OBJ ), CLASS- >_as_oct( OBJ ), CLASS- >_as_hex( OBJ ), CLASS- >_as_bytes( OBJ ), CLASS- >_num( OBJ ), CLASS- >_copy( OBJ ), CLASS- >_len( OBJ ), CLASS- >_zeros( OBJ ), CLASS- >_digit( OBJ, N ), CLASS- >_digitsum( OBJ ), CLASS- >_check( OBJ ), CLASS- >_set( OBJ )

API version 2

CLASS- >_1ex(N), CLASS- >_nok( OBJ1, OBJ2 ), CLASS- >_alen( OBJ )

WRAP YOUR OWN
BUGS
SUPPORT

LICENSE
AUTHOR
SEE ALSO

Math::BigRat - Arbitrary big rational numbers
SYNOPSIS
DESCRIPTION

MATH LIBRARY

METHODS

new(), numerator(), denominator(), parts(), numify(), as_int(), as_number(), as_float(), as_hex(), as_bin(), as_oct(), from_hex(), from_oct(), from_bin(), bnan(), bzero(), binf(), bone(), length(), digit(), bnorm(), bfac(), bround()/round()/bfround(), bmod(), bmodinv(), bmodpow(), bneg(), is_one(), is_zero(), is_pos()/is_positive(), is_neg()/is_negative(), is_int(), is_odd(), is_even(), bceil(), bfloor(), bint(), bsqrt(), broot(), badd(), bmul(), bsub(), bdiv(), bdec(), binc(), copy(), bstr()/bsstr(), bcmp(), bacmp(), beq(), bne(), blt(), ble(), bgt(), bge(), blsft()/brsft(), band(), bior(), bxor(), bnot(), bpow(), blog(), bexp(), bnok(), config()

BUGS
SUPPORT

LICENSE
SEE ALSO
AUTHORS

Math::Complex - complex numbers and associated mathematical functions
SYNOPSIS
DESCRIPTION
OPERATIONS
CREATION
DISPLAYING

CHANGED IN PERL 5.6

USAGE
CONSTANTS

	PI
	Inf

ERRORS DUE TO DIVISION BY ZERO OR LOGARITHM OF ZERO
ERRORS DUE TO INDIGESTIBLE ARGUMENTS
BUGS
SEE ALSO
AUTHORS
LICENSE

Math::Trig - trigonometric functions
SYNOPSIS
DESCRIPTION
ANGLES
TRIGONOMETRIC FUNCTIONS

tan
ERRORS DUE TO DIVISION BY ZERO
SIMPLE ( REAL ) ARGUMENTS, COMPLEX RESULTS

PLANE ANGLE CONVERSIONS

deg2rad, grad2rad, rad2deg, grad2deg, deg2grad, rad2grad, rad2rad, deg2deg, grad2grad

RADIAL COORDINATE CONVERSIONS

COORDINATE SYSTEMS
3-D ANGLE CONVERSIONS

cartesian_to_cylindrical, cartesian_to_spherical, cylindrical_to_cartesian, cylindrical_to_spherical, spherical_to_cartesian, spherical_to_cylindrical

GREAT CIRCLE DISTANCES AND DIRECTIONS

great_circle_distance
great_circle_direction
great_circle_bearing
great_circle_destination
great_circle_midpoint
great_circle_waypoint

EXAMPLES

CAVEAT FOR GREAT CIRCLE FORMULAS
Real-valued asin and acos

asin_real, acos_real

BUGS
SEE ALSO
AUTHORS
LICENSE

Memoize - Make functions faster by trading space for time
SYNOPSIS
DESCRIPTION
DETAILS
OPTIONS

INSTALL
NORMALIZER
"SCALAR_CACHE", "LIST_CACHE"

"MEMORY", "HASH", "TIE", "FAULT", "MERGE"

OTHER FACILITIES

"unmemoize"
"flush_cache"

CAVEATS
PERSISTENT CACHE SUPPORT
EXPIRATION SUPPORT
BUGS
MAILING LIST
AUTHOR
COPYRIGHT AND LICENSE
THANK YOU

Memoize::AnyDBM_File - glue to provide EXISTS for AnyDBM_File for Storable use
DESCRIPTION

Memoize::Expire - Plug-in module for automatic expiration of memoized values
SYNOPSIS
DESCRIPTION
INTERFACE

 TIEHASH,  EXISTS,  STORE

ALTERNATIVES
CAVEATS
AUTHOR
SEE ALSO

Memoize::ExpireFile - test for Memoize expiration semantics
DESCRIPTION

Memoize::ExpireTest - test for Memoize expiration semantics
DESCRIPTION

Memoize::NDBM_File - glue to provide EXISTS for NDBM_File for Storable use
DESCRIPTION

Memoize::SDBM_File - glue to provide EXISTS for SDBM_File for Storable use
DESCRIPTION

Memoize::Storable - store Memoized data in Storable database
DESCRIPTION

Module::CoreList - what modules shipped with versions of perl
SYNOPSIS
DESCRIPTION
FUNCTIONS API

"first_release( MODULE )", "first_release_by_date( MODULE )", "find_modules( REGEX, [ LIST OF PERLS ] )", "find_version( PERL_VERSION )", "is_core( MODULE, [ MODULE_VERSION, [ PERL_VERSION ] ] )", "is_deprecated( MODULE, PERL_VERSION )", "deprecated_in( MODULE )", "removed_from( MODULE )", "removed_from_by_date( MODULE )", "changes_between( PERL_VERSION, PERL_VERSION )"

DATA STRUCTURES

%Module::CoreList::version, %Module::CoreList::delta, %Module::CoreList::released, %Module::CoreList::families, %Module::CoreList::deprecated, %Module::CoreList::upstream, %Module::CoreList::bug_tracker

CAVEATS
HISTORY
AUTHOR
LICENSE
SEE ALSO

Module::CoreList::Utils - what utilities shipped with versions of perl
SYNOPSIS
DESCRIPTION
FUNCTIONS API

"utilities", "first_release( UTILITY )", "first_release_by_date( UTILITY )", "removed_from( UTILITY )", "removed_from_by_date( UTILITY )"

DATA STRUCTURES

%Module::CoreList::Utils::utilities

AUTHOR
LICENSE
SEE ALSO

Module::Load - runtime require of both modules and files
SYNOPSIS
DESCRIPTION

Difference between "load" and "autoload"

FUNCTIONS

load, autoload, load_remote, autoload_remote

Rules
IMPORTS THE FUNCTIONS

"load","autoload","load_remote","autoload_remote", ’all’, ’’,’none’,undef

Caveats
SEE ALSO
ACKNOWLEDGEMENTS
BUG REPORTS
AUTHOR
COPYRIGHT

Module::Load::Conditional - Looking up module information / loading at runtime
SYNOPSIS
DESCRIPTION
Methods

$href = check_install( module => NAME [, version => VERSION,
verbose => BOOL ] );

module, version, verbose, file, dir, version, uptodate

$bool = can_load( modules => { NAME => VERSION [,NAME => VERSION ] },
[verbose => BOOL, nocache => BOOL, autoload => BOOL ] )

modules, verbose, nocache, autoload

@list = requires( MODULE );
Global Variables

$Module::Load::Conditional::VERBOSE
$Module::Load::Conditional::FIND_VERSION
$Module::Load::Conditional::CHECK_INC_HASH
$Module::Load::Conditional::FORCE_SAFE_INC
$Module::Load::Conditional::CACHE
$Module::Load::Conditional::ERROR
$Module::Load::Conditional::DEPRECATED

SEE ALSO

TAP::Parser::Iterator::Array - Iterator for array-based TAP sources
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods
Instance Methods

ATTRIBUTION
SEE ALSO

TAP::Parser::Iterator::Process - Iterator for process-based TAP sources
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods
Instance Methods

ATTRIBUTION
SEE ALSO

TAP::Parser::Iterator::Stream - Iterator for filehandle-based TAP sources
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

Instance Methods
ATTRIBUTION
SEE ALSO

TAP::Parser::IteratorFactory - Figures out which SourceHandler objects to use for a given Source
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

Instance Methods
SUBCLASSING

Example

AUTHORS
ATTRIBUTION
SEE ALSO

TAP::Parser::Multiplexer - Multiplex multiple TAP::Parsers
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

Instance Methods
See Also

TAP::Parser::Result - Base class for TAP::Parser output objects
VERSION
SYNOPSIS

DESCRIPTION
METHODS

Boolean methods

"is_plan", "is_pragma", "is_test", "is_comment", "is_bailout", "is_version", "is_unknown", "is_yaml"

SUBCLASSING

Example

SEE ALSO

TAP::Parser::Result::Bailout - Bailout result token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string"

Instance Methods

TAP::Parser::Result::Comment - Comment result token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string"

Instance Methods

TAP::Parser::Result::Plan - Plan result token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string", "raw"

Instance Methods

TAP::Parser::Result::Pragma - TAP pragma token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string", "raw"

Instance Methods

TAP::Parser::Result::Test - Test result token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

Instance Methods

TAP::Parser::Result::Unknown - Unknown result token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string", "raw"

TAP::Parser::Result::Version - TAP syntax version token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string", "raw"

Instance Methods

TAP::Parser::Result::YAML - YAML result token.
VERSION
DESCRIPTION
OVERRIDDEN METHODS

"as_string", "raw"

Instance Methods

TAP::Parser::ResultFactory - Factory for creating TAP::Parser output objects
SYNOPSIS
VERSION
DESCRIPTION
METHODS
Class Methods
SUBCLASSING

Example

SEE ALSO

TAP::Parser::Scheduler - Schedule tests during parallel testing
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods
Rules data structure

By default, all tests are eligible to be run in parallel. Specifying any of your own rules removes this one, "First match wins". The first rule that matches a test will be the one that applies, Any test which does not match a rule will be run in sequence at the end of the run, The existence of a rule does not imply selecting a test. You must still specify the tests to run, Specifying a rule to allow tests to run in parallel does not make the run in parallel. You still need specify the number of parallel "jobs" in your Harness object

Instance Methods

TAP::Parser::Scheduler::Job - A single testing job.
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

Instance Methods
Attributes

TAP::Parser::Scheduler::Spinner - A no-op job.
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

Instance Methods
SEE ALSO

TAP::Parser::Source - a TAP source & meta data about it
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

Instance Methods
AUTHORS
SEE ALSO

TAP::Parser::SourceHandler - Base class for different TAP source handlers
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

SUBCLASSING

Example

AUTHORS
SEE ALSO

TAP::Parser::SourceHandler::Executable - Stream output from an executable TAP source
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

SUBCLASSING

Example

SEE ALSO

TAP::Parser::SourceHandler::File - Stream TAP from a text file.
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

CONFIGURATION
SUBCLASSING
SEE ALSO

TAP::Parser::SourceHandler::Handle - Stream TAP from an IO::Handle or a GLOB.
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

SUBCLASSING
SEE ALSO

TAP::Parser::SourceHandler::Perl - Stream TAP from a Perl executable
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

SUBCLASSING

Example

SEE ALSO

TAP::Parser::SourceHandler::RawTAP - Stream output from raw TAP in a scalar/array ref.
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods

SUBCLASSING
SEE ALSO

TAP::Parser::YAMLish::Reader - Read YAMLish data from iterator
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods
Instance Methods

AUTHOR
SEE ALSO
COPYRIGHT

TAP::Parser::YAMLish::Writer - Write YAMLish data
VERSION
SYNOPSIS
DESCRIPTION
METHODS

Class Methods
Instance Methods

a reference to a scalar to append YAML to, the handle of an open file, a reference to an array into which YAML will be pushed, a code reference

AUTHOR
SEE ALSO
COPYRIGHT

Term::ANSIColor - Color screen output using ANSI escape sequences
SYNOPSIS
DESCRIPTION

Supported Colors
Function Interface

color(ATTR[, ATTR ... ]), colored( STRING, ATTR[, ATTR ... ]), colored( ATTR-REF, STRING[, STRING... ]), uncolor( ESCAPE ), colorstrip(STRING[, STRING ... ]), colorvalid(ATTR[, ATTR ... ]), coloralias(ALIAS[, ATTR ... ])

Constant Interface
The Color Stack
Supporting CLICOLOR

DIAGNOSTICS

Bad color mapping %s, Bad escape sequence %s, Bareword "%s" not allowed while "strict subs" in use, Cannot alias standard color %s, Cannot alias standard color %s in %s, Invalid alias name %s, Invalid alias name %s in %s, Invalid attribute name %s, Invalid attribute name %s in %s, Name "%s" used only once: possible typo, No comma allowed after filehandle, No name for escape sequence %s

ENVIRONMENT

ANSI_COLORS_ALIASES, ANSI_COLORS_DISABLED, NO_COLOR

COMPATIBILITY
RESTRICTIONS
NOTES
AUTHORS
COPYRIGHT AND LICENSE
SEE ALSO

Term::Cap - Perl termcap interface
SYNOPSIS
DESCRIPTION

METHODS

Tgetent, OSPEED, TERM

Tpad, $string, $cnt, $FH

Tputs, $cap, $cnt, $FH

Tgoto, $cap, $col, $row, $FH

Trequire
EXAMPLES
COPYRIGHT AND LICENSE
AUTHOR
SEE ALSO

Term::Complete - Perl word completion module
SYNOPSIS
DESCRIPTION

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", Attribs, "Features"

Additional supported functions

"tkRunning", "event_loop", "ornaments", "newTTY"

EXPORTS
ENVIRONMENT

Test - provides a simple framework for writing test scripts
SYNOPSIS
DESCRIPTION
QUICK START GUIDE

Functions

"plan(...)", "tests => number", "todo => [1,5,14]", "onfail => sub { ... }", "onfail => \&some_sub"

_to_value

"ok(...)"

"skip(skip_if_true, args...)"
TEST TYPES

NORMAL TESTS, SKIPPED TESTS, TODO TESTS

ONFAIL
BUGS and CAVEATS
ENVIRONMENT
NOTE
SEE ALSO
AUTHOR

Test2 - Framework for writing test tools that all work together.
DESCRIPTION

WHAT IS NEW ?

Easier to test new testing tools, Better diagnostics capabilities, Event driven, More complete API, Support for output other than TAP, Subtest implementation is more sane, Support for threading/forking

GETTING STARTED

Test2, This describes the namespace layout for the Test2 ecosystem. Not all the namespaces listed here are part of the Test2 distribution, some are implemented in Test2::Suite.
Test2::Tools::
Test2::Plugin::
Test2::Bundle::
Test2::Require::
Test2::Formatter::
Test2::Event::
Test2::Hub::
Test2::IPC::
Test2::Util::
Test2::API::
Test2::
SEE ALSO
CONTACTING US
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::API - Primary interface for writing Test2 based testing tools.
***INTERNALS NOTE***
DESCRIPTION
SYNOPSIS

WRITING A TOOL
TESTING YOUR TOOLS

The event from "ok(1, "pass")", The plan event for the subtest, The subtest event itself, with the first 2 events nested inside it as children

OTHER API FUNCTIONS

MAIN API EXPORTS

context(...)

$ctx = context(), $ctx = context(%params), level => $int, wrapped => $int, stack => $stack, hub => $hub, on_init => sub { ... }, on_release => sub { ... }

release($;$)

release $ctx;, release $ctx, ...;

context_do(&;@)
no_context(&;$)

no_context { ... };, no_context { ... } $hid;

intercept(&)
run_subtest(...)

$NAME, \&CODE, $BUFFERED or \%PARAMS, ’buffered’ => $bool, ’inherit_trace’ => $bool, ’no_fork’ => $bool, @ARGS, Things not effected by this flag, Things that are effected by this flag, Things that are formatter dependant

OTHER API EXPORTS

STATUS AND INITIALIZATION STATE

$bool = test2_init_done(), $bool = test2_load_done(), test2_set_is_end(), test2_set_is_end($bool), $bool = test2_get_is_end(), $stack = test2_stack(), $bool = test2_is_testing_done(), test2_ipc_disable, $bool = test2_ipc_diabled, test2_ipc_wait_enable(), test2_ipc_wait_disable(), $bool = test2_ipc_wait_enabled(), $bool = test2_no_wait(), test2_no_wait($bool), $fh = test2_stdout(), $fh = test2_stderr(), test2_reset_io()

BEHAVIOR HOOKS

test2_add_callback_exit(sub { ... }), test2_add_callback_post_load(sub { ... }), test2_add_callback_testing_done(sub { ... }), test2_add_callback_context_acquire(sub { ... }), test2_add_callback_context_init(sub { ... }), test2_add_callback_context_release(sub { ... }), test2_add_callback_pre_subtest(sub { ... }), @list = test2_list_context_acquire_callbacks(), @list = test2_list_context_init_callbacks(), @list = test2_list_context_release_callbacks(), @list = test2_list_exit_callbacks(), @list = test2_list_post_load_callbacks(), @list = test2_list_pre_subtest_callbacks(), test2_add_uuid_via(sub { ... }), $sub = test2_add_uuid_via()

IPC AND CONCURRENCY

$bool = test2_has_ipc(), $ipc = test2_ipc(), test2_ipc_add_driver($DRIVER), @drivers = test2_ipc_drivers(), $bool = test2_ipc_polling(), test2_ipc_enable_polling(), test2_ipc_disable_polling(), test2_ipc_enable_shm(), test2_ipc_set_pending($uniq_val), $pending = test2_ipc_get_pending(), $timeout = test2_ipc_get_timeout(), test2_ipc_set_timeout($timeout)

MANAGING FORMATTERS

$formatter = test2_formatter, test2_formatter_set($class_or_instance), @formatters = test2_formatters(), test2_formatter_add($class_or_instance)

OTHER EXAMPLES
SEE ALSO
MAGIC
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::API::Breakage - What breaks at what version
DESCRIPTION
FUNCTIONS

%mod_ver = upgrade_suggested(), %mod_ver = Test2::API::Breakage->upgrade_suggested(), %mod_ver = upgrade_required(), %mod_ver = Test2::API::Breakage->upgrade_required(), %mod_ver = known_broken(), %mod_ver = Test2::API::Breakage->known_broken()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::API::Context - Object to represent a testing context.
DESCRIPTION
SYNOPSIS
CRITICAL DETAILS

you MUST always use the context() sub from Test2::API, You MUST always release the context when done with it, You MUST NOT pass context objects around, You MUST NOT store or cache a context for later, You SHOULD obtain your context as soon as possible in a given tool

METHODS

$ctx->done_testing;, $clone = $ctx->snapshot(), $ctx->release(), $ctx->throw($message), $ctx->alert($message), $stack = $ctx->stack(), $hub = $ctx->hub(), $dbg = $ctx->trace(), $ctx->do_in_context(\&code, @args);, $ctx->restore_error_vars(), $! = $ctx->errno(), $? = $ctx->child_error(), $@ = $ctx->eval_error()
EVENT PRODUCTION METHODS

$event = $ctx->pass(), $event = $ctx->pass($name), $true = $ctx->pass_and_release(), $true = $ctx->pass_and_release($name), my $event = $ctx->fail(), my $event = $ctx->fail($name), my $event = $ctx->fail($name, @diagnostics), my $false = $ctx->fail_and_release(), my $false = $ctx->fail_and_release($name), my $false = $ctx->fail_and_release($name, @diagnostics), $event = $ctx->ok($bool, $name), $event = $ctx->ok($bool, $name, \@on_fail), $event = $ctx->note($message), $event = $ctx->diag($message), $event = $ctx->plan($max), $event = $ctx->plan(0, ’ SKIP ’, $reason), $event = $ctx->skip($name, $reason);, $event = $ctx->bail($reason), $event = $ctx->send_ev2(%facets), $event = $ctx->build_e2(%facets), $event = $ctx->send_ev2_and_release($Type, %parameters), $event = $ctx->send_event($Type, %parameters), $event = $ctx->build_event($Type, %parameters), $event = $ctx->send_event_and_release($Type, %parameters)

HOOKS

INIT HOOKS
RELEASE HOOKS

THIRD PARTY META-DATA
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>, Kent Fredric <kentnl [AT] cpan.org>

Test2::API::Instance - Object used by Test2::API under the hood
DESCRIPTION
SYNOPSIS

$pid = $obj->pid, $obj->tid, $obj->reset(), $obj->load(), $bool = $obj->loaded, $arrayref = $obj->post_load_callbacks, $obj->add_post_load_callback(sub { ... }), $hashref = $obj->contexts(), $arrayref = $obj->context_acquire_callbacks, $arrayref = $obj->context_init_callbacks, $arrayref = $obj->context_release_callbacks, $arrayref = $obj->pre_subtest_callbacks, $obj->add_context_init_callback(sub { ... }), $obj->add_context_release_callback(sub { ... }), $obj->add_pre_subtest_callback(sub { ... }), $obj->set_exit(), $obj->set_ipc_pending($val), $pending = $obj->get_ipc_pending(), $timeout = $obj->ipc_timeout;, $obj->set_ipc_timeout($timeout);, $drivers = $obj->ipc_drivers, $obj->add_ipc_driver($DRIVER_CLASS), $bool = $obj->ipc_polling, $obj->enable_ipc_polling, $obj->disable_ipc_polling, $bool = $obj->no_wait, $bool = $obj->set_no_wait($bool), $arrayref = $obj->exit_callbacks, $obj->add_exit_callback(sub { ... }), $bool = $obj->finalized, $ipc = $obj->ipc, $obj->ipc_disable, $bool = $obj->ipc_disabled, $stack = $obj->stack, $formatter = $obj->formatter, $bool = $obj->formatter_set(), $obj->add_formatter($class), $obj->add_formatter($obj), $obj->set_add_uuid_via(sub { ... }), $sub = $obj->add_uuid_via()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::API::Stack - Object to manage a stack of Test2::Hub instances.
***INTERNALS NOTE***
DESCRIPTION
SYNOPSIS
METHODS

$stack = Test2::API::Stack->new(), $hub = $stack->new_hub(), $hub = $stack->new_hub(%params), $hub = $stack->new_hub(%params, class => $class), $hub = $stack->top(), $hub = $stack->peek(), $stack->cull, @hubs = $stack->all, $stack->clear, $stack->push($hub), $stack->pop($hub)

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event - Base class for events
DESCRIPTION
SYNOPSIS
METHODS

GENERAL

$trace = $e->trace, $bool_or_undef = $e->related($e2), $e->add_amnesty({tag => $TAG, details => $DETAILS});, $uuid = $e->uuid, $class = $e->load_facet($name), @classes = $e-> FACET_TYPES (), @classes = Test2::Event-> FACET_TYPES ()

NEW API

$hashref = $e->common_facet_data();, $hashref = $e->facet_data(), $hashref = $e->facets(), @errors = $e->validate_facet_data();, @errors = $e->validate_facet_data(%params);, @errors = $e->validate_facet_data(\%facets, %params);, @errors = Test2::Event->validate_facet_data(%params);, @errors = Test2::Event->validate_facet_data(\%facets, %params);, require_facet_class => $BOOL, about => {...}, assert => {...}, control => {...}, meta => {...}, parent => {...}, plan => {...}, trace => {...}, amnesty => [{...}, ...], errors => [{...}, ...], info => [{...}, ...]

LEGACY API

$bool = $e->causes_fail, $bool = $e->increments_count, $e->callback($hub), $num = $e->nested, $bool = $e->global, $code = $e->terminate, $msg = $e->summary, ($count, $directive, $reason) = $e->sets_plan(), $bool = $e->diagnostics, $bool = $e->no_display, $id = $e->in_subtest, $id = $e->subtest_id

THIRD PARTY META-DATA
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Bail - Bailout!
DESCRIPTION
SYNOPSIS
METHODS

$reason = $e->reason

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Diag - Diag event type
DESCRIPTION
SYNOPSIS
ACCESSORS

$diag->message

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Encoding - Set the encoding for the output stream
DESCRIPTION
SYNOPSIS
METHODS

$encoding = $e->encoding

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Exception - Exception event
DESCRIPTION
SYNOPSIS
METHODS

$reason = $e->error

CAVEATS
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Fail - Event for a simple failed assertion
DESCRIPTION
SYNOPSIS
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Generic - Generic event type.
DESCRIPTION
SYNOPSIS
METHODS

$e->facet_data($data), $data = $e->facet_data, $e->callback($hub), $e->set_callback(sub { ... }), $bool = $e->causes_fail, $e->set_causes_fail($bool), $bool = $e->diagnostics, $e->set_diagnostics($bool), $bool_or_undef = $e->global, @bool_or_empty = $e->global, $e->set_global($bool_or_undef), $bool = $e->increments_count, $e->set_increments_count($bool), $bool = $e->no_display, $e->set_no_display($bool), @plan = $e->sets_plan, $e->set_sets_plan(\@plan), $summary = $e->summary, $e->set_summary($summary_or_undef), $int_or_undef = $e->terminate, @int_or_empty = $e->terminate, $e->set_terminate($int_or_undef)

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Note - Note event type
DESCRIPTION
SYNOPSIS
ACCESSORS

$note->message

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Ok - Ok event type
DESCRIPTION
SYNOPSIS
ACCESSORS

$rb = $e->pass, $name = $e->name, $b = $e->effective_pass

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Pass - Event for a simple passing assertion
DESCRIPTION
SYNOPSIS
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Plan - The event of a plan
DESCRIPTION
SYNOPSIS
ACCESSORS

$num = $plan->max, $dir = $plan->directive, $reason = $plan->reason

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Skip - Skip event type
DESCRIPTION
SYNOPSIS
ACCESSORS

$reason = $e->reason

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Subtest - Event for subtest types
DESCRIPTION
ACCESSORS

$arrayref = $e->subevents, $bool = $e->buffered

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::TAP::Version - Event for TAP version.
DESCRIPTION
SYNOPSIS
METHODS

$version = $e->version

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::V2 - Second generation event.
DESCRIPTION
SYNOPSIS

USING A CONTEXT
USING THE CONSTRUCTOR

METHODS

$fd = $e->facet_data(), $about = $e->about(), $trace = $e->trace()
MUTATION

$e->add_amnesty({...}), $e->add_hub({...}), $e->set_uuid($UUID), $e->set_trace($trace)

LEGACY SUPPORT METHODS

causes_fail, diagnostics, global, increments_count, no_display, sets_plan, subtest_id, summary, terminate

THIRD PARTY META-DATA
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Event::Waiting - Tell all procs/threads it is time to be done
DESCRIPTION
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet - Base class for all event facets.
DESCRIPTION
METHODS

$key = $facet_class->facet_key(), $bool = $facet_class->is_list(), $clone = $facet->clone(), $clone = $facet->clone(%replace)

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::About - Facet with event details.
DESCRIPTION
FIELDS

$string = $about->{details}, $string = $about->details(), $package = $about->{package}, $package = $about->package(), $bool = $about->{no_display}, $bool = $about->no_display(), $uuid = $about->{uuid}, $uuid = $about->uuid(), $uuid = $about->{eid}, $uuid = $about->eid()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Amnesty - Facet for assertion amnesty.
DESCRIPTION
NOTES
FIELDS

$string = $amnesty->{details}, $string = $amnesty->details(), $short_string = $amnesty->{tag}, $short_string = $amnesty->tag(), $bool = $amnesty->{inherited}, $bool = $amnesty->inherited()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Assert - Facet representing an assertion.
DESCRIPTION
FIELDS

$string = $assert->{details}, $string = $assert->details(), $bool = $assert->{pass}, $bool = $assert->pass(), $bool = $assert->{no_debug}, $bool = $assert->no_debug(), $int = $assert->{number}, $int = $assert->number()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Control - Facet for hub actions and behaviors.
DESCRIPTION
FIELDS

$string = $control->{details}, $string = $control->details(), $bool = $control->{global}, $bool = $control->global(), $exit = $control->{terminate}, $exit = $control->terminate(), $bool = $control->{halt}, $bool = $control->halt(), $bool = $control->{has_callback}, $bool = $control->has_callback(), $encoding = $control->{encoding}, $encoding = $control->encoding(), $phase = $control->{phase}, $phase = $control->phase()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Error - Facet for errors that need to be shown.
DESCRIPTION
NOTES
FIELDS

$string = $error->{details}, $string = $error->details(), $short_string = $error->{tag}, $short_string = $error->tag(), $bool = $error->{fail}, $bool = $error->fail()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Hub - Facet for the hubs an event passes through.
DESCRIPTION
FACET FIELDS

$string = $trace->{details}, $string = $trace->details(), $int = $trace->{pid}, $int = $trace->pid(), $int = $trace->{tid}, $int = $trace->tid(), $hid = $trace->{hid}, $hid = $trace->hid(), $huuid = $trace->{huuid}, $huuid = $trace->huuid(), $int = $trace->{nested}, $int = $trace->nested(), $bool = $trace->{buffered}, $bool = $trace->buffered()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Info - Facet for information a developer might care about.
DESCRIPTION
NOTES
FIELDS

$string_or_structure = $info->{details}, $string_or_structure = $info->details(), $structure = $info->{table}, $structure = $info->table(), $short_string = $info->{tag}, $short_string = $info->tag(), $bool = $info->{debug}, $bool = $info->debug(), $bool = $info->{important}, $bool = $info->important

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Info::Table - Intermediary representation of a table.
DESCRIPTION
SYNOPSIS
ATTRIBUTES

$header_aref = $t->header(), $rows_aref = $t->rows(), $bool = $t->collapse(), $aref = $t->no_collapse(), $str = $t->as_string(), $href = $t->as_hash(), %args = $t->info_args()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Meta - Facet for meta-data
DESCRIPTION
METHODS AND FIELDS

$anything = $meta->{anything}, $anything = $meta->anything()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Parent - Facet for events contains other events
DESCRIPTION
FIELDS

$string = $parent->{details}, $string = $parent->details(), $hid = $parent->{hid}, $hid = $parent->hid(), $arrayref = $parent->{children}, $arrayref = $parent->children(), $bool = $parent->{buffered}, $bool = $parent->buffered()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Plan - Facet for setting the plan
DESCRIPTION
FIELDS

$string = $plan->{details}, $string = $plan->details(), $positive_int = $plan->{count}, $positive_int = $plan->count(), $bool = $plan->{skip}, $bool = $plan->skip(), $bool = $plan->{none}, $bool = $plan->none()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Render - Facet that dictates how to render an event.
DESCRIPTION
FIELDS

$string = $render->[#]->{details}, $string = $render->[#]->details(), $string = $render->[#]->{tag}, $string = $render->[#]->tag(), $string = $render->[#]->{facet}, $string = $render->[#]->facet(), $mode = $render->[#]->{mode}, $mode = $render->[#]->mode(), calculated, replace

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::EventFacet::Trace - Debug information for events
DESCRIPTION
SYNOPSIS
FACET FIELDS

$string = $trace->{details}, $string = $trace->details(), $frame = $trace->{frame}, $frame = $trace->frame(), $int = $trace->{pid}, $int = $trace->pid(), $int = $trace->{tid}, $int = $trace->tid(), $id = $trace->{cid}, $id = $trace->cid(), $uuid = $trace->{uuid}, $uuid = $trace->uuid()
DISCOURAGED HUB RELATED FIELDS

$hid = $trace->{hid}, $hid = $trace->hid(), $huuid = $trace->{huuid}, $huuid = $trace->huuid(), $int = $trace->{nested}, $int = $trace->nested(), $bool = $trace->{buffered}, $bool = $trace->buffered()

METHODS

$trace->set_detail($msg), $msg = $trace->detail, $str = $trace->debug, $trace->alert($MESSAGE), $trace->throw($MESSAGE), ($package, $file, $line, $subname) = $trace->call(), $pkg = $trace->package, $file = $trace->file, $line = $trace->line, $subname = $trace->subname, $sig = trace->signature

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Formatter - Namespace for formatters.
DESCRIPTION
CREATING FORMATTERS

The number of tests that were planned, The number of tests actually seen, The number of tests which failed, A boolean indicating whether or not the test suite passed, A boolean indicating whether or not this call is for a subtest

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Formatter::TAP - Standard TAP formatter
DESCRIPTION
SYNOPSIS
METHODS

$bool = $tap->no_numbers, $tap->set_no_numbers($bool), $arrayref = $tap->handles, $tap->set_handles(\@handles);, $encoding = $tap->encoding, $tap->encoding($encoding), $tap->write($e, $num)

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>, Kent Fredric <kentnl [AT] cpan.org>

Test2::Hub - The conduit through which all events flow.
SYNOPSIS
DESCRIPTION
COMMON TASKS

SENDING EVENTS
ALTERING OR REMOVING EVENTS
LISTENING FOR EVENTS
POST-TEST BEHAVIORS
SETTING THE FORMATTER

METHODS

$hub->send($event), $hub->process($event), $old = $hub->format($formatter), $sub = $hub->listen(sub { ... }, %optional_params), $hub->unlisten($sub), $sub = $hub->filter(sub { ... }, %optional_params), $sub = $hub->pre_filter(sub { ... }, %optional_params), $hub->unfilter($sub), $hub->pre_unfilter($sub), $hub->follow_op(sub { ... }), $sub = $hub->add_context_acquire(sub { ... });, $hub->remove_context_acquire($sub);, $sub = $hub->add_context_init(sub { ... });, $hub->remove_context_init($sub);, $sub = $hub->add_context_release(sub { ... });, $hub->remove_context_release($sub);, $hub->cull(), $pid = $hub->pid(), $tid = $hub->tid(), $hud = $hub->hid(), $uuid = $hub->uuid(), $ipc = $hub->ipc(), $hub->set_no_ending($bool), $bool = $hub->no_ending, $bool = $hub->active, $hub->set_active($bool)
STATE METHODS

$hub->reset_state(), $num = $hub->count, $num = $hub->failed, $bool = $hub->ended, $bool = $hub->is_passing, $hub->is_passing($bool), $hub->plan($plan), $plan = $hub->plan, $bool = $hub->check_plan

THIRD PARTY META-DATA
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Hub::Interceptor - Hub used by interceptor to grab results.
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Hub::Interceptor::Terminator - Exception class used by Test2::Hub::Interceptor
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::Hub::Subtest - Hub used by subtests
DESCRIPTION
TOGGLES

$bool = $hub->manual_skip_all, $hub->set_manual_skip_all($bool)

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::IPC - Turn on IPC for threading or forking support.
SYNOPSIS

DISABLING IT

EXPORTS

cull()

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::IPC::Driver - Base class for Test2 IPC drivers.
SYNOPSIS
METHODS

$self->abort($msg), $self->abort_trace($msg)

LOADING DRIVERS
WRITING DRIVERS

METHODS SUBCLASSES MUST IMPLEMENT

$ipc->is_viable, $ipc->add_hub($hid), $ipc->drop_hub($hid), $ipc->send($hid, $event);, $ipc->send($hid, $event, $global);, @events = $ipc->cull($hid), $ipc->waiting()

METHODS SUBCLASSES MAY IMPLEMENT OR OVERRIDE

$ipc->driver_abort($msg)

SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test2::IPC::Driver::Files - Temp dir + Files concurrency model.
DESCRIPTION
SYNOPSIS
ENVIRONMENT VARIABLES

T2_KEEP_TEMPDIR=0, T2_TEMPDIR_TEMPLATE=’test2-XXXXXX’

SEE ALSO

Test::Builder::Module - Base class for test modules
SYNOPSIS
DESCRIPTION

Importing

Builder
SEE ALSO

Test::Builder::Tester - test testsuites that have been built with Test::Builder
SYNOPSIS
DESCRIPTION
Functions

test_out, test_err

test_fail

test_diag

test_test, title (synonym ’name’, ’label’), skip_out, skip_err

line_num

color
BUGS
AUTHOR
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

NOTES
SEE ALSO

Test::Builder::Tester::Color - turn on colour in Test::Builder::Tester
SYNOPSIS
DESCRIPTION
AUTHOR
BUGS
SEE ALSO

Test::Builder::TodoDiag - Test::Builder subclass of Test2::Event::Diag
DESCRIPTION
SYNOPSIS
SOURCE
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

AUTHORS

Chad Granum <exodist [AT] cpan.org>

Test::Harness - Run Perl standard test scripts with statistics
VERSION
SYNOPSIS
DESCRIPTION
FUNCTIONS

runtests( @test_files )

execute_tests( tests => \@test_files, out => \*FH )
EXPORT
ENVIRONMENT VARIABLES THAT TAP::HARNESS::COMPATIBLE SETS

"HARNESS_ACTIVE", "HARNESS_VERSION"

ENVIRONMENT VARIABLES THAT AFFECT TEST::HARNESS

"HARNESS_PERL_SWITCHES", "HARNESS_TIMER", "HARNESS_VERBOSE", "HARNESS_OPTIONS", "j<n>", "c", "a<file.tgz>", "fPackage-With-Dashes", "HARNESS_SUBCLASS", "HARNESS_SUMMARY_COLOR_SUCCESS", "HARNESS_SUMMARY_COLOR_FAIL"

Taint Mode
SEE ALSO
BUGS
AUTHORS
LICENCE AND COPYRIGHT

Test::More - yet another framework for writing test scripts
SYNOPSIS
DESCRIPTION

I love it when a plan comes together

done_testing
Test names
I’m ok, you’re not ok.

is, isnt

like

unlike

cmp_ok

can_ok

isa_ok

new_ok

subtest

pass, fail
Module tests

require_ok

use_ok
Complex data structures

is_deeply

Diagnostics

diag, note

explain
Conditional tests

SKIP: BLOCK

TODO: BLOCK , todo_skip

When do I use SKIP vs. TODO ?
Test control

BAIL_OUT

Discouraged comparison functions

eq_array

eq_hash

eq_set
Extending and Embedding Test::More

builder

EXIT CODES
COMPATIBILITY

subtests, "done_testing()", "cmp_ok()", "new_ok()" "note()" and "explain()"

CAVEATS and NOTES

utf8 / "Wide character in print", Overloaded objects, Threads

HISTORY
SEE ALSO

ALTERNATIVES
ADDITIONAL LIBRARIES
OTHER COMPONENTS
BUNDLES

AUTHORS
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

BUGS
SOURCE
COPYRIGHT

Test::Simple - Basic utilities for writing tests.
SYNOPSIS
DESCRIPTION

EXAMPLE
CAVEATS
NOTES
HISTORY
SEE ALSO

Test::More

AUTHORS
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

Test::Tester - Ease testing test modules built with Test::Builder
SYNOPSIS
DESCRIPTION
HOW TO USE ( THE EASY WAY )
HOW TO USE ( THE HARD WAY )
TEST RESULTS

ok, actual_ok, name, type, reason, diag, depth

SPACES AND TABS
COLOUR
EXPORTED FUNCTIONS
HOW IT WORKS
CAVEATS
SEE ALSO
AUTHOR
LICENSE

Test::Tester::Capture - Help testing test modules built with Test::Builder
DESCRIPTION
AUTHOR
LICENSE

Test::Tester::CaptureRunner - Help testing test modules built with Test::Builder
DESCRIPTION
AUTHOR
LICENSE

Test::Tutorial - A tutorial about writing really basic tests
DESCRIPTION

Nuts and bolts of testing.
Where to start?
Names
Test the manual
Sometimes the tests are wrong
Testing lots of values
Informative names
Skipping tests
Todo tests
Testing with taint mode.

FOOTNOTES
AUTHORS
MAINTAINERS

Chad Granum <exodist [AT] cpan.org>

Test::use::ok - Alternative to Test::More::use_ok
SYNOPSIS
DESCRIPTION
SEE ALSO
MAINTAINER

Chad Granum <exodist [AT] cpan.org>

CC0 1.0 Universal

Text::Abbrev - abbrev - create an abbreviation table from a list
SYNOPSIS
DESCRIPTION
EXAMPLE

Text::Balanced - Extract delimited text sequences from strings.
SYNOPSIS
DESCRIPTION

General behaviour in list contexts

[0], [1], [2]

General behaviour in scalar and void contexts
A note about prefixes
"extract_delimited"
"extract_bracketed"
"extract_variable"

[0], [1], [2]

"extract_tagged"

"reject => $listref", "ignore => $listref", "fail => $str", [0], [1], [2], [3], [4], [5]

"gen_extract_tagged"
"extract_quotelike"

[0], [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

"extract_quotelike" and "here documents"

[0], [1], [2], [3], [4], [5], [6], [7..10]

"extract_codeblock"
"extract_multiple"
"gen_delimited_pat"
"delimited_pat"

DIAGNOSTICS

 C<Did not find a suitable bracket: "%s">,  C<Did not find prefix: /%s/>,
C<Did not find opening bracket after prefix: "%s">,  C<No quotelike
operator found after prefix: "%s">,  C<Unmatched closing bracket: "%c">,
C<Unmatched opening bracket(s): "%s">, C<Unmatched embedded quote (%s)>,
C<Did not find closing delimiter to match '%s'>,  C<Mismatched closing
bracket: expected "%c" but found "%s">,  C<No block delimiter found after
quotelike "%s">, C<Did not find leading dereferencer>, C<Bad identifier
after dereferencer>, C<Did not find expected opening bracket at %s>,
C<Improperly nested codeblock at %s>,  C<Missing second block for quotelike
"%s">, C<No match found for opening bracket>, C<Did not find opening tag:
/%s/>, C<Unable to construct closing tag to match: /%s/>, C<Found invalid
nested tag: %s>, C<Found unbalanced nested tag: %s>, C<Did not find closing
tag>

AUTHOR
BUGS AND IRRITATIONS
COPYRIGHT

Text::ParseWords - parse text into an array of tokens or array of arrays
SYNOPSIS
DESCRIPTION
EXAMPLES

0, 1, 2, 3, 4, 5

	grok_bin , grok_hex , grok_infnan , grok_number , grok_number_flags , GROK_NUMERIC_RADIX , grok_numeric_radix , grok_oct , isinfnan , IS_NUMBER_GREATER_THAN_UV_MAX				bool IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_INFINITY
	bool IS_NUMBER_INFINITY, IS_NUMBER_IN_UV bool IS_NUMBER_IN_UV, IS_NUMBER_NAN				bool IS_NUMBER_NAN, IS_NUMBER_NEG
					bool
					IS_NUMBER_NEG, IS_NUMBER_NOT_INT , my_strtod , PERL_ABS , PERL_INT_MAX , Perl_signbit , scan_bin , scan_hex , scan_oct , Strtod , Strtol , Strtoul

				fsize, name, size, kind, PERLIO_K_BUFFERED, PERLIO_K_RAW, PERLIO_K_CANCRLF, PERLIO_K_FASTGETS, PERLIO_K_MULTIARG, Pushed, Popped, Open, Binmode, Getarg, Fileno, Dup, Read, Write, Seek, Tell, Close, Flush, Fill, Eof, Error,
				Clearerr, Setlinebuf, Get_base, Get_bufsiz, Get_ptr, Get_cnt, Set_ptrcnt

		Net::Ping->new([proto, timeout, bytes, device, tos, ttl, family,
		host, port, bind, gateway, retrans, pingstring,

		source_verify econnrefused dontfrag

	`"$parser->_handle_element_start(` element_name`,` attr_hashref `)"`, `"$parser->_handle_element_end(` element_name `)"`, `"$parser->_handle_text(`		text_string
			`)"`, events with an element_name of Document, events with an element_name of Para, events with an element_name of B, C, F, or I, events with an element_name of S, events with an element_name of X, events with an element_name of L, events with an element_name of E or Z, events with an element_name of Verbatim, events with an element_name of head1 .. head4, events with an element_name of encoding, events with an element_name of over-bullet, events with an element_name of over-number, events with an element_name of over-text, events with an element_name of over-block, events with an element_name of over-empty, events with an element_name of item-bullet, events with an element_name of item-number, events with an element_name of item-text, events with an element_name of for, events with an element_name of Data

		`"$parser->accept_targets(` SOMEVALUE `)"`, `"$parser->accept_targets_as_text(` SOMEVALUE
		`)"`, `"$parser->accept_codes(` Codename`,` Codename`... )"`, `"$parser->accept_directive_as_data(` directive_name `)"`, `"$parser->accept_directive_as_verbatim(` directive_name `)"`, `"$parser->accept_directive_as_processed(` directive_name `)"`, `"$parser->nbsp_for_S(` BOOLEAN `);"`, `"$parser->version_report()"`, `"$parser->pod_para_count()"`, `"$parser->line_count()"`, `"$parser->nix_X_codes(` SOMEVALUE `)"`, `"$parser->keep_encoding_directive(` SOMEVALUE `)"`, `"$parser->merge_text(` SOMEVALUE `)"`, `"$parser->code_handler(` CODE_REF `)"`, `"$parser->cut_handler(` CODE_REF `)"`, `"$parser->pod_handler(` CODE_REF `)"`, `"$parser->whiteline_handler(` CODE_REF `)"`, `"$parser->whine(` linenumber`,` complaint string `)"`, `"$parser->scream(` linenumber`,` complaint string `)"`, `"$parser->source_dead(1)"`, `"$parser->hide_line_numbers(` SOMEVALUE `)"`, `"$parser->no_whining(` SOMEVALUE `)"`, `"$parser->no_errata_section(` SOMEVALUE `)"`, `"$parser->complain_stderr(` SOMEVALUE `)"`, `"$parser->bare_output(` SOMEVALUE `)"`, `"$parser->preserve_whitespace(` SOMEVALUE `)"`, `"$parser->parse_empty_lists(` SOMEVALUE `)"`