chiark / gitweb /
dump control command
[inn-innduct.git] / doc / man / innduct.8
index 72ee35ff2c37cc7fbb746d9a3005e98de68bd3d8..50e4a41affa18447af26b704da4165cbeafc4d2b 100644 (file)
@@ -94,16 +94,37 @@ 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 \-\-ctrl-sock-dir= DIR
+Bind the real control socket to a unique filename in
+.IR DIR .
+A symlink will be made pointing to the actual file used, named
+.IB feedfile _control
+in the same directory as
+.IR feedfile ,
+but since
+.IR feedfile 's
+path may be too long for an AF_UNIX socket path, innduct always
+creates the sockets in this dedicated directory which is expected to
+have a short path.  If
+.I DIR
+does not exist it will be created with mode 0700; if it does
+exist it must not be a symlink and must be owned by the user running
+innduct and have no access for "other".  If the control socket cannot
+be set up (for this or any other reason), a warning is logged, but
+such situations are not fatal for innduct's startup.  The default is
+.BR /tmp/innduct.control .
 .TP
 .BI \-\-port= PORT
 Connect to port
@@ -147,9 +168,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 +186,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
@@ -272,13 +307,10 @@ articles it has in hand now, and then exit.  It is harmless to cause
 innd to flush the feed (but innduct won't notice and flushing won't
 start a new feedfile; you have to leave that to innduct).
 .LP
-There are no signals that can usefully be sent to innduct to give it
-complicated instructions.  If you need to kill innduct, feel free to
-send it a
-.B SIGTERM
-or
-.B SIGKILL
-and nothing will be broken or corrupted.
+If you want to stop innduct you can send it SIGTERM or SIGINT, in
+which case it will report statistics so far and quickly exit.
+If innduct receives SIGKILL nothing will be broken or corrupted; you
+just won't see some of the article stats.
 .SH EXIT STATUS
 .TP
 .B 0
@@ -381,11 +413,19 @@ safely remove backlog files.  \fIsomething\fR may not contain \fB#\fR
 you rename it to match the pattern \fIfeedfile\fR\fB_backlog\fR*, as
 otherwise innduct may find and process the file and read it to EOF
 before you have finished creating it.
+.IP \fIfeedfile\fR_dump
+.IX Item "debug dump file"
+On request via a control connection innduct dumps a summary of its
+state to this text file.  This is mostly useful for debugging.
 .IP /etc/news/inn.conf
 .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"