X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=innduct.git;a=blobdiff_plain;f=innduct.8;h=e77fe363fcb29827d7be97a59a6b8ca99d736013;hp=c2a6cef49db63842c542a0f46d218b72aa2d48e8;hb=7f2f7562ac7c2fd27bfe2cf9f9edb87a6ce13c7f;hpb=f8e8b4f4647f437f8931663fcfb5efe711d98d5e

diff --git a/innduct.8 b/innduct.8
index c2a6cef..e77fe36 100644
--- 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,8 +181,17 @@ 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 show
+Writes summary information about innduct's state to the current CLI
+connection.
+.TP
 .BR "dump q" | a
-Writes information about innduct's state to a plain text file
+Writes the same information about innduct's state to a plain text file
 .IR feedfile \fB_dump\fR.
 This overwrites any previous dump.  innduct does not ever delete these
 dump files.
@@ -360,6 +370,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 +425,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 +448,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 +500,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"
@@ -535,12 +561,10 @@ by innduct, and will also be read, updated and removed by innduct.
 However you (the administrator) may also safely remove backlog files.
 .IP \fIfeedfile\fR_backlog\fIsomething\fR
 .IX Item "manual backlog file"
-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 (including blanking out entries for processed articles) and
-eventually remove it.  \fIsomething\fR may not contain \fB#\fR \fB~\fR
-or \fB/\fR.
+Batch file manually provided by the administrator.  innduct will
+automatically find, read and process any file matching this pattern
+(blanking out entries for processed articles) and eventually remove
+it.  \fIsomething\fR may not contain \fB#\fR \fB~\fR or \fB/\fR.
 .IP
 Be sure to have finished writing the file before you rename it to
 match the pattern \fIfeedfile\fR\fB_backlog\fR*, as otherwise innduct