Commit | Line | Data |
cb1a09d0 |
1 | |
2 | =head1 NAME |
3 | |
4 | perltoc - perl documentation table of contents |
5 | |
6 | =head1 DESCRIPTION |
7 | |
8 | This page provides a brief table of contents for the rest of the Perl |
9 | documentation set. |
10 | |
11 | =head1 BASIC DOCUMENTATION |
12 | |
13 | |
14 | |
15 | |
16 | =head2 perl - Practical Extraction and Report Language |
17 | |
18 | =item SYNOPSIS |
19 | |
20 | |
21 | =item DESCRIPTION |
22 | |
23 | |
24 | Many usability enhancements, Simplified grammar, Lexical scoping, |
25 | Arbitrarily nested data structures, Modularity and reusability, |
26 | Object-oriented programming, Embeddible and Extensible, POSIX |
27 | compliant, Package constructors and destructors, Multiple simultaneous |
28 | DBM implementations, Subroutine definitions may now be autoloaded, |
29 | Regular expression enhancements |
30 | |
31 | =item ENVIRONMENT |
32 | |
33 | |
34 | HOME, LOGDIR, PATH, PERL5LIB, PERL5DB, PERLLIB |
35 | |
36 | =item AUTHOR |
37 | |
38 | |
39 | =item FILES |
40 | |
41 | |
42 | =item SEE ALSO |
43 | |
44 | |
45 | =item DIAGNOSTICS |
46 | |
47 | |
48 | =item BUGS |
49 | |
50 | |
51 | =item NOTES |
52 | |
53 | |
54 | |
55 | |
56 | |
57 | =head2 perldata - Perl data types |
58 | |
59 | =item DESCRIPTION |
60 | |
61 | |
62 | =over |
63 | |
64 | =item Variable names |
65 | |
66 | |
67 | =item Context |
68 | |
69 | |
70 | =item Scalar values |
71 | |
72 | |
73 | =item Scalar value constructors |
74 | |
75 | |
76 | =item List value constructors |
77 | |
78 | |
79 | =item Typeglobs and FileHandles |
80 | |
81 | |
82 | |
83 | |
84 | =back |
85 | |
86 | |
87 | |
88 | |
89 | =head2 perlsyn - Perl syntax |
90 | |
91 | =item DESCRIPTION |
92 | |
93 | |
94 | =over |
95 | |
96 | =item Declarations |
97 | |
98 | |
99 | =item Simple statements |
100 | |
101 | |
102 | =item Compound statements |
103 | |
104 | |
105 | =item Loop Control |
106 | |
107 | |
108 | =item For Loops |
109 | |
110 | |
111 | =item Foreach Loops |
112 | |
113 | |
114 | =item Basic BLOCKs and Switch Statements |
115 | |
116 | |
117 | =item Goto |
118 | |
119 | |
120 | =item PODs: Embedded Documentation |
121 | |
122 | |
123 | |
124 | |
125 | =back |
126 | |
127 | |
128 | |
129 | |
130 | =head2 perlop - Perl operators and precedence |
131 | |
132 | =item SYNOPSIS |
133 | |
134 | |
135 | =item DESCRIPTION |
136 | |
137 | |
138 | =over |
139 | |
140 | =item Terms and List Operators (Leftward) |
141 | |
142 | |
143 | =item The Arrow Operator |
144 | |
145 | |
146 | =item Autoincrement and Autodecrement |
147 | |
148 | |
149 | =item Exponentiation |
150 | |
151 | |
152 | =item Symbolic Unary Operators |
153 | |
154 | |
155 | =item Binding Operators |
156 | |
157 | |
158 | =item Multiplicative Operators |
159 | |
160 | |
161 | =item Additive Operators |
162 | |
163 | |
164 | =item Shift Operators |
165 | |
166 | |
167 | =item Named Unary Operators |
168 | |
169 | |
170 | =item Relational Operators |
171 | |
172 | |
173 | =item Equality Operators |
174 | |
175 | |
176 | =item Bitwise And |
177 | |
178 | |
179 | =item Bitwise Or and Exclusive Or |
180 | |
181 | |
182 | =item C-style Logical And |
183 | |
184 | |
185 | =item C-style Logical Or |
186 | |
187 | |
188 | =item Range Operator |
189 | |
190 | |
191 | =item Conditional Operator |
192 | |
193 | |
194 | =item Assignment Operators |
195 | |
196 | |
197 | =item Comma Operator |
198 | |
199 | |
200 | =item List Operators (Rightward) |
201 | |
202 | |
203 | =item Logical Not |
204 | |
205 | |
206 | =item Logical And |
207 | |
208 | |
209 | =item Logical or and Exclusive Or |
210 | |
211 | |
212 | =item C Operators Missing From Perl |
213 | |
214 | |
215 | unary &, unary *, (TYPE) |
216 | |
217 | =item Quote and Quotelike Operators |
218 | |
219 | |
220 | =item Regexp Quotelike Operators |
221 | |
222 | |
223 | ?PATTERN?, m/PATTERN/gimosx, /PATTERN/gimosx, q/STRING/, C<'STRING'>, |
224 | qq/STRING/, "STRING", qx/STRING/, `STRING`, qw/STRING/, |
225 | s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds, |
226 | y/SEARCHLIST/REPLACEMENTLIST/cds |
227 | |
228 | =item I/O Operators |
229 | |
230 | |
231 | =item Constant Folding |
232 | |
233 | |
234 | =item Integer arithmetic |
235 | |
236 | |
237 | |
238 | |
239 | =back |
240 | |
241 | |
242 | |
243 | |
244 | =head2 perlre - Perl regular expressions |
245 | |
246 | =item DESCRIPTION |
247 | |
248 | |
249 | =over |
250 | |
251 | =item Regular Expressions |
252 | |
253 | |
254 | (?#text), (?:regexp), (?=regexp), (?!regexp), (?imsx) |
255 | |
256 | =item Version 8 Regular Expressions |
257 | |
258 | |
259 | =item WARNING on \1 vs $1 |
260 | |
261 | |
262 | |
263 | |
264 | =back |
265 | |
266 | |
267 | |
268 | |
269 | =head2 perlrun - how to execute the Perl interpreter |
270 | |
271 | =item SYNOPSIS |
272 | |
273 | |
274 | =item DESCRIPTION |
275 | |
276 | |
277 | =over |
278 | |
279 | =item Switches |
280 | |
281 | |
282 | B<-0>I<digits>, B<-a>, B<-c>, B<-d>, B<-D>I<number>, B<-D>I<list>, |
283 | B<-e> I<commandline>, B<-F>I<regexp>, B<-i>I<extension>, |
284 | B<-I>I<directory>, B<-l>I<octnum>, B<-n>, B<-p>, B<-P>, B<-s>, B<-S>, |
285 | B<-T>, B<-u>, B<-U>, B<-v>, B<-w>, B<-x> I<directory> |
286 | |
287 | |
288 | |
289 | =back |
290 | |
291 | |
292 | |
293 | |
294 | =head2 perlfunc - Perl builtin functions |
295 | |
296 | =item DESCRIPTION |
297 | |
298 | |
299 | |
300 | |
301 | =over |
302 | |
303 | =item Perl Functions by Category |
304 | |
305 | |
306 | Functions for SCALARs or strings, Regular expressions and pattern |
307 | matching, Numeric functions, Functions for real @ARRAYs, Functions for |
308 | list data, Functions for real %HASHes, Input and output functions, |
309 | Functions for fixed length data or records, Functions for filehandles, |
310 | files, or directories, Keywords related to the control flow of your |
311 | perl program, Keywords related to scoping, Miscellaneous functions, |
312 | Functions for processes and process groups, Keywords related to perl |
313 | modules, Keywords related to classes and object-orientedness, Low-level |
314 | socket functions, System V interprocess communication functions, |
315 | Fetching user and group info, Fetching network info, Time-related |
316 | functions |
317 | |
318 | =item Alphabetical Listing of Perl Functions |
319 | |
320 | |
321 | -X FILEHANDLE, -X EXPR, -X, abs VALUE, accept NEWSOCKET,GENERICSOCKET, |
322 | alarm SECONDS, atan2 Y,X, bind SOCKET,NAME, binmode FILEHANDLE, bless |
323 | REF,CLASSNAME, bless REF, caller EXPR, caller, chdir EXPR, chmod LIST, |
324 | chomp VARIABLE, chomp LIST, chomp, chop VARIABLE, chop LIST, chop, |
325 | chown LIST, chr NUMBER, chroot FILENAME, close FILEHANDLE, closedir |
326 | DIRHANDLE, connect SOCKET,NAME, continue BLOCK, cos EXPR, crypt |
327 | PLAINTEXT,SALT, dbmclose ASSOC_ARRAY, dbmopen ASSOC,DBNAME,MODE, |
328 | defined EXPR, delete EXPR, die LIST, do BLOCK, do SUBROUTINE(LIST), do |
329 | EXPR, dump LABEL, each ASSOC_ARRAY, eof FILEHANDLE, eof (), eof, eval |
330 | EXPR, eval BLOCK, exec LIST, exists EXPR, exit EXPR, exp EXPR, fcntl |
331 | FILEHANDLE,FUNCTION,SCALAR, fileno FILEHANDLE, flock |
332 | FILEHANDLE,OPERATION, fork, format, formline PICTURE, LIST, getc |
333 | FILEHANDLE, getc, getlogin, getpeername SOCKET, getpgrp PID, getppid, |
334 | getpriority WHICH,WHO, getpwnam NAME, getgrnam NAME, gethostbyname |
335 | NAME, getnetbyname NAME, getprotobyname NAME, getpwuid UID, getgrgid |
336 | GID, getservb |
337 | |
338 | |
339 | |
340 | =back |
341 | |
342 | |
343 | |
344 | |
345 | =head2 perlvar - Perl predefined variables |
346 | |
347 | =item DESCRIPTION |
348 | |
349 | |
350 | =over |
351 | |
352 | =item Predefined Names |
353 | |
354 | |
355 | $ARG, $_, $<I<digit>>, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $', |
356 | $LAST_PAREN_MATCH, $+, $MULTILINE_MATCHING, $*, input_line_number |
357 | HANDLE EXPR, $INPUT_LINE_NUMBER, $NR, $, input_record_separator HANDLE |
358 | EXPR, $INPUT_RECORD_SEPARATOR, $RS, $/, autoflush HANDLE EXPR, |
359 | $OUTPUT_AUTOFLUSH, $|, output_field_separator HANDLE EXPR, |
360 | $OUTPUT_FIELD_SEPARATOR, $OFS, $,, output_record_separator HANDLE EXPR, |
361 | $OUTPUT_RECORD_SEPARATOR, $ORS, $\, $LIST_SEPARATOR, $", |
362 | $SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $OFMT, $#, format_page_number HANDLE |
363 | EXPR, $FORMAT_PAGE_NUMBER, $%, format_lines_per_page HANDLE EXPR, |
364 | $FORMAT_LINES_PER_PAGE, $=, format_lines_left HANDLE EXPR, |
365 | $FORMAT_LINES_LEFT, $-, format_name HANDLE EXPR, $FORMAT_NAME, $~, |
366 | format_top_name HANDLE EXPR, $FORMAT_TOP_NAME, $^, |
367 | format_line_break_characters HANDLE EXPR, |
368 | $FORMAT_LINE_BREAK_CHARACTERS, $:, format_formfeed HANDLE EXPR, |
369 | $FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A, $CHILD_ERROR, $?, $OS_ERROR, |
370 | $ERRNO, $!, $EVAL_ERROR, $@, $PROCESS_ID, $PID, $$, $REAL_USER_ID, |
371 | $UID, $<, |
372 | |
373 | |
374 | |
375 | =back |
376 | |
377 | |
378 | |
379 | |
380 | =head2 perlsub - Perl subroutines |
381 | |
382 | =item SYNOPSIS |
383 | |
384 | |
385 | =item DESCRIPTION |
386 | |
387 | |
388 | =over |
389 | |
390 | =item Private Variables via my() |
391 | |
392 | |
393 | =item Temporary Values via local() |
394 | |
395 | |
396 | =item Passing Symbol Table Entries (typeglobs) |
397 | |
398 | |
399 | =item Pass by Reference |
400 | |
401 | |
402 | =item Prototypes |
403 | |
404 | |
405 | =item Overriding Builtin Functions |
406 | |
407 | |
408 | =item Autoloading |
409 | |
410 | |
411 | |
412 | |
413 | =back |
414 | |
415 | =item SEE ALSO |
416 | |
417 | |
418 | |
419 | |
420 | |
421 | =head2 perlmod - Perl modules (packages) |
422 | |
423 | =item DESCRIPTION |
424 | |
425 | |
426 | =over |
427 | |
428 | =item Packages |
429 | |
430 | |
431 | =item Symbol Tables |
432 | |
433 | |
434 | =item Package Constructors and Destructors |
435 | |
436 | |
437 | =item Perl Classes |
438 | |
439 | |
440 | =item Perl Modules |
441 | |
442 | |
443 | |
444 | |
445 | =back |
446 | |
447 | =item NOTE |
448 | |
449 | |
450 | =item THE PERL MODULE LIBRARY |
451 | |
452 | |
453 | =over |
454 | |
455 | =item Pragmatic Modules |
456 | |
457 | |
458 | diagnostics, integer, less, overload, sigtrap, strict, subs |
459 | |
460 | =item Standard Modules |
461 | |
462 | |
463 | AnyDBM_File, AutoLoader, AutoSplit, Benchmark, Carp, Config, Cwd, |
464 | DB_File, Devel::SelfStubber, DynaLoader, English, Env, Exporter, |
465 | ExtUtils::Liblist, ExtUtils::MakeMaker, ExtUtils::Manifest, |
466 | ExtUtils::Mkbootstrap, ExtUtils::Miniperl, Fcntl, File::Basename, |
467 | File::CheckTree, File::Find, FileHandle, File::Path, Getopt::Long, |
468 | Getopt::Std, I18N::Collate, IPC::Open2, IPC::Open3, Net::Ping, POSIX, |
469 | SelfLoader, Socket, Test::Harness, Text::Abbrev |
470 | |
471 | =item Extension Modules |
472 | |
473 | |
474 | |
475 | |
476 | =back |
477 | |
478 | =item CPAN |
479 | |
480 | |
481 | Language Extensions and Documentation Tools, Development Support, |
482 | Operating System Interfaces, Networking, Device Control (modems) and |
483 | InterProcess Communication, Data Types and Data Type Utilities, |
484 | Database Interfaces, User Interfaces, Interfaces to / Emulations of |
485 | Other Programming Languages, File Names, File Systems and File Locking |
486 | (see also File Handles), String Processing, Language Text Processing, |
487 | Parsing and Searching, Option, Argument, Parameter and Configuration |
488 | File Processing, Internationalization and Locale, Authentication, |
489 | Security and Encryption, World Wide Web, HTML, HTTP, CGI, MIME, Server |
490 | and Daemon Utilities, Archiving and Compression, Images, Pixmap and |
491 | Bitmap Manipulation, Drawing and Graphing, Mail and Usenet News, |
492 | Control Flow Utilities (callbacks and exceptions etc), File Handle and |
493 | Input/Output Stream Utilities, Miscellaneous Modules |
494 | |
495 | =item Modules: Creation, Use and Abuse |
496 | |
497 | |
498 | =over |
499 | |
500 | =item Guidelines for Module Creation |
501 | |
502 | |
503 | Do similar modules already exist in some form?, Try to design the new |
504 | module to be easy to extend and reuse, Some simple style guidelines, |
505 | Select what to export, Select a name for the module, Have you got it |
506 | right?, README and other Additional Files, A description of the |
507 | module/package/extension etc, A copyright notice - see below, |
508 | Prerequisites - what else you may need to have, How to build it - |
509 | possible changes to Makefile.PL etc, How to install it, Recent changes |
510 | in this release, especially incompatibilities, Changes / enhancements |
511 | you plan to make in the future, Adding a Copyright Notice, Give the |
512 | module a version/issue/release number, How to release and distribute a |
513 | module, Take care when changing a released module |
514 | |
515 | =item Guidelines for Converting Perl 4 Library Scripts into Modules |
516 | |
517 | |
518 | There is no requirement to convert anything, Consider the implications, |
519 | Make the most of the opportunity, The pl2pm utility will get you |
520 | started, Adds the standard Module prologue lines, Converts package |
521 | specifiers from ' to ::, Converts die(...) to croak(...), Several other |
522 | minor changes |
523 | |
524 | =item Guidelines for Reusing Application Code |
525 | |
526 | |
527 | Complete applications rarely belong in the Perl Module Library, Many |
528 | applications contain some perl code which could be reused, Break-out |
529 | the reusable code into one or more separate module files, Take the |
530 | opportunity to reconsider and redesign the interfaces, In some cases |
531 | the 'application' can then be reduced to a small |
532 | |
533 | |
534 | |
535 | =back |
536 | |
537 | |
538 | |
539 | |
540 | =head2 perlref - Perl references and nested data structures |
541 | |
542 | =item DESCRIPTION |
543 | |
544 | |
545 | =over |
546 | |
547 | =item Symbolic references |
548 | |
549 | |
550 | =item Not-so-symbolic references |
551 | |
552 | |
553 | |
554 | |
555 | =back |
556 | |
557 | =item WARNING |
558 | |
559 | |
560 | =item SEE ALSO |
561 | |
562 | |
563 | |
564 | |
565 | |
566 | =head2 perldsc - Perl Data Structures Cookbook |
567 | |
568 | =item DESCRIPTION |
569 | |
570 | |
571 | arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes, |
572 | more elaborate constructs, recursive and self-referential data |
573 | structures, objects |
574 | |
575 | =item REFERENCES |
576 | |
577 | |
578 | =item COMMON MISTAKES |
579 | |
580 | |
581 | =item CAVEAT ON PRECEDENCE |
582 | |
583 | |
584 | =item WHY YOU SHOULD ALWAYS C<use strict> |
585 | |
586 | |
587 | =item DEBUGGING |
588 | |
589 | |
590 | =item CODE EXAMPLES |
591 | |
592 | |
593 | =item LISTS OF LISTS |
594 | |
595 | |
596 | =over |
597 | |
598 | =item Declaration of a LIST OF LISTS |
599 | |
600 | |
601 | =item Generation of a LIST OF LISTS |
602 | |
603 | |
604 | =item Access and Printing of a LIST OF LISTS |
605 | |
606 | |
607 | |
608 | |
609 | =back |
610 | |
611 | =item HASHES OF LISTS |
612 | |
613 | |
614 | =over |
615 | |
616 | =item Declaration of a HASH OF LISTS |
617 | |
618 | |
619 | =item Generation of a HASH OF LISTS |
620 | |
621 | |
622 | =item Access and Printing of a HASH OF LISTS |
623 | |
624 | |
625 | |
626 | |
627 | =back |
628 | |
629 | =item LISTS OF HASHES |
630 | |
631 | |
632 | =over |
633 | |
634 | =item Declaration of a LIST OF HASHES |
635 | |
636 | |
637 | =item Generation of a LIST OF HASHES |
638 | |
639 | |
640 | =item Access and Printing of a LIST OF HASHES |
641 | |
642 | |
643 | |
644 | |
645 | =back |
646 | |
647 | =item HASHES OF HASHES |
648 | |
649 | |
650 | =over |
651 | |
652 | =item Declaration of a HASH OF HASHES |
653 | |
654 | |
655 | =item Generation of a HASH OF HASHES |
656 | |
657 | |
658 | =item Access and Printing of a HASH OF HASHES |
659 | |
660 | |
661 | |
662 | |
663 | =back |
664 | |
665 | =item MORE ELABORATE RECORDS |
666 | |
667 | |
668 | =over |
669 | |
670 | =item Declaration of MORE ELABORATE RECORDS |
671 | |
672 | |
673 | =item Declaration of a HASH OF COMPLEX RECORDS |
674 | |
675 | |
676 | =item Generation of a HASH OF COMPLEX RECORDS |
677 | |
678 | |
679 | |
680 | |
681 | =back |
682 | |
683 | =item SEE ALSO |
684 | |
685 | |
686 | =item AUTHOR |
687 | |
688 | |
689 | |
690 | |
691 | |
692 | =head2 perllol, perlLoL - Manipulating Lists of Lists in Perl |
693 | |
694 | =item DESCRIPTION |
695 | |
696 | |
697 | =item Declaration and Access of Lists of Lists |
698 | |
699 | |
700 | =item Growing Your Own |
701 | |
702 | |
703 | =item Access and Printing |
704 | |
705 | |
706 | =item Slices |
707 | |
708 | |
709 | =item SEE ALSO |
710 | |
711 | |
712 | =item AUTHOR |
713 | |
714 | |
715 | |
716 | |
717 | |
718 | =head2 perlobj - Perl objects |
719 | |
720 | =item DESCRIPTION |
721 | |
722 | |
723 | =over |
724 | |
725 | =item An Object is Simply a Reference |
726 | |
727 | |
728 | =item A Class is Simply a Package |
729 | |
730 | |
731 | =item A Method is Simply a Subroutine |
732 | |
733 | |
734 | =item Method Invocation |
735 | |
736 | |
737 | =item Destructors |
738 | |
739 | |
740 | =item WARNING |
741 | |
742 | |
743 | =item Summary |
744 | |
745 | |
746 | =item Two-Phased Garbage Collection |
747 | |
748 | |
749 | |
750 | |
751 | =back |
752 | |
753 | =item SEE ALSO |
754 | |
755 | |
756 | |
757 | |
758 | |
759 | =head2 perltie - how to hide an object class in a simple variable |
760 | |
761 | =item SYNOPSIS |
762 | |
763 | |
764 | =item DESCRIPTION |
765 | |
766 | |
767 | =over |
768 | |
769 | =item Tying Scalars |
770 | |
771 | |
772 | TIESCALAR classname, LIST, FETCH this, STORE this, value, DESTROY this |
773 | |
774 | =item Tying Arrays |
775 | |
776 | |
777 | TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value, |
778 | DESTROY this |
779 | |
780 | =item Tying Hashes |
781 | |
782 | |
783 | USER, HOME, CLOBBER, LIST, TIEHASH classname, LIST, FETCH this, key, |
784 | STORE this, key, value, DELETE this, key, CLEAR this, EXISTS this, key, |
785 | FIRSTKEY this, NEXTKEY this, lastkey, DESTROY this |
786 | |
787 | =item Tying FileHandles |
788 | |
789 | |
790 | |
791 | |
792 | =back |
793 | |
794 | =item SEE ALSO |
795 | |
796 | |
797 | =item BUGS |
798 | |
799 | |
800 | =item AUTHOR |
801 | |
802 | |
803 | |
804 | |
805 | |
806 | =head2 perlbot - Bag'o Object Tricks (the BOT) |
807 | |
808 | =item DESCRIPTION |
809 | |
810 | |
811 | =item OO SCALING TIPS |
812 | |
813 | |
814 | =item INSTANCE VARIABLES |
815 | |
816 | |
817 | =item SCALAR INSTANCE VARIABLES |
818 | |
819 | |
820 | =item INSTANCE VARIABLE INHERITANCE |
821 | |
822 | |
823 | =item OBJECT RELATIONSHIPS |
824 | |
825 | |
826 | =item OVERRIDING SUPERCLASS METHODS |
827 | |
828 | |
829 | =item USING RELATIONSHIP WITH SDBM |
830 | |
831 | |
832 | =item THINKING OF CODE REUSE |
833 | |
834 | |
835 | =item CLASS CONTEXT AND THE OBJECT |
836 | |
837 | |
838 | =item INHERITING A CONSTRUCTOR |
839 | |
840 | |
841 | =item DELEGATION |
842 | |
843 | |
844 | |
845 | |
846 | |
847 | =head2 perldebug - Perl debugging |
848 | |
849 | =item DESCRIPTION |
850 | |
851 | |
852 | =over |
853 | |
854 | =item Debugging |
855 | |
856 | |
857 | h, T, s, n, f, c, c line, <CR>, l min+incr, l min-max, l line, l, -, w |
858 | line, l subname, /pattern/, ?pattern?, L, S, t, b line [ condition ], b |
859 | subname [ condition ], d line, D, a line command, A, < command, > |
860 | command, V package [symbols], X [symbols], ! number, ! -number, H |
861 | -number, q or ^D, command, p expr |
862 | |
863 | =item Customization |
864 | |
865 | |
866 | =item Other resources |
867 | |
868 | |
869 | |
870 | |
871 | =back |
872 | |
873 | =item BUGS |
874 | |
875 | |
876 | |
877 | |
878 | |
879 | =head2 perldiag - various Perl diagnostics |
880 | |
881 | =item DESCRIPTION |
882 | |
883 | |
884 | |
885 | |
886 | |
887 | =head2 perlform - Perl formats |
888 | |
889 | =item DESCRIPTION |
890 | |
891 | |
892 | =over |
893 | |
894 | =item Format Variables |
895 | |
896 | |
897 | |
898 | |
899 | =back |
900 | |
901 | =item NOTES |
902 | |
903 | |
904 | =over |
905 | |
906 | =item Footers |
907 | |
908 | |
909 | =item Accessing Formatting Internals |
910 | |
911 | |
912 | |
913 | |
914 | =back |
915 | |
916 | =item WARNING |
917 | |
918 | |
919 | |
920 | |
921 | |
922 | =head2 perlipc - Perl interprocess communication (signals, fifos, |
923 | pipes, safe subprocceses, sockets, and semaphores) |
924 | |
925 | =item DESCRIPTION |
926 | |
927 | |
928 | =item Signals |
929 | |
930 | |
931 | =item Named Pipes |
932 | |
933 | |
934 | =item Using open() for IPC |
935 | |
936 | |
937 | =over |
938 | |
939 | =item Safe Pipe Opens |
940 | |
941 | |
942 | =item Bidirectional Communication |
943 | |
944 | |
945 | |
946 | |
947 | =back |
948 | |
949 | =item Sockets: Client/Server Communication |
950 | |
951 | |
952 | =over |
953 | |
954 | =item Internet TCP Clients and Servers |
955 | |
956 | |
957 | =item Unix-Domain TCP Clients and Servers |
958 | |
959 | |
960 | =item UDP: Message Passing |
961 | |
962 | |
963 | |
964 | |
965 | =back |
966 | |
967 | =item SysV IPC |
968 | |
969 | |
970 | =item WARNING |
971 | |
972 | |
973 | =item NOTES |
974 | |
975 | |
976 | =item BUGS |
977 | |
978 | |
979 | =item AUTHOR |
980 | |
981 | |
982 | =item SEE ALSO |
983 | |
984 | |
985 | |
986 | |
987 | |
988 | =head2 perlsec - Perl security |
989 | |
990 | =item DESCRIPTION |
991 | |
992 | |
993 | |
994 | |
995 | |
996 | =head2 perltrap - Perl traps for the unwary |
997 | |
998 | =item DESCRIPTION |
999 | |
1000 | |
1001 | =over |
1002 | |
1003 | =item Awk Traps |
1004 | |
1005 | |
1006 | =item C Traps |
1007 | |
1008 | |
1009 | =item Sed Traps |
1010 | |
1011 | |
1012 | =item Shell Traps |
1013 | |
1014 | |
1015 | =item Perl Traps |
1016 | |
1017 | |
1018 | =item Perl4 Traps |
1019 | |
1020 | |
1021 | |
1022 | |
1023 | =back |
1024 | |
1025 | |
1026 | |
1027 | |
1028 | =head2 perlstyle - Perl style guide |
1029 | |
1030 | =item DESCRIPTION |
1031 | |
1032 | |
1033 | |
1034 | |
1035 | |
1036 | =head2 perlxs - XS language reference manual |
1037 | |
1038 | =item DESCRIPTION |
1039 | |
1040 | |
1041 | =over |
1042 | |
1043 | =item Introduction |
1044 | |
1045 | |
1046 | =item On The Road |
1047 | |
1048 | |
1049 | =item The Anatomy of an XSUB |
1050 | |
1051 | |
1052 | =item The Argument Stack |
1053 | |
1054 | |
1055 | =item The RETVAL Variable |
1056 | |
1057 | |
1058 | =item The MODULE Keyword |
1059 | |
1060 | |
1061 | =item The PACKAGE Keyword |
1062 | |
1063 | |
1064 | =item The PREFIX Keyword |
1065 | |
1066 | |
1067 | =item The OUTPUT: Keyword |
1068 | |
1069 | |
1070 | =item The CODE: Keyword |
1071 | |
1072 | |
1073 | =item The NO_INIT Keyword |
1074 | |
1075 | |
1076 | =item Initializing Function Parameters |
1077 | |
1078 | |
1079 | =item Default Parameter Values |
1080 | |
1081 | |
1082 | =item Variable-length Parameter Lists |
1083 | |
1084 | |
1085 | =item The PPCODE: Keyword |
1086 | |
1087 | |
1088 | =item Returning Undef And Empty Lists |
1089 | |
1090 | |
1091 | =item The REQUIRE: Keyword |
1092 | |
1093 | |
1094 | =item The CLEANUP: Keyword |
1095 | |
1096 | |
1097 | =item The BOOT: Keyword |
1098 | |
1099 | |
1100 | =item Inserting Comments and C Preprocessor Directives |
1101 | |
1102 | |
1103 | =item Using XS With C++ |
1104 | |
1105 | |
1106 | =item Interface Strategy |
1107 | |
1108 | |
1109 | =item Perl Objects And C Structures |
1110 | |
1111 | |
1112 | =item The Typemap |
1113 | |
1114 | |
1115 | |
1116 | |
1117 | =back |
1118 | |
1119 | =item EXAMPLES |
1120 | |
1121 | |
1122 | =item AUTHOR |
1123 | |
1124 | |
1125 | |
1126 | |
1127 | |
1128 | =head2 perlxstut, perlXStut - Tutorial for XSUB's |
1129 | |
1130 | =item DESCRIPTION |
1131 | |
1132 | |
1133 | =item EXAMPLE 1 |
1134 | |
1135 | |
1136 | =item EXAMPLE 2 |
1137 | |
1138 | |
1139 | =item WHAT HAS GONE ON? |
1140 | |
1141 | |
1142 | =item EXAMPLE 3 |
1143 | |
1144 | |
1145 | =item WHAT'S NEW HERE? |
1146 | |
1147 | |
1148 | =item INPUT AND OUTPUT PARAMETERS |
1149 | |
1150 | |
1151 | =item THE XSUBPP COMPILER |
1152 | |
1153 | |
1154 | =item THE TYPEMAP FILE |
1155 | |
1156 | |
1157 | =item WARNING |
1158 | |
1159 | |
1160 | =item EXAMPLE 4 |
1161 | |
1162 | |
1163 | =item Author |
1164 | |
1165 | |
1166 | =item Last Changed |
1167 | |
1168 | |
1169 | |
1170 | |
1171 | |
1172 | =head2 perlguts - Perl's Internal Functions |
1173 | |
1174 | =item DESCRIPTION |
1175 | |
1176 | |
1177 | =item Datatypes |
1178 | |
1179 | |
1180 | =over |
1181 | |
1182 | =item What is an "IV"? |
1183 | |
1184 | |
1185 | =item Working with SV's |
1186 | |
1187 | |
1188 | =item What's Really Stored in an SV? |
1189 | |
1190 | |
1191 | =item Working with AV's |
1192 | |
1193 | |
1194 | =item Working with HV's |
1195 | |
1196 | |
1197 | =item References |
1198 | |
1199 | |
1200 | =item Blessed References and Class Objects |
1201 | |
1202 | |
1203 | |
1204 | |
1205 | =back |
1206 | |
1207 | =item Creating New Variables |
1208 | |
1209 | |
1210 | =item XSUB's and the Argument Stack |
1211 | |
1212 | |
1213 | =item Mortality |
1214 | |
1215 | |
1216 | =item Stashes |
1217 | |
1218 | |
1219 | =item Magic |
1220 | |
1221 | |
1222 | =over |
1223 | |
1224 | =item Assigning Magic |
1225 | |
1226 | |
1227 | =item Magic Virtual Tables |
1228 | |
1229 | |
1230 | =item Finding Magic |
1231 | |
1232 | |
1233 | |
1234 | |
1235 | =back |
1236 | |
1237 | =item Double-Typed SV's |
1238 | |
1239 | |
1240 | =item Calling Perl Routines from within C Programs |
1241 | |
1242 | |
1243 | =item Memory Allocation |
1244 | |
1245 | |
1246 | =item API LISTING |
1247 | |
1248 | |
1249 | AvFILL, av_clear, av_extend, av_fetch, av_len, av_make, av_pop, |
1250 | av_push, av_shift, av_store, av_undef, av_unshift, CLASS, Copy, croak, |
1251 | CvSTASH, DBsingle, DBsub, dMARK, dORIGMARK, dSP, dXSARGS, ENTER, |
1252 | EXTEND, FREETMPS, G_ARRAY, G_DISCARD, G_EVAL, GIMME, G_NOARGS, |
1253 | G_SCALAR, gv_stashpv, gv_stashsv, GvSV, he_free, hv_clear, hv_delete, |
1254 | hv_exists, hv_fetch, hv_iterinit, hv_iterkey, hv_iternext, |
1255 | hv_iternextsv, hv_iterval, hv_magic, HvNAME, hv_store, hv_undef, |
1256 | isALNUM, isALPHA, isDIGIT, isLOWER, isSPACE, isUPPER, items, LEAVE, |
1257 | MARK, mg_clear, mg_copy, mg_find, mg_free, mg_get, mg_len, mg_magical, |
1258 | mg_set, Move, na, New, Newc, Newz, newAV, newHV, newRV, newSV, newSViv, |
1259 | newSVnv, newSVpv, newSVrv, newSVsv, newXS, newXSproto, Nullav, Nullch, |
1260 | Nullcv, Nullhv, Nullsv, ORIGMARK, perl_alloc, perl_call_argv, |
1261 | perl_call_method, perl_call_pv, perl_call_sv, perl_construct, |
1262 | perl_destruct, perl_eval_sv, perl_free, perl_get_av, perl_get_cv, |
1263 | perl_get_hv, perl_get_sv, perl_parse, perl_require_pv, perl_run, POPi, |
1264 | POPl, POPp, POPn, POPs, |
1265 | |
1266 | =item AUTHOR |
1267 | |
1268 | |
1269 | =item DATE |
1270 | |
1271 | |
1272 | |
1273 | |
1274 | |
1275 | =head2 perlcall - Perl calling conventions from C |
1276 | |
1277 | =item DESCRIPTION |
1278 | |
1279 | |
1280 | An Error Handler, An Event Driven Program |
1281 | |
1282 | =item THE PERL_CALL FUNCTIONS |
1283 | |
1284 | |
1285 | B<perl_call_sv>, B<perl_call_pv>, B<perl_call_method>, |
1286 | B<perl_call_argv> |
1287 | |
1288 | =item FLAG VALUES |
1289 | |
1290 | |
1291 | =over |
1292 | |
1293 | =item G_SCALAR |
1294 | |
1295 | |
1296 | =item G_ARRAY |
1297 | |
1298 | |
1299 | =item G_DISCARD |
1300 | |
1301 | |
1302 | =item G_NOARGS |
1303 | |
1304 | |
1305 | =item G_EVAL |
1306 | |
1307 | |
1308 | =item Determining the Context |
1309 | |
1310 | |
1311 | |
1312 | |
1313 | =back |
1314 | |
1315 | =item KNOWN PROBLEMS |
1316 | |
1317 | |
1318 | =item EXAMPLES |
1319 | |
1320 | |
1321 | =over |
1322 | |
1323 | =item No Parameters, Nothing returned |
1324 | |
1325 | |
1326 | =item Passing Parameters |
1327 | |
1328 | |
1329 | =item Returning a Scalar |
1330 | |
1331 | |
1332 | =item Returning a list of values |
1333 | |
1334 | |
1335 | =item Returning a list in a scalar context |
1336 | |
1337 | |
1338 | =item Returning Data from Perl via the parameter list |
1339 | |
1340 | |
1341 | =item Using G_EVAL |
1342 | |
1343 | |
1344 | =item Using perl_call_sv |
1345 | |
1346 | |
1347 | =item Using perl_call_argv |
1348 | |
1349 | |
1350 | =item Using perl_call_method |
1351 | |
1352 | |
1353 | =item Using GIMME |
1354 | |
1355 | |
1356 | =item Using Perl to dispose of temporaries |
1357 | |
1358 | |
1359 | =item Strategies for storing Callback Context Information |
1360 | |
1361 | |
1362 | 1. Ignore the problem - Allow only 1 callback, 2. Create a sequence of |
1363 | callbacks - hard wired limit, 3. Use a parameter to map to the Perl |
1364 | callback |
1365 | |
1366 | =item Alternate Stack Manipulation |
1367 | |
1368 | |
1369 | |
1370 | |
1371 | =back |
1372 | |
1373 | =item SEE ALSO |
1374 | |
1375 | |
1376 | =item AUTHOR |
1377 | |
1378 | |
1379 | =item DATE |
1380 | |
1381 | |
1382 | |
1383 | |
1384 | |
1385 | =head2 perlembed - how to embed perl in your C program |
1386 | |
1387 | =item DESCRIPTION |
1388 | |
1389 | |
1390 | =over |
1391 | |
1392 | =item PREAMBLE |
1393 | |
1394 | |
1395 | B<Use C from Perl?>, B<Use a UNIX program from Perl?>, B<Use Perl from |
1396 | Perl?>, B<Use C from C?>, B<Use Perl from C?> |
1397 | |
1398 | =item ROADMAP |
1399 | |
1400 | |
1401 | =item Compiling your C program |
1402 | |
1403 | |
1404 | =item Adding a Perl interpreter to your C program |
1405 | |
1406 | |
1407 | =item Calling a Perl subroutine from your C program |
1408 | |
1409 | |
1410 | =item Evaluating a Perl statement from your C program |
1411 | |
1412 | |
1413 | =item Performing Perl pattern matches and substitutions from your C |
1414 | program |
1415 | |
1416 | |
1417 | |
1418 | |
1419 | =back |
1420 | |
1421 | =item MORAL |
1422 | |
1423 | |
1424 | =item AUTHOR |
1425 | |
1426 | |
1427 | |
1428 | |
1429 | |
1430 | =head2 perlpod - plain old documentation |
1431 | |
1432 | =item DESCRIPTION |
1433 | |
1434 | |
1435 | =item Embedding Pods in Perl Modules |
1436 | |
1437 | |
1438 | =item SEE ALSO |
1439 | |
1440 | |
1441 | =item AUTHOR |
1442 | |
1443 | |
1444 | |
1445 | |
1446 | |
1447 | =head2 perlbook - Perl book information |
1448 | |
1449 | =item DESCRIPTION |
1450 | |
1451 | |
1452 | |
1453 | |
1454 | |
1455 | =head1 PRAGMA DOCUMENTATION |
1456 | |
1457 | |
1458 | |
1459 | |
1460 | =head2 diagnostics - Perl compiler pragma to force verbose warning |
1461 | diagnostics |
1462 | |
1463 | =item SYNOPSIS |
1464 | |
1465 | |
1466 | =item DESCRIPTION |
1467 | |
1468 | |
1469 | =over |
1470 | |
1471 | =item The C<diagnostics> Pragma |
1472 | |
1473 | |
1474 | =item The I<splain> Program |
1475 | |
1476 | |
1477 | |
1478 | |
1479 | =back |
1480 | |
1481 | =item EXAMPLES |
1482 | |
1483 | |
1484 | =item INTERNALS |
1485 | |
1486 | |
1487 | =item BUGS |
1488 | |
1489 | |
1490 | =item AUTHOR |
1491 | |
1492 | |
1493 | |
1494 | |
1495 | |
1496 | =head2 integer - Perl pragma to compute arithmetic in integer instead |
1497 | of double |
1498 | |
1499 | =item SYNOPSIS |
1500 | |
1501 | |
1502 | =item DESCRIPTION |
1503 | |
1504 | |
1505 | |
1506 | |
1507 | |
1508 | =head2 less - perl pragma to request less of something from the |
1509 | compiler |
1510 | |
1511 | =item SYNOPSIS |
1512 | |
1513 | |
1514 | =item DESCRIPTION |
1515 | |
1516 | |
1517 | |
1518 | |
1519 | |
1520 | =head2 lib - manipulate @INC at compile time |
1521 | |
1522 | =item SYNOPSIS |
1523 | |
1524 | |
1525 | =item DESCRIPTION |
1526 | |
1527 | |
1528 | =over |
1529 | |
1530 | =item ADDING DIRECTORIES TO @INC |
1531 | |
1532 | |
1533 | =item DELETING DIRECTORIES FROM @INC |
1534 | |
1535 | |
1536 | =item RESTORING ORIGINAL @INC |
1537 | |
1538 | |
1539 | |
1540 | |
1541 | =back |
1542 | |
1543 | =item SEE ALSO |
1544 | |
1545 | |
1546 | =item AUTHOR |
1547 | |
1548 | |
1549 | |
1550 | |
1551 | |
1552 | =head2 overload - Package for overloading perl operations |
1553 | |
1554 | =item SYNOPSIS |
1555 | |
1556 | |
1557 | =item CAVEAT SCRIPTOR |
1558 | |
1559 | |
1560 | =item DESCRIPTION |
1561 | |
1562 | |
1563 | =over |
1564 | |
1565 | =item Declaration of overloaded functions |
1566 | |
1567 | |
1568 | =item Calling Conventions for Binary Operations |
1569 | |
1570 | |
1571 | FALSE, TRUE, C<undef> |
1572 | |
1573 | =item Calling Conventions for Unary Operations |
1574 | |
1575 | |
1576 | =item Overloadable Operations |
1577 | |
1578 | |
1579 | I<Arithmetic operations>, I<Comparison operations>, I<Bit operations>, |
1580 | I<Increment and decrement>, I<Transcendental functions>, I<Boolean, |
1581 | string and numeric conversion>, I<Special> |
1582 | |
1583 | |
1584 | |
1585 | =back |
1586 | |
1587 | =item SPECIAL SYMBOLS FOR C<use overload> |
1588 | |
1589 | |
1590 | =over |
1591 | |
1592 | =item Last Resort |
1593 | |
1594 | |
1595 | =item Fallback |
1596 | |
1597 | |
1598 | C<undef>, TRUE, defined, but FALSE |
1599 | |
1600 | =item Copy Constructor |
1601 | |
1602 | |
1603 | B<Example> |
1604 | |
1605 | |
1606 | |
1607 | =back |
1608 | |
1609 | =item MAGIC AUTOGENERATION |
1610 | |
1611 | |
1612 | I<Assignment forms of arithmetic operations>, I<Conversion operations>, |
1613 | I<Increment and decrement>, C<abs($a)>, I<Unary minus>, |
1614 | I<Concatenation>, I<Comparison operations>, I<Copy operator> |
1615 | |
1616 | =item WARNING |
1617 | |
1618 | |
1619 | =item Run-time Overloading |
1620 | |
1621 | |
1622 | =item Public functions |
1623 | |
1624 | |
1625 | overload::StrVal(arg), overload::Overloaded(arg), |
1626 | overload::Method(obj,op) |
1627 | |
1628 | =item IMPLEMENTATION |
1629 | |
1630 | |
1631 | =item AUTHOR |
1632 | |
1633 | |
1634 | =item DIAGNOSTICS |
1635 | |
1636 | |
1637 | =item BUGS |
1638 | |
1639 | |
1640 | |
1641 | |
1642 | |
1643 | =head2 sigtrap - Perl pragma to enable stack backtrace on unexpected |
1644 | signals |
1645 | |
1646 | =item SYNOPSIS |
1647 | |
1648 | |
1649 | =item DESCRIPTION |
1650 | |
1651 | |
1652 | |
1653 | |
1654 | |
1655 | =head2 strict - Perl pragma to restrict unsafe constructs |
1656 | |
1657 | =item SYNOPSIS |
1658 | |
1659 | |
1660 | =item DESCRIPTION |
1661 | |
1662 | |
1663 | C<strict refs>, C<strict vars>, C<strict subs> |
1664 | |
1665 | |
1666 | |
1667 | |
1668 | =head2 subs - Perl pragma to predeclare sub names |
1669 | |
1670 | =item SYNOPSIS |
1671 | |
1672 | |
1673 | =item DESCRIPTION |
1674 | |
1675 | |
1676 | |
1677 | |
1678 | |
1679 | =head1 MODULE DOCUMENTATION |
1680 | |
1681 | |
1682 | |
1683 | |
1684 | =head2 AnyDBM_File - provide framework for multiple DBMs |
1685 | |
1686 | =item SYNOPSIS |
1687 | |
1688 | |
1689 | =item DESCRIPTION |
1690 | |
1691 | |
1692 | =over |
1693 | |
1694 | =item DBM Comparisons |
1695 | |
1696 | |
1697 | [0], [1], [2], [3] |
1698 | |
1699 | |
1700 | |
1701 | =back |
1702 | |
1703 | =item SEE ALSO |
1704 | |
1705 | |
1706 | |
1707 | |
1708 | |
1709 | =head2 AutoLoader - load functions only on demand |
1710 | |
1711 | =item SYNOPSIS |
1712 | |
1713 | |
1714 | =item DESCRIPTION |
1715 | |
1716 | |
1717 | |
1718 | |
1719 | |
1720 | =head2 AutoSplit - split a package for autoloading |
1721 | |
1722 | =item SYNOPSIS |
1723 | |
1724 | |
1725 | =item DESCRIPTION |
1726 | |
1727 | |
1728 | |
1729 | |
1730 | |
1731 | =head2 Benchmark - benchmark running times of code |
1732 | |
1733 | =item SYNOPSIS |
1734 | |
1735 | |
1736 | =item DESCRIPTION |
1737 | |
1738 | |
1739 | =over |
1740 | |
1741 | =item Methods |
1742 | |
1743 | |
1744 | new, debug |
1745 | |
1746 | =item Standard Exports |
1747 | |
1748 | |
1749 | timeit(COUNT, CODE), timethis, timethese, timediff, timestr |
1750 | |
1751 | =item Optional Exports |
1752 | |
1753 | |
1754 | |
1755 | |
1756 | =back |
1757 | |
1758 | =item NOTES |
1759 | |
1760 | |
1761 | =item INHERITANCE |
1762 | |
1763 | |
1764 | =item CAVEATS |
1765 | |
1766 | |
1767 | =item AUTHORS |
1768 | |
1769 | |
1770 | =item MODIFICATION HISTORY |
1771 | |
1772 | |
1773 | |
1774 | |
1775 | |
1776 | =head2 Carp, carp - warn of errors (from perspective of caller) |
1777 | |
1778 | =item SYNOPSIS |
1779 | |
1780 | |
1781 | =item DESCRIPTION |
1782 | |
1783 | |
1784 | |
1785 | |
1786 | |
1787 | =head2 Config - access Perl configuration option |
1788 | |
1789 | =item SYNOPSIS |
1790 | |
1791 | |
1792 | =item DESCRIPTION |
1793 | |
1794 | |
1795 | =item EXAMPLE |
1796 | |
1797 | |
1798 | =item NOTE |
1799 | |
1800 | |
1801 | |
1802 | |
1803 | |
1804 | =head2 Cwd, getcwd - get pathname of current working directory |
1805 | |
1806 | =item SYNOPSIS |
1807 | |
1808 | |
1809 | =item DESCRIPTION |
1810 | |
1811 | |
1812 | |
1813 | |
1814 | |
1815 | =head2 DB_File - Perl5 access to Berkeley DB |
1816 | |
1817 | =item SYNOPSIS |
1818 | |
1819 | |
1820 | =item DESCRIPTION |
1821 | |
1822 | |
1823 | DB_HASH, DB_BTREE, DB_RECNO |
1824 | |
1825 | =over |
1826 | |
1827 | =item How does DB_File interface to Berkeley DB? |
1828 | |
1829 | |
1830 | =item Differences with Berkeley DB |
1831 | |
1832 | |
1833 | =item RECNO |
1834 | |
1835 | |
1836 | =item In Memory Databases |
1837 | |
1838 | |
1839 | =item Using the Berkeley DB Interface Directly |
1840 | |
1841 | |
1842 | get, put, del, fd, seq, sync |
1843 | |
1844 | |
1845 | |
1846 | =back |
1847 | |
1848 | =item EXAMPLES |
1849 | |
1850 | |
1851 | =over |
1852 | |
1853 | =item Using HASH |
1854 | |
1855 | |
1856 | =item Using BTREE |
1857 | |
1858 | |
1859 | =item Using RECNO |
1860 | |
1861 | |
1862 | =item Locking Databases |
1863 | |
1864 | |
1865 | |
1866 | |
1867 | =back |
1868 | |
1869 | =item HISTORY |
1870 | |
1871 | |
1872 | =item WARNINGS |
1873 | |
1874 | |
1875 | =item BUGS |
1876 | |
1877 | |
1878 | =item AVAILABILITY |
1879 | |
1880 | |
1881 | =item SEE ALSO |
1882 | |
1883 | |
1884 | =item AUTHOR |
1885 | |
1886 | |
1887 | |
1888 | |
1889 | |
1890 | =head2 Devel::SelfStubber - generate stubs for a SelfLoading module |
1891 | |
1892 | =item SYNOPSIS |
1893 | |
1894 | |
1895 | =item DESCRIPTION |
1896 | |
1897 | |
1898 | |
1899 | |
1900 | |
1901 | =head2 DynaLoader - Dynamically load C libraries into Perl code |
1902 | |
1903 | =item SYNOPSIS |
1904 | |
1905 | |
1906 | =item DESCRIPTION |
1907 | |
1908 | |
1909 | @dl_library_path, @dl_resolve_using, @dl_require_symbols, dl_error(), |
1910 | $dl_debug, dl_findfile(), dl_expandspec(), dl_load_file(), |
1911 | dl_find_symbol(), dl_undef_symbols(), dl_install_xsub(), boostrap() |
1912 | |
1913 | =item AUTHOR |
1914 | |
1915 | |
1916 | |
1917 | |
1918 | |
1919 | =head2 English - use nice English (or awk) names for ugly punctuation |
1920 | variables |
1921 | |
1922 | =item SYNOPSIS |
1923 | |
1924 | |
1925 | =item DESCRIPTION |
1926 | |
1927 | |
1928 | |
1929 | |
1930 | |
1931 | =head2 Env - perl module that imports environment variables |
1932 | |
1933 | =item SYNOPSIS |
1934 | |
1935 | |
1936 | =item DESCRIPTION |
1937 | |
1938 | |
1939 | =item AUTHOR |
1940 | |
1941 | |
1942 | |
1943 | |
1944 | |
1945 | =head2 Exporter - provide inport/export controls for Perl modules |
1946 | |
1947 | =item SYNOPSIS |
1948 | |
1949 | |
1950 | =item DESCRIPTION |
1951 | |
1952 | |
1953 | =over |
1954 | |
1955 | =item Module Version Checking |
1956 | |
1957 | |
1958 | |
1959 | |
1960 | =back |
1961 | |
1962 | |
1963 | |
1964 | |
1965 | =head2 ExtUtils::Liblist - determine libraries to use and how to use |
1966 | them |
1967 | |
1968 | =item SYNOPSIS |
1969 | |
1970 | |
1971 | =item DESCRIPTION |
1972 | |
1973 | |
1974 | For static extensions, For dynamic extensions, For dynamic extensions |
1975 | |
1976 | =over |
1977 | |
1978 | =item EXTRALIBS |
1979 | |
1980 | |
1981 | =item LDLOADLIBS and LD_RUN_PATH |
1982 | |
1983 | |
1984 | =item BSLOADLIBS |
1985 | |
1986 | |
1987 | |
1988 | |
1989 | =back |
1990 | |
1991 | =item PORTABILITY |
1992 | |
1993 | |
1994 | =item SEE ALSO |
1995 | |
1996 | |
1997 | |
1998 | |
1999 | |
2000 | =head2 ExtUtils::MakeMaker - create an extension Makefile |
2001 | |
2002 | =item SYNOPSIS |
2003 | |
2004 | |
2005 | =item DESCRIPTION |
2006 | |
2007 | |
2008 | =over |
2009 | |
2010 | =item Hintsfile support |
2011 | |
2012 | |
2013 | =item What's new in version 5 of MakeMaker |
2014 | |
2015 | |
2016 | =item Incompatibilities between MakeMaker 5.00 and 4.23 |
2017 | |
2018 | |
2019 | =item Default Makefile Behaviour |
2020 | |
2021 | |
2022 | =item Special case make install |
2023 | |
2024 | |
2025 | =item PREFIX attribute |
2026 | |
2027 | |
2028 | =item AFS users |
2029 | |
2030 | |
2031 | =item Static Linking of a new Perl Binary |
2032 | |
2033 | |
2034 | =item Determination of Perl Library and Installation Locations |
2035 | |
2036 | |
2037 | =item Useful Default Makefile Macros |
2038 | |
2039 | |
2040 | =item Using Attributes (and Parameters) |
2041 | |
2042 | |
2043 | C, CONFIG, CONFIGURE, DEFINE, DIR, DISTNAME, DL_FUNCS, DL_VARS, |
2044 | EXE_FILES, FIRST_MAKEFILE, FULLPERL, H, INC, INSTALLARCHLIB, |
2045 | INSTALLBIN, INSTALLMAN1DIR, INSTALLMAN3DIR, INSTALLPRIVLIB, |
2046 | INST_ARCHLIB, INST_EXE, INST_LIB, INST_MAN1DIR, INST_MAN3DIR, LDFROM, |
2047 | LIBPERL_A, LIBS, LINKTYPE, MAKEAPERL, MAKEFILE, MAN1PODS, MAN3PODS, |
2048 | MAP_TARGET, MYEXTLIB, NAME, NEEDS_LINKING, NORECURS, OBJECT, PERL, |
2049 | PERLMAINCC, PERL_ARCHLIB, PERL_LIB, PERL_SRC, PL_FILES, PM, PMLIBDIRS, |
2050 | PREFIX, PREREQ, SKIP, TYPEMAPS, VERSION, XS, XSOPT, XSPROTOARG |
2051 | |
2052 | =item Additional lowercase attributes |
2053 | |
2054 | |
2055 | clean, dist, dynamic_lib, installpm, linkext, macro, realclean, |
2056 | tool_autosplit |
2057 | |
2058 | =item Overriding MakeMaker Methods |
2059 | |
2060 | |
2061 | =item Distribution Support |
2062 | |
2063 | |
2064 | make distcheck, make skipcheck, make distclean, make |
2065 | manifest, make distdir, make tardist, make dist, make |
2066 | uutardist, make shdist, make ci |
2067 | |
2068 | |
2069 | |
2070 | =back |
2071 | |
2072 | =item AUTHORS |
2073 | |
2074 | |
2075 | =item MODIFICATION HISTORY |
2076 | |
2077 | |
2078 | =item TODO |
2079 | |
2080 | |
2081 | |
2082 | |
2083 | |
2084 | =head2 ExtUtils::Manifest - utilities to write and check a MANIFEST |
2085 | file |
2086 | |
2087 | =item SYNOPSIS |
2088 | |
2089 | |
2090 | =item DESCRIPTION |
2091 | |
2092 | |
2093 | =item MANIFEST.SKIP |
2094 | |
2095 | |
2096 | =item EXPORT_OK |
2097 | |
2098 | |
2099 | =item GLOBAL VARIABLES |
2100 | |
2101 | |
2102 | =item DIAGNOSTICS |
2103 | |
2104 | |
2105 | C<Not in MANIFEST:> I<file>, C<No such file:> I<file>, C<MANIFEST:> |
2106 | I<$!>, C<Added to MANIFEST:> I<file> |
2107 | |
2108 | =item SEE ALSO |
2109 | |
2110 | |
2111 | =item AUTHOR |
2112 | |
2113 | |
2114 | |
2115 | |
2116 | |
2117 | =head2 ExtUtils::Miniperl, writemain - write the C code for perlmain.c |
2118 | |
2119 | =item SYNOPSIS |
2120 | |
2121 | |
2122 | =item DESCRIPTION |
2123 | |
2124 | |
2125 | =item SEE ALSO |
2126 | |
2127 | |
2128 | |
2129 | |
2130 | |
2131 | =head2 ExtUtils::Mkbootstrap, Mkbootstrap - make a bootstrap file for |
2132 | use by DynaLoader |
2133 | |
2134 | =item SYNOPSIS |
2135 | |
2136 | |
2137 | =item DESCRIPTION |
2138 | |
2139 | |
2140 | |
2141 | |
2142 | |
2143 | =head2 Fcntl - load the C Fcntl.h defines |
2144 | |
2145 | =item SYNOPSIS |
2146 | |
2147 | |
2148 | =item DESCRIPTION |
2149 | |
2150 | |
2151 | =item NOTE |
2152 | |
2153 | |
2154 | |
2155 | |
2156 | |
2157 | =head2 File::Basename, Basename - parse file specifications |
2158 | |
2159 | =item SYNOPSIS |
2160 | |
2161 | |
2162 | =item DESCRIPTION |
2163 | |
2164 | |
2165 | fileparse_set_fstype, fileparse |
2166 | |
2167 | =item EXAMPLES |
2168 | |
2169 | |
2170 | C<basename>, C<dirname> |
2171 | |
2172 | |
2173 | |
2174 | |
2175 | =head2 File::CheckTree, validate - run many filetest checks on a tree |
2176 | |
2177 | =item SYNOPSIS |
2178 | |
2179 | |
2180 | =item DESCRIPTION |
2181 | |
2182 | |
2183 | |
2184 | |
2185 | |
2186 | =head2 File::Find, find - traverse a file tree |
2187 | |
2188 | =item SYNOPSIS |
2189 | |
2190 | |
2191 | =item DESCRIPTION |
2192 | |
2193 | |
2194 | |
2195 | |
2196 | |
2197 | =head2 File::Path - create or remove a series of directories |
2198 | |
2199 | =item SYNOPSIS |
2200 | |
2201 | |
2202 | =item DESCRIPTION |
2203 | |
2204 | |
2205 | =item AUTHORS |
2206 | |
2207 | |
2208 | =item REVISION |
2209 | |
2210 | |
2211 | |
2212 | |
2213 | |
2214 | =head2 FileHandle - supply object methods for filehandles |
2215 | |
2216 | =item SYNOPSIS |
2217 | |
2218 | |
2219 | =item DESCRIPTION |
2220 | |
2221 | |
2222 | $fh->print, $fh->printf, $fh->getline, $fh->getlines |
2223 | |
2224 | =over |
2225 | |
2226 | =item The cacheout() Library |
2227 | |
2228 | |
2229 | |
2230 | |
2231 | =back |
2232 | |
2233 | =item SEE ALSO |
2234 | |
2235 | |
2236 | =item BUGS |
2237 | |
2238 | |
2239 | |
2240 | |
2241 | |
2242 | =head2 Getopt::Long, GetOptions - extended getopt processing |
2243 | |
2244 | =item SYNOPSIS |
2245 | |
2246 | |
2247 | =item DESCRIPTION |
2248 | |
2249 | |
2250 | =item EXAMPLES |
2251 | |
2252 | |
2253 | $autoabbrev, $getopt_compat, $option_start, $order, $ignorecase, $debug |
2254 | |
2255 | =item NOTE |
2256 | |
2257 | |
2258 | |
2259 | |
2260 | |
2261 | =head2 Getopt::Std, getopt - Process single-character switches with |
2262 | switch clustering |
2263 | |
2264 | =item SYNOPSIS |
2265 | |
2266 | |
2267 | =item DESCRIPTION |
2268 | |
2269 | |
2270 | |
2271 | |
2272 | |
2273 | =head2 I18N::Collate, Collate - compare 8-bit scalar data according to |
2274 | the current locale |
2275 | |
2276 | =item SYNOPSIS |
2277 | |
2278 | |
2279 | =item DESCRIPTION |
2280 | |
2281 | |
2282 | |
2283 | |
2284 | |
2285 | =head2 IPC::Open2, open2 - open a process for both reading and writing |
2286 | |
2287 | =item SYNOPSIS |
2288 | |
2289 | |
2290 | =item DESCRIPTION |
2291 | |
2292 | |
2293 | =item WARNING |
2294 | |
2295 | |
2296 | =item SEE ALSO |
2297 | |
2298 | |
2299 | |
2300 | |
2301 | |
2302 | =head2 IPC::Open3, open3 - open a process for reading, writing, and |
2303 | error handling |
2304 | |
2305 | =item SYNOPSIS |
2306 | |
2307 | |
2308 | =item DESCRIPTION |
2309 | |
2310 | |
2311 | |
2312 | |
2313 | |
2314 | =head2 Net::Ping, pingecho - check a host for upness |
2315 | |
2316 | =item SYNOPSIS |
2317 | |
2318 | |
2319 | =item DESCRIPTION |
2320 | |
2321 | |
2322 | =over |
2323 | |
2324 | =item Parameters |
2325 | |
2326 | |
2327 | hostname, timeout |
2328 | |
2329 | |
2330 | |
2331 | =back |
2332 | |
2333 | =item WARNING |
2334 | |
2335 | |
2336 | |
2337 | |
2338 | |
2339 | =head2 POSIX - Perl interface to IEEE Std 1003.1 |
2340 | |
2341 | =item SYNOPSIS |
2342 | |
2343 | |
2344 | =item DESCRIPTION |
2345 | |
2346 | |
2347 | =item NOTE |
2348 | |
2349 | |
2350 | =item CAVEATS |
2351 | |
2352 | |
2353 | =item FUNCTIONS |
2354 | |
2355 | |
2356 | _exit, abort, abs, access, acos, alarm, asctime, asin, assert, atan, |
2357 | atan2, atexit, atof, atoi, atol, bsearch, calloc, ceil, chdir, chmod, |
2358 | chown, clearerr, clock, close, closedir, cos, cosh, creat, ctermid, |
2359 | ctime, cuserid, difftime, div, dup, dup2, errno, execl, execle, execlp, |
2360 | execv, execve, execvp, exit, exp, fabs, fclose, fcntl, fdopen, feof, |
2361 | ferror, fflush, fgetc, fgetpos, fgets, fileno, floor, fmod, fopen, |
2362 | fork, fpathconf, fprintf, fputc, fputs, fread, free, freopen, frexp, |
2363 | fscanf, fseek, fsetpos, fstat, ftell, fwrite, getc, getchar, getcwd, |
2364 | getegid, getenv, geteuid, getgid, getgrgid, getgrnam, getgroups, |
2365 | getlogin, getpgrp, getpid, getppid, getpwnam, getpwuid, gets, getuid, |
2366 | gmtime, isalnum, isalpha, isatty, iscntrl, isdigit, isgraph, islower, |
2367 | isprint, ispunct, isspace, isupper, isxdigit, kill, labs, ldexp, ldiv, |
2368 | link, localeconv, localtime, log, log10, longjmp, lseek, malloc, mblen, |
2369 | mbstowcs, mbtowc, memchr, memcmp, memcpy, memmove, memset, mkdir, |
2370 | mkfifo, mktime, modf, nice, offsetof, open, opendir, pat |
2371 | |
2372 | =item CLASSES |
2373 | |
2374 | |
2375 | =over |
2376 | |
2377 | =item FileHandle |
2378 | |
2379 | |
2380 | new, clearerr, close, eof, error, fileno, flush, getc, getpos, gets, |
2381 | new_from_fd, new_tmpfile, seek, setbuf, setpos, setvbuf, tell, ungetc |
2382 | |
2383 | =item POSIX::SigAction |
2384 | |
2385 | |
2386 | new |
2387 | |
2388 | =item POSIX::SigSet |
2389 | |
2390 | |
2391 | new, addset, delset, emptyset, fillset, ismember |
2392 | |
2393 | =item POSIX::Termios |
2394 | |
2395 | |
2396 | new, getattr, getcc, getcflag, getiflag, getispeed, getlflag, getoflag, |
2397 | getospeed, setattr, setcc, setcflag, setiflag, setispeed, setlflag, |
2398 | setoflag, setospeed, Baud rate values, Terminal interface values, c_cc |
2399 | field values, c_cflag field values, c_iflag field values, c_lflag field |
2400 | values, c_oflag field values |
2401 | |
2402 | |
2403 | |
2404 | =back |
2405 | |
2406 | =item PATHNAME CONSTANTS |
2407 | |
2408 | |
2409 | Constants |
2410 | |
2411 | =item POSIX CONSTANTS |
2412 | |
2413 | |
2414 | Constants |
2415 | |
2416 | =item SYSTEM CONFIGURATION |
2417 | |
2418 | |
2419 | Constants |
2420 | |
2421 | =item ERRNO |
2422 | |
2423 | |
2424 | Constants |
2425 | |
2426 | =item FCNTL |
2427 | |
2428 | |
2429 | Constants |
2430 | |
2431 | =item FLOAT |
2432 | |
2433 | |
2434 | Constants |
2435 | |
2436 | =item LIMITS |
2437 | |
2438 | |
2439 | Constants |
2440 | |
2441 | =item LOCALE |
2442 | |
2443 | |
2444 | Constants |
2445 | |
2446 | =item MATH |
2447 | |
2448 | |
2449 | Constants |
2450 | |
2451 | =item SIGNAL |
2452 | |
2453 | |
2454 | Constants |
2455 | |
2456 | =item STAT |
2457 | |
2458 | |
2459 | Constants, Macros |
2460 | |
2461 | =item STDLIB |
2462 | |
2463 | |
2464 | Constants |
2465 | |
2466 | =item STDIO |
2467 | |
2468 | |
2469 | Constants |
2470 | |
2471 | =item TIME |
2472 | |
2473 | |
2474 | Constants |
2475 | |
2476 | =item UNISTD |
2477 | |
2478 | |
2479 | Constants |
2480 | |
2481 | =item WAIT |
2482 | |
2483 | |
2484 | Constants, Macros |
2485 | |
2486 | =item CREATION |
2487 | |
2488 | |
2489 | |
2490 | |
2491 | |
2492 | =head2 Safe - Safe extension module for Perl |
2493 | |
2494 | =item DESCRIPTION |
2495 | |
2496 | |
2497 | a new namespace, an operator mask |
2498 | |
2499 | =over |
2500 | |
2501 | =item Operator masks |
2502 | |
2503 | |
2504 | =item Methods in class Safe |
2505 | |
2506 | |
2507 | NAMESPACE, MASK, root (NAMESPACE), mask (MASK), trap (OP, ...), untrap |
2508 | (OP, ...), share (VARNAME, ...), varglob (VARNAME), reval (STRING), rdo |
2509 | (FILENAME) |
2510 | |
2511 | =item Subroutines in package Safe |
2512 | |
2513 | |
2514 | ops_to_mask (OP, ...), mask_to_ops (MASK), opcode (OP, ...), opname |
2515 | (OP, ...), fullmask, emptymask, MAXO, op_mask |
2516 | |
2517 | =item AUTHOR |
2518 | |
2519 | |
2520 | |
2521 | |
2522 | =back |
2523 | |
2524 | |
2525 | |
2526 | |
2527 | =head2 SelfLoader - load functions only on demand |
2528 | |
2529 | =item SYNOPSIS |
2530 | |
2531 | |
2532 | =item DESCRIPTION |
2533 | |
2534 | |
2535 | =over |
2536 | |
2537 | =item The __DATA__ token |
2538 | |
2539 | |
2540 | =item SelfLoader autoloading |
2541 | |
2542 | |
2543 | =item Autoloading and package lexicals |
2544 | |
2545 | |
2546 | =item SelfLoader and AutoLoader |
2547 | |
2548 | |
2549 | =item __DATA__, __END__, and the FOOBAR::DATA filehandle. |
2550 | |
2551 | |
2552 | =item Classes and inherited methods. |
2553 | |
2554 | |
2555 | |
2556 | |
2557 | =back |
2558 | |
2559 | =item Multiple packages and fully qualified subroutine names |
2560 | |
2561 | |
2562 | |
2563 | |
2564 | |
2565 | =head2 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load |
2566 | the C |
2567 | socket.h defines and structure manipulators |
2568 | |
2569 | =item SYNOPSIS |
2570 | |
2571 | |
2572 | =item DESCRIPTION |
2573 | |
2574 | |
2575 | inet_aton HOSTNAME, inet_ntoa IP_ADDRESS, INADDR_ANY, INADDR_LOOPBACK, |
2576 | INADDR_NONE, sockaddr_in PORT, ADDRESS, sockaddr_in SOCKADDR_IN, |
2577 | pack_sockaddr_in PORT, IP_ADDRESS, unpack_sockaddr_in SOCKADDR_IN, |
2578 | sockaddr_un PATHNAME, sockaddr_un SOCKADDR_UN, pack_sockaddr_un PATH, |
2579 | unpack_sockaddr_un SOCKADDR_UN |
2580 | |
2581 | |
2582 | |
2583 | |
2584 | =head2 Sys::Hostname - Try every conceivable way to get hostname |
2585 | |
2586 | =item SYNOPSIS |
2587 | |
2588 | |
2589 | =item DESCRIPTION |
2590 | |
2591 | |
2592 | =item AUTHOR |
2593 | |
2594 | |
2595 | |
2596 | |
2597 | |
2598 | =head2 Term::Cap - Perl termcap interface |
2599 | |
2600 | =item SYNOPSIS |
2601 | |
2602 | |
2603 | =item DESCRIPTION |
2604 | |
2605 | |
2606 | =item EXAMPLES |
2607 | |
2608 | |
2609 | |
2610 | |
2611 | |
2612 | =head2 Term::Complete - Perl word completion module |
2613 | |
2614 | =item SYNOPSIS |
2615 | |
2616 | |
2617 | =item DESCRIPTION |
2618 | |
2619 | |
2620 | <tab>Attempts word completion. Cannot be changed, ^D, ^U, <del>, <bs> |
2621 | |
2622 | =item DIAGNOSTICS |
2623 | |
2624 | |
2625 | =item BUGS |
2626 | |
2627 | |
2628 | =item AUTHOR |
2629 | |
2630 | |
2631 | |
2632 | |
2633 | |
2634 | =head2 Test::Harness - run perl standard test scripts with statistics |
2635 | |
2636 | =item SYNOPSIS |
2637 | |
2638 | |
2639 | =item DESCRIPTION |
2640 | |
2641 | |
2642 | =item EXPORT |
2643 | |
2644 | |
2645 | =item DIAGNOSTICS |
2646 | |
2647 | |
2648 | C<All tests successful.\nFiles=%d, Tests=%d, %s>, C<Failed 1 test, |
2649 | $pct% okay.>, C<Failed %d/%d tests, %.2f%% okay.> |
2650 | |
2651 | =item SEE ALSO |
2652 | |
2653 | |
2654 | =item BUGS |
2655 | |
2656 | |
2657 | |
2658 | |
2659 | |
2660 | =head2 Text::Abbrev, abbrev - create an abbreviation table from a list |
2661 | |
2662 | =item SYNOPSIS |
2663 | |
2664 | |
2665 | =item DESCRIPTION |
2666 | |
2667 | |
2668 | =item EXAMPLE |
2669 | |
2670 | |
2671 | |
2672 | |
2673 | |
2674 | =head2 Text::Soundex - Implementation of the Soundex Algorithm as |
2675 | Described by Knuth |
2676 | |
2677 | =item SYNOPSIS |
2678 | |
2679 | |
2680 | =item DESCRIPTION |
2681 | |
2682 | |
2683 | =item EXAMPLES |
2684 | |
2685 | |
2686 | =item LIMITATIONS |
2687 | |
2688 | |
2689 | =item AUTHOR |
2690 | |
2691 | |
2692 | |
2693 | |
2694 | |
2695 | =head2 Text::Tabs -- expand and unexpand tabs |
2696 | |
2697 | =item SYNOPSIS |
2698 | |
2699 | |
2700 | =item DESCRIPTION |
2701 | |
2702 | |
2703 | =item AUTHOR |
2704 | |
2705 | |
2706 | |
2707 | |
2708 | |
2709 | =head2 Text::Wrap -- wrap text into a paragraph |
2710 | |
2711 | =item SYNOPSIS |
2712 | |
2713 | |
2714 | =item DESCRIPTION |
2715 | |
2716 | |
2717 | =item AUTHOR |
2718 | |
2719 | |
2720 | |
2721 | |
2722 | |
2723 | =head2 TieHash, TieHash::Std - base class definitions for tied hashes |
2724 | |
2725 | =item SYNOPSIS |
2726 | |
2727 | |
2728 | =item DESCRIPTION |
2729 | |
2730 | |
2731 | TIEHASH classname, LIST, STORE this, key, value, FETCH this, key, |
2732 | FIRSTKEY this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, |
2733 | key, CLEAR this |
2734 | |
2735 | =item CAVEATS |
2736 | |
2737 | |
2738 | =item MORE INFORMATION |
2739 | |
2740 | |
2741 | |
2742 | |
2743 | |
2744 | =head2 Time::Local - efficiently compute tome from local and GMT time |
2745 | |
2746 | =item SYNOPSIS |
2747 | |
2748 | |
2749 | =item DESCRIPTION |
2750 | |
2751 | |
2752 | |
2753 | |
2754 | =head1 AUXILIARY DOCUMENTATION |
2755 | |
2756 | Here should be listed all the extra program's docs, but they don't all |
2757 | have man pages yet: |
2758 | |
2759 | =item a2p |
2760 | |
2761 | =item s2p |
2762 | |
2763 | =item find2perl |
2764 | |
2765 | =item h2ph |
2766 | |
2767 | =item c2ph |
2768 | |
2769 | =item h2xs |
2770 | |
2771 | =item xsubpp |
2772 | |
2773 | =item pod2man |
2774 | |
2775 | =item wrapsuid |
2776 | |
2777 | |
2778 | =head1 AUTHOR |
2779 | |
2780 | Larry Wall E<lt><F<lwall@netlabs.com>E<gt>, with the help of oodles of |
2781 | other folks. |
2782 | |
2783 | |