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

INN Commit rra at isc.org
Sat Apr 16 10:22:18 UTC 2011


    Date: Saturday, April 16, 2011 @ 03:22:18
  Author: iulius
Revision: 9199

Document the format of ninpaths dump files.

Add a symbolic link for inpaths(8) to ninpaths(8).

Mention that INN 1.7 supports the WP newsfeeds flag.

Modified:
  branches/2.5/doc/man/Makefile
  branches/2.5/doc/pod/actsync.pod
  branches/2.5/doc/pod/ninpaths.pod

------------------+
 man/Makefile     |    2 +
 pod/actsync.pod  |    2 -
 pod/ninpaths.pod |   81 +++++++++++++++++++++++++++++++++++++++--------------
 3 files changed, 64 insertions(+), 21 deletions(-)

Modified: man/Makefile
===================================================================
--- man/Makefile	2011-04-16 10:21:38 UTC (rev 9198)
+++ man/Makefile	2011-04-16 10:22:18 UTC (rev 9199)
@@ -82,6 +82,8 @@
 	$(LN_S) actsync.8 $D$(MAN8)/actsyncd.8
 	rm -f $D$(MAN8)/imapfeed.8
 	$(LN_S) innfeed.8 $D$(MAN8)/imapfeed.8
+	rm -f $D$(MAN8)/inpaths.8
+	$(LN_S) ninpaths.8 $D$(MAN8)/inpaths.8
 	if [ x"$(KRB5_AUTH)" != x ] ; then \
 	    $(CP_MAN) auth_krb5.8 $D$(MAN8)/auth_krb5.8 ; \
 	fi

Modified: pod/actsync.pod
===================================================================
--- pod/actsync.pod	2011-04-16 10:21:38 UTC (rev 9198)
+++ pod/actsync.pod	2011-04-16 10:22:18 UTC (rev 9199)
@@ -777,7 +777,7 @@
 
 $Id$
 
-By: Landon Curt Noll <chongo at toad.com> (chongo was here /\../\).
+By Landon Curt Noll <chongo at toad.com> (chongo was here /\../\).
 
 Copyright (c) Landon Curt Noll, 1993.  All rights reserved.
 

Modified: pod/ninpaths.pod
===================================================================
--- pod/ninpaths.pod	2011-04-16 10:21:38 UTC (rev 9198)
+++ pod/ninpaths.pod	2011-04-16 10:22:18 UTC (rev 9199)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-ninpaths - Report Usenet Path statistics (new inpaths)
+ninpaths - Report Usenet Path: statistics (new inpaths)
 
 =head1 SYNOPSIS
 
@@ -11,17 +11,17 @@
 
 =head1 DESCRIPTION
 
-This is an efficient and space-saving inpaths reporting program.  It works
-as follows:  you feed it the Path lines via an INN channel feed or some
+This is an efficient and space-saving B<inpaths> reporting program.  It works
+as follows:  you feed it the Path: lines via an INN channel feed or some
 other similar method, and from time to time the program writes all its
 internal counters accumulated so far to a dump file.  Another instance of
 the program picks up all the dump files, adds them up and formats them
 into the report.  The purpose of the final report is to summarize the
-frequency of occurrence of sites in the Path headers of articles.
+frequency of occurrence of sites in the Path: headers of articles.
 
-Some central sites accumulate the Path data from many news servers running
+Some central sites accumulate the Path: data from many news servers running
 this program or one like it, and then report statistics on the most
-frequently seen news servers in Usenet article Path lines.  The
+frequently seen news servers in Usenet article Path: lines.  The
 B<sendinpaths> shell script can be run once a month to mail the
 accumulated statistics to such a site and remove the old dump files.
 
@@ -40,7 +40,7 @@
 
     inpaths!:*:Tc,WP:ninpaths -p -d <pathlog>/path/inpaths.%d
 
-if your version of INN supports WP (2.0 and later all do).  Replace
+if your version of INN supports C<WP> (2.0 and later all do).  Replace
 <pathlog> with the full path to your INN log directory.
 
 =item 3.
