Install innduct-stats-report

[innduct.git] / innduct.8

diff --git a/innduct.8 b/innduct.8
index a51325296ad48884e1352d800f297410121d8f8b..e995464f245f8c74eae53b92544fcab4b6e49704 100644 (file)
--- a/innduct.8
+++ b/innduct.8
@@ -1,3 +1,4 @@
+'\" t
 .TH INNDUCT 8
 .SH NAME
 innduct \- quickly and reliably stream Usenet articles to remote site
@@ -180,6 +181,11 @@ to expire early, forcibly completing a previously started flush.)
 .B stop
 Log statistics and exit.  (Same effect as SIGTERM or SIGINT.)
 .TP
+.B logstats
+Log statistics so far and zero the stats counters.  Stats are also
+logged periodically, when an input file is completed and just before
+tidy termination.
+.TP
 .BR "dump q" | a
 Writes information about innduct's state to a plain text file
 .IR feedfile \fB_dump\fR.
@@ -360,6 +366,12 @@ unresponsive or the connection has become broken.
 The default is
 .BR 1000s .
 .TP
+.BI \-\-stats-log-interval= PERIOD
+Log statistics at least every
+.IR PERIOD
+The default is
+.BR 2500s .
+.TP
 .BI \-\-low-volume-thresh= "WIN-THRESH " \-\-low-volume-window= "PERIOD "
 If innduct has only one connection to the peer, and has processed
 fewer than
@@ -409,8 +421,8 @@ defect in the innd channel feed protocol.  innduct uses a file feed,
 constantly "tailing" the feed file, and where implemented uses
 .BR inotify (2)
 to reduce the latency which would come from having to constantly poll
-the feed file.  innduct is much smaller and simpler, at <4kloc to
-innfeed's 25kloc.  innfeed needs a separate helper script or similar
+the feed file.  innduct is much smaller and simpler, at <5kloc to
+innfeed's ~25kloc.  innfeed needs a separate helper 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.
 However, innfeed is capable of feeding multiple peers from a single
@@ -432,6 +444,16 @@ separately for each peer.
 .TP
 .B innxmit
 is the actual NNTP feeder program used by nntpsend.
+.LP
+.TS
+l l l l.
+       \fBinnfeed\fR   \fBinnduct\fR   \fBnntpsend/innxmit\fR
+realtime feed  Yes     Yes     No
+reliable       No      Yes     Yes
+source code size       24kloc  4.6kloc 1.9kloc
+invoke once for all sites      Yes     No      Yes
+number of processes    one     1/site  2/site, intermittently
+.TE
 .SH EXIT STATUS
 .TP
 .B 0
@@ -474,7 +496,7 @@ a bug.
 .SH FILES
 innduct dances a somewhat complicated dance with innd to make sure
 that everything goes smoothly and that there are no races.  (See the
-two ascii-art diagrams in innduct.c for details of the protocol.)  Do
+two ascii-art diagrams in README.states for details of the protocol.)  Do
 not mess with the feedfile and other associated files, other than as
 explained here:
 .IX Header "FILES"