update
[urisagit/Perl-Docs.git] / perlblurb
1 This document gives a short blurb about each of the Perl documents and
2 document groups. It is meant to make it easier to locate which document
3 cover areas of interest to you. You can print any of these documents by
4 running the command 'perldoc <docname> on a terminal or console
5 window. <docname> is the name before each blurb. You can also read and
6 search then at http://perldoc.perl.org.
7
8
9 Overview
10
11 These documents provide an overview of all the Perl documents and an
12 introduction to Perl.
13
14 perl
15
16 This document has a brief description of the Perl language and has a
17 list of all the Perl documents with a one line description of each
18 one. perlblurb has the same list with longer descriptions.
19
20 perlmetadoc
21
22 This document shows how to find and use the set of Perl documents. It
23 covers the installing and finding the Perl documentation, the various
24 types of documents, and tips and tools on how to best read the documents.
25
26 perlblurb
27
28 This document is based on the 'perl' document but has longer
29 descriptions for each document. You are reading it now.
30
31 perltoc
32
33 This is an automatically generated document and it contains all the
34 document section headers. It is in outline form and it is best searched
35 as it is very long. It is useful to find which features are covered in a
36 Perl document.
37
38 perlintro
39
40 This is a introduction to the Perl language for newcomers. It covers the
41 basics of syntax, variables, scoping, flow control, operators, I/O,
42 regular expressions and objects. It is a very good first read for anyone
43 who is learning Perl.
44
45 Tutorials
46
47 The documentation for Perl has a set of tutorials on a wide range of
48 topics. Pretty much any topic where you would want more explanation then
49 the reference documents will be covered in one of these.
50
51 perlreftut
52
53 Perl references are the way you build up data structures and manage
54 dynamic information. This tutorial shows you how to create references
55 and to access the data to which they refer. After reading this you
56 should be able to do basic coding with references and build up your own
57 data structures.
58
59 perllol
60
61 This tutorial focuses on how to build and use an array of array data
62 structure. It shows several ways to build them and also how to access
63 their elements and print them out. It is a companion to perlreftut and
64 perldsc.
65
66 perldsc
67
68 This tutorial covers how to create and access Perl data structures. It
69 is more in depth that perlreftut and perllol and has many code examples
70 which cover all the two level structures of hashes and arrays. Examples
71 show both the declaration and initialization of data structures and also
72 how to build them up with code.
73
74 perlrequick
75
76 This is a quick start guide to Perl's regular expressions. It covers the
77 basics of matching strings, regex metacharacters, character class, and
78 more. It also covers the Perl operators and functions which use
79 regexes. It is a very good read when you are first learning regular
80 expressions.
81
82 perlretut
83
84 This tutorial covers how to use Perl's regular expressions. It is more
85 in depth than perlrequick and covers more topics. When you are ready,
86 you can then read perlre which is the full regular expression manual.
87
88
89 Object Oriented Perl Tutorials
90
91 These next documents are all tutorials on how to do object oriented
92 programmin in Perl. They cover all the needed topics so you can create
93 you own classes, methods and objects. Read the full reference manuals perlobj
94 and perlmod next to get all the details. Note that there are many
95 modules on CPAN that help with OO coding. Ask someone in the Perl
96 community for more about that.
97
98 perlboot
99
100 This tutorial shows step by step how to create a class, methods in a
101 class and how to call those methods. It also covers basic ways to code
102 up constructors which create objects. Before reading this you should
103 know how to write and call Perl subroutines, use references and know
104 your basic Perl syntax and data types.
105
106 perltoot
107
108 This is another tutorial which covers how to code up classes and make
109 object oriented code. It take a different approach than perlboot and
110 makes a good companion read to that tutorial.
111
112 perltooc
113
114 This tutorial covers how to make class level data when coding object
115 oriented Perl. This is data that is private and static to the class but
116 can be accesses by all the methods of the class.
117
118 perlbot
119
120 This is a 'bag of tricks' to help you when coding up object oriented
121 Perl. It augments what is already covered in perlboot, perltoot and
122 perltooc.
123
124         perlstyle           Perl style guide
125
126         perlcheat           Perl cheat sheet
127         perltrap            Perl traps for the unwary
128         perldebtut          Perl debugging tutorial
129
130 perlfaq
131
132 This is an overview of the full Perl FAQ (Frequently Asked
133 Questions). It covers where to find it, how to contribute to it and its
134 authors. The main section is a complete list of all the questions of the
135 9 sections of the FAQ. Reading and searching this will help you find 
136 questions related to your needs and which FAQ section has the answers.
137
138 perlfaq1
139
140 The first FAQ section covers general information about Perl. It covers
141 how Perl came to be, who supports it now, some comparisons to other
142 languages, when and when not to use Perl and other related
143 topics. Newcomers to Perl should read this entire section as it will
144 help them out with understanding of where Perl fits in the programming
145 world.
146
147 perlfaq2
148
149 The second FAQ section covers how to get Perl installed on your system
150 and locations where you can learn more about programming in Perl. These
151 include usenet, mailing lists, periodicals, books, web sites and
152 more. If you are looking to learn Perl, this is a good document to read.
153
154 perlfaq3          Programming Tools
155
156
157 perlfaq4          Data Manipulation
158 perlfaq5          Files and Formats
159 perlfaq6          Regexes
160 perlfaq7          Perl Language Issues
161 perlfaq8          System Interaction
162 perlfaq9          Networking
163
164 Reference Manuals
165
166 These documents are the full reference manuals for the Perl
167 language. They are divided up into topics and each one covers that topic
168 completely. They are dense and full of information so if you have
169 trouble with something, see if there is a related tutorial on it. Each
170 blurb will link to those tutorials.
171
172         perlsyn             Perl syntax
173         perldata            Perl data structures
174         perlop              Perl operators and precedence
175         perlsub             Perl subroutines
176         perlfunc            Perl built-in functions
177           perlopentut       Perl open() tutorial
178           perlpacktut       Perl pack() and unpack() tutorial
179         perlpod             Perl plain old documentation
180         perlpodspec         Perl plain old documentation format specification
181         perlrun             Perl execution and options
182         perldiag            Perl diagnostic messages
183         perllexwarn         Perl warnings and their control
184         perldebug           Perl debugging
185         perlvar             Perl predefined variables
186         perlre              Perl regular expressions, the rest of the story
187         perlrebackslash     Perl regular expression backslash sequences
188         perlrecharclass     Perl regular expression character classes
189         perlreref           Perl regular expressions quick reference
190         perlref             Perl references, the rest of the story
191         perlform            Perl formats
192         perlobj             Perl objects
193
194 perltie
195
196 Tying is a way to replace all or part of the behavior of a basic Perl
197 variable with your own code. You can write a class that can be a scalar,
198 array or hash variable and the user will just see a normal variable with
199 your new logic behind it. This document covers all you need to know on
200 how to tie a variable to a class.
201
202           perldbmfilter     Perl DBM filters
203
204         perlipc             Perl interprocess communication
205         perlfork            Perl fork() information
206         perlnumber          Perl number semantics
207
208         perlthrtut          Perl threads tutorial
209           perlothrtut       Old Perl threads tutorial
210
211         perlport            Perl portability guide
212         perllocale          Perl locale support
213         perluniintro        Perl Unicode introduction
214         perlunicode         Perl Unicode support
215         perlunifaq          Perl Unicode FAQ
216         perlunitut          Perl Unicode tutorial
217         perlebcdic          Considerations for running Perl on EBCDIC platforms
218
219         perlsec             Perl security
220
221         perlmod             Perl modules: how they work
222         perlmodlib          Perl modules: how to write and use
223         perlmodstyle        Perl modules: how to write modules with style
224         perlmodinstall      Perl modules: how to install from CPAN
225         perlnewmod          Perl modules: preparing a new module for distribution
226         perlpragma          Perl modules: writing a user pragma
227
228         perlutil            utilities packaged with the Perl distribution
229
230         perlcompile         Perl compiler suite intro
231
232         perlfilter          Perl source filters
233
234         perlglossary        Perl Glossary
235
236   Internals and C Language Interface
237         perlembed           Perl ways to embed perl in your C or C++ application
238         perldebguts         Perl debugging guts and tips
239         perlxstut           Perl XS tutorial
240         perlxs              Perl XS application programming interface
241         perlclib            Internal replacements for standard C library functions
242         perlguts            Perl internal functions for those doing extensions
243         perlcall            Perl calling conventions from C
244         perlreapi           Perl regular expression plugin interface
245         perlreguts          Perl regular expression engine internals
246
247         perlapi             Perl API listing (autogenerated)
248         perlintern          Perl internal functions (autogenerated)
249         perliol             C API for Perl's implementation of IO in Layers
250         perlapio            Perl internal IO abstraction interface
251
252         perlhack            Perl hackers guide
253
254   Miscellaneous
255         perlbook            Perl book information
256         perlcommunity       Perl community information
257         perltodo            Perl things to do
258
259         perldoc             Look up Perl documentation in Pod format
260
261
262 perlhist
263
264 This has listings of all the released versions of Perl with information
265 on who was the 'pumpking' (the source control manager), dates, etc. It
266 is of interest to those who want to see how Perl has been managed over
267 its history.
268
269 These 'delta' documents cover all the changes in Perl between each
270 released version. It is very useful to find out in which version a new
271 feature first appeared and also when some have been deprecated and/or
272 removed.
273
274         perldelta           Perl changes since previous version
275         perl595delta        Perl changes in version 5.9.5
276         perl594delta        Perl changes in version 5.9.4
277         perl593delta        Perl changes in version 5.9.3
278         perl592delta        Perl changes in version 5.9.2
279         perl591delta        Perl changes in version 5.9.1
280         perl590delta        Perl changes in version 5.9.0
281         perl588delta        Perl changes in version 5.8.8
282         perl587delta        Perl changes in version 5.8.7
283         perl586delta        Perl changes in version 5.8.6
284         perl585delta        Perl changes in version 5.8.5
285         perl584delta        Perl changes in version 5.8.4
286         perl583delta        Perl changes in version 5.8.3
287         perl582delta        Perl changes in version 5.8.2
288         perl581delta        Perl changes in version 5.8.1
289         perl58delta         Perl changes in version 5.8.0
290         perl573delta        Perl changes in version 5.7.3
291         perl572delta        Perl changes in version 5.7.2
292         perl571delta        Perl changes in version 5.7.1
293         perl570delta        Perl changes in version 5.7.0
294         perl561delta        Perl changes in version 5.6.1
295         perl56delta         Perl changes in version 5.6
296         perl5005delta       Perl changes in version 5.005
297         perl5004delta       Perl changes in version 5.004
298
299         perlartistic        Perl Artistic License
300         perlgpl             GNU General Public License
301
302 Language-Specific
303
304 These documents cover the issues when coding Perl with asian character
305 sets.
306
307         perlcn              Perl for Simplified Chinese (in EUC-CN)
308         perljp              Perl for Japanese (in EUC-JP)
309         perlko              Perl for Korean (in EUC-KR)
310         perltw              Perl for Traditional Chinese (in Big5)
311
312 Platform-Specific
313
314 These documents contain notes pertaining to specific platforms where
315 Perl is supported. Each document may cover issues such as building Perl
316 on that platform, file name differences, forking issues, and more. Read
317 the document for your platform to find out if you need to be aware of
318 special issues.
319
320         perlaix             Perl notes for AIX
321         perlamiga           Perl notes for AmigaOS
322         perlapollo          Perl notes for Apollo DomainOS
323         perlbeos            Perl notes for BeOS
324         perlbs2000          Perl notes for POSIX-BC BS2000
325         perlce              Perl notes for WinCE
326         perlcygwin          Perl notes for Cygwin
327         perldgux            Perl notes for DG/UX
328         perldos             Perl notes for DOS
329         perlepoc            Perl notes for EPOC
330         perlfreebsd         Perl notes for FreeBSD
331         perlhpux            Perl notes for HP-UX
332         perlhurd            Perl notes for Hurd
333         perlirix            Perl notes for Irix
334         perllinux           Perl notes for Linux
335         perlmachten         Perl notes for Power MachTen
336         perlmacos           Perl notes for Mac OS (Classic)
337         perlmacosx          Perl notes for Mac OS X
338         perlmint            Perl notes for MiNT
339         perlmpeix           Perl notes for MPE/iX
340         perlnetware         Perl notes for NetWare
341         perlopenbsd         Perl notes for OpenBSD
342         perlos2             Perl notes for OS/2
343         perlos390           Perl notes for OS/390
344         perlos400           Perl notes for OS/400
345         perlplan9           Perl notes for Plan 9
346         perlqnx             Perl notes for QNX
347         perlriscos          Perl notes for RISC OS
348         perlsolaris         Perl notes for Solaris
349         perlsymbian         Perl notes for Symbian
350         perltru64           Perl notes for Tru64
351         perluts             Perl notes for UTS
352         perlvmesa           Perl notes for VM/ESA
353         perlvms             Perl notes for VMS
354         perlvos             Perl notes for Stratus VOS
355         perlwin32           Perl notes for Windows