implements NNTP peer-to-peer news transmission including the streaming
extensions, for sending news articles to a remote site.
-One instance of innduct is run for each peer site. innduct manages
-its interaction with innd so that articles are transmitted quickly,
-and manages the retransmission its own backlog. innduct includes the
+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 feed file name corresponding to
+By default, innduct reads the default feedfile corresponding to
the site
.I site
-(as specified in
-.IR newsfeeds (5))
-and feeds it vian NNTP, streaming if possible, to the host
+(is
+.IR pathoutgoing / site )
+and feeds it via NNTP, streaming if possible, to the host
.IR fqdn .
If
.IR site .
Logging is sent to syslog.
-.SH OPTIONS
+.SH GENERAL OPTIONS
.TP
-.B \-h fqdn
-Specifies the domain name of the host to connect to via NNTP. The
-default is the site name. The domain name may be specified with
-.B \-h
-or as a 2nd non-option argument, but not both.
+.BR \-f | \-\-feedfile= \fIfeedfile\fR
+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 (with status 0) if another innduct holds
+the lock for the site. Without \fB-q\fR, this causes a fatal error to
+be logged and a nonzero exit.
+.TP
+.BR \-\-no-daemon
+Do not daemonise. innduct runs in the foreground and all messages
+(including all debug messages) are written to stderr.
+.TP
+.BI \-\-no-streaming
+Do not try to use the streaming extensions to NNTP (eg if the peer
+can't cope when we send MODE STREAM).
+.TP
+.BI \-\-inndconf= FILE
+Read
+.I FILE
+instead of the default
+.BR inn.conf .
+This is currently only used if
+.BI \-f feedfile
+is not specified, to find the value
+.I pathoutgoing
+for constructing the feedfile name from the site name.
+.TP
+.BI \-\-port= PORT
+Connect to port
+.I PORT
+at the remote site rather than to the NNTP port (119).
+.TP
+.BI \-\-help
+Just print a brief usage message and list of the options to stdout.
+.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. (Non-streaming connections can only handle one
+article at a time.)
+.TP
+.BI \-\-feedfile-flush-size= bytes
+Specifies that innduct should flush when the feedfile size exceeds
+.IR bytes ;
+the effect is that the innduct will try to avoid the various
+batchfiles growing much beyond this size while the link to the peer is
+working. The default is 100,000 bytes.
+.TP
+.BI \-\-period-interval= PERIOD-INTERVAL
+Specifies wakup interval and period granularity.
+innduct wakes up every PERIOD-INTERVAL to do various housekeeping
+checks. Also, many of the timeout and rescan intervals (those
+specified in this manual as
+.IR PERIOD s)
+are rounded up to the next multiple of PERIOD-INTERVAL.
+The default is one minute.
+.SH EXIT STATUS
+0 ok
+4 one is already running
+8 bad usage
+12 trouble
.SH FILES
.IX Header "FILES"
.IP \fIpathoutgoing\fR/\fIsite\fR
~ian / inn-innduct.git / blobdiff