.TH INNDUCT 8
.SH NAME
innduct \- quickly and reliably stream Usenet articles to remote site
.SH SYNOPSIS
.B innduct
.RI [ options ]
.I site
.RI [ fqdn ]
.SH DESCRIPTION
.B innduct
implements NNTP peer-to-peer news transmission including the streaming
extensions, for sending news articles to a remote site.

You need to run one instance of innduct for each peer site.  innduct
manages its interaction with innd, including flushing the feed as
appropriate, etc., so that articles are transmitted quickly, and
manages the retransmission of its own backlog.  innduct includes the
locking necessary to avoid multiple simutaneous invocations.

By default, innduct reads the default feedfile corresponding to
the site
.I site
(is
.IR pathoutgoing / site )
and feeds it via NNTP, streaming if possible, to the host
.IR fqdn .

If
.I fqdn
is not specified, it defaults to
.IR site .

Logging is sent to syslog.
.SH GENERAL OPTIONS
.TP
.BI \-f feedfile
Specifies
.IR feedfile .
If the specified value ends in a
.B /
it is taken as a directory to use as if it were
.I pathoutgoing
and the actual feed file used is
.IR specified_feedfile / site .
.TP
.BR \-q | \-\-quiet-multiple
Makes innduct silently exit if another innduct holds the lock for the
site.  Without \fB-q\fR, this causes a fatal error to be logged.
.SH TUNING OPTIONS
You should not normally need to adjust these.
.TP
.BI \-\-max-connections= max
Restricts the maximum number of simultaneous NNTP connections used by
for each site to
.IR max .
The default is 10.  There is no global limit on the number of
connections.
.TP
.BI \-\-max-queue-per-conn= max
Restricts the maximum number of outstanding articles queued on any
particular connection
.IR max .
The default is 200.
.TP
.BI \-\-max-queue-per-conn= max
Restricts the maximum number of outstanding articles queued on any
particular connection
.IR max .
The default is 200.
.SH FILES
.IX Header "FILES"
.IP \fIpathoutgoing\fR/\fIsite\fR
.IX Item "default feedfile"
Default
.IR feedfile .
.IP \fIfeedfile\fR
.IX Item feedfile
Main feed file as specified in
.IR newsfeeds (5).
This and other batchfiles used by innduct contains lines each of which
is of the form
\&    \fItoken\fR \fImessageid\fR
where \fItoken\fR is the inn storage API token.  Such lines can be
written by \fBTf,Wnm\fR in a \fInewsfeeds\fR(5) entry.  During
processing, innduct overwrites lines in the batch files which
correspond to articles it has processed: the line is replaced with
one containing only spaces.  Only innd should create this file, and
only innduct should remove it.
.IP \fIfeedfile\fR_lock
.IX Item "lock file"
Lockfile, preventing multiple innduct invocations for the same
feed.  A process holds this lock after it has opened the lockfile,
made an fcntl F_SETLK call, and then checked with stat and fstat that
the file it now has open and has locked still has the name
\fIfeedfile\fR_lock.  (Only) the lockholder may delete the lockfile.
.IP \fIfeedfile\fR_flushing
.IX Item "flushing file"
Batch file: the main feedfile is renamed to this filename by innduct
before it asks inn to flush the feed.  Only innduct should create or
remove this file.
.IP \fIfeedfile\fR_defer
.IX Item "flushing file"
Batch file containing details of articles whose transmission has
recently been deferred at the request of the recipient site.  Created,
written, read and removed by innduct.
.IP \fIfeedfile\fR_backlog.\fItime_t\fR.\fIinum\fR
.IX Item "backlog file"
Batch file containing details of articles whose transmission has less
recently been deferred at the request of the recipient site.  Created
by innduct, and will also be read and removed by innduct.  However the
administrator may also safely remove backlog files.
.IP \fIfeedfile\fR_backlog\fIsomething\fR
.IX Item "manual backlog file"
Batch file manually provided by the administrator.  The file should be
complete and ready to process at the time it is renamed or hardlinked
to this name.  innduct will then automatically find and read and
process it and eventually remove it.  The administrator may also
safely remove backlog files.  \fIsomething\fR may not contain
\fB#\fR \fB~\fR or \fB/\fR.
.IP /etc/news/inn.conf
.IX Item inn.conf
Used to find
.IR pathoutgoing
if none is specified.
.SH HISTORY
Written by Ian Jackson <ijackson@chiark.greenend.org.uk>
.SH "SEE ALSO"
inn.conf(5),
newsfeeds(5)