INN commit: branches/2.5/doc (7 files)

INN Commit rra at isc.org
Fri Oct 29 18:09:51 UTC 2010


    Date: Friday, October 29, 2010 @ 11:09:50
  Author: iulius
Revision: 9138

Update our documentation to mention the fact that RFC 6048
now exists and is implemented in INN.

Modified:
  branches/2.5/doc/FAQ
  branches/2.5/doc/pod/distributions.pod
  branches/2.5/doc/pod/innd.pod
  branches/2.5/doc/pod/motd.news.pod
  branches/2.5/doc/pod/nnrpd.pod
  branches/2.5/doc/pod/readme.pod
  branches/2.5/doc/pod/subscriptions.pod

-----------------------+
 FAQ                   |   27 ++++++++++++++-------------
 pod/distributions.pod |    6 +++---
 pod/innd.pod          |    4 ++--
 pod/motd.news.pod     |    5 +++--
 pod/nnrpd.pod         |   26 ++++++++------------------
 pod/readme.pod        |   23 ++++++++++++-----------
 pod/subscriptions.pod |    4 ++++
 7 files changed, 46 insertions(+), 49 deletions(-)

Modified: FAQ
===================================================================
--- FAQ	2010-10-29 18:09:12 UTC (rev 9137)
+++ FAQ	2010-10-29 18:09:50 UTC (rev 9138)
@@ -109,19 +109,20 @@
 The README that comes with INN has this to say (in part):
 
     INN (InterNetNews), originally written by Rich Salz, is an extremely
-    flexible and configurable Usenet / Netnews news server.  For a
-    complete description of the protocols behind Usenet and Netnews, see
-    RFC 3977 (NNTP), RFC 4642 (TLS/NNTP), RFC 4643 (NNTP authentication),
-    RFC 4644 (streaming NNTP feeds), RFC 5536 (USEFOR) and RFC 5537
-    (USEPRO) or their replacements.  In brief, Netnews is a
-    set of protocols for exchanging messages between a decentralized
-    network of news servers.  News articles are organized into newsgroups,
-    which are themselves organized into hierarchies.  Each individual news
-    server stores locally all articles it has received for a given
-    newsgroup, making access to stored articles extremely fast.  Netnews
-    does not require any central server; instead, each news server passes
-    along articles it receives to all of the news servers it peers with,
-    those servers pass the articles along to their peers, and so on,
+    flexible and configurable Usenet / Netnews news server.  For a complete
+    description of the protocols behind Usenet and Netnews, see RFC 3977
+    (NNTP), RFC 4642 (TLS/NNTP), RFC 4643 (NNTP authentication), RFC 4644
+    (streaming NNTP feeds), RFC 5536 (USEFOR), RFC 5537 (USEPRO) and RFC
+    6048 (NNTP LIST additions) or their replacements.
+
+    In brief, Netnews is a set of protocols for exchanging messages between
+    a decentralized network of news servers.  News articles are organized
+    into newsgroups, which are themselves organized into hierarchies.
+    Each individual news server stores locally all articles it has received
+    for a given newsgroup, making access to stored articles extremely fast.
+    Netnews does not require any central server; instead, each news server
+    passes along articles it receives to all of the news servers it peers
+    with, those servers pass the articles along to their peers, and so on,
     resulting in "flood fill" propagation of news articles.
 
     INN is free software, supported by Internet Systems Consortium and

