| blob | ca3bae94cbb14d4007ea43a553d8ca1cd4086d0c |
1 =head Perl 5's pods in the Perl6::Doc tree
3 $$$ denotes the slot in which Perl 6 documents which Perl 5 did not have fit in
5 This tree should be cloned and then refactored/replaced/filled in for Perl 6's
6 documentation tree.
9 perl.pod - Practical Extraction and Report Language
11 # how to use the doc
12 perldoc.pod - Look up Perl documentation in Pod format.
14 # except different
15 Toc - perltoc.pod - perl documentation table of contents
17 Deployment
18 perlcompile.pod - Introduction to the Perl Compiler-Translator
19 Tools
20 perlrun.pod - how to execute the Perl interpreter
21 perlutil.pod - utilities packaged with the Perl distribution
22 History
23 perlhist.pod - the Perl history records
24 Changes
25 perldelta.pod - what is new for perl 5.10.0
26 perl5004delta.pod - what's new for perl5.004
27 perl5005delta.pod - what's new for perl5.005
28 perl561delta.pod - what's new for perl v5.6.x
29 perl56delta.pod - what's new for perl v5.6.0
30 perl570delta.pod - what's new for perl v5.7.0
31 perl571delta.pod - what's new for perl v5.7.1
32 perl572delta.pod - what's new for perl v5.7.2
33 perl573delta.pod - what's new for perl v5.7.3
34 perl581delta.pod - what is new for perl v5.8.1
35 perl582delta.pod - what is new for perl v5.8.2
36 perl583delta.pod - what is new for perl v5.8.3
37 perl584delta.pod - what is new for perl v5.8.4
38 perl585delta.pod - what is new for perl v5.8.5
39 perl586delta.pod - what is new for perl v5.8.6
40 perl58delta.pod - what is new for perl v5.8.0
41 Attic
42 $$$ RFCs
43 $$$ Apocalypses
44 $$$ Exegesis
45 Portability
46 perlport.pod - Writing portable Perl
47 perlebcdic.pod - Considerations for running Perl on EBCDIC platforms
48 Platforms
49 perlaix.pod - README.aix - Perl version 5 on IBM Unix (AIX) systems
50 perlamiga.pod - Perl under Amiga OS
51 perlapollo.pod - README.apollo - Perl version 5 on Apollo DomainOS
52 perlbs2000.pod - README.BS2000 - building and installing Perl for BS2000.
53 perlbeos.pod - README.beos - Perl version 5.8+ on BeOS
54 perlce.pod - Perl for WinCE
55 perldos.pod - Perl under DOS, W31, W95.
56 perlepoc.pod - README.epoc - Perl for EPOC
57 perlfreebsd.pod - README.freebsd - Perl version 5 on FreeBSD systems
58 perldgux.pod - Perl under DG/UX.
59 perlcygwin.pod - README.cygwin - Perl for Cygwin
60 perlhpux.pod - README.hpux - Perl version 5 on Hewlett-Packard Unix (HP-UX) systems
61 perlhurd.pod - README.hurd - Perl version 5 on Hurd
62 perlirix.pod - README.irix - Perl version 5 on Irix systems
63 perlmachten.pod - README.machten - Perl version 5 on Power MachTen systems
64 perlmacos.pod - README.macos - Perl under Mac OS (Classic)
65 perlmacosx.pod - README.macosx - Perl under Mac OS X
66 perlmint.pod - README.mint - Perl version 5 on Atari MiNT
67 perlmpeix.pod - README.mpeix - Perl/iX for HP e3000 MPE
68 perlnetware.pod - Perl for NetWare
69 perlos2.pod - Perl under OS/2, DOS, Win0.3*, Win0.95 and WinNT.
70 perlos390.pod - README.os390 - building and installing Perl for OS/390 and z/OS
71 perlos400.pod - README.os400 - Perl version 5 on OS/400
72 perlqnx.pod - README.qnx - Perl version 5 on QNX
73 perlplan9.pod - Plan 9-specific documentation for Perl
74 perlsolaris.pod - README.solaris - Perl version 5 on Solaris systems
75 perltru64.pod - README.tru64 - Perl version 5 on Tru64 (formerly known as Digital UNIX formerly known as DEC OSF/1) systems
76 perluts.pod - Perl under UTS
77 perlvmesa.pod - README.vmesa - building and installing Perl for VM/ESA.
78 perlvms.pod - README.vms - Configuring, building, testing, and installing perl on VMS
79 perlvos.pod - README.vos - Perl for Stratus VOS
80 perlwin32.pod - Perl under Windows
81 Internationalization
82 perlcn.pod - Chinese
83 perljp.pod - Japanese
84 perlko.pod - Korean
85 perltw.pod - Taiwanese
86 perllocale.pod - Perl locale handling (internationalization and localization)
87 API
88 # these are the programmatic APIs - one layer under the language specification
89 Historical
90 # these will actually be gone by Perl 6 time
91 perlapi.pod - autogenerated documentation for the perl public API
92 perlapio.pod - perl's IO abstraction interface.
93 perldebguts.pod - Guts of Perl debugging
94 perlfilter.pod - Source Filters
95 perltie.pod - how to hide an object class in a simple variable
96 perliol.pod - C API for Perl's implementation of IO in Layers.
97 ### THE REST OF API IS A WORKING DRAFT ###
98 Object Space
99 Prototype/MMD core calculus
100 AST
101 The parse tree of the Perl 6 Grammar - optimized for data retention
102 The AST of Perl expressions ( the parse tree with no annotations and some simplifications - what you get from CODE { } - optimized for transformation (macro processing) )
103 The intermediate core calculus - optimized for simplicity
104 The Perl 6 Grammar
105 Core rules
106 Grammatical categories & Magic Hash core defs
107 Structures and stuff (blockish things, etc)
108 Prelude - Reference Implementations
109 The Standard Macros
110 Object Oriented
111 The class metamodel, declarative syntax
112 single method dispatch
113 Scaffolding
114 use, etc
115 ...
116 Misc Sugar
117 ...
118 The Standard Classes and Roles
119 Core Types ( Str, Num, Int etc )
120 Container Types ( Scalar, Array, Hash )
121 Range, etc
122 ...?
123 The Standard Functions
124 ... in modules?
125 Math
126 String
127 Data Structure Functor things
128 Control Flow Structures
129 (Gather/Take, etc)
130 Resource Allocation and Reclaiming
131 Data Finalization Requirement Declarations
132 Hints # like: this will not need to be finalized until much later, or these are related, or blah blah blah - to help the GC be faster
133 Scope related
134 Data
135 Debugging Hooks
136 # FIXME: model after Devel::ebug? We can get acme to do this part for us
137 Interfaces
138 http
139 command line
140 IDE hooks (the way every IDE in the world knows to talk to gdb?)
141 Programmatic Debugging & Profiling
142 Breakpoint annotations for ASTs
143 Tracing execution
144 Sandbox environments based on filters
145 ## note - try to provide enough hooks for an aspect oriented programming addon to be easy
146 Rule Suppport
147 The DSL Grammar Extension
148 The grammar for the grammar sub language
149 AST
150 The parse tree - data retention
151 Expression tree - optimized for transformation
152 Performance Optimized - An AST with some new node types, like Trie for alternative compilation, etc - performance only reordering/rewriting yields this
153 The Evaluator API
154 The Match object
155 Parse::Rules derived execution API
156 Compiler
157 Parser
158 Linker
159 Generic Optimizers
160 Pre linktime
161 Dead Code eliminator
162 Constant Folder
163 Type Annotation simplification
164 Multimethod Specializer
165 Lexical Scope Flattenner - express lexical storage as stack-allocation-oriented instead of heap-allocation-oriented - for values which can never leave a function
166 Post linktime
167 Auto Closer - Analyze for oppertunistic closing of classes
168 Type Annotation Specializer
169 Multimethod Specializer
170 Symbol Prebinder (lexical symbols, and closed packages)
171 Inliner (assumes prebinding)
172 Backend Specific Optimizers
173 Parrot
174 Branch Prediction Annotation/Guessing
175 Code Simplificationperllexwarn.pod -
176 Licencing
177 perlartistic.pod - the Perl Artistic License
178 perlgpl.pod - the GNU General Public License, version 2
179 Tutorials
180 ObjectOriented
181 perlboot.pod - Beginner's Object-Oriented Tutorial
182 perltooc.pod - Tom's OO Tutorial for Class Data in Perl
183 perltoot.pod - Tom's object-oriented tutorial for perl
184 Debugging
185 perldebtut.pod - Perl debugging tutorial
186 DataStructures
187 perldsc.pod - Perl Data Structures Cookbook
188 perllol.pod - Manipulating Arrays of Arrays in Perl
189 Modules
190 perlmodinstall.pod - Installing CPAN Modules # how to install
191 perlmod.pod - Perl modules (packages and symbol tables) # how to write
192 perlmodlib.pod - constructing new Perl modules and finding existing ones # wtf are modules anyway
193 perlmodstyle.pod - Perl module style guide
194 perlnewmod.pod - preparing a new module for distribution # end to end for writing
195 Functions
196 perlpacktut.pod - tutorial on "pack" and "unpack"
197 perlopentut.pod - tutorial on opening things in Perl
198 PlatformSpecific
199 POSIX
200 perlipc.pod - Perl interprocess communication (signals, fifos, pipes, safe subprocesses, sockets, and semaphores)
201 Concurrency
202 perlothrtut.pod - old tutorial on threads in Perl
203 perlthrtut.pod - Tutorial on threads in Perl
204 Rules
205 perlre.pod - Perl regular expressions
206 perlref.pod - Perl references and nested data structures
207 perlreftut.pod - Mark's very short tutorial about references
208 perlretut.pod - Perl regular expressions tutorial
209 Security
210 perlsec.pod - Perl security
211 Internationalization
212 perluniintro.pod - Perl Unicode introduction
213 Internals # this is just for the "parrot" backend
214 perlembed.pod - how to embed perl in your C program
215 perlcall.pod - Perl calling conventions from C
216 perlguts.pod - Introduction to the Perl API
217 perlhack.pod - How to hack at the Perl internals
218 perlintern.pod - autogenerated documentation of purely
219 perlxs.pod - XS language reference manual
221 FAQ
222 perlfaq.pod - frequently asked questions about Perl
223 perlfaq1.pod - General Questions About Perl
224 perlfaq2.pod - Obtaining and Learning about Perl
225 perlfaq3.pod - Programming Tools
226 perlfaq4.pod - Data Manipulation
227 perlfaq5.pod - Files and Formats
228 perlfaq6.pod - Regular Expressions
229 perlfaq7.pod - General Perl Language Issues
230 perlfaq8.pod - System Interaction
231 perlfaq9.pod - Networking
233 Overview
234 perlcheat.pod - Perl 5 Cheat Sheet
235 perlintro.pod - perlintro -- a brief introduction and overview of Perl # is this really a tutorial
236 System
237 POSIX
238 perlfork.pod - Perl's fork() emulation
239 ObjectOriented
240 perlbot.pod - Bag'o Object Tricks (the BOT)
241 perlobj.pod - Perl objects
242 Extensibility/Internals
243 perlclib.pod - Internal replacements for standard C library functions
244 Language
245 perlvar.pod - Perl predefined variables
246 perlsub.pod - Perl subroutines
247 perldata.pod - Perl data types
248 perlnumber.pod - semantics of numbers and numeric operations in Perl
249 perlsyn.pod - Perl syntax
250 Debugging
251 perldebug.pod - Perl debugging
252 perldiag.pod - various Perl diagnostics
253 Builtins
254 perlop.pod - Perl operators and precedence
255 perlfunc.pod - Perl builtin functions
256 Rules
257 perlrequick.pod - Perl regular expressions quick start
258 perlreref.pod - Perl Regular Expressions Reference
259 Misc
260 perlstyle.pod - Perl style guide
261 perltrap.pod - Perl traps for the unwary
262 Spec
263 $$$ Synopses...
264 perlpod.pod - the Plain Old Documentation format
265 perlpodspec.pod - Plain Old Documentation: format specification and notes
266 perlunicode.pod - Unicode support in Perl
267 $$$ Type system
268 Misc
269 perltodo.pod - Perl TO-DO List
270 perlbook.pod - Perl book information
276 perldbmfilter.pod - Perl DBM Filters # GO AWAY!!!!!!!!!! This is incidentially an interface supported by all the storage backends of DB_File, SDBM_File, NDBM_File, GDBM_File, etc - but this is *NOT* the place
277 perlform.pod - Perl formats # this is now a module