INN commit: trunk/doc/pod (distrib.pats.pod getlist.pod)

INN Commit rra at isc.org
Tue Nov 10 23:16:28 UTC 2009


    Date: Tuesday, November 10, 2009 @ 15:16:28
  Author: iulius
Revision: 8733

Confusion between DISTRIB.PATS and DISTRIBUTIONS.

LIST ACTIVE.TIMES now accepts a third argument (newsgroups
wildmat).

Mention LIST HEADERS [MSGID|RANGE].

Modified:
  trunk/doc/pod/distrib.pats.pod
  trunk/doc/pod/getlist.pod

------------------+
 distrib.pats.pod |    3 ++-
 getlist.pod      |   46 ++++++++++++++++++++++++----------------------
 2 files changed, 26 insertions(+), 23 deletions(-)

Modified: distrib.pats.pod
===================================================================
--- distrib.pats.pod	2009-11-10 23:14:42 UTC (rev 8732)
+++ distrib.pats.pod	2009-11-10 23:16:28 UTC (rev 8733)
@@ -35,7 +35,8 @@
 header will be added.  In case a distribution is added by B<nnrpd>, make
 sure it is not rejected by the F<newsfeeds> C<ME> entry.
 
-A list of recommended distributions can be specified in distributions(5).
+A list of recommended distributions can be specified and described
+in distributions(5).
 
 =head1 HISTORY
 

Modified: getlist.pod
===================================================================
--- getlist.pod	2009-11-10 23:14:42 UTC (rev 8732)
+++ getlist.pod	2009-11-10 23:16:28 UTC (rev 8733)
@@ -11,22 +11,36 @@
 
 B<getlist> obtains a list from an NNTP server and sends it to standard
 output.  I<list> may be one of C<active> (which is the default value),
-C<active.times>, C<distributions>, or C<newsgroups>.  C<active> contains
+C<active.times>, C<distrib.pats>, or C<newsgroups>.  C<active> contains
 a list of all newsgroups carried by the server with the high and low article
-numbers in the group and the group status flag.  C<active.times> is a list of
+numbers in the group, and the group status field.  C<active.times> is a list of
 newsgroups, their creation times (in seconds since epoch), and the creator
-of the group.  C<distributions> is a list of relevant distributions and
-their descriptions.  C<newsgroups> is a list of newsgroups and their short
-descriptions.
+of the group.  C<distrib.pats> is a list of relevant distributions and
+the newsgroups they apply to.  C<newsgroups> is a list of newsgroups
+along with their short descriptions.
 
 For more information on the formats of these files, see active(5),
-active.times(5), distributions(5) and newsgroups(5).
+active.times(5), distrib.pats(5) and newsgroups(5).
 
-The I<pattern> parameter may be used with a I<list> value of C<active> or
-C<newsgroups> to limit the output.  If given, only entries corresponding
-to newsgroups that match the uwildmat(3) pattern I<pattern> will be
-printed.
+The listing files other than the F<active> file are common extensions to the
+NNTP protocol and may not be available on all servers.  For instance,
+C<distributions>, C<headers>, C<moderators>, C<motd>, C<overview.fmt> and
+C<subscriptions>, amongst other, may be available.  Moreover, a uwildmat(3)
+pattern I<pattern> may also be usable for some of these listing files.
 
+For more information on the formats of these files, see distributions(5),
+moderators(5), motd.news(5) and subscriptions(5).  The overview fields
+obtained with C<overview.fmt> are the ones for which the overview database
+is consistent (see I<extraoverviewadvertised> in F<inn.conf> for more
+information).  The list obtained with C<headers> contains the fields
+that can be retrieved using the HDR command (I<pattern> can then be
+either C<msgid> or C<range>).
+
+The I<pattern> parameter may be used with a I<list> value of C<active>,
+C<active.times> or C<newsgroups> to limit the output.  If given, only
+entries corresponding to newsgroups that match the uwildmat(3) pattern
+I<pattern> will be printed.
+
 If the I<list> parameter is C<active>, a third parameter, I<types>, may
 also be used to restrict the list.  If given, only entries corresponding
 to newsgroups with a newsgroup mode found in I<types> will be printed.
@@ -34,18 +48,6 @@
 and a I<types> value of C<ym> would show all unmoderated and moderated
 groups but not aliased groups or groups that disallow postings.
 
-The listing files other than the F<active> file are common extensions to the
-NNTP protocol and may not be available on all servers.  For instance,
-C<distrib.pats>, C<moderators>, C<motd>, C<overview.fmt> and C<subscriptions>,
-amongst other, may be available.  Moreover, a uwildmat(3) pattern I<pattern>
-may also be usable for some of these listing files.
-
-For more information on the formats of these files, see distrib.pats(5),
-moderators(5), motd.news(5) and subscriptions(5).  The overview fields
-obtained with C<overview.fmt> are the ones for which the overview database
-is consistent (see I<extraoverviewadvertised> in F<inn.conf> for more
-information).
-
 =head1 OPTIONS
 
 =over 4




More information about the inn-committers mailing list