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