doc/man/innduct.8

   1 .TH INNDUCT 8
   2 .SH NAME
   3 innduct \- quickly and reliably stream Usenet articles to remote site
   4 .SH SYNOPSIS
   5 .B innduct
   6 .RI [ options ]
   7 .I site
   8 .RI [ fqdn ]
   9 .SH DESCRIPTION
  10 .B innduct
  11 implements NNTP peer-to-peer news transmission including the streaming
  12 extensions, for sending news articles to a remote site.
  13
  14 You need to run one instance of innduct for each peer site.  innduct
  15 manages its interaction with innd, including flushing the feed as
  16 appropriate, etc., so that articles are transmitted quickly, and
  17 manages the retransmission of its own backlog.  innduct includes the
  18 locking necessary to avoid multiple simutaneous invocations.
  19
  20 By default, innduct reads the default feedfile corresponding to
  21 the site
  22 .I site
  23 (is
  24 .IR pathoutgoing / site )
  25 and feeds it via NNTP, streaming if possible, to the host
  26 .IR fqdn .
  27
  28 If
  29 .I fqdn
  30 is not specified, it defaults to
  31 .IR site .
  32
  33 Logging is sent to syslog.
  34 .SH GENERAL OPTIONS
  35 .TP
  36 .BR \-f | \-\-feedfile= \fIfeedfile\fR
  37 Specifies
  38 .IR feedfile .
  39 If the specified value ends in a
  40 .B /
  41 it is taken as a directory to use as if it were
  42 .I pathoutgoing
  43 and the actual feed file used is
  44 .IR specified_feedfile / site .
  45 .TP
  46 .BR \-q | \-\-quiet-multiple
  47 Makes innduct silently exit (with status 0) if another innduct holds
  48 the lock for the site.  Without \fB-q\fR, this causes a fatal error to
  49 be logged and a nonzero exit.
  50 .TP
  51 .BR \-\-no-daemon
  52 Do not daemonise.  innduct runs in the foreground and all messages
  53 (including all debug messages) are written to stderr.
  54 .TP
  55 .BI \-\-no-streaming
  56 Do not try to use the streaming extensions to NNTP (eg if the peer
  57 can't cope when we send MODE STREAM).
  58 .TP
  59 .BI \-\-inndconf= FILE
  60 Read
  61 .I FILE
  62 instead of the default
  63 .BR inn.conf .
  64 This is currently only used if
  65 .BI \-f feedfile
  66 is not specified, to find the value
  67 .I pathoutgoing
  68 for constructing the feedfile name from the site name.
  69 .TP
  70 .BI \-\-port= PORT
  71 Connect to port
  72 .I PORT
  73 at the remote site rather than to the NNTP port (119).
  74 .TP
  75 .BI \-\-help
  76 Just print a brief usage message and list of the options to stdout.
  77 .SH TUNING OPTIONS
  78 You should not normally need to adjust these.
  79 .TP
  80 .BI \-\-max-connections= max
  81 Restricts the maximum number of simultaneous NNTP connections used by
  82 for each site to
  83 .IR max .
  84 The default is 10.  There is no global limit on the number of
  85 connections.
  86 .TP
  87 .BI \-\-max-queue-per-conn= max
  88 Restricts the maximum number of outstanding articles queued on any
  89 particular connection
  90 .IR max .
  91 The default is 200.  (Non-streaming connections can only handle one
  92 article at a time.)
  93 .TP
  94 .BI \-\-feedfile-flush-size= bytes
  95 Specifies that innduct should flush when the feedfile size exceeds
  96 .IR bytes ;
  97 the effect is that the innduct will try to avoid the various
  98 batchfiles growing much beyond this size while the link to the peer is
  99 working.  The default is 100,000 bytes.
 100 .TP
 101 .BI \-\-period-interval= PERIOD-INTERVAL
 102 Specifies wakup interval and period granularity.
 103 innduct wakes up every PERIOD-INTERVAL to do various housekeeping
 104 checks.  Also, many of the timeout and rescan intervals (those
 105 specified in this manual as
 106 .IR PERIOD s)
 107 are rounded up to the next multiple of PERIOD-INTERVAL.
 108 The default is one minute.
 109 .SH EXIT STATUS
 110 0 ok
 111 4 one is already running
 112 8 bad usage
 113 12 trouble
 114 .SH FILES
 115 .IX Header "FILES"
 116 .IP \fIpathoutgoing\fR/\fIsite\fR
 117 .IX Item "default feedfile"
 118 Default
 119 .IR feedfile .
 120 .IP \fIfeedfile\fR
 121 .IX Item feedfile
 122 Main feed file as specified in
 123 .IR newsfeeds (5).
 124 This and other batchfiles used by innduct contains lines each of which
 125 is of the form
 126 \&    \fItoken\fR \fImessageid\fR
 127 where \fItoken\fR is the inn storage API token.  Such lines can be
 128 written by \fBTf,Wnm\fR in a \fInewsfeeds\fR(5) entry.  During
 129 processing, innduct overwrites lines in the batch files which
 130 correspond to articles it has processed: the line is replaced with
 131 one containing only spaces.  Only innd should create this file, and
 132 only innduct should remove it.
 133 .IP \fIfeedfile\fR_lock
 134 .IX Item "lock file"
 135 Lockfile, preventing multiple innduct invocations for the same
 136 feed.  A process holds this lock after it has opened the lockfile,
 137 made an fcntl F_SETLK call, and then checked with stat and fstat that
 138 the file it now has open and has locked still has the name
 139 \fIfeedfile\fR_lock.  (Only) the lockholder may delete the lockfile.
 140 .IP \fIfeedfile\fR_flushing
 141 .IX Item "flushing file"
 142 Batch file: the main feedfile is renamed to this filename by innduct
 143 before it asks inn to flush the feed.  Only innduct should create or
 144 remove this file.
 145 .IP \fIfeedfile\fR_defer
 146 .IX Item "flushing file"
 147 Batch file containing details of articles whose transmission has
 148 recently been deferred at the request of the recipient site.  Created,
 149 written, read and removed by innduct.
 150 .IP \fIfeedfile\fR_backlog.\fItime_t\fR.\fIinum\fR
 151 .IX Item "backlog file"
 152 Batch file containing details of articles whose transmission has less
 153 recently been deferred at the request of the recipient site.  Created
 154 by innduct, and will also be read and removed by innduct.  However the
 155 administrator may also safely remove backlog files.
 156 .IP \fIfeedfile\fR_backlog\fIsomething\fR
 157 .IX Item "manual backlog file"
 158 Batch file manually provided by the administrator.  The file should be
 159 complete and ready to process at the time it is renamed or hardlinked
 160 to this name.  innduct will then automatically find and read and
 161 process it and eventually remove it.  The administrator may also
 162 safely remove backlog files.  \fIsomething\fR may not contain
 163 \fB#\fR \fB~\fR or \fB/\fR.
 164 .IP /etc/news/inn.conf
 165 .IX Item inn.conf
 166 Used to find
 167 .IR pathoutgoing
 168 if none is specified.
 169 .SH HISTORY
 170 Written by Ian Jackson <ijackson@chiark.greenend.org.uk>
 171 .SH "SEE ALSO"
 172 inn.conf(5),
 173 newsfeeds(5)