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