X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;f=doc%2Fman%2Finnduct.8;h=c791d9f6ef87ce63c7d1f1a74a2d289f1604fd0b;hb=55cb8dcfa035728631492596baa74844d98c20d0;hp=56cd8064e35f90d22b97b8766ccf47abb51b5293;hpb=fb4e207fd4e2d3e1cbf933eca4824c99b04c7741;p=inn-innduct.git

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index 56cd806..c791d9f 100644
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -11,17 +11,18 @@ innduct \- quickly and reliably stream Usenet articles to remote site
 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
@@ -30,13 +31,42 @@ is not specified, it defaults to
 .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.
+.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