Modified: pod/distributions.pod
===================================================================
--- pod/distributions.pod	2010-10-29 18:09:12 UTC (rev 9137)
+++ pod/distributions.pod	2010-10-29 18:09:50 UTC (rev 9138)
@@ -24,9 +24,9 @@
 Blank lines and lines beginning with a number sign (C<#>) are ignored.
 
 Any client that issues the LIST DISTRIBUTIONS command obtain these
-recommended values, if available.  However, be aware that use of the
-LIST DISTRIBUTIONS command is not widespread and most news clients will
-never ask for this file.
+recommended values, if available.  However, be aware that use of the LIST
+DISTRIBUTIONS command is not widespread (though documented in S<RFC 6048>)
+and most news clients will never ask for this file.
 
 If this file is empty, it is not an error.  The server will just send
 the client an empty response.  And if the file is missing, the server

Modified: pod/innd.pod
===================================================================
--- pod/innd.pod	2010-10-29 18:09:12 UTC (rev 9137)
+++ pod/innd.pod	2010-10-29 18:09:50 UTC (rev 9138)
@@ -308,8 +308,8 @@
 =head1 PROTOCOL DIFFERENCES
 
 B<innd> implements the NNTP commands defined in S<RFC 3977> (NNTP),
-S<RFC 4643> (NNTP authentication) and S<RFC 4644> (streaming) with
-the following differences:
+S<RFC 4643> (NNTP authentication), S<RFC 4644> (streaming NNTP feeds)
+and S<RFC 6048> (NNTP LIST additions) with the following differences:
 
 =over 4
 

Modified: pod/motd.news.pod
===================================================================
--- pod/motd.news.pod	2010-10-29 18:09:12 UTC (rev 9137)
+++ pod/motd.news.pod	2010-10-29 18:09:50 UTC (rev 9138)
@@ -13,8 +13,9 @@
 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.
+Be aware that use of the LIST MOTD command is not widespread (though
+documented in S<RFC 6048>) 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 the appropriate response for an unmaintained F<motd.news> file.

Modified: pod/nnrpd.pod
===================================================================
--- pod/nnrpd.pod	2010-10-29 18:09:12 UTC (rev 9137)
+++ pod/nnrpd.pod	2010-10-29 18:09:50 UTC (rev 9138)
@@ -227,23 +227,13 @@
 =head1 PROTOCOL DIFFERENCES
 
 B<nnrpd> implements the NNTP commands defined in S<RFC 3977> (NNTP),
-S<RFC 4642> (TLS/NNTP) and S<RFC 4643> (NNTP authentication) with the
-following differences:
+S<RFC 4642> (TLS/NNTP), S<RFC 4643> (NNTP authentication) and S<RFC 6048>
+(NNTP LIST additions) with the following differences:
 
 =over 4
 
 =item 1.
 
-Besides the keywords defined in S<RFC 3977> (ACTIVE, ACTIVE.TIMES,
-DISTRIB.PATS, HEADERS, NEWSGROUPS and OVERVIEW.FMT), the LIST command
-may be followed by the optional keywords COUNTS, DISTRIBUTIONS, MODERATORS,
-MOTD and SUBSCRIPTIONS to respectively get an improved version of the
-ACTIVE variant with the number of articles in every newsgroup, a list
-of valid distributions, the moderators list, the message of the day
-information for readers, and a list of recommended group subscriptions.
-
-=item 2.
-
 The XGTITLE [I<wildmat>] command is provided.  This extension is used by
 ANU-News and documented in S<RFC 2980>.  It returns a C<282> reply code,
 followed by a one-line description of all newsgroups that match the
@@ -251,7 +241,7 @@
 
 Note that LIST NEWSGROUPS should be used instead of XGTITLE.
 
-=item 3.
+=item 2.
 
 The XHDR I<header> [I<message-ID>|I<range>] command is implemented.  It
 returns a C<221> reply code, followed by specific headers for the
@@ -260,7 +250,7 @@
 
 Note that HDR should be used instead of XHDR.
 
-=item 4.
+=item 3.
 
 The XOVER [I<range>] command is provided.  It returns a C<224> reply code,
 followed by the overview data for the specified range; the default is to
@@ -268,7 +258,7 @@
 
 Note that OVER should be used instead of XOVER.
 
-=item 5.
+=item 4.
 
 A new command, XPAT I<header> I<message-ID>|I<range> I<pattern>
 [I<pattern> ...], is provided.  The first argument is the case-insensitive
@@ -280,17 +270,17 @@
 response code, followed by the text response of all article numbers that
 match the pattern.
 
-=item 6.
+=item 5.
 
 A newsgroup name is case-sensitive for B<nnrpd>.
 
-=item 7.
+=item 6.
 
 If IHAVE has been advertised, it will not necessarily be advertised for
 the entire session (contrary to section 3.4.1 of S<RFC 3977>).  B<nnrpd>
 only advertises the IHAVE capability when it is really available.
 
-=item 8.
+=item 7.
 
 B<nnrpd> allows a wider syntax for wildmats and ranges (especially C<->
 and C<-I<article-number>>).

Modified: pod/readme.pod
===================================================================
--- pod/readme.pod	2010-10-29 18:09:12 UTC (rev 9137)
+++ pod/readme.pod	2010-10-29 18:09:50 UTC (rev 9138)
@@ -12,18 +12,19 @@
 flexible and configurable Usenet / Netnews news server.  For a complete
 description of the protocols behind Usenet and Netnews, see S<RFC 3977>
 (NNTP), S<RFC 4642> (TLS/NNTP), S<RFC 4643> (NNTP authentication),
-S<RFC 4644> (streaming NNTP feeds), S<RFC 5536> (USEFOR) and S<RFC 5537>
-(USEPRO) or their replacements.  In brief, Netnews is a set of protocols
-for exchanging messages between a decentralized network of news servers.
-News articles are organized into newsgroups, which are themselves
-organized into hierarchies.  Each individual news server stores locally
-all articles it has received for a given newsgroup, making access to
-stored articles extremely fast.  Netnews does not require any central
-server; instead, each news server passes along articles it receives to all
-of the news servers it peers with, those servers pass the articles along
-to their peers, and so on, resulting in "flood fill" propagation of news
-articles.
+S<RFC 4644> (streaming NNTP feeds), S<RFC 5536> (USEFOR), S<RFC 5537>
+(USEPRO) and S<RFC 6048> (NNTP LIST additions) or their replacements.
 
+In brief, Netnews is a set of protocols for exchanging messages between
+a decentralized network of news servers.  News articles are organized
+into newsgroups, which are themselves organized into hierarchies.
+Each individual news server stores locally all articles it has received
+for a given newsgroup, making access to stored articles extremely fast.
+Netnews does not require any central server; instead, each news server
+passes along articles it receives to all of the news servers it peers
+with, those servers pass the articles along to their peers, and so on,
+resulting in "flood fill" propagation of news articles.
+
 A news server performs three basic functions:  it accepts articles from
 other servers and stores them on disk, sends articles it has received out
 to other servers, and offers stored news articles to readers on demand.

Modified: pod/subscriptions.pod
===================================================================
--- pod/subscriptions.pod	2010-10-29 18:09:12 UTC (rev 9137)
+++ pod/subscriptions.pod	2010-10-29 18:09:50 UTC (rev 9138)
@@ -18,6 +18,10 @@
 significant; the news reading client may present the groups in that order
 to the user.
 
+Be aware that use of the LIST SUBSCRIPTIONS command is not widespread
+(though documented in S<RFC 6048>) and most news clients will never ask
+for this file.
+
 =head1 EXAMPLE
 
 A typical F<subscriptions> file may look like:




More information about the inn-committers mailing list