INN commit: trunk (8 files)
rra at isc.org
Fri Nov 20 17:32:38 UTC 2009
Date: Friday, November 20, 2009 @ 09:32:37
* Mention that the distributions file should be encoded in UTF-8.
* Mention that the motd.news file should be encoded in UTF-8,
doc/pod/distributions.pod | 3 ++-
doc/pod/moderators.pod | 16 ++++++++--------
doc/pod/motd.news.pod | 9 +++++++--
doc/pod/newsgroups.pod | 2 +-
doc/pod/passwd.nntp.pod | 4 ++--
doc/pod/subscriptions.pod | 8 ++++----
samples/distributions | 8 ++++----
samples/motd.news | 6 +++---
8 files changed, 31 insertions(+), 25 deletions(-)
--- doc/pod/distributions.pod 2009-11-17 21:30:28 UTC (rev 8820)
+++ doc/pod/distributions.pod 2009-11-20 17:32:37 UTC (rev 8821)
@@ -13,7 +13,8 @@
information about how a news server handles the Distribution: header.
Each line of this file consists in a distribution area followed by
-its description after at least a whitespace. For instance:
+its description (encoded in UTF-8) after at least a whitespace. For
fr Local to France.
local Local to this news server.
--- doc/pod/moderators.pod 2009-11-17 21:30:28 UTC (rev 8820)
+++ doc/pod/moderators.pod 2009-11-20 17:32:37 UTC (rev 8821)
@@ -9,7 +9,7 @@
via e-mail to the submission address for that newsgroup. The submission
address is determined using this configuration file.
-The F<moderators> file is a list of associations between uwildmat(3)
+The file I<pathetc>/moderators is a list of associations between uwildmat(3)
patterns matching newsgroups and the submission address for those
newsgroups. Blank lines and lines starting with a number sign (C<#>) are
ignored. All other lines should consist of two fields separated by a
@@ -22,7 +22,7 @@
specific patterns should be listed before general patterns.
The second field, the submission address, should be a simple e-mail
-adddress with one exception: At most C<%s> may occur anywhere in the
+address with one exception: at most one C<%s> may occur anywhere in the
address. If present, it will be replaced by the name of the newsgroup,
with all periods in the name changed to dashes (C<->). If there is a
literal C<%> in the submission address, it must be written as C<%%>, even
@@ -33,7 +33,7 @@
correctly. It's probably no longer necessary, but so much now depends on
it that it can't be easily changed.
-It's intended that the sample moderators file included in the INN
+It's intended that the sample F<moderators> file included in the INN
distribution always be sufficient for all world-wide newsgroups. The
hosts behind moderators.isc.org have graciously volunteered to handle
forwarding tasks for all world-wide newsgroups so that individual sites
@@ -66,10 +66,10 @@
example.x-announce example-x-announce at smtp.example.com
alt.dev.null alt-dev-null at moderators.isc.org
-Note that periods are changed to dashes and dashes are left alone, so two
-moderated newsgroups whose names differ only by changing a period to a
-dash would go to the same address. Such newsgroup pairs should therefore
-not be created.
+Note that periods are changed to dashes and dashes are left alone with
+the C<%s> syntax, so two moderated newsgroups whose names differ only by
+changing a period to a dash would go to the same address. Such newsgroup
+pairs should therefore not be created.
@@ -80,6 +80,6 @@
=head1 SEE ALSO
-inn.conf(5), nnrpd(8), uwildmat(3)
+inn.conf(5), nnrpd(8), uwildmat(3).
--- doc/pod/motd.news.pod 2009-11-17 21:30:28 UTC (rev 8820)
+++ doc/pod/motd.news.pod 2009-11-20 17:32:37 UTC (rev 8821)
@@ -9,11 +9,16 @@
to any client that issues the LIST MOTD command. This might be used for
new information, notification of upcoming downtime, or similar purposes.
+Make sure that the F<motd.news> file is encoded in UTF-8. It should also
+be "dot-stuffed", that is to say that a line beginning with a dot should
+have that dot doubled.
Be aware that use of the LIST MOTD command is not widespread and most news
clients will never ask for this file.
If this file is missing, it is not an error. The server will just send
-the client an empty response.
+the client the appropriate response for an unmaintained F<motd.news> file.
@@ -23,6 +28,6 @@
=head1 SEE ALSO
--- doc/pod/newsgroups.pod 2009-11-17 21:30:28 UTC (rev 8820)
+++ doc/pod/newsgroups.pod 2009-11-20 17:32:37 UTC (rev 8821)
@@ -7,7 +7,7 @@
The file I<pathdb>/newsgroups contains a list of newsgroups for which
a short description is available. This file is generally updated by
controlchan(8) whenever a control message is received; it is used by
-B<nnrpd> in response to C<LIST NEWSGROUPS> and is only meant to provide
+B<nnrpd> in response to LIST NEWSGROUPS and is only meant to provide
information to users. News readers often show the list of carried
newsgroups along with these descriptions.
--- doc/pod/passwd.nntp.pod 2009-11-17 21:30:28 UTC (rev 8820)
+++ doc/pod/passwd.nntp.pod 2009-11-20 17:32:37 UTC (rev 8821)
@@ -1,10 +1,10 @@
-passwd.nntp - passwords for connecting to remote NNTP servers
+passwd.nntp - Passwords for connecting to remote NNTP servers
-The file F<passwd.nntp> in I<pathetc> contains host / name / password
+The file I<pathetc>/passwd.nntp contains host / name / password
triplets for use when authenticating client programs to NNTP servers.
This file is normally interpreted by NNTPsendpassword() in libinn(3).
Blank lines and lines beginning with a number sign (C<#>) are ignored.
--- doc/pod/subscriptions.pod 2009-11-17 21:30:28 UTC (rev 8820)
+++ doc/pod/subscriptions.pod 2009-11-20 17:32:37 UTC (rev 8821)
@@ -4,13 +4,13 @@
-The I<pathetc>/F<subscriptions> file contains a list of newsgroups that is
+The I<pathetc>/subscriptions file contains a list of newsgroups that is
returned by the NNTP command LIST SUBSCRIPTIONS.
-Clients that support this command and send it the first time they connect
-to a new news server use the returned list to initialize the list of
+Clients that support this command usually send it the first time they connect
+to a new news server. They use the returned list to initialize the list of
subscribed newsgroups. The F<subscriptions> file therefore should contain
-groups intented for new users, for testing, or that contain FAQs and other
+groups intended for new users, for testing, or that contain FAQs and other
useful information for first-time Usenet users.
The syntax of the F<subscriptions> file is trivial; it is a simple list of
--- samples/distributions 2009-11-17 21:30:28 UTC (rev 8820)
+++ samples/distributions 2009-11-20 17:32:37 UTC (rev 8821)
@@ -5,7 +5,7 @@
## It contains recommended values for the Distribution: header.
## See the distributions man page for more information.
-#fr Local to France.
-#local Local to this news server.
-#nj Local to New Jersey.
-#usa Local to the United States of America.
+#fr Local to France.
+#local Local to this news server.
+#nj Local to New Jersey.
+#usa Local to the United States of America.
--- samples/motd.news 2009-11-17 21:30:28 UTC (rev 8820)
+++ samples/motd.news 2009-11-20 17:32:37 UTC (rev 8821)
@@ -1,3 +1,3 @@
-Sample MOTD file. Any text you put in here will be returned
-to the news reader when it issues the LIST MOTD command. It is not
-an error if this file does not exist nor if it is empty.
+Sample "message of the day" file. Any text you put in here will be
+returned to the news reader when it issues the LIST MOTD command.
+It is not an error if this file does not exist nor if it is empty.
More information about the inn-committers