This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix the phrasing of the previous patch.
[perl5.git] / pod / perl.pod
index 94a6aaa..11dba98 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,8 +137,6 @@ 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
@@ -134,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
@@ -158,46 +174,31 @@ For ease of access, the Perl manual has been split up into several sections.
 
     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
-    perl5150delta      Perl changes in version 5.15.0
+    perl5175delta      Perl changes in version 5.17.5
+    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
+    perl5162delta      Perl changes in version 5.16.2
+    perl5160delta      Perl changes in version 5.16.0
+    perl5143delta      Perl changes in version 5.14.3
+    perl5142delta      Perl changes in version 5.14.2
     perl5141delta      Perl changes in version 5.14.1
     perl5140delta      Perl changes in version 5.14.0
-    perl51311delta     Perl changes in version 5.13.11
-    perl51310delta     Perl changes in version 5.13.10
-    perl5139delta      Perl changes in version 5.13.9
-    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
     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
@@ -208,20 +209,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)
@@ -246,7 +247,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
@@ -258,19 +258,29 @@ 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.
 
 In general, if something strange has gone wrong with your program and you're
-not sure where you should look for help, try the B<-w> switch first.  It will
-often point out exactly where the trouble is.
+not sure where you should look for help, try making your code comply with
+B<use strict> and B<use warnings>.  These will often point out exactly
+where the trouble is.
 
 =head1 DESCRIPTION
 
@@ -319,8 +329,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 *
 
@@ -345,8 +355,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 *
 
@@ -421,8 +430,13 @@ Perl developers, please write to perl-thanks@perl.org .
 
 =head1 DIAGNOSTICS
 
-The C<use warnings> pragma (and the B<-w> switch) produces some 
-lovely diagnostics.
+Using the C<use strict> pragma ensures that all variables are properly
+declared and prevents other misuses of legacy Perl features.
+
+The C<use warnings> pragma produces some lovely diagnostics. One can
+also use the B<-w> flag, but its use is normally discouraged, because
+it gets applied to all executed Perl code, including that not under
+your control.
 
 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 diagnostics> pragma automatically turns Perl's normally terse warnings
@@ -436,12 +450,12 @@ B<-e> is counted as one line.)
 Setuid scripts have additional constraints that can produce error
 messages such as "Insecure dependency".  See L<perlsec>.
 
-Did we mention that you should definitely consider using the B<-w>
-switch?
+Did we mention that you should definitely consider using the B<use warnings>
+pragma?
 
 =head1 BUGS
 
-The B<-w> switch is not mandatory.
+The behavior implied by the B<use warnings> pragma is not mandatory.
 
 Perl is at the mercy of your machine's definitions of various
 operations such as type casting, atof(), and floating-point