Debianisation (initial cut)

[innduct.git] / innduct.8

diff --git a/innduct.8 b/innduct.8
index f297c2dd2e5357414641f7b33ffd82b9c1123fa9..e77fe363fcb29827d7be97a59a6b8ca99d736013 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,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
@@ -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"