This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
29342fb9f3f2c7ec2c9cc07e7e516e05edba201c
[perl5.git] / pod.lst
1 # O     - Header, omit from toc
2 # o     - Item, omit from toc
3 # I     - Header, include in toc
4 # r     - top level READMEs to be copied/symlinked
5 # a     - Item, for auxiliary documentation
6 # a     - Header for auxiliary documentation
7 # number - indent by
8
9 I Overview
10
11   perl                  Perl overview (this section)
12   perlintro             Perl introduction for beginners
13   perltoc               Perl documentation table of contents
14
15 I Tutorials
16
17   perlreftut            Perl references short introduction
18   perldsc               Perl data structures intro
19   perllol               Perl data structures: arrays of arrays
20
21   perlrequick           Perl regular expressions quick start
22   perlretut             Perl regular expressions tutorial
23
24   perlboot              Perl OO tutorial for beginners
25   perltoot              Perl OO tutorial, part 1
26   perltooc              Perl OO tutorial, part 2
27   perlbot               Perl OO tricks and examples
28
29   perlstyle             Perl style guide
30
31   perlcheat             Perl cheat sheet
32   perltrap              Perl traps for the unwary
33   perldebtut            Perl debugging tutorial
34
35   perlfaq               Perl frequently asked questions
36 2 perlfaq1              General Questions About Perl
37 2 perlfaq2              Obtaining and Learning about Perl
38 2 perlfaq3              Programming Tools
39 2 perlfaq4              Data Manipulation
40 2 perlfaq5              Files and Formats
41 2 perlfaq6              Regexes
42 2 perlfaq7              Perl Language Issues
43 2 perlfaq8              System Interaction
44 2 perlfaq9              Networking
45
46 I Reference Manual
47
48   perlsyn               Perl syntax
49   perldata              Perl data structures
50   perlop                Perl operators and precedence
51   perlsub               Perl subroutines
52   perlfunc              Perl built-in functions
53 2 perlopentut           Perl open() tutorial
54 2 perlpacktut           Perl pack() and unpack() tutorial
55   perlpod               Perl plain old documentation
56   perlpodspec           Perl plain old documentation format specification
57   perlrun               Perl execution and options
58   perldiag              Perl diagnostic messages
59   perllexwarn           Perl warnings and their control
60   perldebug             Perl debugging
61   perlvar               Perl predefined variables
62   perlre                Perl regular expressions, the rest of the story
63   perlreref             Perl regular expressions quick reference
64   perlref               Perl references, the rest of the story
65   perlform              Perl formats
66   perlobj               Perl objects
67   perltie               Perl objects hidden behind simple variables
68 2 perldbmfilter         Perl DBM filters
69
70   perlipc               Perl interprocess communication
71   perlfork              Perl fork() information
72   perlnumber            Perl number semantics
73
74   perlthrtut            Perl threads tutorial
75 2 perlothrtut           Old Perl threads tutorial
76
77   perlport              Perl portability guide
78   perllocale            Perl locale support
79   perluniintro          Perl Unicode introduction
80   perlunicode           Perl Unicode support
81   perlebcdic            Considerations for running Perl on EBCDIC platforms
82
83   perlsec               Perl security
84
85   perlmod               Perl modules: how they work
86   perlmodlib            Perl modules: how to write and use
87   perlmodstyle          Perl modules: how to write modules with style
88   perlmodinstall        Perl modules: how to install from CPAN
89   perlnewmod            Perl modules: preparing a new module for distribution
90
91   perlutil              utilities packaged with the Perl distribution
92
93   perlcompile           Perl compiler suite intro
94
95   perlfilter            Perl source filters
96
97 I Internals and C Language Interface
98
99   perlembed             Perl ways to embed perl in your C or C++ application
100   perldebguts           Perl debugging guts and tips
101   perlxstut             Perl XS tutorial
102   perlxs                Perl XS application programming interface
103   perlclib              Internal replacements for standard C library functions
104   perlguts              Perl internal functions for those doing extensions
105   perlcall              Perl calling conventions from C
106
107   perlapi               Perl API listing (autogenerated)
108   perlintern            Perl internal functions (autogenerated)
109   perliol               C API for Perl's implementation of IO in Layers
110   perlapio              Perl internal IO abstraction interface
111
112   perlhack              Perl hackers guide
113
114 I Miscellaneous
115
116   perlbook              Perl book information
117   perltodo              Perl things to do
118
119   perldoc               Look up Perl documentation in Pod format
120
121   perlhist              Perl history records
122   perldelta             Perl changes since previous version
123   perl58delta           Perl changes in version 5.8.0
124   perl573delta          Perl changes in version 5.7.3
125   perl572delta          Perl changes in version 5.7.2
126   perl571delta          Perl changes in version 5.7.1
127   perl570delta          Perl changes in version 5.7.0
128   perl561delta          Perl changes in version 5.6.1
129   perl56delta           Perl changes in version 5.6
130   perl5005delta         Perl changes in version 5.005
131   perl5004delta         Perl changes in version 5.004
132
133   perlartistic          Perl Artistic License
134   perlgpl               GNU General Public License
135
136 O Language-Specific
137
138 or perlcn               Perl for Simplified Chinese (in EUC-CN)
139 or perljp               Perl for Japanese (in EUC-JP)
140 or perlko               Perl for Korean (in EUC-KR)
141 or perltw               Perl for Traditional Chinese (in Big5)
142
143 I Platform-Specific
144
145 r perlaix               Perl notes for AIX
146 r perlamiga             Perl notes for AmigaOS
147 r perlapollo            Perl notes for Apollo DomainOS
148 r perlbeos              Perl notes for BeOS
149 r perlbs2000            Perl notes for POSIX-BC BS2000
150 r perlce                Perl notes for WinCE
151 r perlcygwin            Perl notes for Cygwin
152 r perldgux              Perl notes for DG/UX
153 r perldos               Perl notes for DOS
154 r perlepoc              Perl notes for EPOC
155 r perlfreebsd           Perl notes for FreeBSD
156 r perlhpux              Perl notes for HP-UX
157 r perlhurd              Perl notes for Hurd
158 r perlirix              Perl notes for Irix
159 r perlmachten           Perl notes for Power MachTen
160 r perlmacos             Perl notes for Mac OS (Classic)
161 r perlmacosx            Perl notes for Mac OS X
162 r perlmint              Perl notes for MiNT
163 r perlmpeix             Perl notes for MPE/iX
164 r perlnetware           Perl notes for NetWare
165 r perlos2               Perl notes for OS/2
166 r perlos390             Perl notes for OS/390
167 r perlos400             Perl notes for OS/400
168 r perlplan9             Perl notes for Plan 9
169 r perlqnx               Perl notes for QNX
170 r perlsolaris           Perl notes for Solaris
171 r perltru64             Perl notes for Tru64
172 r perluts               Perl notes for UTS
173 r perlvmesa             Perl notes for VM/ESA
174 r perlvms               Perl notes for VMS
175 r perlvos               Perl notes for Stratus VOS
176 r perlwin32             Perl notes for Windows
177
178 AO Auxiliary Documentation
179
180 ao a2p
181 ao c2ph
182 ao dprofpp
183 ao h2ph
184 ao h2xs
185 ao perlbug
186 ao perldoc
187 ao pl2pm
188 ao pod2html
189 ao pod2man
190 ao s2p
191 ao splain
192 ao xsubpp