This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
5595bda82d068e18e8694f5c5d79d5139091f1a6
[perl5.git] / pod / perltoc.pod
1
2 # !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
3 # This file is autogenerated by buildtoc from all the other pods.
4 # Edit those files and run buildtoc --build-toc to effect changes.
5
6 =head1 NAME
7
8 perltoc - perl documentation table of contents
9
10 =head1 DESCRIPTION
11
12 This page provides a brief table of contents for the rest of the Perl
13 documentation set.  It is meant to be scanned quickly or grepped
14 through to locate the proper section you're looking for.
15
16 =head1 BASIC DOCUMENTATION
17
18 =head2 perl - Practical Extraction and Report Language
19
20 =over 4
21
22 =item SYNOPSIS
23
24 =over 4
25
26 =item Overview
27
28 =item Tutorials
29
30 =item Reference Manual
31
32 =item Internals and C Language Interface
33
34 =item Miscellaneous
35
36 =item Language-Specific
37
38 =item Platform-Specific
39
40 =back
41
42 =item DESCRIPTION
43
44 =item AVAILABILITY
45
46 =item ENVIRONMENT
47
48 =item AUTHOR
49
50 =item FILES
51
52 =item SEE ALSO
53
54 =item DIAGNOSTICS
55
56 =item BUGS
57
58 =item NOTES
59
60 =back
61
62 =head2 perlintro -- a brief introduction and overview of Perl
63
64 =over 4
65
66 =item DESCRIPTION
67
68 =over 4
69
70 =item What is Perl?
71
72 =item Running Perl programs
73
74 =item Basic syntax overview
75
76 =item Perl variable types
77
78 Scalars, Arrays, Hashes
79
80 =item Variable scoping
81
82 =item Conditional and looping constructs
83
84 if, while, for, foreach
85
86 =item Builtin operators and functions
87
88 Arithmetic, Numeric comparison, String comparison, Boolean logic,
89 Miscellaneous
90
91 =item Files and I/O
92
93 =item Regular expressions
94
95 Simple matching, Simple substitution, More complex regular expressions,
96 Parentheses for capturing, Other regexp features
97
98 =item Writing subroutines
99
100 =item OO Perl
101
102 =item Using Perl modules
103
104 =back
105
106 =item AUTHOR
107
108 =back
109
110 =head2 perlreftut - Mark's very short tutorial about references
111
112 =over 4
113
114 =item DESCRIPTION
115
116 =item Who Needs Complicated Data Structures?
117
118 =item The Solution
119
120 =item Syntax
121
122 =over 4
123
124 =item Making References
125
126 =item Using References
127
128 =item An Example
129
130 =item Arrow Rule
131
132 =back
133
134 =item Solution
135
136 =item The Rest
137
138 =item Summary
139
140 =item Credits
141
142 =over 4
143
144 =item Distribution Conditions
145
146 =back
147
148 =back
149
150 =head2 perldsc - Perl Data Structures Cookbook
151
152 =over 4
153
154 =item DESCRIPTION
155
156 arrays of arrays, hashes of arrays, arrays of hashes, hashes of hashes,
157 more elaborate constructs
158
159 =item REFERENCES
160
161 =item COMMON MISTAKES
162
163 =item CAVEAT ON PRECEDENCE
164
165 =item WHY YOU SHOULD ALWAYS C<use strict>
166
167 =item DEBUGGING
168
169 =item CODE EXAMPLES
170
171 =item ARRAYS OF ARRAYS
172
173 =over 4
174
175 =item Declaration of an ARRAY OF ARRAYS
176
177 =item Generation of an ARRAY OF ARRAYS
178
179 =item Access and Printing of an ARRAY OF ARRAYS
180
181 =back
182
183 =item HASHES OF ARRAYS
184
185 =over 4
186
187 =item Declaration of a HASH OF ARRAYS
188
189 =item Generation of a HASH OF ARRAYS
190
191 =item Access and Printing of a HASH OF ARRAYS
192
193 =back
194
195 =item ARRAYS OF HASHES
196
197 =over 4
198
199 =item Declaration of an ARRAY OF HASHES
200
201 =item Generation of an ARRAY OF HASHES
202
203 =item Access and Printing of an ARRAY OF HASHES
204
205 =back
206
207 =item HASHES OF HASHES
208
209 =over 4
210
211 =item Declaration of a HASH OF HASHES
212
213 =item Generation of a HASH OF HASHES
214
215 =item Access and Printing of a HASH OF HASHES
216
217 =back
218
219 =item MORE ELABORATE RECORDS
220
221 =over 4
222
223 =item Declaration of MORE ELABORATE RECORDS
224
225 =item Declaration of a HASH OF COMPLEX RECORDS
226
227 =item Generation of a HASH OF COMPLEX RECORDS
228
229 =back
230
231 =item Database Ties
232
233 =item SEE ALSO
234
235 =item AUTHOR
236
237 =back
238
239 =head2 perllol - Manipulating Arrays of Arrays in Perl
240
241 =over 4
242
243 =item DESCRIPTION
244
245 =over 4
246
247 =item Declaration and Access of Arrays of Arrays
248
249 =item Growing Your Own
250
251 =item Access and Printing
252
253 =item Slices
254
255 =back
256
257 =item SEE ALSO
258
259 =item AUTHOR
260
261 =back
262
263 =head2 perlrequick - Perl regular expressions quick start
264
265 =over 4
266
267 =item DESCRIPTION
268
269 =item The Guide
270
271 =over 4
272
273 =item Simple word matching
274
275 =item Using character classes
276
277 =item Matching this or that
278
279 =item Grouping things and hierarchical matching
280
281 =item Extracting matches
282
283 =item Matching repetitions
284
285 =item More matching
286
287 =item Search and replace
288
289 =item The split operator
290
291 =back
292
293 =item BUGS
294
295 =item SEE ALSO
296
297 =item AUTHOR AND COPYRIGHT
298
299 =over 4
300
301 =item Acknowledgments
302
303 =back
304
305 =back
306
307 =head2 perlretut - Perl regular expressions tutorial
308
309 =over 4
310
311 =item DESCRIPTION
312
313 =item Part 1: The basics
314
315 =over 4
316
317 =item Simple word matching
318
319 =item Using character classes
320
321 =item Matching this or that
322
323 =item Grouping things and hierarchical matching
324
325 =item Extracting matches
326
327 =item Matching repetitions
328
329 =item Building a regexp
330
331 =item Using regular expressions in Perl
332
333 =back
334
335 =item Part 2: Power tools
336
337 =over 4
338
339 =item More on characters, strings, and character classes
340
341 =item Compiling and saving regular expressions
342
343 =item Embedding comments and modifiers in a regular expression
344
345 =item Non-capturing groupings
346
347 =item Looking ahead and looking behind
348
349 =item Using independent subexpressions to prevent backtracking
350
351 =item Conditional expressions
352
353 =item A bit of magic: executing Perl code in a regular expression
354
355 =item Pragmas and debugging
356
357 =back
358
359 =item BUGS
360
361 =item SEE ALSO
362
363 =item AUTHOR AND COPYRIGHT
364
365 =over 4
366
367 =item Acknowledgments
368
369 =back
370
371 =back
372
373 =head2 perlboot - Beginner's Object-Oriented Tutorial
374
375 =over 4
376
377 =item DESCRIPTION
378
379 =over 4
380
381 =item If we could talk to the animals...
382
383 =item Introducing the method invocation arrow
384
385 =item Invoking a barnyard
386
387 =item The extra parameter of method invocation
388
389 =item Calling a second method to simplify things
390
391 =item Inheriting the windpipes
392
393 =item A few notes about @ISA
394
395 =item Overriding the methods
396
397 =item Starting the search from a different place
398
399 =item The SUPER way of doing things
400
401 =item Where we're at so far...
402
403 =item A horse is a horse, of course of course -- or is it?
404
405 =item Invoking an instance method
406
407 =item Accessing the instance data
408
409 =item How to build a horse
410
411 =item Inheriting the constructor
412
413 =item Making a method work with either classes or instances
414
415 =item Adding parameters to a method
416
417 =item More interesting instances
418
419 =item A horse of a different color
420
421 =item Summary
422
423 =back
424
425 =item SEE ALSO
426
427 =item COPYRIGHT
428
429 =back
430
431 =head2 perltoot - Tom's object-oriented tutorial for perl
432
433 =over 4
434
435 =item DESCRIPTION
436
437 =item Creating a Class
438
439 =over 4
440
441 =item Object Representation
442
443 =item Class Interface
444
445 =item Constructors and Instance Methods
446
447 =item Planning for the Future: Better Constructors
448
449 =item Destructors
450
451 =item Other Object Methods
452
453 =back
454
455 =item Class Data
456
457 =over 4
458
459 =item Accessing Class Data
460
461 =item Debugging Methods
462
463 =item Class Destructors
464
465 =item Documenting the Interface
466
467 =back
468
469 =item Aggregation
470
471 =item Inheritance
472
473 =over 4
474
475 =item Overridden Methods
476
477 =item Multiple Inheritance
478
479 =item UNIVERSAL: The Root of All Objects
480
481 =back
482
483 =item Alternate Object Representations
484
485 =over 4
486
487 =item Arrays as Objects
488
489 =item Closures as Objects
490
491 =back
492
493 =item AUTOLOAD: Proxy Methods
494
495 =over 4
496
497 =item Autoloaded Data Methods
498
499 =item Inherited Autoloaded Data Methods
500
501 =back
502
503 =item Metaclassical Tools
504
505 =over 4
506
507 =item Class::Struct
508
509 =item Data Members as Variables
510
511 =back
512
513 =item NOTES
514
515 =over 4
516
517 =item Object Terminology
518
519 =back
520
521 =item SEE ALSO
522
523 =item AUTHOR AND COPYRIGHT
524
525 =item COPYRIGHT
526
527 =over 4
528
529 =item Acknowledgments
530
531 =back
532
533 =back
534
535 =head2 perltooc - Tom's OO Tutorial for Class Data in Perl
536
537 =over 4
538
539 =item DESCRIPTION
540
541 =item Class Data in a Can
542
543 =item Class Data as Package Variables
544
545 =over 4
546
547 =item Putting All Your Eggs in One Basket
548
549 =item Inheritance Concerns
550
551 =item The Eponymous Meta-Object
552
553 =item Indirect References to Class Data
554
555 =item Monadic Classes
556
557 =item Translucent Attributes
558
559 =back
560
561 =item Class Data as Lexical Variables
562
563 =over 4
564
565 =item Privacy and Responsibility 
566
567 =item File-Scoped Lexicals
568
569 =item More Inheritance Concerns
570
571 =item Locking the Door and Throwing Away the Key
572
573 =item Translucency Revisited
574
575 =back
576
577 =item NOTES
578
579 =item SEE ALSO
580
581 =item AUTHOR AND COPYRIGHT
582
583 =item ACKNOWLEDGEMENTS
584
585 =item HISTORY
586
587 =back
588
589 =head2 perlbot - Bag'o Object Tricks (the BOT)
590
591 =over 4
592
593 =item DESCRIPTION
594
595 =item OO SCALING TIPS
596
597 =item INSTANCE VARIABLES
598
599 =item SCALAR INSTANCE VARIABLES
600
601 =item INSTANCE VARIABLE INHERITANCE
602
603 =item OBJECT RELATIONSHIPS
604
605 =item OVERRIDING SUPERCLASS METHODS
606
607 =item USING RELATIONSHIP WITH SDBM
608
609 =item THINKING OF CODE REUSE
610
611 =item CLASS CONTEXT AND THE OBJECT
612
613 =item INHERITING A CONSTRUCTOR
614
615 =item DELEGATION
616
617 =item SEE ALSO
618
619 =back
620
621 =head2 perlstyle - Perl style guide
622
623 =over 4
624
625 =item DESCRIPTION
626
627 =back
628
629 =head2 perlcheat - Perl 5 Cheat Sheet
630
631 =over 4
632
633 =item DESCRIPTION
634
635 =over 4
636
637 =item The sheet
638
639 =back
640
641 =item ACKNOWLEDGEMENTS
642
643 =item AUTHOR
644
645 =item SEE ALSO
646
647 =back
648
649 =head2 perltrap - Perl traps for the unwary
650
651 =over 4
652
653 =item DESCRIPTION
654
655 =over 4
656
657 =item Awk Traps
658
659 =item C/C++ Traps
660
661 =item Sed Traps
662
663 =item Shell Traps
664
665 =item Perl Traps
666
667 =item Perl4 to Perl5 Traps
668
669 Discontinuance, Deprecation, and BugFix traps, Parsing Traps, Numerical
670 Traps, General data type traps, Context Traps - scalar, list contexts,
671 Precedence Traps, General Regular Expression Traps using s///, etc,
672 Subroutine, Signal, Sorting Traps, OS Traps, DBM Traps, Unclassified Traps
673
674 =item Discontinuance, Deprecation, and BugFix traps
675
676 Discontinuance, Deprecation, BugFix, Discontinuance, Discontinuance,
677 Discontinuance, BugFix, Discontinuance, Discontinuance, BugFix,
678 Discontinuance, Deprecation, Discontinuance, Discontinuance
679
680 =item Parsing Traps
681
682 Parsing, Parsing, Parsing, Parsing, Parsing
683
684 =item Numerical Traps
685
686 Numerical, Numerical, Numerical, Bitwise string ops
687
688 =item General data type traps
689
690 (Arrays), (Arrays), (Hashes), (Globs), (Globs), (Scalar String),
691 (Constants), (Scalars), (Variable Suicide)
692
693 =item Context Traps - scalar, list contexts
694
695 (list context), (scalar context), (scalar context), (list, builtin)
696
697 =item Precedence Traps
698
699 Precedence, Precedence, Precedence, Precedence, Precedence, Precedence,
700 Precedence
701
702 =item General Regular Expression Traps using s///, etc.
703
704 Regular Expression, Regular Expression, Regular Expression, Regular
705 Expression, Regular Expression, Regular Expression, Regular Expression,
706 Regular Expression, Regular Expression
707
708 =item Subroutine, Signal, Sorting Traps
709
710 (Signals), (Sort Subroutine), warn() won't let you specify a filehandle
711
712 =item OS Traps
713
714 (SysV), (SysV)
715
716 =item Interpolation Traps
717
718 Interpolation, Interpolation, Interpolation, Interpolation, Interpolation,
719 Interpolation, Interpolation, Interpolation, Interpolation
720
721 =item DBM Traps
722
723 DBM, DBM
724
725 =item Unclassified Traps
726
727 C<require>/C<do> trap using returned value, C<split> on empty string with
728 LIMIT specified
729
730 =back
731
732 =back
733
734 =head2 perldebtut - Perl debugging tutorial
735
736 =over 4
737
738 =item DESCRIPTION
739
740 =item use strict
741
742 =item Looking at data and -w and v
743
744 =item help
745
746 =item Stepping through code
747
748 =item Placeholder for a, w, t, T
749
750 =item REGULAR EXPRESSIONS
751
752 =item OUTPUT TIPS
753
754 =item CGI
755
756 =item GUIs
757
758 =item SUMMARY
759
760 =item SEE ALSO
761
762 =item AUTHOR
763
764 =item CONTRIBUTORS
765
766 =back
767
768 =head2 perlfaq - frequently asked questions about Perl ($Date: 2003/01/31
769 17:37:17 $)
770
771 =over 4
772
773 =item DESCRIPTION
774
775 =over 4
776
777 =item Where to get the perlfaq
778
779 =item How to contribute to the perlfaq
780
781 =item What will happen if you mail your Perl programming problems to the
782 authors
783
784 =back
785
786 =item Credits
787
788 =item Author and Copyright Information
789
790 =over 4
791
792 =item Bundled Distributions
793
794 =item Disclaimer
795
796 =back
797
798 =item Table of Contents
799
800 perlfaq  - this document, perlfaq1 - General Questions About Perl, perlfaq2
801 - Obtaining and Learning about Perl, perlfaq3 - Programming Tools, perlfaq4
802 - Data Manipulation, perlfaq5 - Files and Formats, perlfaq6 - Regular
803 Expressions, perlfaq7 - General Perl Language Issues, perlfaq8 - System
804 Interaction, perlfaq9 - Networking
805
806 =item The Questions
807
808 =over 4
809
810 =item L<perlfaq1>: General Questions About Perl
811
812 =item L<perlfaq2>: Obtaining and Learning about Perl
813
814 =item L<perlfaq3>: Programming Tools
815
816 =item L<perlfaq4>: Data Manipulation
817
818 =item L<perlfaq5>: Files and Formats
819
820 =item L<perlfaq6>: Regular Expressions
821
822 =item L<perlfaq7>: General Perl Language Issues
823
824 =item L<perlfaq8>: System Interaction
825
826 =item L<perlfaq9>: Networking
827
828 =back
829
830 =back
831
832 =head2 perlfaq1 - General Questions About Perl ($Revision: 1.14 $, $Date:
833 2003/11/23 08:02:29 $)
834
835 =over 4
836
837 =item DESCRIPTION
838
839 =over 4
840
841 =item What is Perl?
842
843 =item Who supports Perl?  Who develops it?  Why is it free?
844
845 =item Which version of Perl should I use?
846
847 =item What are perl4 and perl5?
848
849 =item What is Ponie?
850
851 =item What is perl6?
852
853 =item How stable is Perl?
854
855 =item Is Perl difficult to learn?
856
857 =item How does Perl compare with other languages like Java, Python, REXX,
858 Scheme, or Tcl?
859
860 =item Can I do [task] in Perl?
861
862 =item When shouldn't I program in Perl?
863
864 =item What's the difference between "perl" and "Perl"?
865
866 =item Is it a Perl program or a Perl script?
867
868 =item What is a JAPH?
869
870 =item Where can I get a list of Larry Wall witticisms?
871
872 =item How can I convince my sysadmin/supervisor/employees to use version
873 5/5.6.1/Perl instead of some other language?
874
875 =back
876
877 =item AUTHOR AND COPYRIGHT
878
879 =back
880
881 =head2 perlfaq2 - Obtaining and Learning about Perl ($Revision: 1.25 $,
882 $Date: 2003/10/16 04:57:38 $)
883
884 =over 4
885
886 =item DESCRIPTION
887
888 =over 4
889
890 =item What machines support Perl?  Where do I get it?
891
892 =item How can I get a binary version of Perl?
893
894 =item I don't have a C compiler on my system.  How can I compile perl?
895
896 =item I copied the Perl binary from one machine to another, but scripts
897 don't work.
898
899 =item I grabbed the sources and tried to compile but gdbm/dynamic
900 loading/malloc/linking/... failed.  How do I make it work?
901
902 =item What modules and extensions are available for Perl?  What is CPAN? 
903 What does CPAN/src/... mean?
904
905 =item Is there an ISO or ANSI certified version of Perl?
906
907 =item Where can I get information on Perl?
908
909 =item What are the Perl newsgroups on Usenet?  Where do I post questions?
910
911 =item Where should I post source code?
912
913 =item Perl Books
914
915 References, Tutorials, Task-Oriented, Special Topics
916
917 =item Perl in Magazines
918
919 =item Perl on the Net: FTP and WWW Access
920
921 =item What mailing lists are there for Perl?
922
923 =item Archives of comp.lang.perl.misc
924
925 =item Where can I buy a commercial version of Perl?
926
927 =item Where do I send bug reports?
928
929 =item What is perl.com? Perl Mongers? pm.org? perl.org? cpan.org?
930
931 =back
932
933 =item AUTHOR AND COPYRIGHT
934
935 =back
936
937 =head2 perlfaq3 - Programming Tools ($Revision: 1.37 $, $Date: 2003/11/24
938 19:55:50 $)
939
940 =over 4
941
942 =item DESCRIPTION
943
944 =over 4
945
946 =item How do I do (anything)?
947
948 =item How can I use Perl interactively?
949
950 =item Is there a Perl shell?
951
952 =item How do I find which modules are installed on my system?
953
954 =item How do I debug my Perl programs?
955
956 =item How do I profile my Perl programs?
957
958 =item How do I cross-reference my Perl programs?
959
960 =item Is there a pretty-printer (formatter) for Perl?
961
962 =item Is there a ctags for Perl?
963
964 =item Is there an IDE or Windows Perl Editor?
965
966 Komodo, The Object System, Open Perl IDE, PerlBuilder, visiPerl+, OptiPerl,
967 GNU Emacs, MicroEMACS, XEmacs, Jed, Elvis, Vile, Vim, Codewright,
968 MultiEdit, SlickEdit, Bash, Ksh, Tcsh, Zsh, BBEdit and BBEdit Lite, Alpha
969
970 =item Where can I get Perl macros for vi?
971
972 =item Where can I get perl-mode for emacs?
973
974 =item How can I use curses with Perl?
975
976 =item How can I use X or Tk with Perl?
977
978 =item How can I generate simple menus without using CGI or Tk?
979
980 =item How can I make my Perl program run faster?
981
982 =item How can I make my Perl program take less memory?
983
984 Don't slurp!, Use map and grep selectively, Avoid unnecessary quotes and
985 stringification, Pass by reference, Tie large variables to disk
986
987 =item Is it safe to return a reference to local or lexical data?
988
989 =item How can I free an array or hash so my program shrinks?
990
991 =item How can I make my CGI script more efficient?
992
993 =item How can I hide the source for my Perl program?
994
995 =item How can I compile my Perl program into byte code or C?
996
997 =item How can I compile Perl into Java?
998
999 =item How can I get C<#!perl> to work on [MS-DOS,NT,...]?
1000
1001 =item Can I write useful Perl programs on the command line?
1002
1003 =item Why don't Perl one-liners work on my DOS/Mac/VMS system?
1004
1005 =item Where can I learn about CGI or Web programming in Perl?
1006
1007 =item Where can I learn about object-oriented Perl programming?
1008
1009 =item Where can I learn about linking C with Perl? [h2xs, xsubpp]
1010
1011 =item I've read perlembed, perlguts, etc., but I can't embed perl in
1012 my C program; what am I doing wrong?
1013
1014 =item When I tried to run my script, I got this message. What does it mean?
1015
1016 =item What's MakeMaker?
1017
1018 =back
1019
1020 =item AUTHOR AND COPYRIGHT
1021
1022 =back
1023
1024 =head2 perlfaq4 - Data Manipulation ($Revision: 1.54 $, $Date: 2003/11/30
1025 00:50:08 $)
1026
1027 =over 4
1028
1029 =item DESCRIPTION
1030
1031 =item Data: Numbers
1032
1033 =over 4
1034
1035 =item Why am I getting long decimals (eg, 19.9499999999999) instead of the
1036 numbers I should be getting (eg, 19.95)?
1037
1038 =item Why is int() broken?
1039
1040 =item Why isn't my octal data interpreted correctly?
1041
1042 =item Does Perl have a round() function?  What about ceil() and floor()? 
1043 Trig functions?
1044
1045 =item How do I convert between numeric representations/bases/radixes?
1046
1047 How do I convert hexadecimal into decimal, How do I convert from decimal to
1048 hexadecimal, How do I convert from octal to decimal, How do I convert from
1049 decimal to octal, How do I convert from binary to decimal, How do I convert
1050 from decimal to binary
1051
1052 =item Why doesn't & work the way I want it to?
1053
1054 =item How do I multiply matrices?
1055
1056 =item How do I perform an operation on a series of integers?
1057
1058 =item How can I output Roman numerals?
1059
1060 =item Why aren't my random numbers random?
1061
1062 =item How do I get a random number between X and Y?
1063
1064 =back
1065
1066 =item Data: Dates
1067
1068 =over 4
1069
1070 =item How do I find the day or week of the year?
1071
1072 =item How do I find the current century or millennium?
1073
1074 =item How can I compare two dates and find the difference?
1075
1076 =item How can I take a string and turn it into epoch seconds?
1077
1078 =item How can I find the Julian Day?
1079
1080 =item How do I find yesterday's date?
1081
1082 =item Does Perl have a Year 2000 problem?  Is Perl Y2K compliant?
1083
1084 =back
1085
1086 =item Data: Strings
1087
1088 =over 4
1089
1090 =item How do I validate input?
1091
1092 =item How do I unescape a string?
1093
1094 =item How do I remove consecutive pairs of characters?
1095
1096 =item How do I expand function calls in a string?
1097
1098 =item How do I find matching/nesting anything?
1099
1100 =item How do I reverse a string?
1101
1102 =item How do I expand tabs in a string?
1103
1104 =item How do I reformat a paragraph?
1105
1106 =item How can I access or change N characters of a string?
1107
1108 =item How do I change the Nth occurrence of something?
1109
1110 =item How can I count the number of occurrences of a substring within a
1111 string?
1112
1113 =item How do I capitalize all the words on one line?
1114
1115 =item How can I split a [character] delimited string except when inside
1116 [character]?
1117
1118 =item How do I strip blank space from the beginning/end of a string?
1119
1120 =item How do I pad a string with blanks or pad a number with zeroes?
1121
1122 =item How do I extract selected columns from a string?
1123
1124 =item How do I find the soundex value of a string?
1125
1126 =item How can I expand variables in text strings?
1127
1128 =item What's wrong with always quoting "$vars"?
1129
1130 =item Why don't my E<lt>E<lt>HERE documents work?
1131
1132 There must be no space after the E<lt>E<lt> part, There (probably) should
1133 be a semicolon at the end, You can't (easily) have any space in front of
1134 the tag
1135
1136 =back
1137
1138 =item Data: Arrays
1139
1140 =over 4
1141
1142 =item What is the difference between a list and an array?
1143
1144 =item What is the difference between $array[1] and @array[1]?
1145
1146 =item How can I remove duplicate elements from a list or array?
1147
1148 a), b), c), d), e)
1149
1150 =item How can I tell whether a certain element is contained in a list or
1151 array?
1152
1153 =item How do I compute the difference of two arrays?  How do I compute the
1154 intersection of two arrays?
1155
1156 =item How do I test whether two arrays or hashes are equal?
1157
1158 =item How do I find the first array element for which a condition is true?
1159
1160 =item How do I handle linked lists?
1161
1162 =item How do I handle circular lists?
1163
1164 =item How do I shuffle an array randomly?
1165
1166 =item How do I process/modify each element of an array?
1167
1168 =item How do I select a random element from an array?
1169
1170 =item How do I permute N elements of a list?
1171
1172 =item How do I sort an array by (anything)?
1173
1174 =item How do I manipulate arrays of bits?
1175
1176 =item Why does defined() return true on empty arrays and hashes?
1177
1178 =back
1179
1180 =item Data: Hashes (Associative Arrays)
1181
1182 =over 4
1183
1184 =item How do I process an entire hash?
1185
1186 =item What happens if I add or remove keys from a hash while iterating over
1187 it?
1188
1189 =item How do I look up a hash element by value?
1190
1191 =item How can I know how many entries are in a hash?
1192
1193 =item How do I sort a hash (optionally by value instead of key)?
1194
1195 =item How can I always keep my hash sorted?
1196
1197 =item What's the difference between "delete" and "undef" with hashes?
1198
1199 =item Why don't my tied hashes make the defined/exists distinction?
1200
1201 =item How do I reset an each() operation part-way through?
1202
1203 =item How can I get the unique keys from two hashes?
1204
1205 =item How can I store a multidimensional array in a DBM file?
1206
1207 =item How can I make my hash remember the order I put elements into it?
1208
1209 =item Why does passing a subroutine an undefined element in a hash create
1210 it?
1211
1212 =item How can I make the Perl equivalent of a C structure/C++ class/hash or
1213 array of hashes or arrays?
1214
1215 =item How can I use a reference as a hash key?
1216
1217 =back
1218
1219 =item Data: Misc
1220
1221 =over 4
1222
1223 =item How do I handle binary data correctly?
1224
1225 =item How do I determine whether a scalar is a number/whole/integer/float?
1226
1227 =item How do I keep persistent data across program calls?
1228
1229 =item How do I print out or copy a recursive data structure?
1230
1231 =item How do I define methods for every class/object?
1232
1233 =item How do I verify a credit card checksum?
1234
1235 =item How do I pack arrays of doubles or floats for XS code?
1236
1237 =back
1238
1239 =item AUTHOR AND COPYRIGHT
1240
1241 =back
1242
1243 =head2 perlfaq5 - Files and Formats ($Revision: 1.30 $, $Date: 2003/11/23
1244 08:07:46 $)
1245
1246 =over 4
1247
1248 =item DESCRIPTION
1249
1250 =over 4
1251
1252 =item How do I flush/unbuffer an output filehandle?  Why must I do this?
1253
1254 =item How do I change one line in a file/delete a line in a file/insert a
1255 line in the middle of a file/append to the beginning of a file?
1256
1257 =item How do I count the number of lines in a file?
1258
1259 =item How can I use Perl's C<-i> option from within a program?
1260
1261 =item How do I make a temporary file name?
1262
1263 =item How can I manipulate fixed-record-length files?
1264
1265 =item How can I make a filehandle local to a subroutine?  How do I pass
1266 filehandles between subroutines?  How do I make an array of filehandles?
1267
1268 =item How can I use a filehandle indirectly?
1269
1270 =item How can I set up a footer format to be used with write()?
1271
1272 =item How can I write() into a string?
1273
1274 =item How can I output my numbers with commas added?
1275
1276 =item How can I translate tildes (~) in a filename?
1277
1278 =item How come when I open a file read-write it wipes it out?
1279
1280 =item Why do I sometimes get an "Argument list too long" when I use
1281 E<lt>*E<gt>?
1282
1283 =item Is there a leak/bug in glob()?
1284
1285 =item How can I open a file with a leading ">" or trailing blanks?
1286
1287 =item How can I reliably rename a file?
1288
1289 =item How can I lock a file?
1290
1291 =item Why can't I just open(FH, "E<gt>file.lock")?
1292
1293 =item I still don't get locking.  I just want to increment the number in
1294 the file.  How can I do this?
1295
1296 =item All I want to do is append a small amount of text to the end of a
1297 file.  Do I still have to use locking?
1298
1299 =item How do I randomly update a binary file?
1300
1301 =item How do I get a file's timestamp in perl?
1302
1303 =item How do I set a file's timestamp in perl?
1304
1305 =item How do I print to more than one file at once?
1306
1307 =item How can I read in an entire file all at once?
1308
1309 =item How can I read in a file by paragraphs?
1310
1311 =item How can I read a single character from a file?  From the keyboard?
1312
1313 =item How can I tell whether there's a character waiting on a filehandle?
1314
1315 =item How do I do a C<tail -f> in perl?
1316
1317 =item How do I dup() a filehandle in Perl?
1318
1319 =item How do I close a file descriptor by number?
1320
1321 =item Why can't I use "C:\temp\foo" in DOS paths?  Why doesn't
1322 `C:\temp\foo.exe` work?
1323
1324 =item Why doesn't glob("*.*") get all the files?
1325
1326 =item Why does Perl let me delete read-only files?  Why does C<-i> clobber
1327 protected files?  Isn't this a bug in Perl?
1328
1329 =item How do I select a random line from a file?
1330
1331 =item Why do I get weird spaces when I print an array of lines?
1332
1333 =back
1334
1335 =item AUTHOR AND COPYRIGHT
1336
1337 =back
1338
1339 =head2 perlfaq6 - Regular Expressions ($Revision: 1.20 $, $Date: 2003/01/03
1340 20:05:28 $)
1341
1342 =over 4
1343
1344 =item DESCRIPTION
1345
1346 =over 4
1347
1348 =item How can I hope to use regular expressions without creating illegible
1349 and unmaintainable code?
1350
1351 Comments Outside the Regex, Comments Inside the Regex, Different Delimiters
1352
1353 =item I'm having trouble matching over more than one line.  What's wrong?
1354
1355 =item How can I pull out lines between two patterns that are themselves on
1356 different lines?
1357
1358 =item I put a regular expression into $/ but it didn't work. What's wrong?
1359
1360 =item How do I substitute case insensitively on the LHS while preserving
1361 case on the RHS?
1362
1363 =item How can I make C<\w> match national character sets?
1364
1365 =item How can I match a locale-smart version of C</[a-zA-Z]/>?
1366
1367 =item How can I quote a variable to use in a regex?
1368
1369 =item What is C</o> really for?
1370
1371 =item How do I use a regular expression to strip C style comments from a
1372 file?
1373
1374 =item Can I use Perl regular expressions to match balanced text?
1375
1376 =item What does it mean that regexes are greedy?  How can I get around it?
1377
1378 =item How do I process each word on each line?
1379
1380 =item How can I print out a word-frequency or line-frequency summary?
1381
1382 =item How can I do approximate matching?
1383
1384 =item How do I efficiently match many regular expressions at once?
1385
1386 =item Why don't word-boundary searches with C<\b> work for me?
1387
1388 =item Why does using $&, $`, or $' slow my program down?
1389
1390 =item What good is C<\G> in a regular expression?
1391
1392 =item Are Perl regexes DFAs or NFAs?  Are they POSIX compliant?
1393
1394 =item What's wrong with using grep in a void context?
1395
1396 =item How can I match strings with multibyte characters?
1397
1398 =item How do I match a pattern that is supplied by the user?
1399
1400 =back
1401
1402 =item AUTHOR AND COPYRIGHT
1403
1404 =back
1405
1406 =head2 perlfaq7 - General Perl Language Issues ($Revision: 1.15 $, $Date:
1407 2003/07/24 02:17:21 $)
1408
1409 =over 4
1410
1411 =item DESCRIPTION
1412
1413 =over 4
1414
1415 =item Can I get a BNF/yacc/RE for the Perl language?
1416
1417 =item What are all these $@%&* punctuation signs, and how do I know when to
1418 use them?
1419
1420 =item Do I always/never have to quote my strings or use semicolons and
1421 commas?
1422
1423 =item How do I skip some return values?
1424
1425 =item How do I temporarily block warnings?
1426
1427 =item What's an extension?
1428
1429 =item Why do Perl operators have different precedence than C operators?
1430
1431 =item How do I declare/create a structure?
1432
1433 =item How do I create a module?
1434
1435 =item How do I create a class?
1436
1437 =item How can I tell if a variable is tainted?
1438
1439 =item What's a closure?
1440
1441 =item What is variable suicide and how can I prevent it?
1442
1443 =item How can I pass/return a {Function, FileHandle, Array, Hash, Method,
1444 Regex}?
1445
1446 Passing Variables and Functions, Passing Filehandles, Passing Regexes,
1447 Passing Methods
1448
1449 =item How do I create a static variable?
1450
1451 =item What's the difference between dynamic and lexical (static) scoping? 
1452 Between local() and my()?
1453
1454 =item How can I access a dynamic variable while a similarly named lexical
1455 is in scope?
1456
1457 =item What's the difference between deep and shallow binding?
1458
1459 =item Why doesn't "my($foo) = E<lt>FILEE<gt>;" work right?
1460
1461 =item How do I redefine a builtin function, operator, or method?
1462
1463 =item What's the difference between calling a function as &foo and foo()?
1464
1465 =item How do I create a switch or case statement?
1466
1467 =item How can I catch accesses to undefined variables, functions, or
1468 methods?
1469
1470 =item Why can't a method included in this same file be found?
1471
1472 =item How can I find out my current package?
1473
1474 =item How can I comment out a large block of perl code?
1475
1476 =item How do I clear a package?
1477
1478 =item How can I use a variable as a variable name?
1479
1480 =item What does "bad interpreter" mean?
1481
1482 =back
1483
1484 =item AUTHOR AND COPYRIGHT
1485
1486 =back
1487
1488 =head2 perlfaq8 - System Interaction ($Revision: 1.17 $, $Date: 2003/01/26
1489 17:44:04 $)
1490
1491 =over 4
1492
1493 =item DESCRIPTION
1494
1495 =over 4
1496
1497 =item How do I find out which operating system I'm running under?
1498
1499 =item How come exec() doesn't return?
1500
1501 =item How do I do fancy stuff with the keyboard/screen/mouse?
1502
1503 Keyboard, Screen, Mouse
1504
1505 =item How do I print something out in color?
1506
1507 =item How do I read just one key without waiting for a return key?
1508
1509 =item How do I check whether input is ready on the keyboard?
1510
1511 =item How do I clear the screen?
1512
1513 =item How do I get the screen size?
1514
1515 =item How do I ask the user for a password?
1516
1517 =item How do I read and write the serial port?
1518
1519 lockfiles, open mode, end of line, flushing output, non-blocking input
1520
1521 =item How do I decode encrypted password files?
1522
1523 =item How do I start a process in the background?
1524
1525 STDIN, STDOUT, and STDERR are shared, Signals, Zombies
1526
1527 =item How do I trap control characters/signals?
1528
1529 =item How do I modify the shadow password file on a Unix system?
1530
1531 =item How do I set the time and date?
1532
1533 =item How can I sleep() or alarm() for under a second?
1534
1535 =item How can I measure time under a second?
1536
1537 =item How can I do an atexit() or setjmp()/longjmp()? (Exception handling)
1538
1539 =item Why doesn't my sockets program work under System V (Solaris)?  What
1540 does the error message "Protocol not supported" mean?
1541
1542 =item How can I call my system's unique C functions from Perl?
1543
1544 =item Where do I get the include files to do ioctl() or syscall()?
1545
1546 =item Why do setuid perl scripts complain about kernel problems?
1547
1548 =item How can I open a pipe both to and from a command?
1549
1550 =item Why can't I get the output of a command with system()?
1551
1552 =item How can I capture STDERR from an external command?
1553
1554 =item Why doesn't open() return an error when a pipe open fails?
1555
1556 =item What's wrong with using backticks in a void context?
1557
1558 =item How can I call backticks without shell processing?
1559
1560 =item Why can't my script read from STDIN after I gave it EOF (^D on Unix,
1561 ^Z on MS-DOS)?
1562
1563 =item How can I convert my shell script to perl?
1564
1565 =item Can I use perl to run a telnet or ftp session?
1566
1567 =item How can I write expect in Perl?
1568
1569 =item Is there a way to hide perl's command line from programs such as
1570 "ps"?
1571
1572 =item I {changed directory, modified my environment} in a perl script.  How
1573 come the change disappeared when I exited the script?  How do I get my
1574 changes to be visible?
1575
1576 Unix
1577
1578 =item How do I close a process's filehandle without waiting for it to
1579 complete?
1580
1581 =item How do I fork a daemon process?
1582
1583 =item How do I find out if I'm running interactively or not?
1584
1585 =item How do I timeout a slow event?
1586
1587 =item How do I set CPU limits?
1588
1589 =item How do I avoid zombies on a Unix system?
1590
1591 =item How do I use an SQL database?
1592
1593 =item How do I make a system() exit on control-C?
1594
1595 =item How do I open a file without blocking?
1596
1597 =item How do I install a module from CPAN?
1598
1599 =item What's the difference between require and use?
1600
1601 =item How do I keep my own module/library directory?
1602
1603 =item How do I add the directory my program lives in to the module/library
1604 search path?
1605
1606 =item How do I add a directory to my include path (@INC) at runtime?
1607
1608 =item What is socket.ph and where do I get it?
1609
1610 =back
1611
1612 =item AUTHOR AND COPYRIGHT
1613
1614 =back
1615
1616 =head2 perlfaq9 - Networking ($Revision: 1.15 $, $Date: 2003/01/31 17:36:57
1617 $)
1618
1619 =over 4
1620
1621 =item DESCRIPTION
1622
1623 =over 4
1624
1625 =item What is the correct form of response from a CGI script?
1626
1627 =item My CGI script runs from the command line but not the browser.  (500
1628 Server Error)
1629
1630 =item How can I get better error messages from a CGI program?
1631
1632 =item How do I remove HTML from a string?
1633
1634 =item How do I extract URLs?
1635
1636 =item How do I download a file from the user's machine?  How do I open a
1637 file on another machine?
1638
1639 =item How do I make a pop-up menu in HTML?
1640
1641 =item How do I fetch an HTML file?
1642
1643 =item How do I automate an HTML form submission?
1644
1645 =item How do I decode or create those %-encodings on the web?
1646
1647 =item How do I redirect to another page?
1648
1649 =item How do I put a password on my web pages?
1650
1651 =item How do I edit my .htpasswd and .htgroup files with Perl?
1652
1653 =item How do I make sure users can't enter values into a form that cause my
1654 CGI script to do bad things?
1655
1656 =item How do I parse a mail header?
1657
1658 =item How do I decode a CGI form?
1659
1660 =item How do I check a valid mail address?
1661
1662 =item How do I decode a MIME/BASE64 string?
1663
1664 =item How do I return the user's mail address?
1665
1666 =item How do I send mail?
1667
1668 =item How do I use MIME to make an attachment to a mail message?
1669
1670 =item How do I read mail?
1671
1672 =item How do I find out my hostname/domainname/IP address?
1673
1674 =item How do I fetch a news article or the active newsgroups?
1675
1676 =item How do I fetch/put an FTP file?
1677
1678 =item How can I do RPC in Perl?
1679
1680 =back
1681
1682 =item AUTHOR AND COPYRIGHT
1683
1684 =back
1685
1686 =head2 perlsyn - Perl syntax
1687
1688 =over 4
1689
1690 =item DESCRIPTION
1691
1692 =over 4
1693
1694 =item Declarations
1695
1696 =item Comments
1697
1698 =item Simple Statements
1699
1700 =item Truth and Falsehood
1701
1702 =item Statement Modifiers
1703
1704 =item Compound Statements
1705
1706 =item Loop Control
1707
1708 =item For Loops
1709
1710 =item Foreach Loops
1711
1712 =item Basic BLOCKs and Switch Statements
1713
1714 =item Goto
1715
1716 =item PODs: Embedded Documentation
1717
1718 =item Plain Old Comments (Not!)
1719
1720 =back
1721
1722 =back
1723
1724 =head2 perldata - Perl data types
1725
1726 =over 4
1727
1728 =item DESCRIPTION
1729
1730 =over 4
1731
1732 =item Variable names
1733
1734 =item Context
1735
1736 =item Scalar values
1737
1738 =item Scalar value constructors
1739
1740 =item List value constructors
1741
1742 =item Subscripts
1743
1744 =item Slices
1745
1746 =item Typeglobs and Filehandles
1747
1748 =back
1749
1750 =item SEE ALSO
1751
1752 =back
1753
1754 =head2 perlop - Perl operators and precedence
1755
1756 =over 4
1757
1758 =item DESCRIPTION
1759
1760 =over 4
1761
1762 =item Operator Precedence and Associativity
1763
1764 =item Terms and List Operators (Leftward)
1765
1766 =item The Arrow Operator
1767
1768 =item Auto-increment and Auto-decrement
1769
1770 =item Exponentiation
1771
1772 =item Symbolic Unary Operators
1773
1774 =item Binding Operators
1775
1776 =item Multiplicative Operators
1777
1778 =item Additive Operators
1779
1780 =item Shift Operators
1781
1782 =item Named Unary Operators
1783
1784 =item Relational Operators
1785
1786 =item Equality Operators
1787
1788 =item Bitwise And
1789
1790 =item Bitwise Or and Exclusive Or
1791
1792 =item C-style Logical And
1793
1794 =item C-style Logical Or
1795
1796 =item C-style Logical Defined-Or
1797
1798 =item Range Operators
1799
1800 =item Conditional Operator
1801
1802 =item Assignment Operators
1803
1804 =item Comma Operator
1805
1806 =item List Operators (Rightward)
1807
1808 =item Logical Not
1809
1810 =item Logical And
1811
1812 =item Logical or, Defined or, and Exclusive Or
1813
1814 =item C Operators Missing From Perl
1815
1816 unary &, unary *, (TYPE)
1817
1818 =item Quote and Quote-like Operators
1819
1820 =item Regexp Quote-Like Operators
1821
1822 ?PATTERN?, m/PATTERN/cgimosx, /PATTERN/cgimosx, q/STRING/, C<'STRING'>,
1823 qq/STRING/, "STRING", qr/STRING/imosx, qx/STRING/, `STRING`, qw/STRING/,
1824 s/PATTERN/REPLACEMENT/egimosx, tr/SEARCHLIST/REPLACEMENTLIST/cds,
1825 y/SEARCHLIST/REPLACEMENTLIST/cds, <<EOF
1826
1827 =item Gory details of parsing quoted constructs
1828
1829 Finding the end, Removal of backslashes before delimiters, Interpolation,
1830 C<<<'EOF'>, C<m''>, C<s'''>, C<tr///>, C<y///>, C<''>, C<q//>, C<"">,
1831 C<``>, C<qq//>, C<qx//>, C<< <file*glob> >>, C<?RE?>, C</RE/>, C<m/RE/>,
1832 C<s/RE/foo/>,, Interpolation of regular expressions, Optimization of
1833 regular expressions
1834
1835 =item I/O Operators
1836
1837 =item Constant Folding
1838
1839 =item Bitwise String Operators
1840
1841 =item Integer Arithmetic
1842
1843 =item Floating-point Arithmetic
1844
1845 =item Bigger Numbers
1846
1847 =back
1848
1849 =back
1850
1851 =head2 perlsub - Perl subroutines
1852
1853 =over 4
1854
1855 =item SYNOPSIS
1856
1857 =item DESCRIPTION
1858
1859 =over 4
1860
1861 =item Private Variables via my()
1862
1863 =item Persistent Private Variables
1864
1865 =item Temporary Values via local()
1866
1867 =item Lvalue subroutines
1868
1869 Lvalue subroutines are EXPERIMENTAL
1870
1871 =item Passing Symbol Table Entries (typeglobs)
1872
1873 =item When to Still Use local()
1874
1875 =item Pass by Reference
1876
1877 =item Prototypes
1878
1879 =item Constant Functions
1880
1881 =item Overriding Built-in Functions
1882
1883 =item Autoloading
1884
1885 =item Subroutine Attributes
1886
1887 =back
1888
1889 =item SEE ALSO
1890
1891 =back
1892
1893 =head2 perlfunc - Perl builtin functions
1894
1895 =over 4
1896
1897 =item DESCRIPTION
1898
1899 =over 4
1900
1901 =item Perl Functions by Category
1902
1903 Functions for SCALARs or strings, Regular expressions and pattern matching,
1904 Numeric functions, Functions for real @ARRAYs, Functions for list data,
1905 Functions for real %HASHes, Input and output functions, Functions for fixed
1906 length data or records, Functions for filehandles, files, or directories,
1907 Keywords related to the control flow of your perl program, Keywords related
1908 to scoping, Miscellaneous functions, Functions for processes and process
1909 groups, Keywords related to perl modules, Keywords related to classes and
1910 object-orientedness, Low-level socket functions, System V interprocess
1911 communication functions, Fetching user and group info, Fetching network
1912 info, Time-related functions, Functions new in perl5, Functions obsoleted
1913 in perl5
1914
1915 =item Portability
1916
1917 =item Alphabetical Listing of Perl Functions
1918
1919 -I<X> FILEHANDLE, -I<X> EXPR, -I<X>, abs VALUE, abs, accept
1920 NEWSOCKET,GENERICSOCKET, alarm SECONDS, alarm, atan2 Y,X, bind SOCKET,NAME,
1921 binmode FILEHANDLE, LAYER, binmode FILEHANDLE, bless REF,CLASSNAME, bless
1922 REF, caller EXPR, caller, chdir EXPR, chmod LIST, chomp VARIABLE, chomp(
1923 LIST ), chomp, chop VARIABLE, chop( LIST ), chop, chown LIST, chr NUMBER,
1924 chr, chroot FILENAME, chroot, close FILEHANDLE, close, closedir DIRHANDLE,
1925 connect SOCKET,NAME, continue BLOCK, cos EXPR, cos, crypt PLAINTEXT,SALT,
1926 dbmclose HASH, dbmopen HASH,DBNAME,MASK, defined EXPR, defined, delete
1927 EXPR, die LIST, do BLOCK, do SUBROUTINE(LIST), do EXPR, dump LABEL, dump,
1928 each HASH, eof FILEHANDLE, eof (), eof, eval EXPR, eval BLOCK, exec LIST,
1929 exec PROGRAM LIST, exists EXPR, exit EXPR, exp EXPR, exp, fcntl
1930 FILEHANDLE,FUNCTION,SCALAR, fileno FILEHANDLE, flock FILEHANDLE,OPERATION,
1931 fork, format, formline PICTURE,LIST, getc FILEHANDLE, getc, getlogin,
1932 getpeername SOCKET, getpgrp PID, getppid, getpriority WHICH,WHO, getpwnam
1933 NAME, getgrnam NAME, gethostbyname NAME, getnetbyname NAME, getprotobyname
1934 NAME, getpwuid UID, getgrgid GID, getservbyname NAME,PROTO, gethostbyaddr
1935 ADDR,ADDRTYPE, getnetbyaddr ADDR,ADDRTYPE, getprotobynumber NUMBER,
1936 getservbyport PORT,PROTO, getpwent, getgrent, gethostent, getnetent,
1937 getprotoent, getservent, setpwent, setgrent, sethostent STAYOPEN, setnetent
1938 STAYOPEN, setprotoent STAYOPEN, setservent STAYOPEN, endpwent, endgrent,
1939 endhostent, endnetent, endprotoent, endservent, getsockname SOCKET,
1940 getsockopt SOCKET,LEVEL,OPTNAME, glob EXPR, glob, gmtime EXPR, goto LABEL,
1941 goto EXPR, goto &NAME, grep BLOCK LIST, grep EXPR,LIST, hex EXPR, hex,
1942 import, index STR,SUBSTR,POSITION, index STR,SUBSTR, int EXPR, int, ioctl
1943 FILEHANDLE,FUNCTION,SCALAR, join EXPR,LIST, keys HASH, kill SIGNAL, LIST,
1944 last LABEL, last, lc EXPR, lc, lcfirst EXPR, lcfirst, length EXPR, length,
1945 link OLDFILE,NEWFILE, listen SOCKET,QUEUESIZE, local EXPR, localtime EXPR,
1946 lock THING, log EXPR, log, lstat EXPR, lstat, m//, map BLOCK LIST, map
1947 EXPR,LIST, mkdir FILENAME,MASK, mkdir FILENAME, msgctl ID,CMD,ARG, msgget
1948 KEY,FLAGS, msgrcv ID,VAR,SIZE,TYPE,FLAGS, msgsnd ID,MSG,FLAGS, my EXPR, my
1949 TYPE EXPR, my EXPR : ATTRS, my TYPE EXPR : ATTRS, next LABEL, next, no
1950 Module VERSION LIST, no Module VERSION, no Module LIST, no Module, oct
1951 EXPR, oct, open FILEHANDLE,EXPR, open FILEHANDLE,MODE,EXPR, open
1952 FILEHANDLE,MODE,EXPR,LIST, open FILEHANDLE,MODE,REFERENCE, open FILEHANDLE,
1953 opendir DIRHANDLE,EXPR, ord EXPR, ord, our EXPR, our EXPR TYPE, our EXPR :
1954 ATTRS, our TYPE EXPR : ATTRS, pack TEMPLATE,LIST, package NAMESPACE,
1955 package, pipe READHANDLE,WRITEHANDLE, pop ARRAY, pop, pos SCALAR, pos,
1956 print FILEHANDLE LIST, print LIST, print, printf FILEHANDLE FORMAT, LIST,
1957 printf FORMAT, LIST, prototype FUNCTION, push ARRAY,LIST, q/STRING/,
1958 qq/STRING/, qr/STRING/, qx/STRING/, qw/STRING/, quotemeta EXPR, quotemeta,
1959 rand EXPR, rand, read FILEHANDLE,SCALAR,LENGTH,OFFSET, read
1960 FILEHANDLE,SCALAR,LENGTH, readdir DIRHANDLE, readline EXPR, readlink EXPR,
1961 readlink, readpipe EXPR, recv SOCKET,SCALAR,LENGTH,FLAGS, redo LABEL, redo,
1962 ref EXPR, ref, rename OLDNAME,NEWNAME, require VERSION, require EXPR,
1963 require, reset EXPR, reset, return EXPR, return, reverse LIST, rewinddir
1964 DIRHANDLE, rindex STR,SUBSTR,POSITION, rindex STR,SUBSTR, rmdir FILENAME,
1965 rmdir, s///, scalar EXPR, seek FILEHANDLE,POSITION,WHENCE, seekdir
1966 DIRHANDLE,POS, select FILEHANDLE, select, select RBITS,WBITS,EBITS,TIMEOUT,
1967 semctl ID,SEMNUM,CMD,ARG, semget KEY,NSEMS,FLAGS, semop KEY,OPSTRING, send
1968 SOCKET,MSG,FLAGS,TO, send SOCKET,MSG,FLAGS, setpgrp PID,PGRP, setpriority
1969 WHICH,WHO,PRIORITY, setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL, shift ARRAY,
1970 shift, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS, shmread ID,VAR,POS,SIZE,
1971 shmwrite ID,STRING,POS,SIZE, shutdown SOCKET,HOW, sin EXPR, sin, sleep
1972 EXPR, sleep, socket SOCKET,DOMAIN,TYPE,PROTOCOL, socketpair
1973 SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, sort SUBNAME LIST, sort BLOCK LIST,
1974 sort LIST, splice ARRAY,OFFSET,LENGTH,LIST, splice ARRAY,OFFSET,LENGTH,
1975 splice ARRAY,OFFSET, splice ARRAY, split /PATTERN/,EXPR,LIMIT, split
1976 /PATTERN/,EXPR, split /PATTERN/, split, sprintf FORMAT, LIST, format
1977 parameter index, flags, vector flag, (minimum) width, precision, or maximum
1978 width, size, order of arguments, sqrt EXPR, sqrt, srand EXPR, srand, stat
1979 FILEHANDLE, stat EXPR, stat, study SCALAR, study, sub NAME BLOCK, sub NAME
1980 (PROTO) BLOCK, sub NAME : ATTRS BLOCK, sub NAME (PROTO) : ATTRS BLOCK,
1981 substr EXPR,OFFSET,LENGTH,REPLACEMENT, substr EXPR,OFFSET,LENGTH, substr
1982 EXPR,OFFSET, symlink OLDFILE,NEWFILE, syscall NUMBER, LIST, sysopen
1983 FILEHANDLE,FILENAME,MODE, sysopen FILEHANDLE,FILENAME,MODE,PERMS, sysread
1984 FILEHANDLE,SCALAR,LENGTH,OFFSET, sysread FILEHANDLE,SCALAR,LENGTH, sysseek
1985 FILEHANDLE,POSITION,WHENCE, system LIST, system PROGRAM LIST, syswrite
1986 FILEHANDLE,SCALAR,LENGTH,OFFSET, syswrite FILEHANDLE,SCALAR,LENGTH,
1987 syswrite FILEHANDLE,SCALAR, tell FILEHANDLE, tell, telldir DIRHANDLE, tie
1988 VARIABLE,CLASSNAME,LIST, tied VARIABLE, time, times, tr///, truncate
1989 FILEHANDLE,LENGTH, truncate EXPR,LENGTH, uc EXPR, uc, ucfirst EXPR,
1990 ucfirst, umask EXPR, umask, undef EXPR, undef, unlink LIST, unlink, unpack
1991 TEMPLATE,EXPR, unpack TEMPLATE, untie VARIABLE, unshift ARRAY,LIST, use
1992 Module VERSION LIST, use Module VERSION, use Module LIST, use Module, use
1993 VERSION, utime LIST, values HASH, vec EXPR,OFFSET,BITS, wait, waitpid
1994 PID,FLAGS, wantarray, warn LIST, write FILEHANDLE, write EXPR, write, y///
1995
1996 =back
1997
1998 =back
1999
2000 =head2 perlopentut - tutorial on opening things in Perl
2001
2002 =over 4
2003
2004 =item DESCRIPTION
2005
2006 =item Open E<agrave> la shell
2007
2008 =over 4
2009
2010 =item Simple Opens
2011
2012 =item Indirect Filehandles
2013
2014 =item Pipe Opens
2015
2016 =item The Minus File
2017
2018 =item Mixing Reads and Writes
2019
2020 =item Filters 
2021
2022 =back
2023
2024 =item Open E<agrave> la C
2025
2026 =over 4
2027
2028 =item Permissions E<agrave> la mode
2029
2030 =back
2031
2032 =item Obscure Open Tricks
2033
2034 =over 4
2035
2036 =item Re-Opening Files (dups)
2037
2038 =item Dispelling the Dweomer
2039
2040 =item Paths as Opens
2041
2042 =item Single Argument Open
2043
2044 =item Playing with STDIN and STDOUT
2045
2046 =back
2047
2048 =item Other I/O Issues
2049
2050 =over 4
2051
2052 =item Opening Non-File Files
2053
2054 =item Opening Named Pipes
2055
2056 =item Opening Sockets
2057
2058 =item Binary Files
2059
2060 =item File Locking
2061
2062 =item IO Layers
2063
2064 =back
2065
2066 =item SEE ALSO 
2067
2068 =item AUTHOR and COPYRIGHT
2069
2070 =item HISTORY
2071
2072 =back
2073
2074 =head2 perlpacktut - tutorial on C<pack> and C<unpack>
2075
2076 =over 4
2077
2078 =item DESCRIPTION
2079
2080 =item The Basic Principle
2081
2082 =item Packing Text
2083
2084 =item Packing Numbers
2085
2086 =over 4
2087
2088 =item Integers
2089
2090 =item Unpacking a Stack Frame
2091
2092 =item How to Eat an Egg on a Net
2093
2094 =item Floating point Numbers
2095
2096 =back
2097
2098 =item Exotic Templates
2099
2100 =over 4
2101
2102 =item Bit Strings
2103
2104 =item Uuencoding
2105
2106 =item Doing Sums
2107
2108 =item  Unicode
2109
2110 =item Another Portable Binary Encoding
2111
2112 =back
2113
2114 =item Template Grouping
2115
2116 =item Lengths and Widths
2117
2118 =over 4
2119
2120 =item String Lengths
2121
2122 =item Dynamic Templates
2123
2124 =item Counting Repetitions
2125
2126 =back
2127
2128 =item Packing and Unpacking C Structures
2129
2130 =over 4
2131
2132 =item The Alignment Pit
2133
2134 =item Alignment, Take 2
2135
2136 =item Alignment, Take 3
2137
2138 =item Pointers for How to Use Them
2139
2140 =back
2141
2142 =item Pack Recipes
2143
2144 =item Funnies Section
2145
2146 =item Authors
2147
2148 =back
2149
2150 =head2 perlpod - the Plain Old Documentation format
2151
2152 =over 4
2153
2154 =item DESCRIPTION
2155
2156 =over 4
2157
2158 =item Ordinary Paragraph
2159
2160 =item Verbatim Paragraph
2161
2162 =item Command Paragraph
2163
2164 C<=head1 I<Heading Text>>, C<=head2 I<Heading Text>>, C<=head3 I<Heading
2165 Text>>, C<=head4 I<Heading Text>>, C<=over I<indentlevel>>, C<=item
2166 I<stuff...>>, C<=back>, C<=cut>, C<=pod>, C<=begin I<formatname>>, C<=end
2167 I<formatname>>, C<=for I<formatname> I<text...>>, C<=encoding
2168 I<encodingname>>
2169
2170 =item Formatting Codes
2171
2172 C<IE<lt>textE<gt>> -- italic text, C<BE<lt>textE<gt>> -- bold text,
2173 C<CE<lt>codeE<gt>> -- code text, C<LE<lt>nameE<gt>> -- a hyperlink,
2174 C<EE<lt>escapeE<gt>> -- a character escape, C<FE<lt>filenameE<gt>> -- used
2175 for filenames, C<SE<lt>textE<gt>> -- text contains non-breaking spaces,
2176 C<XE<lt>topic nameE<gt>> -- an index entry, C<ZE<lt>E<gt>> -- a null
2177 (zero-effect) formatting code
2178
2179 =item The Intent
2180
2181 =item Embedding Pods in Perl Modules
2182
2183 =item Hints for Writing Pod
2184
2185 =back
2186
2187 =item SEE ALSO
2188
2189 =item AUTHOR
2190
2191 =back
2192
2193 =head2 perlpodspec - Plain Old Documentation: format specification and
2194 notes
2195
2196 =over 4
2197
2198 =item DESCRIPTION
2199
2200 =item Pod Definitions
2201
2202 =item Pod Commands
2203
2204 "=head1", "=head2", "=head3", "=head4", "=pod", "=cut", "=over", "=item",
2205 "=back", "=begin formatname", "=end formatname", "=for formatname text...",
2206 "=encoding encodingname"
2207
2208 =item Pod Formatting Codes
2209
2210 C<IE<lt>textE<gt>> -- italic text, C<BE<lt>textE<gt>> -- bold text,
2211 C<CE<lt>codeE<gt>> -- code text, C<FE<lt>filenameE<gt>> -- style for
2212 filenames, C<XE<lt>topic nameE<gt>> -- an index entry, C<ZE<lt>E<gt>> -- a
2213 null (zero-effect) formatting code, C<LE<lt>nameE<gt>> -- a hyperlink,
2214 C<EE<lt>escapeE<gt>> -- a character escape, C<SE<lt>textE<gt>> -- text
2215 contains non-breaking spaces
2216
2217 =item Notes on Implementing Pod Processors
2218
2219 =item About LE<lt>...E<gt> Codes
2220
2221 First:, Second:, Third:, Fourth:, Fifth:, Sixth:
2222
2223 =item About =over...=back Regions
2224
2225 =item About Data Paragraphs and "=begin/=end" Regions
2226
2227 =item SEE ALSO
2228
2229 =item AUTHOR
2230
2231 =back
2232
2233 =head2 perlrun - how to execute the Perl interpreter
2234
2235 =over 4
2236
2237 =item SYNOPSIS
2238
2239 =item DESCRIPTION
2240
2241 =over 4
2242
2243 =item #! and quoting on non-Unix systems
2244
2245 OS/2, MS-DOS, Win95/NT, Macintosh, VMS
2246
2247 =item Location of Perl
2248
2249 =item Command Switches
2250
2251 B<-0>[I<octal/hexadecimal>], B<-A [I<assertions>]>, B<-a>, B<-C
2252 [I<number/list>]>, B<-c>, B<-d>, B<-d:>I<foo[=bar,baz]>, B<-D>I<letters>,
2253 B<-D>I<number>, B<-e> I<commandline>, B<-F>I<pattern>, B<-h>,
2254 B<-i>[I<extension>], B<-I>I<directory>, B<-l>[I<octnum>],
2255 B<-m>[B<->]I<module>, B<-M>[B<->]I<module>, B<-M>[B<->]I<'module ...'>,
2256 B<-[mM]>[B<->]I<module=arg[,arg]...>, B<-n>, B<-p>, B<-P>, B<-s>, B<-S>,
2257 B<-t>, B<-T>, B<-u>, B<-U>, B<-v>, B<-V>, B<-V:>I<name>, B<-w>, B<-W>,
2258 B<-X>, B<-x> I<directory>
2259
2260 =back
2261
2262 =item ENVIRONMENT
2263
2264 HOME, LOGDIR, PATH, PERL5LIB, PERL5OPT, PERLIO, :bytes, :crlf, :mmap,
2265 :perlio, :pop, :raw, :stdio, :unix, :utf8, :win32, PERLIO_DEBUG, PERLLIB,
2266 PERL5DB, PERL5SHELL (specific to the Win32 port), PERL_DEBUG_MSTATS,
2267 PERL_DESTRUCT_LEVEL, PERL_DL_NONLAZY, PERL_ENCODING, PERL_HASH_SEED,
2268 PERL_HASH_SEED_DEBUG, PERL_ROOT (specific to the VMS port), PERL_SIGNALS,
2269 PERL_UNICODE, SYS$LOGIN (specific to the VMS port)
2270
2271 =back
2272
2273 =head2 perldiag - various Perl diagnostics
2274
2275 =over 4
2276
2277 =item DESCRIPTION
2278
2279 =back
2280
2281 =head2 perllexwarn - Perl Lexical Warnings
2282
2283 =over 4
2284
2285 =item DESCRIPTION
2286
2287 =over 4
2288
2289 =item Default Warnings and Optional Warnings
2290
2291 =item What's wrong with B<-w> and C<$^W>
2292
2293 =item Controlling Warnings from the Command Line
2294
2295 B<-w>, B<-W>, B<-X>
2296
2297 =item Backward Compatibility
2298
2299 =item Category Hierarchy
2300
2301 =item Fatal Warnings
2302
2303 =item Reporting Warnings from a Module
2304
2305 =back
2306
2307 =item TODO
2308
2309 =item SEE ALSO
2310
2311 =item AUTHOR
2312
2313 =back
2314
2315 =head2 perldebug - Perl debugging
2316
2317 =over 4
2318
2319 =item DESCRIPTION
2320
2321 =item The Perl Debugger
2322
2323 =over 4
2324
2325 =item Debugger Commands
2326
2327 h, h [command], h h, p expr, x [maxdepth] expr, V [pkg [vars]], X [vars], y
2328 [level [vars]], T, s [expr], n [expr], r, <CR>, c [line|sub], l, l
2329 min+incr, l min-max, l line, l subname, -, v [line], f filename, /pattern/,
2330 ?pattern?, L [abw], S [[!]regex], t, t expr, b, b [line] [condition], b
2331 subname [condition], b postpone subname [condition], b load filename, b
2332 compile subname, B line, B *, a [line] command, A line, A *, w expr, W
2333 expr, W *, o, o booloption .., o anyoption? .., o option=value .., < ?, < [
2334 command ], < *, << command, > ?, > command, > *, >> command, { ?, { [
2335 command ], { *, {{ command, ! number, ! -number, ! pattern, !! cmd, source
2336 file, H -number, q or ^D, R, |dbcmd, ||dbcmd, command, m expr, M, man
2337 [manpage]
2338
2339 =item Configurable Options
2340
2341 C<recallCommand>, C<ShellBang>, C<pager>, C<tkRunning>, C<signalLevel>,
2342 C<warnLevel>, C<dieLevel>, C<AutoTrace>, C<LineInfo>, C<inhibit_exit>,
2343 C<PrintRet>, C<ornaments>, C<frame>, C<maxTraceLen>, C<windowSize>,
2344 C<arrayDepth>, C<hashDepth>, C<dumpDepth>, C<compactDump>, C<veryCompact>,
2345 C<globPrint>, C<DumpDBFiles>, C<DumpPackages>, C<DumpReused>, C<quote>,
2346 C<HighBit>, C<undefPrint>, C<UsageOnly>, C<TTY>, C<noTTY>, C<ReadLine>,
2347 C<NonStop>
2348
2349 =item Debugger input/output
2350
2351 Prompt, Multiline commands, Stack backtrace, Line Listing Format, Frame
2352 listing
2353
2354 =item Debugging compile-time statements
2355
2356 =item Debugger Customization
2357
2358 =item Readline Support
2359
2360 =item Editor Support for Debugging
2361
2362 =item The Perl Profiler
2363
2364 =back
2365
2366 =item Debugging regular expressions
2367
2368 =item Debugging memory usage
2369
2370 =item SEE ALSO
2371
2372 =item BUGS
2373
2374 =back
2375
2376 =head2 perlvar - Perl predefined variables
2377
2378 =over 4
2379
2380 =item DESCRIPTION
2381
2382 =over 4
2383
2384 =item Predefined Names
2385
2386 $ARG, $_, $a, $b, $<I<digits>>, $MATCH, $&, $PREMATCH, $`, $POSTMATCH, $',
2387 $LAST_PAREN_MATCH, $+, $^N, @LAST_MATCH_END, @+,
2388 HANDLE->input_line_number(EXPR), $INPUT_LINE_NUMBER, $NR, $,
2389 IO::Handle->input_record_separator(EXPR), $INPUT_RECORD_SEPARATOR, $RS, $/,
2390 HANDLE->autoflush(EXPR), $OUTPUT_AUTOFLUSH, $|,
2391 IO::Handle->output_field_separator EXPR, $OUTPUT_FIELD_SEPARATOR, $OFS, $,,
2392 IO::Handle->output_record_separator EXPR, $OUTPUT_RECORD_SEPARATOR, $ORS,
2393 $\, $LIST_SEPARATOR, $", $SUBSCRIPT_SEPARATOR, $SUBSEP, $;, $#,
2394 HANDLE->format_page_number(EXPR), $FORMAT_PAGE_NUMBER, $%,
2395 HANDLE->format_lines_per_page(EXPR), $FORMAT_LINES_PER_PAGE, $=,
2396 HANDLE->format_lines_left(EXPR), $FORMAT_LINES_LEFT, $-, @LAST_MATCH_START,
2397 @-, C<$`> is the same as C<substr($var, 0, $-[0])>, C<$&> is the same as
2398 C<substr($var, $-[0], $+[0] - $-[0])>, C<$'> is the same as C<substr($var,
2399 $+[0])>, C<$1> is the same as C<substr($var, $-[1], $+[1] - $-[1])>, C<$2>
2400 is the same as C<substr($var, $-[2], $+[2] - $-[2])>, C<$3> is the same as
2401 C<substr $var, $-[3], $+[3] - $-[3])>, HANDLE->format_name(EXPR),
2402 $FORMAT_NAME, $~, HANDLE->format_top_name(EXPR), $FORMAT_TOP_NAME, $^,
2403 IO::Handle->format_line_break_characters EXPR,
2404 $FORMAT_LINE_BREAK_CHARACTERS, $:, IO::Handle->format_formfeed EXPR,
2405 $FORMAT_FORMFEED, $^L, $ACCUMULATOR, $^A, $CHILD_ERROR, $?, ${^ENCODING},
2406 $OS_ERROR, $ERRNO, $!, %!, $EXTENDED_OS_ERROR, $^E, $EVAL_ERROR, $@,
2407 $PROCESS_ID, $PID, $$, $REAL_USER_ID, $UID, $<, $EFFECTIVE_USER_ID, $EUID,
2408 $>, $REAL_GROUP_ID, $GID, $(, $EFFECTIVE_GROUP_ID, $EGID, $),
2409 $PROGRAM_NAME, $0, $[, $], $COMPILING, $^C, $DEBUGGING, $^D,
2410 $SYSTEM_FD_MAX, $^F, $^H, %^H, $INPLACE_EDIT, $^I, $^M, $OSNAME, $^O,
2411 ${^OPEN}, $PERLDB, $^P, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80,
2412 0x100, 0x200, 0x400, $LAST_REGEXP_CODE_RESULT, $^R,
2413 $EXCEPTIONS_BEING_CAUGHT, $^S, $BASETIME, $^T, ${^TAINT}, ${^UNICODE},
2414 $PERL_VERSION, $^V, $WARNING, $^W, ${^WARNING_BITS}, $EXECUTABLE_NAME, $^X,
2415 ARGV, $ARGV, @ARGV, ARGVOUT, @F, @INC, @_, %INC, %ENV, $ENV{expr}, %SIG,
2416 $SIG{expr}
2417
2418 =item Error Indicators
2419
2420 =item Technical Note on the Syntax of Variable Names
2421
2422 =back
2423
2424 =item BUGS
2425
2426 =back
2427
2428 =head2 perlre - Perl regular expressions
2429
2430 =over 4
2431
2432 =item DESCRIPTION
2433
2434 i, m, s, x
2435
2436 =over 4
2437
2438 =item Regular Expressions
2439
2440 [1], [2], [3], cntrl, graph, print, punct, xdigit
2441
2442 =item Extended Patterns
2443
2444 C<(?#text)>, C<(?imsx-imsx)>, C<(?:pattern)>, C<(?imsx-imsx:pattern)>,
2445 C<(?=pattern)>, C<(?!pattern)>, C<(?<=pattern)>, C<(?<!pattern)>, C<(?{
2446 code })>, C<(??{ code })>, C<< (?>pattern) >>,
2447 C<(?(condition)yes-pattern|no-pattern)>, C<(?(condition)yes-pattern)>
2448
2449 =item Backtracking
2450
2451 =item Version 8 Regular Expressions
2452
2453 =item Warning on \1 vs $1
2454
2455 =item Repeated patterns matching zero-length substring
2456
2457 =item Combining pieces together
2458
2459 C<ST>, C<S|T>, C<S{REPEAT_COUNT}>, C<S{min,max}>, C<S{min,max}?>, C<S?>,
2460 C<S*>, C<S+>, C<S??>, C<S*?>, C<S+?>, C<< (?>S) >>, C<(?=S)>, C<(?<=S)>,
2461 C<(?!S)>, C<(?<!S)>, C<(??{ EXPR })>,
2462 C<(?(condition)yes-pattern|no-pattern)>
2463
2464 =item Creating custom RE engines
2465
2466 =back
2467
2468 =item BUGS
2469
2470 =item SEE ALSO
2471
2472 =back
2473
2474 =head2 perlreref - Perl Regular Expressions Reference
2475
2476 =over 4
2477
2478 =item DESCRIPTION
2479
2480 =over 4
2481
2482 =item OPERATORS
2483
2484 =item SYNTAX
2485
2486 =item ESCAPE SEQUENCES
2487
2488 =item CHARACTER CLASSES
2489
2490 =item ANCHORS
2491
2492 =item QUANTIFIERS
2493
2494 =item EXTENDED CONSTRUCTS
2495
2496 =item VARIABLES
2497
2498 =item FUNCTIONS
2499
2500 =item TERMINOLOGY
2501
2502 =back
2503
2504 =item AUTHOR
2505
2506 =item SEE ALSO
2507
2508 =item THANKS
2509
2510 =back
2511
2512 =head2 perlref - Perl references and nested data structures
2513
2514 =over 4
2515
2516 =item NOTE
2517
2518 =item DESCRIPTION
2519
2520 =over 4
2521
2522 =item Making References
2523
2524 =item Using References
2525
2526 =item Symbolic references
2527
2528 =item Not-so-symbolic references
2529
2530 =item Pseudo-hashes: Using an array as a hash
2531
2532 =item Function Templates
2533
2534 =back
2535
2536 =item WARNING
2537
2538 =item SEE ALSO
2539
2540 =back
2541
2542 =head2 perlform - Perl formats
2543
2544 =over 4
2545
2546 =item DESCRIPTION
2547
2548 =over 4
2549
2550 =item Format Variables
2551
2552 =back
2553
2554 =item NOTES
2555
2556 =over 4
2557
2558 =item Footers
2559
2560 =item Accessing Formatting Internals
2561
2562 =back
2563
2564 =item WARNINGS
2565
2566 =back
2567
2568 =head2 perlobj - Perl objects
2569
2570 =over 4
2571
2572 =item DESCRIPTION
2573
2574 =over 4
2575
2576 =item An Object is Simply a Reference
2577
2578 =item A Class is Simply a Package
2579
2580 =item A Method is Simply a Subroutine
2581
2582 =item Method Invocation
2583
2584 =item Indirect Object Syntax
2585
2586 =item Default UNIVERSAL methods
2587
2588 isa(CLASS), can(METHOD), VERSION( [NEED] )
2589
2590 =item Destructors
2591
2592 =item Summary
2593
2594 =item Two-Phased Garbage Collection
2595
2596 =back
2597
2598 =item SEE ALSO
2599
2600 =back
2601
2602 =head2 perltie - how to hide an object class in a simple variable
2603
2604 =over 4
2605
2606 =item SYNOPSIS
2607
2608 =item DESCRIPTION
2609
2610 =over 4
2611
2612 =item Tying Scalars
2613
2614 TIESCALAR classname, LIST, FETCH this, STORE this, value, UNTIE this,
2615 DESTROY this
2616
2617 =item Tying Arrays
2618
2619 TIEARRAY classname, LIST, FETCH this, index, STORE this, index, value,
2620 FETCHSIZE this, STORESIZE this, count, EXTEND this, count, EXISTS this,
2621 key, DELETE this, key, CLEAR this, PUSH this, LIST, POP this, SHIFT this,
2622 UNSHIFT this, LIST, SPLICE this, offset, length, LIST, UNTIE this, DESTROY
2623 this
2624
2625 =item Tying Hashes
2626
2627 USER, HOME, CLOBBER, LIST, TIEHASH classname, LIST, FETCH this, key, STORE
2628 this, key, value, DELETE this, key, CLEAR this, EXISTS this, key, FIRSTKEY
2629 this, NEXTKEY this, lastkey, SCALAR this, UNTIE this, DESTROY this
2630
2631 =item Tying FileHandles
2632
2633 TIEHANDLE classname, LIST, WRITE this, LIST, PRINT this, LIST, PRINTF this,
2634 LIST, READ this, LIST, READLINE this, GETC this, CLOSE this, UNTIE this,
2635 DESTROY this
2636
2637 =item UNTIE this
2638
2639 =item The C<untie> Gotcha
2640
2641 =back
2642
2643 =item SEE ALSO
2644
2645 =item BUGS
2646
2647 =item AUTHOR
2648
2649 =back
2650
2651 =head2 perldbmfilter - Perl DBM Filters
2652
2653 =over 4
2654
2655 =item SYNOPSIS
2656
2657 =item DESCRIPTION
2658
2659 B<filter_store_key>, B<filter_store_value>, B<filter_fetch_key>,
2660 B<filter_fetch_value>
2661
2662 =over 4
2663
2664 =item The Filter
2665
2666 =item An Example -- the NULL termination problem.
2667
2668 =item Another Example -- Key is a C int.
2669
2670 =back
2671
2672 =item SEE ALSO
2673
2674 =item AUTHOR
2675
2676 =back
2677
2678 =head2 perlipc - Perl interprocess communication (signals, fifos, pipes,
2679 safe subprocesses, sockets, and semaphores)
2680
2681 =over 4
2682
2683 =item DESCRIPTION
2684
2685 =item Signals
2686
2687 =over 4
2688
2689 =item Handling the SIGHUP Signal in Daemons
2690
2691 =back
2692
2693 =item Named Pipes
2694
2695 =over 4
2696
2697 =item Deferred Signals (Safe Signals)
2698
2699 Long running opcodes, Interrupting IO, Restartable system calls, Signals as
2700 "faults", Signals triggered by operating system state
2701
2702 =back
2703
2704 =item Using open() for IPC
2705
2706 =over 4
2707
2708 =item Filehandles
2709
2710 =item Background Processes
2711
2712 =item Complete Dissociation of Child from Parent
2713
2714 =item Safe Pipe Opens
2715
2716 =item Bidirectional Communication with Another Process
2717
2718 =item Bidirectional Communication with Yourself
2719
2720 =back
2721
2722 =item Sockets: Client/Server Communication
2723
2724 =over 4
2725
2726 =item Internet Line Terminators
2727
2728 =item Internet TCP Clients and Servers
2729
2730 =item Unix-Domain TCP Clients and Servers
2731
2732 =back
2733
2734 =item TCP Clients with IO::Socket
2735
2736 =over 4
2737
2738 =item A Simple Client
2739
2740 C<Proto>, C<PeerAddr>, C<PeerPort>
2741
2742 =item A Webget Client
2743
2744 =item Interactive Client with IO::Socket
2745
2746 =back
2747
2748 =item TCP Servers with IO::Socket
2749
2750 Proto, LocalPort, Listen, Reuse
2751
2752 =item UDP: Message Passing
2753
2754 =item SysV IPC
2755
2756 =item NOTES
2757
2758 =item BUGS
2759
2760 =item AUTHOR
2761
2762 =item SEE ALSO
2763
2764 =back
2765
2766 =head2 perlfork - Perl's fork() emulation
2767
2768 =over 4
2769
2770 =item SYNOPSIS
2771
2772 =item DESCRIPTION
2773
2774 =over 4
2775
2776 =item Behavior of other Perl features in forked pseudo-processes
2777
2778 $$ or $PROCESS_ID, %ENV, chdir() and all other builtins that accept
2779 filenames, wait() and waitpid(), kill(), exec(), exit(), Open handles to
2780 files, directories and network sockets
2781
2782 =item Resource limits
2783
2784 =item Killing the parent process
2785
2786 =item Lifetime of the parent process and pseudo-processes
2787
2788 =item CAVEATS AND LIMITATIONS
2789
2790 BEGIN blocks, Open filehandles, Forking pipe open() not yet implemented,
2791 Global state maintained by XSUBs, Interpreter embedded in larger
2792 application, Thread-safety of extensions
2793
2794 =back
2795
2796 =item BUGS
2797
2798 =item AUTHOR
2799
2800 =item SEE ALSO
2801
2802 =back
2803
2804 =head2 perlnumber - semantics of numbers and numeric operations in Perl
2805
2806 =over 4
2807
2808 =item SYNOPSIS
2809
2810 =item DESCRIPTION
2811
2812 =item Storing numbers
2813
2814 =item Numeric operators and numeric conversions
2815
2816 =item Flavors of Perl numeric operations
2817
2818 Arithmetic operators, ++, Arithmetic operators during C<use integer>, Other
2819 mathematical operators, Bitwise operators, Bitwise operators during C<use
2820 integer>, Operators which expect an integer, Operators which expect a
2821 string
2822
2823 =item AUTHOR
2824
2825 =item SEE ALSO
2826
2827 =back
2828
2829 =head2 perlthrtut - tutorial on threads in Perl
2830
2831 =over 4
2832
2833 =item DESCRIPTION
2834
2835 =item Status
2836
2837 =item What Is A Thread Anyway?
2838
2839 =item Threaded Program Models
2840
2841 =over 4
2842
2843 =item Boss/Worker
2844
2845 =item Work Crew
2846
2847 =item Pipeline
2848
2849 =back
2850
2851 =item What kind of threads are Perl threads?
2852
2853 =item Thread-Safe Modules
2854
2855 =item Thread Basics
2856
2857 =over 4
2858
2859 =item Basic Thread Support
2860
2861 =item A Note about the Examples
2862
2863 =item Creating Threads
2864
2865 =item Waiting For A Thread To Exit
2866
2867 =item Ignoring A Thread
2868
2869 =back
2870
2871 =item Threads And Data
2872
2873 =over 4
2874
2875 =item Shared And Unshared Data
2876
2877 =item Thread Pitfalls: Races
2878
2879 =back
2880
2881 =item Synchronization and control
2882
2883 =over 4
2884
2885 =item Controlling access: lock()
2886
2887 =item A Thread Pitfall: Deadlocks
2888
2889 =item Queues: Passing Data Around
2890
2891 =item Semaphores: Synchronizing Data Access
2892
2893 =item Basic semaphores
2894
2895 =item Advanced Semaphores
2896
2897 =item cond_wait() and cond_signal()
2898
2899 =item Giving up control
2900
2901 =back
2902
2903 =item General Thread Utility Routines
2904
2905 =over 4
2906
2907 =item What Thread Am I In?
2908
2909 =item Thread IDs
2910
2911 =item Are These Threads The Same?
2912
2913 =item What Threads Are Running?
2914
2915 =back
2916
2917 =item A Complete Example
2918
2919 =item Different implementations of threads
2920
2921 =item Performance considerations
2922
2923 =item Process-scope Changes
2924
2925 =item Thread-Safety of System Libraries
2926
2927 =item Conclusion
2928
2929 =item Bibliography
2930
2931 =over 4
2932
2933 =item Introductory Texts
2934
2935 =item OS-Related References
2936
2937 =item Other References
2938
2939 =back
2940
2941 =item Acknowledgements
2942
2943 =item AUTHOR
2944
2945 =item Copyrights
2946
2947 =back
2948
2949 =head2 perlothrtut - old tutorial on threads in Perl
2950
2951 =over 4
2952
2953 =item DESCRIPTION
2954
2955 =item What Is A Thread Anyway?
2956
2957 =item Threaded Program Models
2958
2959 =over 4
2960
2961 =item Boss/Worker
2962
2963 =item Work Crew
2964
2965 =item Pipeline
2966
2967 =back
2968
2969 =item Native threads
2970
2971 =item What kind of threads are perl threads?
2972
2973 =item Threadsafe Modules
2974
2975 =item Thread Basics
2976
2977 =over 4
2978
2979 =item Basic Thread Support
2980
2981 =item Creating Threads
2982
2983 =item Giving up control
2984
2985 =item Waiting For A Thread To Exit
2986
2987 =item Errors In Threads
2988
2989 =item Ignoring A Thread
2990
2991 =back
2992
2993 =item Threads And Data
2994
2995 =over 4
2996
2997 =item Shared And Unshared Data
2998
2999 =item Thread Pitfall: Races
3000
3001 =item Controlling access: lock()
3002
3003 =item Thread Pitfall: Deadlocks
3004
3005 =item Queues: Passing Data Around
3006
3007 =back
3008
3009 =item Threads And Code
3010
3011 =over 4
3012
3013 =item Semaphores: Synchronizing Data Access
3014
3015 Basic semaphores, Advanced Semaphores
3016
3017 =item Attributes: Restricting Access To Subroutines
3018
3019 =item Subroutine Locks
3020
3021 =item Methods
3022
3023 =item Locking A Subroutine
3024
3025 =back
3026
3027 =item General Thread Utility Routines
3028
3029 =over 4
3030
3031 =item What Thread Am I In?
3032
3033 =item Thread IDs
3034
3035 =item Are These Threads The Same?
3036
3037 =item What Threads Are Running?
3038
3039 =back
3040
3041 =item A Complete Example
3042
3043 =item Conclusion
3044
3045 =item Bibliography
3046
3047 =over 4
3048
3049 =item Introductory Texts
3050
3051 =item OS-Related References
3052
3053 =item Other References
3054
3055 =back
3056
3057 =item Acknowledgements
3058
3059 =item AUTHOR
3060
3061 =item Copyrights
3062
3063 =back
3064
3065 =head2 perlport - Writing portable Perl
3066
3067 =over 4
3068
3069 =item DESCRIPTION
3070
3071 Not all Perl programs have to be portable, Nearly all of Perl already I<is>
3072 portable
3073
3074 =item ISSUES
3075
3076 =over 4
3077
3078 =item Newlines
3079
3080 =item Numbers endianness and Width
3081
3082 =item Files and Filesystems
3083
3084 =item System Interaction
3085
3086 =item Command names versus file pathnames
3087
3088 =item Networking
3089
3090 =item Interprocess Communication (IPC)
3091
3092 =item External Subroutines (XS)
3093
3094 =item Standard Modules
3095
3096 =item Time and Date
3097
3098 =item Character sets and character encoding
3099
3100 =item Internationalisation
3101
3102 =item System Resources
3103
3104 =item Security
3105
3106 =item Style
3107
3108 =back
3109
3110 =item CPAN Testers
3111
3112 Mailing list: cpan-testers@perl.org, Testing results:
3113 http://testers.cpan.org/
3114
3115 =item PLATFORMS
3116
3117 =over 4
3118
3119 =item Unix
3120
3121 =item DOS and Derivatives
3122
3123 =item S<Mac OS>
3124
3125 =item VMS
3126
3127 =item VOS
3128
3129 =item EBCDIC Platforms
3130
3131 =item Acorn RISC OS
3132
3133 =item Other perls
3134
3135 =back
3136
3137 =item FUNCTION IMPLEMENTATIONS
3138
3139 =over 4
3140
3141 =item Alphabetical Listing of Perl Functions
3142
3143 -I<X> FILEHANDLE, -I<X> EXPR, -I<X>, alarm SECONDS, alarm, binmode
3144 FILEHANDLE, chmod LIST, chown LIST, chroot FILENAME, chroot, crypt
3145 PLAINTEXT,SALT, dbmclose HASH, dbmopen HASH,DBNAME,MODE, dump LABEL, exec
3146 LIST, exit EXPR, exit, fcntl FILEHANDLE,FUNCTION,SCALAR, flock
3147 FILEHANDLE,OPERATION, fork, getlogin, getpgrp PID, getppid, getpriority
3148 WHICH,WHO, getpwnam NAME, getgrnam NAME, getnetbyname NAME, getpwuid UID,
3149 getgrgid GID, getnetbyaddr ADDR,ADDRTYPE, getprotobynumber NUMBER,
3150 getservbyport PORT,PROTO, getpwent, getgrent, gethostbyname, gethostent,
3151 getnetent, getprotoent, getservent, sethostent STAYOPEN, setnetent
3152 STAYOPEN, setprotoent STAYOPEN, setservent STAYOPEN, endpwent, endgrent,
3153 endhostent, endnetent, endprotoent, endservent, getsockopt
3154 SOCKET,LEVEL,OPTNAME, glob EXPR, glob, ioctl FILEHANDLE,FUNCTION,SCALAR,
3155 kill SIGNAL, LIST, link OLDFILE,NEWFILE, lstat FILEHANDLE, lstat EXPR,
3156 lstat, msgctl ID,CMD,ARG, msgget KEY,FLAGS, msgsnd ID,MSG,FLAGS, msgrcv
3157 ID,VAR,SIZE,TYPE,FLAGS, open FILEHANDLE,EXPR, open FILEHANDLE, pipe
3158 READHANDLE,WRITEHANDLE, readlink EXPR, readlink, select
3159 RBITS,WBITS,EBITS,TIMEOUT, semctl ID,SEMNUM,CMD,ARG, semget
3160 KEY,NSEMS,FLAGS, semop KEY,OPSTRING, setgrent, setpgrp PID,PGRP,
3161 setpriority WHICH,WHO,PRIORITY, setpwent, setsockopt
3162 SOCKET,LEVEL,OPTNAME,OPTVAL, shmctl ID,CMD,ARG, shmget KEY,SIZE,FLAGS,
3163 shmread ID,VAR,POS,SIZE, shmwrite ID,STRING,POS,SIZE, sockatmark SOCKET,
3164 socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL, stat FILEHANDLE, stat
3165 EXPR, stat, symlink OLDFILE,NEWFILE, syscall LIST, sysopen
3166 FILEHANDLE,FILENAME,MODE,PERMS, system LIST, times, truncate
3167 FILEHANDLE,LENGTH, truncate EXPR,LENGTH, umask EXPR, umask, utime LIST,
3168 wait, waitpid PID,FLAGS
3169
3170 =back
3171
3172 =item CHANGES
3173
3174 v1.49, 12 August 2002, v1.48, 02 February 2001, v1.47, 22 March 2000,
3175 v1.46, 12 February 2000, v1.45, 20 December 1999, v1.44, 19 July 1999,
3176 v1.43, 24 May 1999, v1.42, 22 May 1999, v1.41, 19 May 1999, v1.40, 11 April
3177 1999, v1.39, 11 February 1999, v1.38, 31 December 1998, v1.37, 19 December
3178 1998, v1.36, 9 September 1998, v1.35, 13 August 1998, v1.33, 06 August
3179 1998, v1.32, 05 August 1998, v1.30, 03 August 1998, v1.23, 10 July 1998
3180
3181 =item Supported Platforms
3182
3183 =item SEE ALSO
3184
3185 =item AUTHORS / CONTRIBUTORS
3186
3187 =back
3188
3189 =head2 perllocale - Perl locale handling (internationalization and
3190 localization)
3191
3192 =over 4
3193
3194 =item DESCRIPTION
3195
3196 =item PREPARING TO USE LOCALES
3197
3198 =item USING LOCALES
3199
3200 =over 4
3201
3202 =item The use locale pragma
3203
3204 =item The setlocale function
3205
3206 =item Finding locales
3207
3208 =item LOCALE PROBLEMS
3209
3210 =item Temporarily fixing locale problems
3211
3212 =item Permanently fixing locale problems
3213
3214 =item Permanently fixing your system's locale configuration
3215
3216 =item Fixing system locale configuration
3217
3218 =item The localeconv function
3219
3220 =item I18N::Langinfo
3221
3222 =back
3223
3224 =item LOCALE CATEGORIES
3225
3226 =over 4
3227
3228 =item Category LC_COLLATE: Collation
3229
3230 =item Category LC_CTYPE: Character Types
3231
3232 =item Category LC_NUMERIC: Numeric Formatting
3233
3234 =item Category LC_MONETARY: Formatting of monetary amounts
3235
3236 =item LC_TIME
3237
3238 =item Other categories
3239
3240 =back
3241
3242 =item SECURITY
3243
3244 =item ENVIRONMENT
3245
3246 PERL_BADLANG, LC_ALL, LANGUAGE, LC_CTYPE, LC_COLLATE, LC_MONETARY,
3247 LC_NUMERIC, LC_TIME, LANG
3248
3249 =item NOTES
3250
3251 =over 4
3252
3253 =item Backward compatibility
3254
3255 =item I18N:Collate obsolete
3256
3257 =item Sort speed and memory use impacts
3258
3259 =item write() and LC_NUMERIC
3260
3261 =item Freely available locale definitions
3262
3263 =item I18n and l10n
3264
3265 =item An imperfect standard
3266
3267 =back
3268
3269 =item Unicode and UTF-8
3270
3271 =item BUGS
3272
3273 =over 4
3274
3275 =item Broken systems
3276
3277 =back
3278
3279 =item SEE ALSO
3280
3281 =item HISTORY
3282
3283 =back
3284
3285 =head2 perluniintro - Perl Unicode introduction
3286
3287 =over 4
3288
3289 =item DESCRIPTION
3290
3291 =over 4
3292
3293 =item Unicode
3294
3295 =item Perl's Unicode Support
3296
3297 =item Perl's Unicode Model
3298
3299 =item Unicode and EBCDIC
3300
3301 =item Creating Unicode
3302
3303 =item Handling Unicode
3304
3305 =item Legacy Encodings
3306
3307 =item Unicode I/O
3308
3309 =item Displaying Unicode As Text
3310
3311 =item Special Cases
3312
3313 =item Advanced Topics
3314
3315 =item Miscellaneous
3316
3317 =item Questions With Answers
3318
3319 =item Hexadecimal Notation
3320
3321 =item Further Resources
3322
3323 =back
3324
3325 =item UNICODE IN OLDER PERLS
3326
3327 =item SEE ALSO
3328
3329 =item ACKNOWLEDGMENTS
3330
3331 =item AUTHOR, COPYRIGHT, AND LICENSE
3332
3333 =back
3334
3335 =head2 perlunicode - Unicode support in Perl
3336
3337 =over 4
3338
3339 =item DESCRIPTION
3340
3341 =over 4
3342
3343 =item Important Caveats
3344
3345 Input and Output Layers, Regular Expressions, C<use utf8> still needed to
3346 enable UTF-8/UTF-EBCDIC in scripts, C<use encoding> needed to upgrade
3347 non-Latin-1 byte strings
3348
3349 =item Byte and Character Semantics
3350
3351 =item Effects of Character Semantics
3352
3353 =item Scripts
3354
3355 =item Blocks
3356
3357 =item User-Defined Character Properties
3358
3359 =item Character Encodings for Input and Output
3360
3361 =item Unicode Regular Expression Support Level
3362
3363 =item Unicode Encodings
3364
3365 =item Security Implications of Unicode
3366
3367 =item Unicode in Perl on EBCDIC
3368
3369 =item Locales
3370
3371 =item When Unicode Does Not Happen
3372
3373 =item Forcing Unicode in Perl (Or Unforcing Unicode in Perl)
3374
3375 =item Using Unicode in XS
3376
3377 =back
3378
3379 =item BUGS
3380
3381 =over 4
3382
3383 =item Interaction with Locales
3384
3385 =item Interaction with Extensions
3386
3387 =item Speed
3388
3389 =item Porting code from perl-5.6.X
3390
3391 =back
3392
3393 =item SEE ALSO
3394
3395 =back
3396
3397 =head2 perlebcdic - Considerations for running Perl on EBCDIC platforms
3398
3399 =over 4
3400
3401 =item DESCRIPTION
3402
3403 =item COMMON CHARACTER CODE SETS
3404
3405 =over 4
3406
3407 =item ASCII
3408
3409 =item ISO 8859
3410
3411 =item Latin 1 (ISO 8859-1)
3412
3413 =item EBCDIC
3414
3415 =item 13 variant characters
3416
3417 =item 0037
3418
3419 =item 1047
3420
3421 =item POSIX-BC
3422
3423 =item Unicode code points versus EBCDIC code points
3424
3425 =item Remaining Perl Unicode problems in EBCDIC
3426
3427 =item Unicode and UTF
3428
3429 =item Using Encode
3430
3431 =back
3432
3433 =item SINGLE OCTET TABLES
3434
3435 recipe 0, recipe 1, recipe 2, recipe 3, recipe 4, recipe 5, recipe 6
3436
3437 =item IDENTIFYING CHARACTER CODE SETS
3438
3439 =item CONVERSIONS
3440
3441 =over 4
3442
3443 =item tr///
3444
3445 =item iconv
3446
3447 =item C RTL
3448
3449 =back
3450
3451 =item OPERATOR DIFFERENCES
3452
3453 =item FUNCTION DIFFERENCES
3454
3455 chr(), ord(), pack(), print(), printf(), sort(), sprintf(), unpack()
3456
3457 =item REGULAR EXPRESSION DIFFERENCES
3458
3459 =item SOCKETS
3460
3461 =item SORTING
3462
3463 =over 4
3464
3465 =item Ignore ASCII vs. EBCDIC sort differences.
3466
3467 =item MONO CASE then sort data.
3468
3469 =item Convert, sort data, then re convert.
3470
3471 =item Perform sorting on one type of machine only.
3472
3473 =back
3474
3475 =item TRANSFORMATION FORMATS
3476
3477 =over 4
3478
3479 =item URL decoding and encoding
3480
3481 =item uu encoding and decoding
3482
3483 =item Quoted-Printable encoding and decoding
3484
3485 =item Caesarian ciphers
3486
3487 =back
3488
3489 =item Hashing order and checksums
3490
3491 =item I18N AND L10N
3492
3493 =item MULTI OCTET CHARACTER SETS
3494
3495 =item OS ISSUES
3496
3497 =over 4
3498
3499 =item OS/400
3500
3501 PASE, IFS access
3502
3503 =item OS/390, z/OS
3504
3505 chcp, dataset access, OS/390, z/OS iconv, locales
3506
3507 =item VM/ESA?
3508
3509 =item POSIX-BC?
3510
3511 =back
3512
3513 =item BUGS
3514
3515 =item SEE ALSO
3516
3517 =item REFERENCES
3518
3519 =item HISTORY
3520
3521 =item AUTHOR
3522
3523 =back
3524
3525 =head2 perlsec - Perl security
3526
3527 =over 4
3528
3529 =item DESCRIPTION
3530
3531 =over 4
3532
3533 =item Laundering and Detecting Tainted Data
3534
3535 =item Switches On the "#!" Line
3536
3537 =item Taint mode and @INC
3538
3539 =item Cleaning Up Your Path
3540
3541 =item Security Bugs
3542
3543 =item Protecting Your Programs
3544
3545 =item Unicode
3546
3547 =item Algorithmic Complexity Attacks
3548
3549 =back
3550
3551 =item SEE ALSO
3552
3553 =back
3554
3555 =head2 perlmod - Perl modules (packages and symbol tables)
3556
3557 =over 4
3558
3559 =item DESCRIPTION
3560
3561 =over 4
3562
3563 =item Packages
3564
3565 =item Symbol Tables
3566
3567 =item BEGIN, CHECK, INIT and END
3568
3569 =item Perl Classes
3570
3571 =item Perl Modules
3572
3573 =item Making your module threadsafe
3574
3575 =back
3576
3577 =item SEE ALSO
3578
3579 =back
3580
3581 =head2 perlmodlib - constructing new Perl modules and finding existing ones
3582
3583 =over 4
3584
3585 =item THE PERL MODULE LIBRARY
3586
3587 =over 4
3588
3589 =item Pragmatic Modules
3590
3591 assertions, assertions::activate, attributes, attrs, autouse, base, bigint,
3592 bignum, bigrat, blib, bytes, charnames, constant, diagnostics, encoding,
3593 fields, filetest, if, integer, less, lib, locale, open, ops, overload, re,
3594 sigtrap, sort, strict, subs, threads, threads::shared, utf8, vars, version,
3595 vmsish, warnings, warnings::register
3596
3597 =item Standard Modules
3598
3599 AnyDBM_File, Attribute::Handlers, AutoLoader, AutoSplit, B, B::Asmdata,
3600 B::Assembler, B::Bblock, B::Bytecode, B::C, B::CC, B::Concise, B::Debug,
3601 B::Deparse, B::Disassembler, B::Lint, B::Showlex, B::Stackobj, B::Stash,
3602 B::Terse, B::Xref, Benchmark, ByteLoader, CGI, CGI::Apache, CGI::Carp,
3603 CGI::Cookie, CGI::Fast, CGI::Pretty, CGI::Push, CGI::Switch, CGI::Util,
3604 CPAN, CPAN::FirstTime, CPAN::Nox, Carp, Carp::Heavy, Class::ISA,
3605 Class::Struct, Config, Cwd, DB, DB_File, Data::Dumper, Devel::DProf,
3606 Devel::PPPort, Devel::Peek, Devel::SelfStubber, Digest, Digest::MD5,
3607 Digest::base, DirHandle, Dumpvalue, DynaLoader, Encode, Encode::Alias,
3608 Encode::Byte, Encode::CJKConstants, Encode::CN, Encode::CN::HZ,
3609 Encode::Config, Encode::EBCDIC, Encode::Encoder, Encode::Encoding,
3610 Encode::Guess, Encode::JP, Encode::JP::H2Z, Encode::JP::JIS7, Encode::KR,
3611 Encode::KR::2022_KR, Encode::MIME::Header, Encode::PerlIO,
3612 Encode::Supported, Encode::Symbol, Encode::TW, Encode::Unicode,
3613 Encode::Unicode::UTF7, English, Env, Errno, Exporter, Exporter::Heavy,
3614 ExtUtils::Command, ExtUtils::Command::MM, ExtUtils::Constant,
3615 ExtUtils::Embed, ExtUtils::Install, ExtUtils::Installed, ExtUtils::Liblist,
3616 ExtUtils::MM, ExtUtils::MM_Any, ExtUtils::MM_BeOS, ExtUtils::MM_Cygwin,
3617 ExtUtils::MM_DOS, ExtUtils::MM_MacOS, ExtUtils::MM_NW5, ExtUtils::MM_OS2,
3618 ExtUtils::MM_UWIN, ExtUtils::MM_Unix, ExtUtils::MM_VMS, ExtUtils::MM_Win32,
3619 ExtUtils::MM_Win95, ExtUtils::MY, ExtUtils::MakeMaker,
3620 ExtUtils::MakeMaker::FAQ, ExtUtils::MakeMaker::Tutorial,
3621 ExtUtils::MakeMaker::bytes, ExtUtils::MakeMaker::vmsish,
3622 ExtUtils::Manifest, ExtUtils::Mkbootstrap, ExtUtils::Mksymlists,
3623 ExtUtils::Packlist, ExtUtils::testlib, Fatal, Fcntl, File::Basename,
3624 File::CheckTree, File::Compare, File::Copy, File::DosGlob, File::Find,
3625 File::Glob, File::Path, File::Spec, File::Spec::Cygwin, File::Spec::Epoc,
3626 File::Spec::Functions, File::Spec::Mac, File::Spec::OS2, File::Spec::Unix,
3627 File::Spec::VMS, File::Spec::Win32, File::Temp, File::stat, FileCache,
3628 FileHandle, Filter::Simple, Filter::Util::Call, FindBin, GDBM_File,
3629 Getopt::Long, Getopt::Std, Hash::Util, I18N::Collate, I18N::LangTags,
3630 I18N::LangTags::List, I18N::Langinfo, IO, IO::Dir, IO::File, IO::Handle,
3631 IO::Pipe, IO::Poll, IO::Seekable, IO::Select, IO::Socket, IO::Socket::INET,
3632 IO::Socket::UNIX, IPC::Open2, IPC::Open3, IPC::SysV, IPC::SysV::Msg,
3633 IPC::SysV::Semaphore, List::Util, Locale::Constants, Locale::Country,
3634 Locale::Currency, Locale::Language, Locale::Maketext,
3635 Locale::Maketext::TPJ13, Locale::Script, MIME::Base64,
3636 MIME::Base64::QuotedPrint, Math::BigFloat, Math::BigInt,
3637 Math::BigInt::Calc, Math::BigRat, Math::Complex, Math::Trig, Memoize,
3638 Memoize::AnyDBM_File, Memoize::Expire, Memoize::ExpireFile,
3639 Memoize::ExpireTest, Memoize::NDBM_File, Memoize::SDBM_File,
3640 Memoize::Storable, NDBM_File, NEXT, Net::Cmd, Net::Config, Net::Domain,
3641 Net::FTP, Net::NNTP, Net::Netrc, Net::POP3, Net::Ping, Net::SMTP,
3642 Net::Time, Net::hostent, Net::libnetFAQ, Net::netent, Net::protoent,
3643 Net::servent, O, ODBM_File, Opcode, POSIX, PerlIO, PerlIO::encoding,
3644 PerlIO::scalar, PerlIO::via, PerlIO::via::QuotedPrint, Pod::Checker,
3645 Pod::Find, Pod::Functions, Pod::Html, Pod::InputObjects, Pod::LaTeX,
3646 Pod::Man, Pod::ParseLink, Pod::ParseUtils, Pod::Parser,
3647 Pod::Perldoc::ToChecker, Pod::Perldoc::ToMan, Pod::Perldoc::ToNroff,
3648 Pod::Perldoc::ToPod, Pod::Perldoc::ToRtf, Pod::Perldoc::ToText,
3649 Pod::Perldoc::ToTk, Pod::Perldoc::ToXml, Pod::PlainText, Pod::Plainer,
3650 Pod::Select, Pod::Text, Pod::Text::Color, Pod::Text::Overstrike,
3651 Pod::Text::Termcap, Pod::Usage, SDBM_File, Safe, Scalar::Util,
3652 Search::Dict, SelectSaver, SelfLoader, Shell, Socket, Storable, Switch,
3653 Symbol, Sys::Hostname, Sys::Syslog, Term::ANSIColor, Term::Cap,
3654 Term::Complete, Term::ReadLine, Test, Test::Builder, Test::Harness,
3655 Test::Harness::Assert, Test::Harness::Iterator, Test::Harness::Straps,
3656 Test::More, Test::Simple, Test::Tutorial, Text::Abbrev, Text::Balanced,
3657 Text::ParseWords, Text::Soundex, Text::Tabs, Text::Wrap, Thread,
3658 Thread::Queue, Thread::Semaphore, Thread::Signal, Thread::Specific,
3659 Tie::Array, Tie::File, Tie::Handle, Tie::Hash, Tie::Memoize, Tie::RefHash,
3660 Tie::Scalar, Tie::SubstrHash, Time::HiRes, Time::Local, Time::gmtime,
3661 Time::localtime, Time::tm, UNIVERSAL, Unicode::Collate, Unicode::Normalize,
3662 Unicode::UCD, User::grent, User::pwent, Win32, XS::APItest, XS::Typemap,
3663 XSLoader
3664
3665 =item Extension Modules
3666
3667 =back
3668
3669 =item CPAN
3670
3671 =over 4
3672
3673 =item Africa
3674
3675 South Africa
3676
3677 =item Asia
3678
3679 China, Indonesia, Israel, Japan, Malaysia, Russian Federation, Saudi
3680 Arabia, Singapore, South Korea, Taiwan, Thailand
3681
3682 =item Central America
3683
3684 Costa Rica
3685
3686 =item Europe
3687
3688 Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Czech
3689 Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary,
3690 Iceland, Ireland, Italy, Latvia, Lithuania, Netherlands, Norway, Poland,
3691 Portugal, Romania, Russia, Slovakia, Slovenia, Spain, Sweden, Switzerland,
3692 Turkey, Ukraine, United Kingdom
3693
3694 =item North America
3695
3696 Canada, Alberta, Manitoba, Nova Scotia, Ontario, Mexico, United States,
3697 Alabama, California, Colorado, Delaware, District of Columbia, Florida,
3698 Indiana, Kentucky, Massachusetts, Michigan, Nevada, New Jersey, New York,
3699 North Carolina, Oklahoma, Oregon, Pennsylvania, Tennessee, Texas, Utah,
3700 Virginia, Washington, Wisconsin
3701
3702 =item Oceania
3703
3704 Australia, New Zealand, United States
3705
3706 =item South America
3707
3708 Argentina, Brazil, Chile
3709
3710 =item RSYNC Mirrors
3711
3712 =back
3713
3714 =item Modules: Creation, Use, and Abuse
3715
3716 =over 4
3717
3718 =item Guidelines for Module Creation
3719
3720 =item Guidelines for Converting Perl 4 Library Scripts into Modules
3721
3722 =item Guidelines for Reusing Application Code
3723
3724 =back
3725
3726 =item NOTE
3727
3728 =back
3729
3730 =head2 perlmodstyle - Perl module style guide
3731
3732 =over 4
3733
3734 =item INTRODUCTION
3735
3736 =item QUICK CHECKLIST
3737
3738 =over 4
3739
3740 =item Before you start
3741
3742 =item The API
3743
3744 =item Stability
3745
3746 =item Documentation
3747
3748 =item Release considerations
3749
3750 =back
3751
3752 =item BEFORE YOU START WRITING A MODULE
3753
3754 =over 4
3755
3756 =item Has it been done before?
3757
3758 =item Do one thing and do it well
3759
3760 =item What's in a name?
3761
3762 =back
3763
3764 =item DESIGNING AND WRITING YOUR MODULE
3765
3766 =over 4
3767
3768 =item To OO or not to OO?
3769
3770 =item Designing your API
3771
3772 Write simple routines to do simple things, Separate functionality from
3773 output, Provide sensible shortcuts and defaults, Naming conventions,
3774 Parameter passing
3775
3776 =item Strictness and warnings
3777
3778 =item Backwards compatibility
3779
3780 =item Error handling and messages
3781
3782 =back
3783
3784 =item DOCUMENTING YOUR MODULE
3785
3786 =over 4
3787
3788 =item POD
3789
3790 =item README, INSTALL, release notes, changelogs
3791
3792 perl Makefile.PL, make, make test, make install, perl Build.PL, perl Build,
3793 perl Build test, perl Build install
3794
3795 =back
3796
3797 =item RELEASE CONSIDERATIONS
3798
3799 =over 4
3800
3801 =item Version numbering
3802
3803 =item Pre-requisites
3804
3805 =item Testing
3806
3807 =item Packaging
3808
3809 =item Licensing
3810
3811 =back
3812
3813 =item COMMON PITFALLS
3814
3815 =over 4
3816
3817 =item Reinventing the wheel
3818
3819 =item Trying to do too much
3820
3821 =item Inappropriate documentation
3822
3823 =back
3824
3825 =item SEE ALSO
3826
3827 L<perlstyle>, L<perlnewmod>, L<perlpod>, L<podchecker>, Packaging Tools,
3828 Testing tools, http://pause.perl.org/, Any good book on software
3829 engineering
3830
3831 =item AUTHOR
3832
3833 =back
3834
3835 =head2 perlmodinstall - Installing CPAN Modules
3836
3837 =over 4
3838
3839 =item DESCRIPTION
3840
3841 =over 4
3842
3843 =item PREAMBLE
3844
3845 B<DECOMPRESS> the file, B<UNPACK> the file into a directory, B<BUILD> the
3846 module (sometimes unnecessary), B<INSTALL> the module
3847
3848 =back
3849
3850 =item PORTABILITY
3851
3852 =item HEY
3853
3854 =item AUTHOR
3855
3856 =item COPYRIGHT
3857
3858 =back
3859
3860 =head2 perlnewmod - preparing a new module for distribution
3861
3862 =over 4
3863
3864 =item DESCRIPTION
3865
3866 =over 4
3867
3868 =item Warning
3869
3870 =item What should I make into a module?
3871
3872 =item Step-by-step: Preparing the ground
3873
3874 Look around, Check it's new, Discuss the need, Choose a name, Check again
3875
3876 =item Step-by-step: Making the module
3877
3878 Start with F<h2xs>, Use L<strict|strict> and L<warnings|warnings>, Use
3879 L<Carp|Carp>, Use L<Exporter|Exporter> - wisely!, Use L<plain old
3880 documentation|perlpod>, Write tests, Write the README
3881
3882 =item Step-by-step: Distributing your module
3883
3884 Get a CPAN user ID, C<perl Makefile.PL; make test; make dist>, Upload the
3885 tarball, Announce to the modules list, Announce to clpa, Fix bugs!
3886
3887 =back
3888
3889 =item AUTHOR
3890
3891 =item SEE ALSO
3892
3893 =back
3894
3895 =head2 perlutil - utilities packaged with the Perl distribution
3896
3897 =over 4
3898
3899 =item DESCRIPTION
3900
3901 =over 4
3902
3903 =item DOCUMENTATION
3904
3905 L<perldoc|perldoc>, L<pod2man|pod2man> and L<pod2text|pod2text>,
3906 L<pod2html|pod2html> and L<pod2latex|pod2latex>, L<pod2usage|pod2usage>,
3907 L<podselect|podselect>, L<podchecker|podchecker>, L<splain|splain>,
3908 L<roffitall|roffitall>
3909
3910 =item CONVERTORS
3911
3912 L<a2p|a2p>, L<s2p|s2p>, L<find2perl|find2perl>
3913
3914 =item Administration
3915
3916 L<libnetcfg|libnetcfg>
3917
3918 =item Development
3919
3920 L<perlbug|perlbug>, L<h2ph|h2ph>, L<c2ph|c2ph> and L<pstruct|pstruct>,
3921 L<h2xs|h2xs>, L<dprofpp|dprofpp>, L<perlcc|perlcc>
3922
3923 =item SEE ALSO
3924
3925 =back
3926
3927 =back
3928
3929 =head2 perlcompile - Introduction to the Perl Compiler-Translator 
3930
3931 =over 4
3932
3933 =item DESCRIPTION
3934
3935 =over 4
3936
3937 =item Layout
3938
3939 B::Bytecode, B::C, B::CC, B::Lint, B::Deparse, B::Xref
3940
3941 =back
3942
3943 =item Using The Back Ends
3944
3945 =over 4
3946
3947 =item The Cross Referencing Back End
3948
3949 i, &, s, r
3950
3951 =item The Decompiling Back End
3952
3953 =item The Lint Back End
3954
3955 =item The Simple C Back End
3956
3957 =item The Bytecode Back End
3958
3959 =item The Optimized C Back End
3960
3961 =back
3962
3963 =item Module List for the Compiler Suite
3964
3965 B, O, B::Asmdata, B::Assembler, B::Bblock, B::Bytecode, B::C, B::CC,
3966 B::Concise, B::Debug, B::Deparse, B::Disassembler, B::Lint, B::Showlex,
3967 B::Stackobj, B::Stash, B::Terse, B::Xref
3968
3969 =item KNOWN PROBLEMS
3970
3971 =item AUTHOR
3972
3973 =back
3974
3975 =head2 perlfilter - Source Filters
3976
3977 =over 4
3978
3979 =item DESCRIPTION
3980
3981 =item CONCEPTS
3982
3983 =item USING FILTERS
3984
3985 =item WRITING A SOURCE FILTER
3986
3987 =item WRITING A SOURCE FILTER IN C
3988
3989 B<Decryption Filters>
3990
3991 =item CREATING A SOURCE FILTER AS A SEPARATE EXECUTABLE
3992
3993 =item WRITING A SOURCE FILTER IN PERL
3994
3995 =item USING CONTEXT: THE DEBUG FILTER
3996
3997 =item CONCLUSION
3998
3999 =item THINGS TO LOOK OUT FOR
4000
4001 Some Filters Clobber the C<DATA> Handle
4002
4003 =item REQUIREMENTS
4004
4005 =item AUTHOR
4006
4007 =item Copyrights
4008
4009 =back
4010
4011 =head2 perlembed - how to embed perl in your C program
4012
4013 =over 4
4014
4015 =item DESCRIPTION
4016
4017 =over 4
4018
4019 =item PREAMBLE
4020
4021 B<Use C from Perl?>, B<Use a Unix program from Perl?>, B<Use Perl from
4022 Perl?>, B<Use C from C?>, B<Use Perl from C?>
4023
4024 =item ROADMAP
4025
4026 =item Compiling your C program
4027
4028 =item Adding a Perl interpreter to your C program
4029
4030 =item Calling a Perl subroutine from your C program
4031
4032 =item Evaluating a Perl statement from your C program
4033
4034 =item Performing Perl pattern matches and substitutions from your C program
4035
4036 =item Fiddling with the Perl stack from your C program
4037
4038 =item Maintaining a persistent interpreter
4039
4040 =item Execution of END blocks
4041
4042 =item Maintaining multiple interpreter instances
4043
4044 =item Using Perl modules, which themselves use C libraries, from your C
4045 program
4046
4047 =back
4048
4049 =item Embedding Perl under Win32
4050
4051 =item Hiding Perl_
4052
4053 =item MORAL
4054
4055 =item AUTHOR
4056
4057 =item COPYRIGHT
4058
4059 =back
4060
4061 =head2 perldebguts - Guts of Perl debugging 
4062
4063 =over 4
4064
4065 =item DESCRIPTION
4066
4067 =item Debugger Internals
4068
4069 =over 4
4070
4071 =item Writing Your Own Debugger
4072
4073 =back
4074
4075 =item Frame Listing Output Examples
4076
4077 =item Debugging regular expressions
4078
4079 =over 4
4080
4081 =item Compile-time output
4082
4083 C<anchored> I<STRING> C<at> I<POS>, C<floating> I<STRING> C<at>
4084 I<POS1..POS2>, C<matching floating/anchored>, C<minlen>, C<stclass>
4085 I<TYPE>, C<noscan>, C<isall>, C<GPOS>, C<plus>, C<implicit>, C<with eval>,
4086 C<anchored(TYPE)>
4087
4088 =item Types of nodes
4089
4090 =item Run-time output
4091
4092 =back
4093
4094 =item Debugging Perl memory usage
4095
4096 =over 4
4097
4098 =item Using C<$ENV{PERL_DEBUG_MSTATS}>
4099
4100 C<buckets SMALLEST(APPROX)..GREATEST(APPROX)>, Free/Used, C<Total sbrk():
4101 SBRKed/SBRKs:CONTINUOUS>, C<pad: 0>, C<heads: 2192>, C<chain: 0>, C<tail:
4102 6144>
4103
4104 =item Example of using B<-DL> switch
4105
4106 C<717>, C<002>, C<054>, C<602>, C<702>, C<704>
4107
4108 =item B<-DL> details
4109
4110 C<!!!>, C<!!>, C<!>
4111
4112 =item Limitations of B<-DL> statistics
4113
4114 =back
4115
4116 =item SEE ALSO
4117
4118 =back
4119
4120 =head2 perlxstut, perlXStut - Tutorial for writing XSUBs
4121
4122 =over 4
4123
4124 =item DESCRIPTION
4125
4126 =item SPECIAL NOTES
4127
4128 =over 4
4129
4130 =item make
4131
4132 =item Version caveat
4133
4134 =item Dynamic Loading versus Static Loading
4135
4136 =back
4137
4138 =item TUTORIAL
4139
4140 =over 4
4141
4142 =item EXAMPLE 1
4143
4144 =item EXAMPLE 2
4145
4146 =item What has gone on?
4147
4148 =item Writing good test scripts
4149
4150 =item EXAMPLE 3
4151
4152 =item What's new here?
4153
4154 =item Input and Output Parameters
4155
4156 =item The XSUBPP Program
4157
4158 =item The TYPEMAP file
4159
4160 =item Warning about Output Arguments
4161
4162 =item EXAMPLE 4
4163
4164 =item What has happened here?
4165
4166 =item Anatomy of .xs file
4167
4168 =item Getting the fat out of XSUBs
4169
4170 =item More about XSUB arguments
4171
4172 =item The Argument Stack
4173
4174 =item Extending your Extension
4175
4176 =item Documenting your Extension
4177
4178 =item Installing your Extension
4179
4180 =item EXAMPLE 5
4181
4182 =item New Things in this Example
4183
4184 =item EXAMPLE 6
4185
4186 =item New Things in this Example
4187
4188 =item EXAMPLE 7 (Coming Soon)
4189
4190 =item EXAMPLE 8 (Coming Soon)
4191
4192 =item EXAMPLE 9 Passing open files to XSes
4193
4194 =item Troubleshooting these Examples
4195
4196 =back
4197
4198 =item See also
4199
4200 =item Author
4201
4202 =over 4
4203
4204 =item Last Changed
4205
4206 =back
4207
4208 =back
4209
4210 =head2 perlxs - XS language reference manual
4211
4212 =over 4
4213
4214 =item DESCRIPTION
4215
4216 =over 4
4217
4218 =item Introduction
4219
4220 =item On The Road
4221
4222 =item The Anatomy of an XSUB
4223
4224 =item The Argument Stack
4225
4226 =item The RETVAL Variable
4227
4228 =item The MODULE Keyword
4229
4230 =item The PACKAGE Keyword
4231
4232 =item The PREFIX Keyword
4233
4234 =item The OUTPUT: Keyword
4235
4236 =item The NO_OUTPUT Keyword
4237
4238 =item The CODE: Keyword
4239
4240 =item The INIT: Keyword
4241
4242 =item The NO_INIT Keyword
4243
4244 =item Initializing Function Parameters
4245
4246 =item Default Parameter Values
4247
4248 =item The PREINIT: Keyword
4249
4250 =item The SCOPE: Keyword
4251
4252 =item The INPUT: Keyword
4253
4254 =item The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords
4255
4256 =item The C<length(NAME)> Keyword
4257
4258 =item Variable-length Parameter Lists
4259
4260 =item The C_ARGS: Keyword
4261
4262 =item The PPCODE: Keyword
4263
4264 =item Returning Undef And Empty Lists
4265
4266 =item The REQUIRE: Keyword
4267
4268 =item The CLEANUP: Keyword
4269
4270 =item The POSTCALL: Keyword
4271
4272 =item The BOOT: Keyword
4273
4274 =item The VERSIONCHECK: Keyword
4275
4276 =item The PROTOTYPES: Keyword
4277
4278 =item The PROTOTYPE: Keyword
4279
4280 =item The ALIAS: Keyword
4281
4282 =item The OVERLOAD: Keyword
4283
4284 =item The FALLBACK: Keyword
4285
4286 =item The INTERFACE: Keyword
4287
4288 =item The INTERFACE_MACRO: Keyword
4289
4290 =item The INCLUDE: Keyword
4291
4292 =item The CASE: Keyword
4293
4294 =item The & Unary Operator
4295
4296 =item Inserting POD, Comments and C Preprocessor Directives
4297
4298 =item Using XS With C++
4299
4300 =item Interface Strategy
4301
4302 =item Perl Objects And C Structures
4303
4304 =item The Typemap
4305
4306 =item Safely Storing Static Data in XS
4307
4308 MY_CXT_KEY, typedef my_cxt_t, START_MY_CXT, MY_CXT_INIT, dMY_CXT, MY_CXT
4309
4310 =back
4311
4312 =item EXAMPLES
4313
4314 =item XS VERSION
4315
4316 =item AUTHOR
4317
4318 =back
4319
4320 =head2 perlclib - Internal replacements for standard C library functions
4321
4322 =over 4
4323
4324 =item DESCRIPTION
4325
4326 =over 4
4327
4328 =item Conventions
4329
4330 C<t>, C<p>, C<n>, C<s>
4331
4332 =item File Operations
4333
4334 =item File Input and Output
4335
4336 =item File Positioning
4337
4338 =item Memory Management and String Handling
4339
4340 =item Character Class Tests
4341
4342 =item F<stdlib.h> functions
4343
4344 =item Miscellaneous functions
4345
4346 =back
4347
4348 =item SEE ALSO
4349
4350 =back
4351
4352 =head2 perlguts - Introduction to the Perl API
4353
4354 =over 4
4355
4356 =item DESCRIPTION
4357
4358 =item Variables
4359
4360 =over 4
4361
4362 =item Datatypes
4363
4364 =item What is an "IV"?
4365
4366 =item Working with SVs
4367
4368 =item Offsets
4369
4370 =item What's Really Stored in an SV?
4371
4372 =item Working with AVs
4373
4374 =item Working with HVs
4375
4376 =item Hash API Extensions
4377
4378 =item AVs, HVs and undefined values
4379
4380 =item References
4381
4382 =item Blessed References and Class Objects
4383
4384 =item Creating New Variables
4385
4386 GV_ADDMULTI, GV_ADDWARN
4387
4388 =item Reference Counts and Mortality
4389
4390 =item Stashes and Globs
4391
4392 =item Double-Typed SVs
4393
4394 =item Magic Variables
4395
4396 =item Assigning Magic
4397
4398 =item Magic Virtual Tables
4399
4400 =item Finding Magic
4401
4402 =item Understanding the Magic of Tied Hashes and Arrays
4403
4404 =item Localizing changes
4405
4406 C<SAVEINT(int i)>, C<SAVEIV(IV i)>, C<SAVEI32(I32 i)>, C<SAVELONG(long i)>,
4407 C<SAVESPTR(s)>, C<SAVEPPTR(p)>, C<SAVEFREESV(SV *sv)>, C<SAVEMORTALIZESV(SV
4408 *sv)>, C<SAVEFREEOP(OP *op)>, C<SAVEFREEPV(p)>, C<SAVECLEARSV(SV *sv)>,
4409 C<SAVEDELETE(HV *hv, char *key, I32 length)>,
4410 C<SAVEDESTRUCTOR(DESTRUCTORFUNC_NOCONTEXT_t f, void *p)>,
4411 C<SAVEDESTRUCTOR_X(DESTRUCTORFUNC_t f, void *p)>, C<SAVESTACK_POS()>, C<SV*
4412 save_scalar(GV *gv)>, C<AV* save_ary(GV *gv)>, C<HV* save_hash(GV *gv)>,
4413 C<void save_item(SV *item)>, C<void save_list(SV **sarg, I32 maxsarg)>,
4414 C<SV* save_svref(SV **sptr)>, C<void save_aptr(AV **aptr)>, C<void
4415 save_hptr(HV **hptr)>
4416
4417 =back
4418
4419 =item Subroutines
4420
4421 =over 4
4422
4423 =item XSUBs and the Argument Stack
4424
4425 =item Calling Perl Routines from within C Programs
4426
4427 =item Memory Allocation
4428
4429 =item PerlIO
4430
4431 =item Putting a C value on Perl stack
4432
4433 =item Scratchpads
4434
4435 =item Scratchpads and recursion
4436
4437 =back
4438
4439 =item Compiled code
4440
4441 =over 4
4442
4443 =item Code tree
4444
4445 =item Examining the tree
4446
4447 =item Compile pass 1: check routines
4448
4449 =item Compile pass 1a: constant folding
4450
4451 =item Compile pass 2: context propagation
4452
4453 =item Compile pass 3: peephole optimization
4454
4455 =item Pluggable runops
4456
4457 =back
4458
4459 =item Examining internal data structures with the C<dump> functions
4460
4461 =item How multiple interpreters and concurrency are supported
4462
4463 =over 4
4464
4465 =item Background and PERL_IMPLICIT_CONTEXT
4466
4467 =item So what happened to dTHR?
4468
4469 =item How do I use all this in extensions?
4470
4471 =item Should I do anything special if I call perl from multiple threads?
4472
4473 =item Future Plans and PERL_IMPLICIT_SYS
4474
4475 =back
4476
4477 =item Internal Functions
4478
4479 A, p, d, s, n, r, f, M, o, x, m, X, E, b
4480
4481 =over 4
4482
4483 =item Formatted Printing of IVs, UVs, and NVs
4484
4485 =item Pointer-To-Integer and Integer-To-Pointer
4486
4487 =item Source Documentation
4488
4489 =back
4490
4491 =item Unicode Support
4492
4493 =over 4
4494
4495 =item What B<is> Unicode, anyway?
4496
4497 =item How can I recognise a UTF-8 string?
4498
4499 =item How does UTF-8 represent Unicode characters?
4500
4501 =item How does Perl store UTF-8 strings?
4502
4503 =item How do I convert a string to UTF-8?
4504
4505 =item Is there anything else I need to know?
4506
4507 =back
4508
4509 =item Custom Operators
4510
4511 =item AUTHORS
4512
4513 =item SEE ALSO
4514
4515 =back
4516
4517 =head2 perlcall - Perl calling conventions from C
4518
4519 =over 4
4520
4521 =item DESCRIPTION
4522
4523 An Error Handler, An Event Driven Program
4524
4525 =item THE CALL_ FUNCTIONS
4526
4527 call_sv, call_pv, call_method, call_argv
4528
4529 =item FLAG VALUES
4530
4531 =over 4
4532
4533 =item  G_VOID
4534
4535 =item  G_SCALAR
4536
4537 =item G_ARRAY
4538
4539 =item G_DISCARD
4540
4541 =item G_NOARGS
4542
4543 =item G_EVAL
4544
4545 =item G_KEEPERR
4546
4547 =item Determining the Context
4548
4549 =back
4550
4551 =item KNOWN PROBLEMS
4552
4553 =item EXAMPLES
4554
4555 =over 4
4556
4557 =item No Parameters, Nothing returned
4558
4559 =item Passing Parameters
4560
4561 =item Returning a Scalar
4562
4563 =item Returning a list of values
4564
4565 =item Returning a list in a scalar context
4566
4567 =item Returning Data from Perl via the parameter list
4568
4569 =item Using G_EVAL
4570
4571 =item Using G_KEEPERR
4572
4573 =item Using call_sv
4574
4575 =item Using call_argv
4576
4577 =item Using call_method
4578
4579 =item Using GIMME_V
4580
4581 =item Using Perl to dispose of temporaries
4582
4583 =item Strategies for storing Callback Context Information
4584
4585 1. Ignore the problem - Allow only 1 callback, 2. Create a sequence of
4586 callbacks - hard wired limit, 3. Use a parameter to map to the Perl
4587 callback
4588
4589 =item Alternate Stack Manipulation
4590
4591 =item Creating and calling an anonymous subroutine in C
4592
4593 =back
4594
4595 =item SEE ALSO
4596
4597 =item AUTHOR
4598
4599 =item DATE
4600
4601 =back
4602
4603 =head2 perlapi - autogenerated documentation for the perl public API
4604
4605 =over 4
4606
4607 =item DESCRIPTION
4608
4609 =item "Gimme" Values
4610
4611 GIMME, GIMME_V, G_ARRAY, G_DISCARD, G_EVAL, G_NOARGS, G_SCALAR, G_VOID
4612
4613 =item Array Manipulation Functions
4614
4615 AvFILL, av_clear, av_delete, av_exists, av_extend, av_fetch, av_fill,
4616 av_len, av_make, av_pop, av_push, av_shift, av_store, av_undef, av_unshift,
4617 get_av, newAV, Nullav, sortsv
4618
4619 =item Callback Functions
4620
4621 call_argv, call_method, call_pv, call_sv, ENTER, eval_pv, eval_sv,
4622 FREETMPS, LEAVE, SAVETMPS
4623
4624 =item Character classes
4625
4626 isALNUM, isALPHA, isDIGIT, isLOWER, isSPACE, isUPPER, toLOWER, toUPPER
4627
4628 =item Cloning an interpreter
4629
4630 perl_clone
4631
4632 =item CV Manipulation Functions
4633
4634 CvSTASH, get_cv, Nullcv
4635
4636 =item Embedding Functions
4637
4638 cv_undef, load_module, nothreadhook, perl_alloc, perl_construct,
4639 perl_destruct, perl_free, perl_parse, perl_run, require_pv
4640
4641 =item Functions in file pp_pack.c
4642
4643 packlist, pack_cat, unpackstring, unpack_str
4644
4645 =item Global Variables
4646
4647 PL_modglobal, PL_na, PL_sv_no, PL_sv_undef, PL_sv_yes
4648
4649 =item GV Functions
4650
4651 GvSV, gv_fetchmeth, gv_fetchmethod, gv_fetchmethod_autoload,
4652 gv_fetchmeth_autoload, gv_stashpv, gv_stashsv
4653
4654 =item Handy Values
4655
4656 HEf_SVKEY, Nullch, Nullsv
4657
4658 =item Hash Manipulation Functions
4659
4660 get_hv, HeHASH, HeKEY, HeKLEN, HePV, HeSVKEY, HeSVKEY_force, HeSVKEY_set,
4661 HeVAL, HvNAME, hv_assert, hv_clear, hv_clear_placeholders, hv_delete,
4662 hv_delete_ent, hv_exists, hv_exists_ent, hv_fetch, hv_fetch_ent,
4663 hv_iterinit, hv_iterkey, hv_iterkeysv, hv_iternext, hv_iternextsv,
4664 hv_iternext_flags, hv_iterval, hv_magic, hv_scalar, hv_store, hv_store_ent,
4665 hv_undef, newHV, Nullhv
4666
4667 =item Magical Functions
4668
4669 mg_clear, mg_copy, mg_find, mg_free, mg_get, mg_length, mg_magical, mg_set,
4670 SvGETMAGIC, SvLOCK, SvSETMAGIC, SvSetMagicSV, SvSetMagicSV_nosteal,
4671 SvSetSV, SvSetSV_nosteal, SvSHARE
4672
4673 =item Memory Management
4674
4675 Copy, Move, New, Newc, NEWSV, Newz, Poison, Renew, Renewc, Safefree,
4676 savepv, savepvn, savesharedpv, StructCopy, Zero
4677
4678 =item Miscellaneous Functions
4679
4680 fbm_compile, fbm_instr, form, getcwd_sv, new_version, scan_version, strEQ,
4681 strGE, strGT, strLE, strLT, strNE, strnEQ, strnNE, sv_nolocking,
4682 sv_nosharing, sv_nounlocking, upg_version, vcmp, vnumify, vstringify
4683
4684 =item Numeric functions
4685
4686 grok_bin, grok_hex, grok_number, grok_numeric_radix, grok_oct, scan_bin,
4687 scan_hex, scan_oct
4688
4689 =item Optree Manipulation Functions
4690
4691 cv_const_sv, newCONSTSUB, newXS
4692
4693 =item Pad Data Structures
4694
4695 pad_sv
4696
4697 =item Stack Manipulation Macros
4698
4699 dMARK, dORIGMARK, dSP, EXTEND, MARK, ORIGMARK, POPi, POPl, POPn, POPp,
4700 POPpbytex, POPpx, POPs, PUSHi, PUSHMARK, PUSHn, PUSHp, PUSHs, PUSHu,
4701 PUTBACK, SP, SPAGAIN, XPUSHi, XPUSHn, XPUSHp, XPUSHs, XPUSHu, XSRETURN,
4702 XSRETURN_IV, XSRETURN_NO, XSRETURN_NV, XSRETURN_PV, XSRETURN_UNDEF,
4703 XSRETURN_UV, XSRETURN_YES, XST_mIV, XST_mNO, XST_mNV, XST_mPV, XST_mUNDEF,
4704 XST_mYES
4705
4706 =item SV Flags
4707
4708 svtype, SVt_IV, SVt_NV, SVt_PV, SVt_PVAV, SVt_PVCV, SVt_PVHV, SVt_PVMG
4709
4710 =item SV Manipulation Functions
4711
4712 get_sv, looks_like_number, newRV_inc, newRV_noinc, newSV, newSViv, newSVnv,
4713 newSVpv, newSVpvf, newSVpvn, newSVpvn_share, newSVrv, newSVsv, newSVuv,
4714 SvCUR, SvCUR_set, SvEND, SvGROW, SvIOK, SvIOKp, SvIOK_notUV, SvIOK_off,
4715 SvIOK_on, SvIOK_only, SvIOK_only_UV, SvIOK_UV, SvIsCOW,
4716 SvIsCOW_shared_hash, SvIV, SvIVx, SvIVX, SvLEN, SvNIOK, SvNIOKp,
4717 SvNIOK_off, SvNOK, SvNOKp, SvNOK_off, SvNOK_on, SvNOK_only, SvNV, SvNVX,
4718 SvNVx, SvOK, SvOOK, SvPOK, SvPOKp, SvPOK_off, SvPOK_on, SvPOK_only,
4719 SvPOK_only_UTF8, SvPV, SvPVbyte, SvPVbytex, SvPVbytex_force,
4720 SvPVbyte_force, SvPVbyte_nolen, SvPVutf8, SvPVutf8x, SvPVutf8x_force,
4721 SvPVutf8_force, SvPVutf8_nolen, SvPVx, SvPVX, SvPV_force, SvPV_force_nomg,
4722 SvPV_nolen, SvREFCNT, SvREFCNT_dec, SvREFCNT_inc, SvROK, SvROK_off,
4723 SvROK_on, SvRV, SvSTASH, SvTAINT, SvTAINTED, SvTAINTED_off, SvTAINTED_on,
4724 SvTRUE, SvTYPE, SvUNLOCK, SvUOK, SvUPGRADE, SvUTF8, SvUTF8_off, SvUTF8_on,
4725 SvUV, SvUVX, SvUVx, SvVOK, sv_2bool, sv_2cv, sv_2io, sv_2iv, sv_2mortal,
4726 sv_2nv, sv_2pvbyte, sv_2pvbyte_nolen, sv_2pvutf8, sv_2pvutf8_nolen,
4727 sv_2pv_flags, sv_2pv_nolen, sv_2uv, sv_backoff, sv_bless, sv_catpv,
4728 sv_catpvf, sv_catpvf_mg, sv_catpvn, sv_catpvn_flags, sv_catpvn_mg,
4729 sv_catpv_mg, sv_catsv, sv_catsv_flags, sv_catsv_mg, sv_chop, sv_clear,
4730 sv_cmp, sv_cmp_locale, sv_collxfrm, sv_copypv, sv_dec, sv_derived_from,
4731 sv_eq, sv_force_normal, sv_force_normal_flags, sv_free, sv_gets, sv_grow,
4732 sv_inc, sv_insert, sv_isa, sv_isobject, sv_iv, sv_len, sv_len_utf8,
4733 sv_magic, sv_magicext, sv_mortalcopy, sv_newmortal, sv_newref, sv_nv,
4734 sv_pos_b2u, sv_pos_u2b, sv_pv, sv_pvbyte, sv_pvbyten, sv_pvbyten_force,
4735 sv_pvn, sv_pvn_force, sv_pvn_force_flags, sv_pvutf8, sv_pvutf8n,
4736 sv_pvutf8n_force, sv_reftype, sv_replace, sv_report_used, sv_reset,
4737 sv_rvweaken, sv_setiv, sv_setiv_mg, sv_setnv, sv_setnv_mg, sv_setpv,
4738 sv_setpvf, sv_setpvf_mg, sv_setpviv, sv_setpviv_mg, sv_setpvn,
4739 sv_setpvn_mg, sv_setpv_mg, sv_setref_iv, sv_setref_nv, sv_setref_pv,
4740 sv_setref_pvn, sv_setref_uv, sv_setsv, sv_setsv_flags, sv_setsv_mg,
4741 sv_setuv, sv_setuv_mg, sv_taint, sv_tainted, sv_true, sv_unmagic, sv_unref,
4742 sv_unref_flags, sv_untaint, sv_upgrade, sv_usepvn, sv_usepvn_mg,
4743 sv_utf8_decode, sv_utf8_downgrade, sv_utf8_encode, sv_utf8_upgrade,
4744 sv_utf8_upgrade_flags, sv_uv, sv_vcatpvfn, sv_vsetpvfn
4745
4746 =item Unicode Support
4747
4748 bytes_from_utf8, bytes_to_utf8, ibcmp_utf8, is_utf8_char, is_utf8_string,
4749 is_utf8_string_loc, pv_uni_display, sv_cat_decode, sv_recode_to_utf8,
4750 sv_uni_display, to_utf8_case, to_utf8_fold, to_utf8_lower, to_utf8_title,
4751 to_utf8_upper, utf8n_to_uvchr, utf8n_to_uvuni, utf8_distance, utf8_hop,
4752 utf8_length, utf8_to_bytes, utf8_to_uvchr, utf8_to_uvuni, uvchr_to_utf8,
4753 uvuni_to_utf8_flags
4754
4755 =item Variables created by C<xsubpp> and C<xsubpp> internal functions
4756
4757 ax, CLASS, dAX, dITEMS, dXSARGS, dXSI32, items, ix, newXSproto, RETVAL, ST,
4758 THIS, XS, XSRETURN_EMPTY, XS_VERSION, XS_VERSION_BOOTCHECK
4759
4760 =item Warning and Dieing
4761
4762 croak, warn
4763
4764 =item AUTHORS
4765
4766 =item SEE ALSO
4767
4768 =back
4769
4770 =head2 perlintern - autogenerated documentation of purely B<internal>
4771                  Perl functions
4772
4773 =over 4
4774
4775 =item DESCRIPTION
4776
4777 =item CV reference counts and CvOUTSIDE
4778
4779 CvWEAKOUTSIDE
4780
4781 =item Functions in file pad.h
4782
4783 CX_CURPAD_SAVE, CX_CURPAD_SV, PAD_BASE_SV, PAD_CLONE_VARS,
4784 PAD_COMPNAME_FLAGS, PAD_COMPNAME_GEN, PAD_COMPNAME_OURSTASH,
4785 PAD_COMPNAME_PV, PAD_COMPNAME_TYPE, PAD_DUP, PAD_RESTORE_LOCAL,
4786 PAD_SAVE_LOCAL, PAD_SAVE_SETNULLPAD, PAD_SETSV, PAD_SET_CUR,
4787 PAD_SET_CUR_NOSAVE, PAD_SV, PAD_SVl, SAVECLEARSV, SAVECOMPPAD, SAVEPADSV
4788
4789 =item Functions in file pp_ctl.c
4790
4791 find_runcv
4792
4793 =item Global Variables
4794
4795 PL_DBsingle, PL_DBsub, PL_DBtrace, PL_dowarn, PL_last_in_gv, PL_ofs_sv,
4796 PL_rs
4797
4798 =item GV Functions
4799
4800 is_gv_magical
4801
4802 =item IO Functions
4803
4804 start_glob
4805
4806 =item Pad Data Structures
4807
4808 CvPADLIST, cv_clone, cv_dump, do_dump_pad, intro_my, pad_add_anon,
4809 pad_add_name, pad_alloc, pad_block_start, pad_check_dup, pad_findlex,
4810 pad_findmy, pad_fixup_inner_anons, pad_free, pad_leavemy, pad_new,
4811 pad_push, pad_reset, pad_setsv, pad_swipe, pad_tidy, pad_undef
4812
4813 =item Stack Manipulation Macros
4814
4815 djSP, LVRET
4816
4817 =item SV Manipulation Functions
4818
4819 report_uninit, sv_add_arena, sv_clean_all, sv_clean_objs, sv_free_arenas
4820
4821 =item AUTHORS
4822
4823 =item SEE ALSO
4824
4825 =back
4826
4827 =head2 perliol - C API for Perl's implementation of IO in Layers.
4828
4829 =over 4
4830
4831 =item SYNOPSIS
4832
4833 =item DESCRIPTION
4834
4835 =over 4
4836
4837 =item History and Background
4838
4839 =item Basic Structure
4840
4841 =item Layers vs Disciplines
4842
4843 =item Data Structures
4844
4845 =item Functions and Attributes
4846
4847 =item Per-instance Data
4848
4849 =item Layers in action.
4850
4851 =item Per-instance flag bits
4852
4853 PERLIO_F_EOF, PERLIO_F_CANWRITE,  PERLIO_F_CANREAD, PERLIO_F_ERROR,
4854 PERLIO_F_TRUNCATE, PERLIO_F_APPEND, PERLIO_F_CRLF, PERLIO_F_UTF8,
4855 PERLIO_F_UNBUF, PERLIO_F_WRBUF, PERLIO_F_RDBUF, PERLIO_F_LINEBUF,
4856 PERLIO_F_TEMP, PERLIO_F_OPEN, PERLIO_F_FASTGETS
4857
4858 =item Methods in Detail
4859
4860 fsize, name, size, kind, PERLIO_K_BUFFERED, PERLIO_K_RAW, PERLIO_K_CANCRLF,
4861 PERLIO_K_FASTGETS, PERLIO_K_MULTIARG, Pushed, Popped, Open, Binmode,
4862 Getarg, Fileno, Dup, Read, Write, Seek, Tell, Close, Flush, Fill, Eof,
4863 Error,  Clearerr, Setlinebuf, Get_base, Get_bufsiz, Get_ptr, Get_cnt,
4864 Set_ptrcnt
4865
4866 =item Utilities
4867
4868 =item Implementing PerlIO Layers
4869
4870 C implementations, Perl implementations
4871
4872 =item Core Layers
4873
4874 "unix", "perlio", "stdio", "crlf", "mmap", "pending", "raw", "utf8"
4875
4876 =item Extension Layers
4877
4878 ":encoding", ":scalar", ":via"
4879
4880 =back
4881
4882 =item TODO
4883
4884 =back
4885
4886 =head2 perlapio - perl's IO abstraction interface.
4887
4888 =over 4
4889
4890 =item SYNOPSIS
4891
4892 =item DESCRIPTION
4893
4894 1. USE_STDIO, 2. USE_SFIO, 3. USE_PERLIO, B<PerlIO_stdin()>,
4895 B<PerlIO_stdout()>, B<PerlIO_stderr()>, B<PerlIO_open(path, mode)>,
4896 B<PerlIO_fdopen(fd,mode)>, B<PerlIO_reopen(path,mode,f)>,
4897 B<PerlIO_printf(f,fmt,...)>, B<PerlIO_vprintf(f,fmt,a)>,
4898 B<PerlIO_stdoutf(fmt,...)>, B<PerlIO_read(f,buf,count)>,
4899 B<PerlIO_write(f,buf,count)>, B<PerlIO_close(f)>, B<PerlIO_puts(f,s)>,
4900 B<PerlIO_putc(f,c)>, B<PerlIO_ungetc(f,c)>, B<PerlIO_getc(f)>,
4901 B<PerlIO_eof(f)>, B<PerlIO_error(f)>, B<PerlIO_fileno(f)>,
4902 B<PerlIO_clearerr(f)>, B<PerlIO_flush(f)>, B<PerlIO_seek(f,offset,whence)>,
4903 B<PerlIO_tell(f)>, B<PerlIO_getpos(f,p)>, B<PerlIO_setpos(f,p)>,
4904 B<PerlIO_rewind(f)>, B<PerlIO_tmpfile()>, B<PerlIO_setlinebuf(f)>
4905
4906 =over 4
4907
4908 =item Co-existence with stdio
4909
4910 B<PerlIO_importFILE(f,mode)>, B<PerlIO_exportFILE(f,mode)>,
4911 B<PerlIO_releaseFILE(p,f)>, B<PerlIO_findFILE(f)>
4912
4913 =item "Fast gets" Functions
4914
4915 B<PerlIO_fast_gets(f)>, B<PerlIO_has_cntptr(f)>, B<PerlIO_get_cnt(f)>,
4916 B<PerlIO_get_ptr(f)>, B<PerlIO_set_ptrcnt(f,p,c)>, B<PerlIO_canset_cnt(f)>,
4917 B<PerlIO_set_cnt(f,c)>, B<PerlIO_has_base(f)>, B<PerlIO_get_base(f)>,
4918 B<PerlIO_get_bufsiz(f)>
4919
4920 =item Other Functions
4921
4922 PerlIO_apply_layers(f,mode,layers), PerlIO_binmode(f,ptype,imode,layers),
4923 'E<lt>' read, 'E<gt>' write, '+' read/write, PerlIO_debug(fmt,...)
4924
4925 =back
4926
4927 =back
4928
4929 =head2 perlhack - How to hack at the Perl internals
4930
4931 =over 4
4932
4933 =item DESCRIPTION
4934
4935 Does concept match the general goals of Perl?, Where is the
4936 implementation?, Backwards compatibility, Could it be a module instead?, Is
4937 the feature generic enough?, Does it potentially introduce new bugs?, Does
4938 it preclude other desirable features?, Is the implementation robust?, Is
4939 the implementation generic enough to be portable?, Is the implementation
4940 tested?, Is there enough documentation?, Is there another way to do it?,
4941 Does it create too much work?, Patches speak louder than words
4942
4943 =over 4
4944
4945 =item Keeping in sync
4946
4947 rsync'ing the source tree, Using rsync over the LAN, Using pushing over the
4948 NFS, rsync'ing the patches
4949
4950 =item Why rsync the source tree
4951
4952 It's easier to rsync the source tree, It's more reliable
4953
4954 =item Why rsync the patches
4955
4956 It's easier to rsync the patches, It's a good reference, Finding a start
4957 point, Finding how to fix a bug, Finding the source of misbehaviour
4958
4959 =item Perlbug administration
4960
4961 =item Submitting patches
4962
4963 L<perlguts>, L<perlxstut> and L<perlxs>, L<perlapi>,
4964 F<Porting/pumpkin.pod>, The perl5-porters FAQ
4965
4966 =item Finding Your Way Around
4967
4968 Core modules, Tests, Documentation, Configure, Interpreter
4969
4970 =item Elements of the interpreter
4971
4972 Startup, Parsing, Optimization, Running
4973
4974 =item Internal Variable Types
4975
4976 =item Op Trees
4977
4978 =item Stacks
4979
4980 Argument stack, Mark stack, Save stack
4981
4982 =item Millions of Macros
4983
4984 =item The .i Targets
4985
4986 =item Poking at Perl
4987
4988 =item Using a source-level debugger
4989
4990 run [args], break function_name, break source.c:xxx, step, next, continue,
4991 finish, 'enter', print
4992
4993 =item gdb macro support
4994
4995 =item Dumping Perl Data Structures
4996
4997 =item Patching
4998
4999 =item Patching a core module
5000
5001 =item Adding a new function to the core
5002
5003 =item Writing a test
5004
5005 F<t/base/>, F<t/cmd/>, F<t/comp/>, F<t/io/>, F<t/lib/>, F<t/op/>,
5006 F<t/pod/>, F<t/run/>, F<t/uni/>, F<t/win32/>, F<t/x2p>, t/base t/comp,
5007 t/cmd t/run t/io t/op, t/lib ext lib
5008
5009 =item Special Make Test Targets
5010
5011 coretest, test.deparse, test.taintwarn, minitest, test.valgrind
5012 check.valgrind utest.valgrind ucheck.valgrind, test.third check.third
5013 utest.third ucheck.third, test.torture torturetest, utest ucheck test.utf8
5014 check.utf8, test_harness
5015
5016 =item Running tests by hand
5017
5018 PERL_CORE=1, PERL_DESTRUCT_LEVEL=2, PERL, PERL_SKIP_TTY_TEST
5019
5020 =back
5021
5022 =item EXTERNAL TOOLS FOR DEBUGGING PERL
5023
5024 =over 4
5025
5026 =item Rational Software's Purify
5027
5028 =item Purify on Unix
5029
5030 -Accflags=-DPURIFY, -Doptimize='-g', -Uusemymalloc, -Dusemultiplicity
5031
5032 =item Purify on NT
5033
5034 DEFINES, USE_MULTI = define, #PERL_MALLOC = define, CFG = Debug
5035
5036 =item valgrind
5037
5038 =item Compaq's/Digital's/HP's Third Degree
5039
5040 =item PERL_DESTRUCT_LEVEL
5041
5042 =item Profiling
5043
5044 =item Gprof Profiling
5045
5046 -a, -b, -e routine, -f routine, -s, -z
5047
5048 =item GCC gcov Profiling
5049
5050 =item Pixie Profiling
5051
5052 -h, -l, -p[rocedures], -h[eavy], -i[nvocations], -l[ines], -testcoverage,
5053 -z[ero]
5054
5055 =item Miscellaneous tricks
5056
5057 =item CONCLUSION
5058
5059 I<The Road goes ever on and on, down from the door where it began.>
5060
5061 =back
5062
5063 =item AUTHOR
5064
5065 =back
5066
5067 =head2 perlbook - Perl book information
5068
5069 =over 4
5070
5071 =item DESCRIPTION
5072
5073 =back
5074
5075 =head2 perltodo - Perl TO-DO List
5076
5077 =over 4
5078
5079 =item DESCRIPTION
5080
5081 =item To do during 5.6.x
5082
5083 =over 4
5084
5085 =item Support for I/O disciplines
5086
5087 =item Autoload bytes.pm
5088
5089 =item Make "\u{XXXX}" et al work
5090
5091 =item Create a char *sv_pvprintify(sv, STRLEN *lenp, UV flags)
5092
5093 =item Overloadable regex assertions
5094
5095 =item Unicode
5096
5097 =item Work out exit/die semantics for threads
5098
5099 =item Better support for nonpreemptive threading systems like GNU pth
5100
5101 =item Typed lexicals for compiler
5102
5103 =item Compiler workarounds for Win32
5104
5105 =item AUTOLOADing in the compiler
5106
5107 =item Fixing comppadlist when compiling
5108
5109 =item Cleaning up exported namespace
5110
5111 =item Complete signal handling
5112
5113 =item Out-of-source builds
5114
5115 =item POSIX realtime support
5116
5117 =item UNIX98 support
5118
5119 =item IPv6 Support
5120
5121 =item Long double conversion
5122
5123 =item Locales
5124
5125 =item Arithmetic on non-Arabic numerals
5126
5127 =item POSIX Unicode character classes
5128
5129 =item Factoring out common suffices/prefices in regexps (trie optimization)
5130
5131 =item Security audit shipped utilities
5132
5133 =item Sort out the uid-setting mess
5134
5135 =item Custom opcodes
5136
5137 =item DLL Versioning
5138
5139 =item Introduce @( and @)
5140
5141 =item Floating point handling
5142
5143 =item IV/UV preservation
5144
5145 =item Replace pod2html with something using Pod::Parser
5146
5147 =item Automate module testing on CPAN
5148
5149 =item sendmsg and recvmsg
5150
5151 =item Rewrite perlre documentation
5152
5153 =item Convert example code to IO::Handle filehandles
5154
5155 =item Document Win32 choices
5156
5157 =item Check new modules
5158
5159 =item Make roffitall find pods and libs itself
5160
5161 =back
5162
5163 =item To do at some point
5164
5165 =over 4
5166
5167 =item Remove regular expression recursion
5168
5169 =item Memory leaks after failed eval
5170
5171 =item bitfields in pack
5172
5173 =item Cross compilation
5174
5175 =item Perl preprocessor / macros
5176
5177 =item Perl lexer in Perl
5178
5179 =item Using POSIX calls internally
5180
5181 =item -i rename file when changed
5182
5183 =item All ARGV input should act like E<lt>E<gt>
5184
5185 =item Support for rerunning debugger
5186
5187 =item Test Suite for the Debugger
5188
5189 =item my sub foo { }
5190
5191 =item One-pass global destruction
5192
5193 =item Rewrite regexp parser
5194
5195 =item Cache recently used regexps
5196
5197 =item Cross-compilation support
5198
5199 =item Bit-shifting bitvectors
5200
5201 =item debugger pragma
5202
5203 =item use less pragma
5204
5205 =item switch structures
5206
5207 =item Cache eval tree
5208
5209 =item rcatmaybe
5210
5211 =item Shrink opcode tables
5212
5213 =item Optimize away @_
5214
5215 =item Prototypes versus indirect objects
5216
5217 =item Install HTML
5218
5219 =item Prototype method calls
5220
5221 =item Return context prototype declarations
5222
5223 =item magic_setisa
5224
5225 =item Garbage collection
5226
5227 =item IO tutorial
5228
5229 =item Rewrite perldoc
5230
5231 =item Install .3p manpages
5232
5233 =item Unicode tutorial
5234
5235 =item Update POSIX.pm for 1003.1-2
5236
5237 =item Retargetable installation
5238
5239 =item POSIX emulation on non-POSIX systems
5240
5241 =item Rename Win32 headers
5242
5243 =item Finish off lvalue functions
5244
5245 =item Update sprintf documentation
5246
5247 =item Use fchown/fchmod internally
5248
5249 =item Make v-strings overloaded objects
5250
5251 =item Allow restricted hash assignment
5252
5253 =item Should overload be inheritable?
5254
5255 =item Taint rethink
5256
5257 =item Perform correctly when XSUBs call subroutines that exit via
5258 goto(LABEL) and friends
5259
5260 =back
5261
5262 =item Vague ideas
5263
5264 =over 4
5265
5266 =item ref() in list context
5267
5268 =item Make tr/// return histogram of characters in list context
5269
5270 =item Compile to real threaded code
5271
5272 =item Structured types
5273
5274 =item Modifiable $1 et al.
5275
5276 =item Procedural interfaces for IO::*, etc.
5277
5278 =item RPC modules
5279
5280 =item Attach/detach debugger from running program
5281
5282 =item GUI::Native
5283
5284 =item foreach(reverse ...)
5285
5286 =item Constant function cache
5287
5288 =item Approximate regular expression matching
5289
5290 =back
5291
5292 =item Ongoing
5293
5294 =over 4
5295
5296 =item Update guts documentation
5297
5298 =item Add more tests
5299
5300 =item Update auxiliary tools
5301
5302 =item Create debugging macros
5303
5304 =item truncate to the people
5305
5306 =item Unicode in Filenames
5307
5308 =back
5309
5310 =item Unicode in %ENV
5311
5312 =item Recently done things
5313
5314 =over 4
5315
5316 =item Alternative RE syntax module
5317
5318 =item Safe signal handling
5319
5320 =item Tie Modules
5321
5322 =item gettimeofday
5323
5324 =item setitimer and getimiter
5325
5326 =item Testing __DIE__ hook
5327
5328 =item CPP equivalent in Perl
5329
5330 =item Explicit switch statements
5331
5332 =item autocroak
5333
5334 =item UTF/EBCDIC
5335
5336 =item UTF Regexes
5337
5338 =item perlcc to produce executable
5339
5340 =item END blocks saved in compiled output
5341
5342 =item Secure temporary file module
5343
5344 =item Integrate Time::HiRes
5345
5346 =item Turn Cwd into XS
5347
5348 =item Mmap for input
5349
5350 =item Byte to/from UTF-8 and UTF-8 to/from local conversion
5351
5352 =item Add sockatmark support
5353
5354 =item Mailing list archives
5355
5356 =item Bug tracking
5357
5358 =item Integrate MacPerl
5359
5360 =item Web "nerve center" for Perl
5361
5362 =item Regular expression tutorial
5363
5364 =item Debugging Tutorial
5365
5366 =item Integrate new modules
5367
5368 =item Integrate profiler
5369
5370 =item Y2K error detection
5371
5372 =item Regular expression debugger
5373
5374 =item POD checker
5375
5376 =item "Dynamic" lexicals
5377
5378 =item Cache precompiled modules
5379
5380 =back
5381
5382 =item Deprecated Wishes
5383
5384 =over 4
5385
5386 =item Loop control on do{}
5387
5388 =item Lexically scoped typeglobs
5389
5390 =item format BOTTOM
5391
5392 =item report HANDLE
5393
5394 =item Generalised want()/caller())
5395
5396 =item Named prototypes
5397
5398 =item Built-in globbing
5399
5400 =item Regression tests for suidperl
5401
5402 =item Cached hash values
5403
5404 =item Add compression modules
5405
5406 =item Reorganise documentation into tutorials/references
5407
5408 =item Remove distinction between functions and operators
5409
5410 =item Make XS easier to use
5411
5412 =item Make embedding easier to use
5413
5414 =item man for perl
5415
5416 =item my $Package::variable
5417
5418 =item "or" tests defined, not truth
5419
5420 =item "class"-based lexicals
5421
5422 =item byteperl
5423
5424 =item Lazy evaluation / tail recursion removal
5425
5426 =item Make "use utf8" the default
5427
5428 =item Unicode collation and normalization
5429
5430 =item pack/unpack tutorial
5431
5432 =back
5433
5434 =back
5435
5436 =head2 perldoc - Look up Perl documentation in Pod format.
5437
5438 =over 4
5439
5440 =item SYNOPSIS
5441
5442 =item DESCRIPTION
5443
5444 =item OPTIONS
5445
5446 B<-h>, B<-v>, B<-t>, B<-u>, B<-m> I<module>, B<-l>, B<-F>, B<-f>
5447 I<perlfunc>, B<-q> I<perlfaq-search-regexp>, B<-T>, B<-d>
5448 I<destination-filename>, B<-o> I<output-formatname>, B<-M> I<module-name>,
5449 B<-w> I<option:value> or B<-w> I<option>, B<-X>,
5450 B<PageName|ModuleName|ProgramName>, B<-n> I<some-formatter>, B<-r>, B<-i>,
5451 B<-V>
5452
5453 =item SECURITY
5454
5455 =item ENVIRONMENT
5456
5457 =item AUTHOR
5458
5459 =back
5460
5461 =head2 perlhist - the Perl history records
5462
5463 =over 4
5464
5465 =item DESCRIPTION
5466
5467 =item INTRODUCTION
5468
5469 =item THE KEEPERS OF THE PUMPKIN
5470
5471 =over 4
5472
5473 =item PUMPKIN?
5474
5475 =back
5476
5477 =item THE RECORDS
5478
5479 =over 4
5480
5481 =item SELECTED RELEASE SIZES
5482
5483 =item SELECTED PATCH SIZES
5484
5485 =back
5486
5487 =item THE KEEPERS OF THE RECORDS
5488
5489 =back
5490
5491 =head2 perldelta - what is new for perl v5.9.0
5492
5493 =over 4
5494
5495 =item DESCRIPTION
5496
5497 =item Incompatible Changes
5498
5499 =over 4
5500
5501 =item Hash Randomisation
5502
5503 =item UTF-8 On Filehandles No Longer Activated By Locale
5504
5505 =item Single-number v-strings are no longer v-strings before "=>"
5506
5507 =item (Win32) The -C Switch Has Been Repurposed
5508
5509 =item (Win32) The /d Switch Of cmd.exe
5510
5511 =item The C<$*> variable has been removed
5512
5513 =back
5514
5515 =item Core Enhancements
5516
5517 =over 4
5518
5519 =item Assertions
5520
5521 =item Defined-or operators
5522
5523 =item UTF-8 no longer default under UTF-8 locales
5524
5525 =item Unsafe signals again available
5526
5527 =item Tied Arrays with Negative Array Indices
5528
5529 =item Tied hashes in scalar context
5530
5531 =item local ${$x}
5532
5533 =item Unicode Character Database 4.0.0
5534
5535 =item Miscellaneous Enhancements
5536
5537 =back
5538
5539 =item Modules and Pragmata
5540
5541 =over 4
5542
5543 =item Updated Modules And Pragmata
5544
5545 base, B::Bytecode, B::Concise, B::Deparse, Benchmark, ByteLoader, bytes,
5546 CGI, charnames, CPAN, Data::Dumper, DB_File, Devel::PPPort, Digest::MD5,
5547 Encode, fields, libnet, Math::BigInt, MIME::Base64, NEXT, Net::Ping,
5548 PerlIO::scalar, podlators, Pod::LaTeX, PodParsers, Pod::Perldoc,
5549 Scalar::Util, Storable, strict, Term::ANSIcolor, Test::Harness, Test::More,
5550 Test::Simple, Text::Balanced, Time::HiRes, threads, threads::shared,
5551 Unicode::Collate, Unicode::Normalize, Win32::GetFolderPath,
5552 Win32::GetOSVersion
5553
5554 =back
5555
5556 =item Utility Changes
5557
5558 =item New Documentation
5559
5560 =item Performance Enhancements
5561
5562 =item Installation and Configuration Improvements
5563
5564 =over 4
5565
5566 =item Platform-specific enhancements
5567
5568 =back
5569
5570 =item Selected Bug Fixes
5571
5572 =over 4
5573
5574 =item Closures, eval and lexicals
5575
5576 =item Generic fixes
5577
5578 =item Platform-specific fixes
5579
5580 =back
5581
5582 =item New or Changed Diagnostics
5583
5584 =over 4
5585
5586 =item Changed "A thread exited while %d threads were running"
5587
5588 =item Removed "Attempt to clear a restricted hash"
5589
5590 =item New "Illegal declaration of anonymous subroutine"
5591
5592 =item Changed "Invalid range "%s" in transliteration operator"
5593
5594 =item New "Missing control char name in \c"
5595
5596 =item New "Newline in left-justified string for %s"
5597
5598 =item New "Possible precedence problem on bitwise %c operator"
5599
5600 =item New "read() on %s filehandle %s"
5601
5602 =item New "Tied variable freed while still in use"
5603
5604 =item New "To%s: illegal mapping '%s'"
5605
5606 =item New "Use of freed value in iteration"
5607
5608 =back
5609
5610 =item Changed Internals
5611
5612 =item New Tests
5613
5614 =item Known Problems
5615
5616 =over 4
5617
5618 =item Net::Ping 450_service and 510_ping_udp failures
5619
5620 =item B::C
5621
5622 =back
5623
5624 =item Platform Specific Problems
5625
5626 =over 4
5627
5628 =item EBCDIC Platforms
5629
5630 =item Cygwin 1.5 problems
5631
5632 =item HP-UX: HP cc warnings about sendfile and sendpath
5633
5634 =item IRIX: t/uni/tr_7jis.t falsely failing
5635
5636 =item Mac OS X: no usemymalloc
5637
5638 =item Tru64: No threaded builds with GNU cc (gcc)
5639
5640 =item Win32: sysopen, sysread, syswrite
5641
5642 =back
5643
5644 =item TODO
5645
5646 =item Reporting Bugs
5647
5648 =item SEE ALSO
5649
5650 =back
5651
5652 =head2 perl58delta, perldelta - what is new for perl v5.8.0
5653
5654 =over 4
5655
5656 =item DESCRIPTION
5657
5658 =item Highlights In 5.8.0
5659
5660 =item Incompatible Changes
5661
5662 =over 4
5663
5664 =item Binary Incompatibility
5665
5666 =item 64-bit platforms and malloc
5667
5668 =item AIX Dynaloading
5669
5670 =item Attributes for C<my> variables now handled at run-time
5671
5672 =item Socket Extension Dynamic in VMS
5673
5674 =item IEEE-format Floating Point Default on OpenVMS Alpha
5675
5676 =item New Unicode Semantics (no more C<use utf8>, almost)
5677
5678 =item New Unicode Properties
5679
5680 =item REF(...) Instead Of SCALAR(...)
5681
5682 =item pack/unpack D/F recycled
5683
5684 =item glob() now returns filenames in alphabetical order
5685
5686 =item Deprecations
5687
5688 =back
5689
5690 =item Core Enhancements
5691
5692 =over 4
5693
5694 =item Unicode Overhaul
5695
5696 =item PerlIO is Now The Default
5697
5698 =item ithreads
5699
5700 =item Restricted Hashes
5701
5702 =item Safe Signals
5703
5704 =item Understanding of Numbers
5705
5706 =item Arrays now always interpolate into double-quoted strings [561]
5707
5708 =item Miscellaneous Changes
5709
5710 =back
5711
5712 =item Modules and Pragmata
5713
5714 =over 4
5715
5716 =item New Modules and Pragmata
5717
5718 =item Updated And Improved Modules and Pragmata
5719
5720 =back
5721
5722 =item Utility Changes
5723
5724 =item New Documentation
5725
5726 =item Performance Enhancements
5727
5728 =item Installation and Configuration Improvements
5729
5730 =over 4
5731
5732 =item Generic Improvements
5733
5734 =item New Or Improved Platforms
5735
5736 =back
5737
5738 =item Selected Bug Fixes
5739
5740 =over 4
5741
5742 =item Platform Specific Changes and Fixes
5743
5744 =back
5745
5746 =item New or Changed Diagnostics
5747
5748 =item Changed Internals
5749
5750 =item Security Vulnerability Closed [561]
5751
5752 =item New Tests
5753
5754 =item Known Problems
5755
5756 =over 4
5757
5758 =item The Compiler Suite Is Still Very Experimental
5759
5760 =item Localising Tied Arrays and Hashes Is Broken
5761
5762 =item Building Extensions Can Fail Because Of Largefiles
5763
5764 =item Modifying $_ Inside for(..)
5765
5766 =item mod_perl 1.26 Doesn't Build With Threaded Perl
5767
5768 =item lib/ftmp-security tests warn 'system possibly insecure'
5769
5770 =item libwww-perl (LWP) fails base/date #51
5771
5772 =item PDL failing some tests
5773
5774 =item Perl_get_sv
5775
5776 =item Self-tying Problems
5777
5778 =item ext/threads/t/libc
5779
5780 =item Failure of Thread (5.005-style) tests
5781
5782 =item Timing problems
5783
5784 =item Tied/Magical Array/Hash Elements Do Not Autovivify
5785
5786 =item Unicode in package/class and subroutine names does not work
5787
5788 =back
5789
5790 =item Platform Specific Problems
5791
5792 =over 4
5793
5794 =item AIX
5795
5796 =item Alpha systems with old gccs fail several tests
5797
5798 =item AmigaOS
5799
5800 =item BeOS
5801
5802 =item Cygwin "unable to remap"
5803
5804 =item Cygwin ndbm tests fail on FAT
5805
5806 =item DJGPP Failures
5807
5808 =item FreeBSD built with ithreads coredumps reading large directories
5809
5810 =item FreeBSD Failing locale Test 117 For ISO 8859-15 Locales
5811
5812 =item IRIX fails ext/List/Util/t/shuffle.t or Digest::MD5
5813
5814 =item HP-UX lib/posix Subtest 9 Fails When LP64-Configured
5815
5816 =item Linux with glibc 2.2.5 fails t/op/int subtest #6 with -Duse64bitint
5817
5818 =item Linux With Sfio Fails op/misc Test 48
5819
5820 =item Mac OS X
5821
5822 =item Mac OS X dyld undefined symbols
5823
5824 =item OS/2 Test Failures
5825
5826 =item op/sprintf tests 91, 129, and 130
5827
5828 =item SCO
5829
5830 =item Solaris 2.5
5831
5832 =item Solaris x86 Fails Tests With -Duse64bitint
5833
5834 =item SUPER-UX (NEC SX)
5835
5836 =item Term::ReadKey not working on Win32
5837
5838 =item UNICOS/mk
5839
5840 =item UTS
5841
5842 =item VOS (Stratus)