more manpage, remove -h option

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

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index 5e298280ffbd4dd5c90937f81ceee8eb355597f4..c791d9f6ef87ce63c7d1f1a74a2d289f1604fd0b 100644 (file)
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -4,27 +4,25 @@ innduct \- quickly and reliably stream Usenet articles to remote site
 .SH SYNOPSIS
 .B innduct
 .RI [ options ]
-[
 .I site
-[
-.I fqdn
-]]
+.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.
 
-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
@@ -33,13 +31,42 @@ is not specified, it defaults to
 .IR site .
 
 Logging is sent to syslog.
-.SH OPTIONS
+.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
-.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 \-\-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
@@ -76,11 +103,6 @@ remove this 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_defer
-.IX Item "defer 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
@@ -93,8 +115,13 @@ 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 should not contain
-\fB#\fR or \fB~\fR.
+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"