options for everything

[inn-innduct.git] / doc / man / innduct.8

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index c791d9f6ef87ce63c7d1f1a74a2d289f1604fd0b..b71c2f8cb6a634a8f23950769cb9ac669b79084b 100644 (file)
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -33,7 +33,7 @@ is not specified, it defaults to
 Logging is sent to syslog.
 .SH GENERAL OPTIONS
 .TP
 Logging is sent to syslog.
 .SH GENERAL OPTIONS
 .TP

-.BI \-f feedfile
+.BR \-f | \-\-feedfile= \fIfeedfile\fR

 Specifies
 .IR feedfile .
 If the specified value ends in a
 Specifies
 .IR feedfile .
 If the specified value ends in a


@@ -44,8 +44,36 @@ and the actual feed file used is
 .IR specified_feedfile / site .
 .TP
 .BR \-q | \-\-quiet-multiple
 .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.
+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
 .SH TUNING OPTIONS
 You should not normally need to adjust these.
 .TP


@@ -60,13 +88,29 @@ connections.
 Restricts the maximum number of outstanding articles queued on any
 particular connection
 .IR max .
 Restricts the maximum number of outstanding articles queued on any
 particular connection
 .IR max .

-The default is 200.
+The default is 200.  (Non-streaming connections can only handle one
+article at a time.)

 .TP
 .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.
+.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
 .SH FILES
 .IX Header "FILES"
 .IP \fIpathoutgoing\fR/\fIsite\fR