contrib/README

   1 This directory contains unsupported contributions to INN.  Most of these
   2 programs are of interest to a limited set of sites, require some manual
   3 modifications to make work, and/or are separately maintained independent
   4 of INN.  Programs in here may or may not have been tested on the latest
   5 version of INN, so keep that in mind when trying them out.  The INN
   6 developers may not be able to answer bug reports for these utilities; it's
   7 best to send them to the original author.
   8
   9 Volunteers who would like to take particularly useful applications in this
  10 directory and make them suitable for inclusion in INN proper are heartily
  11 encouraged, but discuss this on inn-workers@isc.org.  Sometimes there's a
  12 reason why this hasn't already been done or something specific that's
  13 needed before they can be included.
  14
  15 Type "make <program>" to build any of the following programs and then copy
  16 the binary to somewhere on your PATH to use it.  For details on what each
  17 program does, see below, as well as the comments at the beginning of each
  18 file (if any).
  19
  20 In addition to these files, also see the contrib section of the INN FTP
  21 site at <ftp://ftp.isc.org/isc/inn/contrib/> for more software designed
  22 to work with INN.
  23
  24                         -------------------------
  25
  26 archivegz
  27
  28     A compressing version of archive, writing out .gz files instead of
  29     plain text files.  May not work with the storage API without some
  30     changes to use sm.
  31
  32 backlogstat
  33
  34     Prints informations about the current state of innfeed's backlog, if
  35     any.
  36
  37 backupfeed
  38
  39     Another version of suck or pullnews that downloads posts from a remote
  40     news server and offers them to the local news server.
  41
  42 cleannewsgroups
  43
  44     Performs various cleanups on the newsgroups file.
  45
  46 count_overview.pl
  47
  48     Counts the groups in a bunch of Xref records.
  49
  50 delayer
  51
  52     Sits in a data stream and delays it by some constant period of time.
  53     Mostly useful for delaying innfeed feeds to allow cancels a chance to
  54     remove articles before innfeed sends them to your peers.  See the
  55     beginning of the file for an example of how to use it.
  56
  57 expirectl
  58
  59     Automatically builds expire.ctl based on current available disk space
  60     and a template, adjusting the expiration times of groups based on a
  61     weight and the available space.  Uses a template expire.ctl.ctl file;
  62     see the end of expirectl.c for a sample.
  63
  64 findreadgroups
  65
  66     Scans the news log files and generates a file giving readership counts
  67     by newsgroup.  Used by makeexpctl and makestorconf.
  68
  69 fixhist
  70
  71     Performs various cleanups and sanity checks on the history database.
  72
  73 innconfcheck
  74
  75     Merges your inn.conf settings with the inn.conf man page to make it
  76     easier to be sure that your settings match what you want.  Edit this
  77     script to add the correct paths to the man page; see the comments at
  78     the beginning of this script.
  79
  80 makeexpctl
  81
  82     Generates an expire.ctl based on what newsgroups are actually read.
  83     Uses data generated by findreadgroups.  This script will require
  84     editing before being usable for your server.
  85
  86 makestorconf
  87
  88     Generates a storage.conf file putting frequently read newsgroups into
  89     timecaf rather than CNFS.  Uses data gefnerated by findreadgroups.
  90     This script will require editing before being usable for your server.
  91
  92 mkbuf
  93
  94     Creates a CNFS cycbuff; see the comments at the beginning of
  95     this script.
  96
  97 mlockfile
  98
  99     Locks files given on the command line into memory using mlock (only
 100     tested on Solaris).  Useful primarily for locking the history files
 101     (history.hash and history.index) into memory on a system with
 102     sufficient memory to speed history lookups in innd.  This seems to
 103     help some systems quite a lot and others not at all.
 104
 105 newsresp
 106
 107     Opens an NNTP channel to a server and takes a peek at various response
 108     times.  Can check the round-trip time and the history lookup time.
 109     See the comments at the beginning of the source for more details.
 110
 111 pullart
 112
 113     Attempts to pull news articles out of CNFS cycbuffs.  Useful for
 114     emergency recoveries.
 115
 116 reset-cnfs
 117
 118     Clears a CNFS cycbuff; see the comments at the beginning of
 119     this script.
 120
 121 respool
 122
 123     Takes a list of tokens on stdin and respools them, by retrieving the
 124     article, storing it again, and then calling SMcancel on the previous
 125     instance of the article.  Note that after running this program, you'd
 126     need to rebuild the history and overview, since it doesn't update
 127     either.
 128
 129 showtoken
 130
 131     Decodes storage API tokens.
 132
 133 stathist
 134
 135     Parses and summarizes the log files created by the history profiling
 136     code.
 137
 138 thdexpire
 139
 140     A dynamic expire daemon for timehash and timecaf spools.  It should
 141     be started along with innd and periodically looks if news spool space
 142     is getting tight, and then frees space by removing articles until
 143     enough is free.  It is an adjunct to (not a replacement for) INN's
 144     expire program.
 145
 146 tunefeed
 147
 148     Given two active files, attempts to produce a good set of wildmat
 149     patterns for newsfeeds to minimize the number of rejects.  For full
 150     documentation, run "perldoc tunefeed".