It has grown a bit

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

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index c6f8b701974f8bb7208a14e150d1a39059a2b3d2..580f317ed853af04e96c463253e3b87fb1c4913a 100644 (file)
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -51,7 +51,7 @@ constantly "tailing" the feed file, and where implemented uses
 to reduce the latency which would come from having to constantly poll
 the feed file.  innfeed is capable of feeding multiple peers from a
 single innfeed instance, whereas each innduct process handles exactly
-one peer.  innduct is much smaller and simpler, at 3kloc to innfeed's
+one peer.  innduct is much smaller and simpler, at <4kloc to innfeed's
 25kloc.  innfeed needs a separate wrapper script or similar
 infrastructure (of which there is an example in its manpage), whereas
 innduct can be run directly and doesn't need help from shell scripts.
@@ -143,14 +143,20 @@ The default is
 .BR 10 .
 There is no global limit on the number of connections.
 .TP
-.BI \-\-max-queue-per-conn= max
+.BI \-\-max-queue-per-conn= per-conn-max
 Restricts the maximum number of outstanding articles queued on any
-particular connection
+particular connection to
 .IR max .
 (Non-streaming connections can only handle one article at a time.)
 The default is
 .BR 200 .
 .TP
+.BI \-\-max-queue-per-file= max
+Restricts the maximum number articles read into core from any one
+input file to
+.IR max .
+The default is twice the value of per-conn-max.
+.TP
 .BI \-\-feedfile-flush-size= bytes
 Specifies that innduct should flush the feed and start a new feedfile
 when the existing feedfile size exceeds
@@ -255,6 +261,18 @@ threshold.
 The default is
 .BR 100000s .
 .TP
+.BI \-\-flush-finish-timeout= FLUSH-FINISH-PERIOD
+If we flushed
+.IR FLUSH-FINISH-PERIOD
+ago, and are still trying to finish processing articles that were
+written to the old feed file, we forcibly and violently make sure that
+we do by abandoning and deferring all the work (which includes
+unceremoniously dropping any connections on which we've sent some of
+those articles but not yet had replies, as they're probably stuck
+somehow).
+The default is
+.BR 2000s .
+.TP
 .BI \-\-idle-timeout= PERIOD
 Connections which have had no activity for
 .IR PERIOD
@@ -331,7 +349,10 @@ should only be used by a developer in conjuction with the innduct
 source code.
 .TP
 .B flush
-Start a new feed file and trigger a flush of the feed.
+Start a new feed file and trigger a flush of the feed.  (Or, cause
+the
+.I FLUSH-FINISH-PERIOD
+to expire early, forcibly completing a previously started flush.)
 .TP
 .B stop
 Log statistics and exit.  (Same effect as SIGTERM or SIGINT.)