cvs commit: perlfaq/templates usenet_post.txt
[email protected] (brian d foy) 8 Jan 2006 14:29:07 -0000
| Newsgroups | perl.cvs.perlfaq |
|---|---|
| Message-ID | <[email protected]> |
cvsuser 06/01/08 06:29:06
Modified: . perlfaq.pod
bin perlfaq_toc.pl
templates usenet_post.txt
Log:
* I rewrote the perlfaq preamble to give it a nicer tone and to provide
better information.
* I rewrote the usenet PerlFAQ server wrapper so its shorter, nicer,
and more informative.
Revision Changes Path
1.29 +67 -67 perlfaq/perlfaq.pod
Index: perlfaq.pod
===================================================================
RCS file: /cvs/public/perlfaq/perlfaq.pod,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- perlfaq.pod 30 Dec 2005 15:04:07 -0000 1.28
+++ perlfaq.pod 8 Jan 2006 14:29:06 -0000 1.29
@@ -1,72 +1,79 @@
=head1 NAME
-perlfaq - frequently asked questions about Perl ($Date$)
+perlfaq - frequently asked questions about Perl
=head1 DESCRIPTION
-The perlfaq is divided into several documents based on topics. A table
-of contents is at the end of this document.
+The perlfaq comprises several documents that answer the most commonly
+asked questions about Perl and Perl programming. It's divided by topic
+into nine major sections outlined in this document.
=head2 Where to get the perlfaq
-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/
+The perlfaq comes with the standard Perl distribution, so if you have Perl
+you should have the perlfaq. You should also have the C<perldoc> tool
+that let's you read the L<perlfaq>:
+
+ $ perldoc perlfaq
+
+Besides your local system, you can find the perlfaq on the web, including
+at http://perldoc.perl.org/ .
+
+The perlfaq is an evolving document and you can read the latest version
+at http://faq.perl.org/ . The perlfaq-workers periodically post extracts
+of the latest perlfaq to comp.lang.perl.misc.
+
+You can view the source tree at
+http://cvs.perl.org/viewcvs/cvs-public/perlfaq/ (which is outside of the
+main Perl source tree). The CVS repository notes all changes to the FAQ
+and holds the latest version of the working documents and may vary
+significantly from the version distributed with the latest version of
+Perl. Check the repository before sending your corrections.
=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. 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.
-
-=head1 Credits
-
-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-2005 Tom Christiansen, Nathan Torkington, and
-other contributors noted in the answers.
-
-All rights reserved.
-
-=head2 Bundled Distributions
-
-This documentation is free; you can redistribute it and/or modify it
-under the same terms as Perl itself.
-
-Irrespective of its distribution, all code examples in these files
-are hereby placed into the public domain. You are permitted and
-encouraged to use this code in your own programs for fun
-or for profit as you see fit. A simple comment in the code giving
-credit would be courteous but is not required.
-
-=head2 Disclaimer
-
-This information is offered in good faith and in the hope that it may
-be of use, but is not guaranteed to be correct, up to date, or suitable
-for any particular purpose whatsoever. The authors accept no liability
-in respect of this information or its use.
+You can mail corrections, additions, and suggestions to
+C<< <perlfaq-workers AT perl DOT org> >>. The perlfaq volunteers use this
+address to coordinate their efforts and track the perlfaq development.
+They appreciate your contributions to the FAQ but do not have time to
+provide individual help, so don't use this address to ask FAQs.
+
+The perlfaq server posts extracts of the perlfaq to that newsgroup every
+6 hours (or so), and the community of volunteers reviews and updates the
+answers. If you'd like to help review and update the answers, check out
+comp.lang.perl.misc.
+
+=head2 What will happen if you mail your Perl programming problems to the authors?
+
+The perlfaq-workers like to keep all traffic on the perlfaq-workers list
+so that everyone can see the work being done (and the work that needs to
+be done). The mailing list serves as an official record. If you email the
+authors or maintainers directly, you'll probably get a reply asking you
+to post to the mailing list. If you don't get a reply, it probably means
+that the person never saw the message or didn't have time to deal with
+it. Posting to the list allows the volunteers with time to deal with it
+when others are busy.
+
+If you have a question that isn't in the FAQ and you would like help with
+it, try the resources in L<perlfaq2>.
+
+=head1 CREDITS
+
+Tom Christiansen wrote the original perlfaq then expanded it with the
+help of Nat Torkington. The perlfaq-workers maintain current document
+and the dezinens of comp.lang.perl.misc regularly review and update the
+FAQ. Several people have contributed answers, corrections, and comments,
+and the perlfaq notes those contributions wherever appropriate.
+
+=head1 AUTHOR AND COPYRIGHT
+
+Tom Christainsen wrote the original version of this document.
+brian d foy C<< <[email protected]> >> wrote this version. See the
+individual perlfaq documents for additional copyright information.
+
+This document is available under the same terms as Perl itself. Code
+examples in all the perlfaq documents are in the public domain. Use
+them as you see fit (and at your own risk with no warranty from anyone).
=head1 Table of Contents
@@ -92,13 +99,10 @@
=item perlfaq9 - Networking
-
=back
-
=head1 The Questions
-
=head2 L<perlfaq1>: General Questions About Perl
Very general, high-level questions about Perl.
@@ -224,11 +228,7 @@
=item *
-Perl in Magazines
-
-=item *
-
-Perl on the Net: FTP and WWW Access
+Which magazines have Perl content?
=item *
@@ -236,7 +236,7 @@
=item *
-Archives of comp.lang.perl.misc
+Where are the archives for comp.lang.perl.misc?
=item *
1.6 +26 -26 perlfaq/bin/perlfaq_toc.pl
Index: perlfaq_toc.pl
===================================================================
RCS file: /cvs/public/perlfaq/bin/perlfaq_toc.pl,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- perlfaq_toc.pl 31 Dec 2005 01:06:29 -0000 1.5
+++ perlfaq_toc.pl 8 Jan 2006 14:29:06 -0000 1.6
@@ -43,7 +43,7 @@
print <<'PREAMBLE';
=head1 NAME
-perlfaq - frequently asked questions about Perl ($Date$)
+perlfaq - frequently asked questions about Perl
=head1 DESCRIPTION
@@ -55,50 +55,50 @@
The perlfaq comes with the standard Perl distribution, so if you have Perl
you should have the perlfaq. You should also have the C<perldoc> tool
-that let's you read the perlfaq:
+that let's you read the L<perlfaq>:
$ perldoc perlfaq
-Besides your local system, you can find the perlfaq on the web,
-including at http://perldoc.perl.org/ .
+Besides your local system, you can find the perlfaq on the web, including
+at http://perldoc.perl.org/ .
The perlfaq is an evolving document and you can read the latest version
at http://faq.perl.org/ . The perlfaq-workers periodically post extracts
of the latest perlfaq to comp.lang.perl.misc.
-You can view the source tree at http://cvs.perl.org/viewcvs/cvs-public/perlfaq/
-(which is outside of the main Perl source tree). The CVS repository
-notes all changes to the FAQ and holds the latest version of the working
-documents and may vary significantly from the version distributed with
-the latest version of Perl. Check the repository before sending your
-corrections.
+You can view the source tree at
+http://cvs.perl.org/viewcvs/cvs-public/perlfaq/ (which is outside of the
+main Perl source tree). The CVS repository notes all changes to the FAQ
+and holds the latest version of the working documents and may vary
+significantly from the version distributed with the latest version of
+Perl. Check the repository before sending your corrections.
=head2 How to contribute to the perlfaq
-You can mail corrections, additions, and suggestions to
[email protected] . The perlfaq volunteers use this address to
-coordinate their efforts and track the perlfaq development. They
-appreciate your contributions to the FAQ but do not have time to provide
-individual help, so don't use this address to ask FAQs.
+You can mail corrections, additions, and suggestions to
+C<< <perlfaq-workers AT perl DOT org> >>. The perlfaq volunteers use this
+address to coordinate their efforts and track the perlfaq development.
+They appreciate your contributions to the FAQ but do not have time to
+provide individual help, so don't use this address to ask FAQs.
The perlfaq server posts extracts of the perlfaq to that newsgroup every
6 hours (or so), and the community of volunteers reviews and updates the
answers. If you'd like to help review and update the answers, check out
comp.lang.perl.misc.
-=head2 What will happen if you mail your Perl programming problems to the authors
+=head2 What will happen if you mail your Perl programming problems to the authors?
-The perlfaq-workers like to keep all traffic on the [email protected]
-so that everyone can see the work being done (and the work that needs to
+The perlfaq-workers like to keep all traffic on the perlfaq-workers list
+so that everyone can see the work being done (and the work that needs to
be done). The mailing list serves as an official record. If you email the
-authors or maintainers directly, you'll probably get a reply asking you to
-post to the mailing list. If you don't get a reply, it probably means that
-the person never saw the message or didn't have time to deal with it. Posting
-to the list allows the volunteers with time to deal with it when others are
-busy.
+authors or maintainers directly, you'll probably get a reply asking you
+to post to the mailing list. If you don't get a reply, it probably means
+that the person never saw the message or didn't have time to deal with
+it. Posting to the list allows the volunteers with time to deal with it
+when others are busy.
-If you have a question that isn't in the FAQ and you would like help with it,
-try the resources in L<perlfaq2>.
+If you have a question that isn't in the FAQ and you would like help with
+it, try the resources in L<perlfaq2>.
=head1 CREDITS
1.4 +14 -33 perlfaq/templates/usenet_post.txt
Index: usenet_post.txt
===================================================================
RCS file: /cvs/public/perlfaq/templates/usenet_post.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- usenet_post.txt 29 Dec 2002 11:17:13 -0000 1.3
+++ usenet_post.txt 8 Jan 2006 14:29:06 -0000 1.4
@@ -1,7 +1,8 @@
-This message is one of several periodic postings to comp.lang.perl.misc
-intended to make it easier for perl programmers to find answers to
-common questions. The core of this message represents an excerpt
-from the documentation provided with Perl.
+This is an excerpt from the latest version perlfaq{$major}.pod, which
+comes with the standard Perl distribution. These postings aim to
+reduce the number of repeated questions as well as allow the community
+to review and update the answers. The latest version of the complete
+perlfaq is at http://faq.perl.org .
--------------------------------------------------------------------
@@ -11,32 +12,12 @@
--------------------------------------------------------------------
-Documents such as this have been called "Answers to Frequently
-Asked Questions" or FAQ for short. They represent an important
-part of the Usenet tradition. They serve to reduce the volume of
-redundant traffic on a news group by providing quality answers to
-questions that keep coming up.
-
-If you are some how irritated by seeing these postings you are free
-to ignore them or add the sender to your killfile. If you find
-errors or other problems with these postings please send corrections
-or comments to the posting email address or to the maintainers as
-directed in the perlfaq manual page.
-
-Note that the FAQ text posted by this server may have been modified
-from that distributed in the stable Perl release. It may have been
-edited to reflect the additions, changes and corrections provided
-by respondents, reviewers, and critics to previous postings of
-these FAQ. Complete text of these FAQ are available on request.
-
-The perlfaq manual page contains the following copyright notice.
-
- AUTHOR AND COPYRIGHT
-
- Copyright (c) 1997-2002 Tom Christiansen and Nathan
- Torkington, and other contributors as noted. All rights
- reserved.
-
-This posting is provided in the hope that it will be useful but
-does not represent a commitment or contract of any kind on the part
-of the contributers, authors or their agents.
+The perlfaq-workers, a group of volunteers, maintain the perlfaq. They
+are not necessarily experts in every domain where Perl might show up,
+so please include as much information as possible and relevant in any
+corrections. The perlfaq-workers also don't have access to every operating
+system or platform, so please include relevant details for corrections
+to examples that do not work on particular platforms. Working code is
+greatly appreciated.
+
+If you'd like to help maintain the perlfaq, see the details in perlfaq.pod.