@@ -70,9 +70,11 @@
 the current system time when the dump is made.  This option should be used
 with B<-p>.
 
+The format of these dump files is described below.
+
 =item B<-p>
 
-Read Path lines from standard input.
+Read Path: lines from standard input.
 
 =item B<-r> I<site>
 
@@ -91,10 +93,51 @@
 
 =back
 
+=head1 DUMP FILE FORMAT
+
+The format of the generated dump files is:
+
+   !!NINP <version> <start-time> <end-time> <nb-sites> <nb-articles> <average-time>
+   <site_0> <count_0> <site_1> <count_1> <site_2> <count_2> ...
+   !!NLREC
+   :<site_a>!<site_b>,<count_ab>:<site_c>!<site_d>,<count_cd> ...
+   !!NEND <nb-relations>
+
+where times are UNIX timestamps.  Then, I<nb-sites> records follow.
+Each record is separated by a space or a new line, and consists of a host
+name I<site_n> followed by a number of appearances I<count_n>.  The number
+of processed Path: header lines is I<nb-articles>.
+
+Afterwards, I<nb-relations> relations follow.  In 3.0.x versions, the
+relations are separated by a space or a new line, and their syntax is
+C<< I<site_a>!I<site_b>!I<count_ab> >> where I<site_a> and I<site_b>
+are numbers of the site records starting at 0.
+
+In 3.1.x versions, the relations begin with a colon and are
+separated by either nothing or a new line.  Their syntax is C<<
+:I<site_a>!I<site_b>,I<count_ab> >> with the same meaning as in previous
+versions.  The count can be omitted when it is C<1>.  More than two sites can
+be specified in the relation (C<< :I<site_a>!I<site_b>!I<site_c>,I<count_abc>
+>>).
+
+For instance:
+
+    !!NINP 3.1.1 1302944821 1302944838 5 2 1302944826
+    newsgate.cistron.nl 1 news.trigofacile.com 2 news.ecp.fr 2 usenet.stanford.edu 1
+    bleachbot 1
+    !!NLREC
+    :3!2:2!1,2:4!0:0!2
+    !!NLEND 4
+
+where the two processed Path: headers are:
+
+    Path: news.trigofacile.com!news.ecp.fr!usenet.stanford.edu!not-for-mail
+    Path: news.trigofacile.com!news.ecp.fr!newsgate.cistron.nl!bleachbot!not-for-mail
+
 =head1 NOTES
 
-If your INN doesn't have the WP feed flag (1.5 does not, 1.6 does, 1.7 I
-don't know, 2.0 and later all do), use the following newsfeeds entry:
+If your INN doesn't have the C<WP> feed flag (1.5 does not, 1.6 and 1.7 do,
+2.0 and later all do), use the following F<newsfeeds> entry:
 
    inpaths!:*:Tc,WH:ginpaths
 
@@ -105,22 +148,20 @@
 
 replacing <pathlog> as above.
 
-=head1 SEE ALSO
+=head1 HISTORY
 
-newsfeeds(5), sendinpaths(8)
-
-This is a slightly modified version of Olaf Titz's original ninpaths
+This is a slightly modified version of Olaf Titz's original B<ninpaths>
 program, which is posted to alt.sources and kept on his WWW archive under
 L<http://sites.inka.de/~bigred/sw/>.
 
-=head1 HISTORY
-
-B<ninpaths> was written by Olaf Titz <olaf at bigred.inka.de>.
-
-The idea and some implementation details for ninpaths come from the
-original inpaths program, but most of the code has been rewritten for
+The idea and some implementation details for B<ninpaths> come from the
+original B<inpaths> program, but most of the code has been rewritten for
 clarity.  This program is in the public domain.
 
 $Id$
 
+=head1 SEE ALSO
+
+newsfeeds(5), sendinpaths(8).
+
 =cut




More information about the inn-committers mailing list