diff options
author | Jarkko Hietaniemi <jhi@iki.fi> | 2001-01-01 18:10:58 +0000 |
---|---|---|
committer | Jarkko Hietaniemi <jhi@iki.fi> | 2001-01-01 18:10:58 +0000 |
commit | ab648d5eb0a7286231b7140c37b59641898641f5 (patch) | |
tree | 822356eb9040603346e6c8dbc747677532ffdf75 /pod/perltoc.pod | |
parent | bc89e66f06f2a92e37ea7c110f66788fcfbe6847 (diff) | |
download | perl-ab648d5eb0a7286231b7140c37b59641898641f5.tar.gz |
Podify README.mpeix (a new version from the web),
add a dummy NAME to Carp::Heavy, regen toc.
p4raw-id: //depot/perl@8291
Diffstat (limited to 'pod/perltoc.pod')
-rw-r--r-- | pod/perltoc.pod | 367 |
1 files changed, 168 insertions, 199 deletions
diff --git a/pod/perltoc.pod b/pod/perltoc.pod index 89272113cf..c0750e82dc 100644 --- a/pod/perltoc.pod +++ b/pod/perltoc.pod @@ -19,16 +19,6 @@ through to locate the proper section you're looking for. =item DESCRIPTION -modularity and reusability using innumerable modules, embeddable and -extensible, roll-your-own magic variables (including multiple simultaneous -DBM implementations), subroutines can now be overridden, autoloaded, and -prototyped, arbitrarily nested data structures and anonymous functions, -object-oriented programming, compilability into C code or Perl bytecode, -support for light-weight processes (threads), support for -internationalization, localization, and Unicode, lexical scoping, regular -expression enhancements, enhanced debugger and interactive Perl -environment, with integrated editor support, POSIX 1003.1 compliant library - =item AVAILABILITY =item ENVIRONMENT @@ -320,7 +310,7 @@ DIAGNOSTICS, BUGS, NOTES =item perlfaq - frequently asked questions about Perl ($Date: 1999/05/23 20:38:02 $) -DESCRIPTION +DESCRIPTION, Where to get this document, How to contribute =back @@ -511,10 +501,6 @@ regular expressions =item When to Still Use local() -1. You need to give a global variable a temporary value, especially $_, 2. -You need to create a local file or directory handle or a local function, 3. -You want to temporarily change just one element of an array or hash - =item Pass by Reference =item Prototypes @@ -778,13 +764,6 @@ more elaborate constructs =item Using character classes -\d is a digit and represents [0-9], \s is a whitespace character and -represents [\ \t\r\n\f], \w is a word character (alphanumeric or _) and -represents [0-9a-zA-Z_], \D is a negated \d; it represents any character -but a digit [^0-9], \S is a negated \s; it represents any non-whitespace -character [^\s], \W is a negated \w; it represents any non-word character -[^\w], The period '.' matches any character but "\n" - =item Matching this or that =item Grouping things and hierarchical matching @@ -1262,90 +1241,16 @@ ${^WIDE_SYSTEM_CALLS}, $EXECUTABLE_NAME, $^X, $ARGV, @ARGV, @INC, @_, %INC, =item Using character classes -\d is a digit and represents [0-9], \s is a whitespace character and -represents [\ \t\r\n\f], \w is a word character (alphanumeric or _) and -represents [0-9a-zA-Z_], \D is a negated \d; it represents any character -but a digit [^0-9], \S is a negated \s; it represents any non-whitespace -character [^\s], \W is a negated \w; it represents any non-word character -[^\w], The period '.' matches any character but "\n", no modifiers (//): -Default behavior. C<'.'> matches any character except C<"\n">. C<^> -matches only at the beginning of the string and C<$> matches only at the -end or before a newline at the end, s modifier (//s): Treat string as a -single long line. C<'.'> matches any character, even C<"\n">. C<^> -matches only at the beginning of the string and C<$> matches only at the -end or before a newline at the end, m modifier (//m): Treat string as a set -of multiple lines. C<'.'> matches any character except C<"\n">. C<^> and -C<$> are able to match at the start or end of I<any> line within the -string, both s and m modifiers (//sm): Treat string as a single long line, -but detect multiple lines. C<'.'> matches any character, even C<"\n">. -C<^> and C<$>, however, are able to match at the start or end of I<any> -line within the string - =item Matching this or that =item 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" - =item Extracting matches =item Matching repetitions -C<a?> = match 'a' 1 or 0 times, C<a*> = match 'a' 0 or more times, i.e., -any number of times, C<a+> = match 'a' 1 or more times, i.e., at least -once, C<a{n,m}> = match at least C<n> times, but not more than C<m> times, -C<a{n,}> = match at least C<n> or more times, C<a{n}> = match exactly C<n> -times, Principle 0: Taken as a whole, any regexp will be matched at the -earliest possible position in the string, Principle 1: In an alternation -C<a|b|c...>, the leftmost alternative that allows a match for the whole -regexp will be the one used, Principle 2: The maximal matching quantifiers -C<?>, C<*>, C<+> and C<{n,m}> will in general match as much of the string -as possible while still allowing the whole regexp to match, Principle 3: If -there are two or more elements in a regexp, the leftmost greedy quantifier, -if any, will match as much of the string as possible while still allowing -the whole regexp to match. The next leftmost greedy quantifier, if any, -will try to match as much of the string remaining available to it as -possible, while still allowing the whole regexp to match. And so on, until -all the regexp elements are satisfied, C<a??> = match 'a' 0 or 1 times. Try -0 first, then 1, C<a*?> = match 'a' 0 or more times, i.e., any number of -times, but as few times as possible, C<a+?> = match 'a' 1 or more times, -i.e., at least once, but as few times as possible, C<a{n,m}?> = match at -least C<n> times, not more than C<m> times, as few times as possible, -C<a{n,}?> = match at least C<n> times, but as few times as possible, -C<a{n}?> = match exactly C<n> times. Because we match exactly C<n> times, -C<a{n}?> is equivalent to C<a{n}> and is just there for notational -consistency, Principle 3: If there are two or more elements in a regexp, -the leftmost greedy (non-greedy) quantifier, if any, will match as much -(little) of the string as possible while still allowing the whole regexp to -match. The next leftmost greedy (non-greedy) quantifier, if any, will try -to match as much (little) of the string remaining available to it as -possible, while still allowing the whole regexp to match. And so on, until -all the regexp elements are satisfied, 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! - =item Building a regexp -specifying the task in detail,, breaking down the problem into smaller -parts,, translating the small parts into regexps,, combining the regexps,, -and optimizing the final combined regexp - =item Using regular expressions in Perl =back @@ -2251,15 +2156,6 @@ localization) =item SECURITY -B<Comparison operators> (C<lt>, C<le>, C<ge>, C<gt> and C<cmp>):, -B<Case-mapping interpolation> (with C<\l>, C<\L>, C<\u> or C<\U>), -B<Matching operator> (C<m//>):, B<Substitution operator> (C<s///>):, -B<Output formatting functions> (printf() and write()):, B<Case-mapping -functions> (lc(), lcfirst(), uc(), ucfirst()):, B<POSIX locale-dependent -functions> (localeconv(), strcoll(), strftime(), strxfrm()):, B<POSIX -character class tests> (isalnum(), isalpha(), isdigit(), isgraph(), -islower(), isprint(), ispunct(), isspace(), isupper(), isxdigit()): - =item ENVIRONMENT PERL_BADLANG, LC_ALL, LANGUAGE, LC_CTYPE, LC_COLLATE, LC_MONETARY, @@ -2546,20 +2442,8 @@ User::pwent =item CPAN -Language Extensions and Documentation Tools, Development Support, Operating -System Interfaces, Networking, Device Control (modems) and InterProcess -Communication, Data Types and Data Type Utilities, Database Interfaces, -User Interfaces, Interfaces to / Emulations of Other Programming Languages, -File Names, File Systems and File Locking (see also File Handles), String -Processing, Language Text Processing, Parsing, and Searching, Option, -Argument, Parameter, and Configuration File Processing, -Internationalization and Locale, Authentication, Security, and Encryption, -World Wide Web, HTML, HTTP, CGI, MIME, Server and Daemon Utilities, -Archiving and Compression, Images, Pixmap and Bitmap Manipulation, Drawing, -and Graphing, Mail and Usenet News, Control Flow Utilities (callbacks and -exceptions etc), File Handle and Input/Output Stream Utilities, -Miscellaneous Modules, Africa, Asia, Australasia, Central America, Europe, -North America, South America +Africa, Asia, Australasia, Central America, Europe, North America, South +America =item Modules: Creation, Use, and Abuse @@ -2588,12 +2472,6 @@ to ::, Converts die(...) to croak(...), Several other minor changes =item Guidelines for Reusing Application Code -Complete applications rarely belong in the Perl Module Library, Many -applications contain some Perl code that could be reused, Break-out the -reusable code into one or more separate module files, Take the opportunity -to reconsider and redesign the interfaces, In some cases the 'application' -can then be reduced to a small - =back =item NOTE @@ -2959,11 +2837,7 @@ the tag =item How can I remove duplicate elements from a list or array? -a) If @in is sorted, and you want @out to be sorted: (this assumes all true -values in the array), b) If you don't know whether @in is sorted:, c) Like -(b), but @in contains only small integers:, d) A way to do (b) without any -loops or greps:, e) Like (d), but @in contains only small positive -integers: +a), b), c), d), e) =item How can I tell whether a list or array contains a certain element? @@ -3545,14 +3419,6 @@ Perl?>, B<Use C from C?>, B<Use Perl from C?> =item ROADMAP -Compiling your C program, Adding a Perl interpreter to your C program, -Calling a Perl subroutine from your C program, Evaluating a Perl statement -from your C program, Performing Perl pattern matches and substitutions from -your C program, Fiddling with the Perl stack from your C program, -Maintaining a persistent interpreter, Maintaining multiple interpreter -instances, Using Perl modules, which themselves use C libraries, from your -C program, Embedding Perl under Win32 - =item Compiling your C program =item Adding a Perl interpreter to your C program @@ -4719,15 +4585,6 @@ I<The Road goes ever on and on, down from the door where it began.> =item Performance Enhancements -sort() has been changed to use mergesort internally as opposed to the -earlier quicksort. For very small lists this may result in slightly slower -sorting times, but in general the speedup should be at least 20%. -Additional bonuses are that the worst case behaviour of sort() is now -better (in computer science terms it now runs in time O(N log N), as -opposed to quicksort's Theta(N**2) worst-case run time behaviour), and that -sort() is now stable (meaning that elements with identical keys will stay -ordered as they were before the sort) - =item Installation and Configuration Improvements =over 4 @@ -4738,9 +4595,6 @@ ordered as they were before the sort) =item Selected Bug Fixes -sort() arguments are now compiled in the right wantarray context (they were -accidentally using the context of the sort() itself) - =over 4 =item Platform Specific Changes and Fixes @@ -5111,8 +4965,7 @@ Format of $English::PERL_VERSION is different, Literals of the form C<1.2.3> parse differently, Possibly changed pseudo-random number generator, Hashing function for hash keys has changed, C<undef> fails on read only values, Close-on-exec bit may be set on pipe and socket handles, -Writing C<"$$1"> to mean C<"${$}1"> is unsupported, delete(), values() and -C<\(%h)> operate on aliases to values, not copies, vec(EXPR,OFFSET,BITS) +Writing C<"$$1"> to mean C<"${$}1"> is unsupported, vec(EXPR,OFFSET,BITS) enforces powers-of-two BITS, Text of some diagnostic output has changed, C<%@> has been removed, Parenthesized not() behaves like a list operator, Semantics of bareword prototype C<(*)> have changed, Semantics of bit @@ -5194,10 +5047,6 @@ to mean "${$}<digit>" is deprecated =item C Source Compatibility -Core sources now require ANSI C compiler, All Perl global variables must -now be referenced with an explicit prefix, Enabling threads has source -compatibility issues - =item Binary Compatibility =item Security fixes may affect compatibility @@ -5335,9 +5184,9 @@ Eval-group not allowed at run time, Explicit blessing to '' (assuming package main), Illegal hex digit ignored, No such array field, No such field "%s" in variable %s of type %s, Out of memory during ridiculously large request, Range iterator outside integer range, Recursive inheritance -detected while looking for method '%s' in package '%s', Reference found -where even-sized list expected, Undefined value assigned to typeglob, Use -of reserved word "%s" is deprecated, perl: warning: Setting locale failed +detected while looking for method '%s' %s, Reference found where even-sized +list expected, Undefined value assigned to typeglob, Use of reserved word +"%s" is deprecated, perl: warning: Setting locale failed =item Obsolete Diagnostics @@ -5534,14 +5383,14 @@ possible typo, Null picture in formline, Offset outside string, Out of memory!, Out of memory during request for %s, panic: frexp, Possible attempt to put comments in qw() list, Possible attempt to separate words with commas, Scalar value @%s{%s} better written as $%s{%s}, Stub found -while resolving method `%s' overloading `%s' in package `%s', Too late for -"B<-T>" option, untie attempted while %d inner references still exist, -Unrecognized character %s, Unsupported function fork, Use of "$$<digit>" to -mean "${$}<digit>" is deprecated, Value of %s can be "0"; test with -defined(), Variable "%s" may be unavailable, Variable "%s" will not stay -shared, Warning: something's wrong, Ill-formed logical name |%s| in -prime_env_iter, Got an error from DosAllocMem, Malformed PERLLIB_PREFIX, -PERL_SH_DIR too long, Process terminated by SIG%s +while resolving method `%s' overloading `%s' in %s, Too late for "B<-T>" +option, untie attempted while %d inner references still exist, Unrecognized +character %s, Unsupported function fork, Use of "$$<digit>" to mean +"${$}<digit>" is deprecated, Value of %s can be "0"; test with defined(), +Variable "%s" may be unavailable, Variable "%s" will not stay shared, +Warning: something's wrong, Ill-formed logical name |%s| in prime_env_iter, +Got an error from DosAllocMem, Malformed PERLLIB_PREFIX, PERL_SH_DIR too +long, Process terminated by SIG%s =item BUGS @@ -5741,6 +5590,50 @@ Source, Compiled Module Source, Perl Modules/Scripts =back +=head2 perldos - Perl under DOS, W31, W95. + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=over 4 + +=item Prerequisites + +DJGPP, Pthreads + +=item Shortcomings of Perl under DOS + +=item Building + +=item Testing + +=item Installation + +=back + +=item BUILDING AND INSTALLING MODULES + +=over 4 + +=item Prerequisites + +=item Unpacking CPAN Modules + +=item Building Non-XS Modules + +=item Building XS Modules + +=back + +=item AUTHOR + +=item SEE ALSO + +=back + =head2 perlepoc, README.epoc - Perl for EPOC =over 4 @@ -5847,6 +5740,30 @@ op/lexassign.t, pragma/warnings.t =back +=head2 perlmpeix, README.mpeix - Perl/iX for HP e3000 MPE + +=head1 SYNOPSIS + +=over 4 + +=item What's New + +=item System Requirements + +=item How to Obtain Perl/iX + +=item Distribution Contents Highlights + +README, public_html/feedback.cgi, 4, 6 + +=item Getting Started with Perl/iX + +=item MPE/iX Implementation Considerations + +=item Change History + +=back + =head2 perlos2 - Perl under OS/2, DOS, Win0.3*, Win0.95 and WinNT. =over 4 @@ -6357,6 +6274,48 @@ LIST, waitpid PID,FLAGS =back +=head2 perlwin32 - Perl under Win32 + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=over 4 + +=item Setting Up + +Make, Command Shell, Borland C++, Microsoft Visual C++, Mingw32 with GCC + +=item Building + +=item Testing + +=item Installation + +=item Usage Hints + +Environment Variables, File Globbing, Using perl from the command line, +Building Extensions, Command-line Wildcard Expansion, Win32 Specific +Extensions, Running Perl Scripts, Miscellaneous Things + +=back + +=item BUGS AND CAVEATS + +=item AUTHORS + +Gary Ng E<lt>71564.1743@CompuServe.COME<gt>, Gurusamy Sarathy +E<lt>gsar@activestate.comE<gt>, Nick Ing-Simmons +E<lt>nick@ing-simmons.netE<gt> + +=item SEE ALSO + +=item HISTORY + +=back + =head1 PRAGMA DOCUMENTATION =head2 attrs - set/get attributes of a subroutine (deprecated) @@ -6849,6 +6808,19 @@ C<strict refs>, C<strict vars>, C<strict subs> =back +=head2 unicode::distinct - Perl pragma to strictly distinguish UTF8 data +and non-UTF data. + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item SEE ALSO + +=back + =head2 utf8 - Perl pragma to enable/disable UTF-8 in source code =over 4 @@ -7471,10 +7443,6 @@ output. =back =item CALLING CGI.PM ROUTINES -1. Use another name for the argument, if one is available. For example, --value is an alias for -values, 2. Change the capitalization, e.g. -Values, -3. Put quotes around the argument name, e.g. '-values' - =item CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE): =item CREATING A NEW QUERY OBJECT FROM AN INPUT FILE @@ -7621,8 +7589,7 @@ B<Parameters:> =item CREATING A CLICKABLE IMAGE BUTTON -B<Parameters:>, 3. The third option (-align, optional) is an alignment -type, and may be TOP, BOTTOM or MIDDLE +B<Parameters:> =item CREATING A JAVASCRIPT ACTION BUTTON @@ -7652,16 +7619,15 @@ the <FORM> tag =item FETCHING ENVIRONMENT VARIABLES B<Accept()>, B<raw_cookie()>, B<user_agent()>, B<path_info()>, -B<path_translated()>, B<remote_host()>, B<script_name()> Return the script -name as a partial URL, for self-refering scripts, B<referer()>, B<auth_type -()>, B<server_name ()>, B<virtual_host ()>, B<server_port ()>, +B<path_translated()>, B<remote_host()>, B<script_name()>, B<referer()>, +B<auth_type ()>, B<server_name ()>, B<virtual_host ()>, B<server_port ()>, B<server_software ()>, B<remote_user ()>, B<user_name ()>, B<request_method()>, B<content_type()>, B<http()>, B<https()> =item USING NPH SCRIPTS In the B<use> statement, By calling the B<nph()> method:, By using B<-nph> -parameters in the B<header()> and B<redirect()> statements: +parameters =item Server Push @@ -7984,20 +7950,7 @@ http firewall, ftp firewall, One way visibility, SOCKS, IP Masquerade =item FAQ -1) I installed a new version of module X but CPAN keeps saying, I -have the old version installed, 2) So why is UNINST=1 not the default?, 3) -I want to clean up my mess, and install a new perl along with all -modules I have. How do I go about it?, 4) When I install bundles or -multiple modules with one command there is too much output to keep -track of, 5) I am not root, how can I install a module in a personal -directory?, 6) How to get a package, unwrap it, and make a change before - building it?, 7) I installed a Bundle and had a couple of fails. When I - retried, everything resolved nicely. Can this be fixed to work -on first try?, 8) In our intranet we have many modules for internal use. -How can I integrate these modules with CPAN.pm but without uploading - the modules to CPAN?, 9) When I run CPAN's shell, I get error msg -about line 1 to 4, setting meta input/output via the /etc/inputrc -file, 10) Some authors have strange characters in their names +1), 2), 3), 4), 5), 6), 7), 8), 9), 10) =item BUGS @@ -8048,6 +8001,8 @@ module =back +=head2 Carp::Heavy, Carp heavy machinery - no user serviceable parts inside + =head2 Class::Struct - declare struct-like datatypes as Perl classes =over 4 @@ -10146,6 +10101,10 @@ $fh->print, $fh->printf, $fh->getline, $fh->getlines =over 4 +=item SYNOPSIS + + use Filter::Util::Call ; + =item DESCRIPTION =over 4 @@ -12476,6 +12435,23 @@ specification "%s", %s:%d: Unknown command paragraph "%s", Unknown escape: =back +=head2 Pod::Text::Overstrike - Convert POD data to formatted overstrike +text + +=over 4 + +=item SYNOPSIS + +=item DESCRIPTION + +=item BUGS + +=item SEE ALSO + +=item AUTHOR + +=back + =head2 Pod::Text::Termcap, Pod::Text::Color - Convert POD data to ASCII text with format escapes @@ -12931,12 +12907,6 @@ arrays =item EXAMPLES -0 a simple word, 1 multiple spaces are skipped because of our $delim, 2 use -of quotes to include a space in a word, 3 use of a backslash to include a -space in a word, 4 use of a backslash to remove the special meaning of a -double-quote, 5 another simple word (note the lack of effect of the -backslashed double-quote) - =item AUTHORS =back @@ -13292,8 +13262,7 @@ Win32::GetChipName(), Win32::GetCwd(), Win32::GetFullPathName(FILENAME), Win32::GetLastError(), Win32::GetLongPathName(PATHNAME), Win32::GetNextAvailDrive(), Win32::GetOSVersion(), Win32::GetShortPathName(PATHNAME), Win32::GetProcAddress(INSTANCE, -PROCNAME), Win32::GetTickCount(), Win32::InitiateSystemShutdown(MACHINE, -MESSAGE, TIMEOUT, FORCECLOSE, REBOOT), Win32::IsWinNT(), Win32::IsWin95(), +PROCNAME), Win32::GetTickCount(), Win32::IsWinNT(), Win32::IsWin95(), Win32::LoadLibrary(LIBNAME), Win32::LoginName(), Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID, SIDTYPE), Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE), |