This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlreapi.pod: Update RXf_SPLIT section
[perl5.git] / pod / perl.pod
index 6cd5ab4..fa0a7f9 100644 (file)
@@ -15,6 +15,8 @@ B<perl>       S<[ B<-sTtuUWX> ]>
        S<[ B<-i>[I<extension>] ]>
        S<[ [B<-e>|B<-E>] I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
 
+For more information on these options, you can run C<perldoc perlrun>.
+
 =head1 GETTING HELP
 
 The F<perldoc> program gives you access to all the documentation that comes
@@ -28,10 +30,29 @@ perldoc> to learn more things you can do with F<perldoc>.
 
 For ease of access, the Perl manual has been split up into several sections.
 
+=begin buildtoc
+
+# This section is parsed by Porting/pod_lib.pl for use by pod/buildtoc etc
+
+flag =g  perluniprops perlmodlib perlapi perlintern
+flag =go perltoc
+flag =ro perlcn perljp perlko perltw
+flag =   perlvms
+
+path perlfaq.*               cpan/perlfaq/lib/
+path perlglossary            cpan/perlfaq/lib/
+path perlxs(?:tut|typemap)?  dist/ExtUtils-ParseXS/lib/
+path perldoc                 cpan/Pod-Perldoc/lib/
+
+aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
+
+=end buildtoc
+
 =head2 Overview
 
     perl               Perl overview (this section)
     perlintro          Perl introduction for beginners
+    perlrun            Perl execution and options
     perltoc            Perl documentation table of contents
 
 =head2 Tutorials
@@ -43,10 +64,7 @@ For ease of access, the Perl manual has been split up into several sections.
     perlrequick        Perl regular expressions quick start
     perlretut          Perl regular expressions tutorial
 
-    perlboot           Perl OO tutorial for beginners
-    perltoot           Perl OO tutorial, part 1
-    perltooc           Perl OO tutorial, part 2
-    perlbot            Perl OO tricks and examples
+    perlootut          Perl OO tutorial for beginners
 
     perlperf           Perl Performance and Optimization Techniques
 
@@ -79,7 +97,6 @@ For ease of access, the Perl manual has been split up into several sections.
     perlpod            Perl plain old documentation
     perlpodspec        Perl plain old documentation format specification
     perlpodstyle       Perl POD style guide
-    perlrun            Perl execution and options
     perldiag           Perl diagnostic messages
     perllexwarn        Perl warnings and their control
     perldebug          Perl debugging
@@ -105,7 +122,7 @@ For ease of access, the Perl manual has been split up into several sections.
     perluniintro       Perl Unicode introduction
     perlunicode        Perl Unicode support
     perlunifaq         Perl Unicode FAQ
-    perluniprops       Index of Unicode Version 6.0.0 properties in Perl
+    perluniprops       Index of Unicode properties in Perl
     perlunitut         Perl Unicode tutorial
     perlebcdic         Considerations for running Perl on EBCDIC platforms
 
@@ -120,10 +137,10 @@ For ease of access, the Perl manual has been split up into several sections.
 
     perlutil           utilities packaged with the Perl distribution
 
-    perlcompile        Perl compiler suite intro
-
     perlfilter         Perl source filters
 
+    perldtrace         Perl's support for DTrace
+
     perlglossary       Perl Glossary
 
 =head2 Internals and C Language Interface
@@ -132,6 +149,7 @@ For ease of access, the Perl manual has been split up into several sections.
     perldebguts        Perl debugging guts and tips
     perlxstut          Perl XS tutorial
     perlxs             Perl XS application programming interface
+    perlxstypemap      Perl XS C/Perl type conversion tools
     perlclib           Internal replacements for standard C library functions
     perlguts           Perl internal functions for those doing extensions
     perlcall           Perl calling conventions from C
@@ -145,45 +163,39 @@ For ease of access, the Perl manual has been split up into several sections.
     perlapio           Perl internal IO abstraction interface
 
     perlhack           Perl hackers guide
+    perlsource         Guide to the Perl source tree
+    perlinterp         Overview of the Perl interpreter source and how it works
+    perlhacktut        Walk through the creation of a simple C code patch
+    perlhacktips       Tips for Perl core C code hacking
     perlpolicy         Perl development policies
-    perlrepository     Perl source repository
+    perlgit            Using git with the Perl repository
 
 =head2 Miscellaneous
 
     perlbook           Perl book information
     perlcommunity      Perl community information
-    perltodo           Perl things to do
 
     perldoc            Look up Perl documentation in Pod format
 
     perlhist           Perl history records
     perldelta          Perl changes since previous version
-    perl5138delta      Perl changes in version 5.13.8
-    perl5137delta      Perl changes in version 5.13.7
-    perl5136delta      Perl changes in version 5.13.6
-    perl5135delta      Perl changes in version 5.13.5
-    perl5134delta      Perl changes in version 5.13.4
-    perl5133delta      Perl changes in version 5.13.3
-    perl5132delta      Perl changes in version 5.13.2
-    perl5131delta      Perl changes in version 5.13.1
-    perl5130delta      Perl changes in version 5.13.0
+    perl5174delta      Perl changes in version 5.17.4
+    perl5173delta      Perl changes in version 5.17.3
+    perl5172delta      Perl changes in version 5.17.2
+    perl5171delta      Perl changes in version 5.17.1
+    perl5170delta      Perl changes in version 5.17.0
+    perl5161delta      Perl changes in version 5.16.1
+    perl5160delta      Perl changes in version 5.16.0
+    perl5142delta      Perl changes in version 5.14.2
+    perl5141delta      Perl changes in version 5.14.1
+    perl5140delta      Perl changes in version 5.14.0
+    perl5124delta      Perl changes in version 5.12.4
+    perl5123delta      Perl changes in version 5.12.3
     perl5122delta      Perl changes in version 5.12.2
     perl5121delta      Perl changes in version 5.12.1
     perl5120delta      Perl changes in version 5.12.0
-    perl5115delta      Perl changes in version 5.11.5
-    perl5114delta      Perl changes in version 5.11.4
-    perl5113delta      Perl changes in version 5.11.3
-    perl5112delta      Perl changes in version 5.11.2
-    perl5111delta      Perl changes in version 5.11.1
-    perl5110delta      Perl changes in version 5.11.0
     perl5101delta      Perl changes in version 5.10.1
     perl5100delta      Perl changes in version 5.10.0
-    perl595delta       Perl changes in version 5.9.5
-    perl594delta       Perl changes in version 5.9.4
-    perl593delta       Perl changes in version 5.9.3
-    perl592delta       Perl changes in version 5.9.2
-    perl591delta       Perl changes in version 5.9.1
-    perl590delta       Perl changes in version 5.9.0
     perl589delta       Perl changes in version 5.8.9
     perl588delta       Perl changes in version 5.8.8
     perl587delta       Perl changes in version 5.8.7
@@ -194,20 +206,20 @@ For ease of access, the Perl manual has been split up into several sections.
     perl582delta       Perl changes in version 5.8.2
     perl581delta       Perl changes in version 5.8.1
     perl58delta        Perl changes in version 5.8.0
-    perl573delta       Perl changes in version 5.7.3
-    perl572delta       Perl changes in version 5.7.2
-    perl571delta       Perl changes in version 5.7.1
-    perl570delta       Perl changes in version 5.7.0
     perl561delta       Perl changes in version 5.6.1
     perl56delta        Perl changes in version 5.6
     perl5005delta      Perl changes in version 5.005
     perl5004delta      Perl changes in version 5.004
 
+    perlexperiment     A listing of experimental features in Perl
+
     perlartistic       Perl Artistic License
     perlgpl            GNU General Public License
 
 =head2 Language-Specific
 
+=for buildtoc flag +r
+
     perlcn             Perl for Simplified Chinese (in EUC-CN)
     perljp             Perl for Japanese (in EUC-JP)
     perlko             Perl for Korean (in EUC-KR)
@@ -232,7 +244,6 @@ For ease of access, the Perl manual has been split up into several sections.
     perllinux          Perl notes for Linux
     perlmacos          Perl notes for Mac OS (Classic)
     perlmacosx         Perl notes for Mac OS X
-    perlmpeix          Perl notes for MPE/iX
     perlnetware        Perl notes for NetWare
     perlopenbsd        Perl notes for OpenBSD
     perlos2            Perl notes for OS/2
@@ -244,12 +255,21 @@ For ease of access, the Perl manual has been split up into several sections.
     perlsolaris        Perl notes for Solaris
     perlsymbian        Perl notes for Symbian
     perltru64          Perl notes for Tru64
-    perluts            Perl notes for UTS
-    perlvmesa          Perl notes for VM/ESA
     perlvms            Perl notes for VMS
     perlvos            Perl notes for Stratus VOS
     perlwin32          Perl notes for Windows
 
+=for buildtoc flag -r
+
+=head2 Stubs for Deleted Documents
+
+    perlboot           
+    perlbot            
+    perltodo
+    perltooc           
+    perltoot           
+
+=for buildtoc __END__
 
 On a Unix-like system, these documentation files will usually also be
 available as manpages for use with the F<man> program.
@@ -267,7 +287,7 @@ Perl was originally a language optimized for scanning arbitrary
 text files, extracting information from those text files, and printing
 reports based on that information.  It quickly became a good language
 for many system management tasks. Over the years, Perl has grown into
-a general-purpose progammming language. It's widely used for everything
+a general-purpose programming language. It's widely used for everything
 from quick "one-liners" to full-scale application development.
 
 The language is intended to be practical (easy to use, efficient,
@@ -305,8 +325,8 @@ Described in L<perlmod>, L<perlmodlib>, and L<perlmodinstall>.
 
 embeddable and extensible 
 
-Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlcall>,
-L<perlguts>, and L<xsubpp>.
+Described in L<perlembed>, L<perlxstut>, L<perlxs>, L<perlxstypemap>,
+L<perlcall>, L<perlguts>, and L<xsubpp>.
 
 =item *
 
@@ -331,8 +351,7 @@ Described in L<perlreftut>, L<perlref>, L<perldsc>, and L<perllol>.
 
 object-oriented programming
 
-Described in L<perlobj>, L<perlboot>, L<perltoot>, L<perltooc>,
-and L<perlbot>.
+Described in L<perlobj> and L<perlootut>.
 
 =item *