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