INN commit: trunk/contrib (README)

[INN Commit]

    Date: Tuesday, November 21, 2006 @ 00:32:27
  Author: eagle
Revision: 7583

Various updates for new files and verb tense.  Remove ninpaths, which is
now included in the main part of INN.  Patch from Julien ?\195?\137LIE.

Modified:
  trunk/contrib/README

--------+
 README |   52 +++++++++++++++++++++++++++++++++-------------------
 1 file changed, 33 insertions(+), 19 deletions(-)

Modified: README
===================================================================
--- README	2006-11-21 08:29:39 UTC (rev 7582)
+++ README	2006-11-21 08:32:27 UTC (rev 7583)
@@ -40,20 +40,24 @@
     database.  Could also be easily modified to check against any other
     type of database that Perl's DBI module can talk to.
 
+backlogstat
+
+    Prints informations about the current state of innfeed's backlog, if
+    any.
+
 backupfeed
 
     Another version of suck or pullnews that downloads posts from a remote
     news server and offers them to the local news server.
 
-backlogstat
-
-    Prints informations about the current state of innfeed's backlog, if
-    any.
-
 cleannewsgroups
 
     Performs various cleanups on the newsgroups file.
 
+count_overview.pl
+
+    Counts the groups in a bunch of Xref records.
+
 delayer
 
     Sits in a data stream and delays it by some constant period of time.
@@ -70,9 +74,13 @@
 
 findreadgroups
 
-    Scan the news log files and generate a file giving readership counts
+    Scans the news log files and generates a file giving readership counts
     by newsgroup.  Used by makeexpctl and makestorconf.
 
+fixhist
+
+    Performs various cleanups and sanity checks on the history database.
+
 innconfcheck
 
     Merges your inn.conf settings with the inn.conf man page to make it
@@ -82,19 +90,24 @@
 
 makeexpctl
 
-    Generate an expire.ctl based on what newsgroups are actually read.
+    Generates an expire.ctl based on what newsgroups are actually read.
     Uses data generated by findreadgroups.  This script will require
     editing before being usable for your server.
 
 makestorconf
 
-    Generate a storage.conf file putting frequently read newsgroups into
+    Generates a storage.conf file putting frequently read newsgroups into
     timecaf rather than CNFS.  Uses data gefnerated by findreadgroups.
     This script will require editing before being usable for your server.
 
+mkbuf
+
+    Creates a CNFS cycbuff; see the comments at the beginning of
+    this script.
+
 mlockfile
 
-    Lock files given on the command line into memory using mlock (only
+    Locks files given on the command line into memory using mlock (only
     tested on Solaris).  Useful primarily for locking the history files
     (history.hash and history.index) into memory on a system with
     sufficient memory to speed history lookups in innd.  This seems to
@@ -112,21 +125,16 @@
     times.  Can check the round-trip time and the history lookup time.
     See the comments at the beginning of the source for more details.
 
-ninpaths
-
-    Collects and submits Path survey data, used to determine the top
-    transit news servers and collect other interesting information about
-    Usenet connectivity.  The more data is collected, the more accurate
-    and interesting the results, so if you have a few moments to set it
-    up give it a try.  See ninpaths/README for more information; just
-    typing make in that directory should be sufficient to build the
-    software.
-
 pullart
 
     Attempts to pull news articles out of CNFS cycbuffs.  Useful for
     emergency recoveries.
 
+reset-cnfs
+
+    Clears a CNFS cycbuff; see the comments at the beginning of
+    this script.
+
 respool
 
     Takes a list of tokens on stdin and respools them, by retrieving the
@@ -135,6 +143,12 @@
     need to rebuild the history and overview, since it doesn't update
     either.
 
+sample.init.script
+
+    Tries to increase the file descriptor limits to the maximum allowed by
+    the system since INN and related programs can be file descriptor hogs.
+    It then starts INN.
+
 showtoken
 
     Decodes storage API tokens.