option for no inotify; manpage fix

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

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index d5f6be024d33ba2f17efe30925c61adc7a63b0bc..64fd7bb71b8704c44df9cdd8d1e90b3a875ccf57 100644 (file)
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -94,16 +94,17 @@ Do not daemonise.  innduct runs in the foreground and all messages
 Do not try to use the streaming extensions to NNTP (for use eg if the
 peer can't cope when we send MODE STREAM).
 .TP
-.BI \-\-inndconf= FILE
+.BI \-\-no-filemon
+Do not try to use the file change monitoring support to watch for
+writes by innd to the feed file; poll it instead.  (If file monitoring
+is not compiled in, this option just downgrades the log message which
+warns about this situation.)
+.TP
+.BR \-C | \-\-inndconf= \fIFILE\fR
 Read
 .I FILE
 instead of the default
 .BR inn.conf .
-This is currently only used if
-.I feedfile
-is not specified, to find the value
-.I pathoutgoing
-for constructing the feedfile name from the site name.
 .TP
 .BI \-\-port= PORT
 Connect to port
@@ -147,9 +148,13 @@ working.  The default is
 .TP
 .BI \-\-period-interval= PERIOD-INTERVAL
 Specifies wakup interval and period granularity.
-innduct wakes up every PERIOD-INTERVAL to do various housekeeping
-checks.  Also, many of the timeout and rescan intervals (those
-specified in this manual as
+innduct wakes up every
+.I PERIOD-INTERVAL
+to do various housekeeping checks.  Also, many of the timeout and
+rescan intervals (those specified in this manual as
+.IR PERIOD )
+are rounded up to the next multiple of
+.IR PERIOD-INTERVAL .
 .TP
 .BI \-\-connection-timeout= TIME
 How long to allow for a connection setup attempt before giving up.
@@ -161,6 +166,16 @@ How long to wait for innd to respond to a flush request before giving
 up.  The default is
 .BR 100s .
 .TP
+.BI \-\-feedfile-poll= TIME
+How often to poll the feedfile for new articles written by innd
+if file monitoring
+.RI ( inotify
+or equivalent) is not available.  (When file monitoring is available,
+there is no need for periodic checks and we wake immediately up
+whenever the feedfile changes.)
+The default is
+.BR 5s .
+.TP
 .BI \-\-no-check-proportion= PERCENT
 If the moving average of the proportion of articles being accepted
 (rather than declined) by the peer exceeds this value, innduct uses
@@ -344,6 +359,16 @@ feed.  A process holds this lock after it has opened the lockfile,
 made an fcntl F_SETLK call, and then checked with stat and fstat that
 the file it now has open and has locked still has the name
 \fIfeedfile\fR_lock.  (Only) the lockholder may delete the lockfile.
+For your convenience, after the lockfile is locked,
+.IR innfeed 's
+pid, the
+.IR site ,
+.IR feedfile
+and
+.IR fqdn
+are all written to the lockfile.  NB that stale lockfiles may contain
+stale data so this information should not be relied on other than for
+troubleshooting.
 .IP \fIfeedfile\fR_flushing
 .IX Item "flushing file"
 Batch file: the main feedfile is renamed to this filename by innduct
@@ -375,7 +400,11 @@ before you have finished creating it.
 .IX Item inn.conf
 Used to find
 .IR pathoutgoing
-if none is specified.
+if none is specified, for finding how to communicate with innd,
+and also for
+.IR sourceaddress
+and/or
+.IR sourceaddress6 .
 .SH HISTORY
 Written by Ian Jackson <ijackson@chiark.greenend.org.uk>
 .SH "SEE ALSO"