/*
 *---------------------------------------------------------------------------
 *
 *		nestor -- NEws STatistics ORganizer
 *
 *  Copyright (C) 1991  Edwin H. Kremer <edwin@cs.ruu.nl>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 1, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *---------------------------------------------------------------------------
 */

INTRODUCTION
============
  This is  ``nestor'',  a  program  to  summarize  the  copious  logging
information  from the NNTP Usenet News transport agent (for the curious:
"Nestor" is short for "NEws STatistics ORganizer").

  I got inspired to write this program after I tried out the  "nntp_awk"
script written back in 1986 by Erik E. Fair <fair@ucbarpa.berkeley.edu>,
that comes with the NNTP-1.5 software package. This big awk script  runs
sloooooooooowwwwww.  Lots  of  people  must  have  rewritten that script
since, probably in Perl, Tcl, Gawk, Python or even Cobol :-). Anyway,  I
decided to spend some spare time to do the thing in C.

  Some effort has been taken  to  keep  this  program  portable  amongst
various systems. However, if it fails to compile on your exotic machine,
or goes bananas on your syslog file,  please  let  me  (edwin@cs.ruu.nl)
know how I blew it.

REQUIREMENTS
============
  In order to use this package, you should configure the NNTP daemon  as
well as NNTPXMIT to use syslog __and__ to do statistics logging.
  This excerpt from the file "where_your_nntp_sources_are/common/conf.h"
shows a possible configuration:

	#define	SYSLOG	LOG_LOCAL7	/* or LOG_NEWS if you have it	*/

	#ifdef SYSLOG	/* Define LOG if you want copious logging info	*/
	#define	 LOG	/* undef it if you don't			*/
	#endif		/* but you can only have LOG if you have SYSLOG	*/


HOW TO INSTALL
==============
1) Take a quick look at the "Makefile". You might want to change the
   values of "BINDIR" and "MANDIR".  (you might even be unhappy with
   CFLAGS and/or LDFLAGS -- change them at will).

2) Make a site specific copy of the "defs.h.dist" file by doing:

	$ cp defs.h.dist defs.h

3) Edit "defs.h" and modify it to reflect your system. Here's a short
   description on the defines:

	SYSV		- define this if you're compiling on a SysV
			  or derived system. If your system is more
			  Berkeley-ish, undef it. HP-UX 7.0x users
			  may safely ignore this.
			  (default: undefined)

	HAVE_STRSTR	- define this if your standard C library includes
			  the "strstr()" routine (check with ``man strings'').
			    If it doesn't, undef it so that the supplied
			  "strstr()" will be used instead.
			  (default: defined)

	NNTP_SYSLOG	- define this to be the full pathname of the file to
			  which the NNTP statistics are syslogged.
			  (default: "/usr/local/lib/news/syslog")

	NUM_NNTP_HOSTS	- make a rough guess on how many hosts are contacting
			  your NNTP server and you are contacting via NNTPXMIT.
			  If your guess turns out to be too low, you'll be
			  warned at runtime.
			  (default: 50)

4) Compile the program by running:

	$ make

5) Test the program by running:

	$ ./nestor -oi
   or
	$ ./nestor -a

6) Install the program by doing a:

	$ make install

7) Congratulations! You're done. Hope you enjoy this pogram.


BUG REPORTS
===========
  I'd be very interested to hear what problems you had with  nestor.  If
you think you've encountered a bug, please submit a bug report by e-mail
to  <edwin@cs.ruu.nl>.  PLEASE,  PLEASE  include  version   number   and
patchlevel in the bug report (``nestor -V'' will tell you).


ARCHIVING NESTOR
================
  If you are archiving the nestor package on your FTP site  and/or  your
mail-server  archive,  please  let me know so I can inform you of future
enhancements (often called 'bug fixes').
  The latest version of nestor is always available by anonymous FTP from
"archive.cs.ruu.nl" [131.211.80.5]


NOTE THAT
=========
	this software is distributed under the terms of the
	GNU General Public License. See the file "COPYING"
	for details.


			enjoy,
						--[ Edwin ]--
--
Edwin Kremer, systems and network administrator.  [NIC-Whois handle: EHK3]
     Department of Computer Science,  Utrecht University,  The Netherlands
     Email: edwin@cs.ruu.nl                 NeXTmail: edwin@edge.cs.ruu.nl
