cvs commit: perlfaq/bin perlfaq_toc.pl
[email protected] (brian d foy) 5 Oct 2004 22:14:51 -0000
| Newsgroups | perl.cvs.perlfaq |
|---|---|
| Message-ID | <[email protected]> |
cvsuser 04/10/05 15:14:50
Modified: bin perlfaq_toc.pl
Log:
* updated header and footer bits to match current perlfaq.pod
Revision Changes Path
1.2 +63 -107 perlfaq/bin/perlfaq_toc.pl
Index: perlfaq_toc.pl
===================================================================
RCS file: /cvs/public/perlfaq/bin/perlfaq_toc.pl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- perlfaq_toc.pl 8 Apr 2002 22:50:48 -0000 1.1
+++ perlfaq_toc.pl 5 Oct 2004 22:14:50 -0000 1.2
@@ -1,5 +1,5 @@
#!/usr/bin/perl -w
-# $Id: perlfaq_toc.pl,v 1.1 2002/04/08 22:50:48 comdog Exp $
+# $Id: perlfaq_toc.pl,v 1.2 2004/10/05 22:14:50 comdog Exp $
use strict;
=head1 NAME
@@ -43,81 +43,54 @@
print <<'PREAMBLE';
=head1 NAME
-perlfaq - frequently asked questions about Perl ($Date: 2002/04/08 22:50:48 $)
+perlfaq - frequently asked questions about Perl ($Date: 2004/10/05 22:14:50 $)
=head1 DESCRIPTION
-The perlfaq is structured into the following documents:
-
-
-=head2 perlfaq: Structural overview of the FAQ.
-
-This document.
-
-PREAMBLE
-
-foreach my $file ( @files )
- {
- open FILE, $file or die "Could not open $file: $!";
- $_ = <FILE>;
- close FILE;
-
- my( $title, $short ) = m/=head1 NAME\s+(perlfaq\d)\s+-\s+(.*?)\s+\(\$R/;
- print "=head2 L<$title>: $short\n\n";
-
- my( $d ) = m/^=head1 DESCRIPTION\s+(.*?)\s+=head[12]/sm;
- $d =~ s/This section(?: of the FAQ)? (?:answers|deals with)(?: questions (?:about|related to))?(?: the)? //;
- $d =~ s/\s+/ /g;
- $d = ucfirst $d;
-
- print "$d\n\n=over 4\n\n";
-
- foreach my $q ( m/^=head2\s+(.*)$/mg )
- {
- print "=item *\n\n$q\n\n";
- }
-
- print "=back\n\n\n";
- }
-
-print <<'POSTAMBLE';
-=head1 About the perlfaq documents
+The perlfaq is divided into several documents based on topics. A table
+of contents is at the end of this document.
=head2 Where to get the perlfaq
-This document is posted regularly to comp.lang.perl.announce and
-several other related newsgroups. It is available on many
-web sites: http://www.perldoc.com/ and http://perlfaq.cpan.org/ .
+Extracts of the perlfaq are posted regularly to
+comp.lang.perl.misc. It is available on many web sites:
+http://www.perldoc.com/ and http://faq.perl.org/
=head2 How to contribute to the perlfaq
You may mail corrections, additions, and suggestions to
[email protected] . This alias should not be
-used to I<ask> FAQs. It's for fixing the current FAQ.
-Send questions to the comp.lang.perl.misc newsgroup.
[email protected] . This alias should not be used to
+I<ask> FAQs. It's for fixing the current FAQ. Send
+questions to the comp.lang.perl.misc newsgroup. You can
+view the source tree at http://cvs.perl.org/cvsweb/perlfaq/
+(which is outside of the main Perl source tree). The CVS
+repository notes all changes to the FAQ.
=head2 What will happen if you mail your Perl programming problems to the authors
-Your questions will probably go unread, unless they're suggestions of
-new questions to add to the FAQ, in which case they should have gone
-to the [email protected] instead.
-
-You should have read section 2 of this faq. There you would have
-learned that comp.lang.perl.misc is the appropriate place to go for
-free advice. If your question is really important and you require a
-prompt and correct answer, you should hire a consultant.
+Your questions will probably go unread, unless they're
+suggestions of new questions to add to the FAQ, in which
+case they should have gone to the [email protected]
+instead.
+
+You should have read section 2 of this faq. There you would
+have learned that comp.lang.perl.misc is the appropriate
+place to go for free advice. If your question is really
+important and you require a prompt and correct answer, you
+should hire a consultant.
=head1 Credits
-When I first began the Perl FAQ in the late 80s, I never realized it
-would have grown to over a hundred pages, nor that Perl would ever become
-so popular and widespread. This document could not have been written
-without the tremendous help provided by Larry Wall and the rest of the
-Perl Porters.
+The original perlfaq was written by Tom Christiansen, then expanded
+by collaboration between Tom and Nathan Torkington. The current
+document is maintained by the perlfaq-workers ([email protected]).
+Several people have contributed answers, corrections, and comments.
=head1 Author and Copyright Information
-Copyright (c) 1997-2002 Tom Christiansen and Nathan Torkington.
+Copyright (c) 1997-2003 Tom Christiansen, Nathan Torkington, and
+other contributors noted in the answers.
+
All rights reserved.
=head2 Bundled Distributions
@@ -138,79 +111,62 @@
for any particular purpose whatsoever. The authors accept no liability
in respect of this information or its use.
-=head1 Changes
+=head1 Table of Contents
=over 4
-=item 1/November/2000
-
-A few grammatical fixes and updates implemented by John Borwick.
+=item perlfaq - this document
-=item 23/May/99
+=item perlfaq1 - General Questions About Perl
-Extensive updates from the net in preparation for 5.6 release.
+=item perlfaq2 - Obtaining and Learning about Perl
-=item 13/April/99
+=item perlfaq3 - Programming Tools
-More minor touch-ups. Added new question at the end
-of perlfaq7 on variable names within variables.
+=item perlfaq4 - Data Manipulation
-=item 7/January/99
+=item perlfaq5 - Files and Formats
-Small touch ups here and there. Added all questions in this
-document as a sort of table of contents.
+=item perlfaq6 - Regular Expressions
-=item 22/June/98
+=item perlfaq7 - General Perl Language Issues
-Significant changes throughout in preparation for the 5.005
-release.
+=item perlfaq8 - System Interaction
-=item 24/April/97
+=item perlfaq9 - Networking
-Style and whitespace changes from Chip, new question on reading one
-character at a time from a terminal using POSIX from Tom.
-=item 23/April/97
-
-Added http://www.oasis.leo.org/perl/ to L<perlfaq2>. Style fix to
-L<perlfaq3>. Added floating point precision, fixed complex number
-arithmetic, cross-references, caveat for Text::Wrap, alternative
-answer for initial capitalizing, fixed incorrect regexp, added example
-of Tie::IxHash to L<perlfaq4>. Added example of passing and storing
-filehandles, added commify to L<perlfaq5>. Restored variable suicide,
-and added mass commenting to L<perlfaq7>. Added Net::Telnet, fixed
-backticks, added reader/writer pair to telnet question, added FindBin,
-grouped module questions together in L<perlfaq8>. Expanded caveats
-for the simple URL extractor, gave LWP example, added CGI security
-question, expanded on the mail address answer in L<perlfaq9>.
-
-=item 25/March/97
+=back
-Added more info to the binary distribution section of L<perlfaq2>.
-Added Net::Telnet to L<perlfaq6>. Fixed typos in L<perlfaq8>. Added
-mail sending example to L<perlfaq9>. Added Merlyn's columns to
-L<perlfaq2>.
-=item 18/March/97
+=head1 The Questions
-Added the DATE to the NAME section, indicating which sections have
-changed.
-Mentioned SIGPIPE and L<perlipc> in the forking open answer in
-L<perlfaq8>.
+PREAMBLE
-Fixed description of a regular expression in L<perlfaq4>.
+foreach my $file ( @files )
+ {
+ open FILE, $file or die "Could not open $file: $!";
+ $_ = <FILE>;
+ close FILE;
-=item 17/March/97 Version
+ my( $title, $short ) = m/=head1 NAME\s+(perlfaq\d)\s+-\s+(.*?)\s+\(\$R/;
+ print "=head2 L<$title>: $short\n\n";
-Various typos fixed throughout.
+ my( $d ) = m/^=head1 DESCRIPTION\s+(.*?)\s+=head[12]/sm;
+ $d =~ s/This section(?: of the FAQ)? (?:answers|deals with)(?: questions (?:about|related to))?(?: the)? //;
+ $d =~ s/\s+/ /g;
+ $d = ucfirst $d;
-Added new question on Perl BNF on L<perlfaq7>.
+ print "$d\n\n=over 4\n\n";
-=item Initial Release: 11/March/97
+ foreach my $q ( m/^=head2\s+(.*)$/mg )
+ {
+ print "=item *\n\n$q\n\n";
+ }
-This is the initial release of version 3 of the FAQ; consequently there
-have been no changes since its initial release.
+ print "=back\n\n\n";
+ }
-=back
+print <<'POSTAMBLE';
POSTAMBLE