.SH DESCRIPTION
.B innduct
implements NNTP peer-to-peer news transmission including the streaming
-extensions, for sending news articles to a remote site.
+extensions, for sending news articles to a remote site. It is
+intended as a replacement for
+.I innfeed
+or
+.IR nntpsend
+and
+.IR innxmit .
You need to run one instance of innduct for each peer site. innduct
manages its interaction with innd, including flushing the feed as
By default, innduct reads the default feedfile corresponding to
the site
.I site
-(is
+(ie
.IR pathoutgoing / site )
and feeds it via NNTP, streaming if possible, to the host
.IR fqdn .
-
If
.I fqdn
is not specified, it defaults to
.BR news ).
The best way to run innduct is probably to periodically invoke innduct
-for each feed (e.g. from cron), passing innduct it the
+for each feed (e.g. from cron), passing the
.B \-q
-option to arrange that it silently exits if an innduct is already
-running for that site.
+option to arrange that innduct silently exits if an instance is
+already running for that site.
.SH INNDUCT VS INNFEED/NNTPSEND/INNXMIT
.TP
.B innfeed
to reduce the latency which would come from having to constantly poll
the feed file. innfeed is capable of feeding multiple peers from a
single innfeed instance, whereas each innduct process handles exactly
-one peer. innduct is much smaller and simpler, at 3kloc to innfeed's
+one peer. innduct is much smaller and simpler, at <4kloc to innfeed's
25kloc. innfeed needs a separate wrapper 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.
is the actual NNTP feeder program used by nntpsend.
.SH GENERAL OPTIONS
.TP
-.BR \-f | \-\-feedfile= \fIfeedfile\fR
-Specifies
-.IR feedfile .
-If the specified value ends in a
+.BR \-f | \-\-feedfile= \fIpath\fR
+Specifies the
+.I feedfile
+to read, and indirectly specifies the paths to
+be used for various ancillary files (see FILES, below).
+If
+.I path
+ends in a
.B /
-it is taken as a directory to use as if it were
-.I pathoutgoing
-and the actual feed file used is
-.IR specified_feedfile / site .
+it is taken as a directory to use, and the actual feed file used is
+.IR path / site .
+If
+.I path
+does not start with a
+.BR / ,
+it is taken to be relative to
+.IR pathoutgoing
+from inn.conf.
+The default is
+.IR site .
.TP
.BR \-q | \-\-quiet-multiple
Makes innduct silently exit (with status 0) if another innduct holds
.TP
.BR \-\-no-daemon
Do not daemonise. innduct runs in the foreground and all messages
-(including all debug messages) are written to stderr.
+(including all debug messages) are written to stderr. A control
+command line is also available on stdin/stdout.
.TP
.BI \-\-no-streaming
Do not try to use the streaming extensions to NNTP (for use eg if the
instead of the default
.BR inn.conf .
.TP
-.BI \-\-ctrl-sock-dir= DIR
-Use
-.I DIR
-as the directory to contain the actual control socket. See
-CONTROLLING INNDUCT, below.
-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
.I PORT
at the remote site rather than to the NNTP port (119).
.TP
+.BI \-\-chdir= pathrun
+Change directory to
+.IR pathrun
+at startup. The default is
+.I pathrun
+from inn.conf.
+.TP
+.BR \-\-cli= \fICLI-DIR\fR / |\fICLI-PATH\fR| none
+Listen for control command line connections on
+.IB CLI-DIR / site
+(if the value ends with a
+.BR /)
+or
+.I CLI-PATH
+(if it doesn't). See CONTROLLING INNDUCT, below.
+Note that there is a fairly short limit on the paths to AF_UNIX
+sockets. If specified as
+.IR CLI-DIR \fB/\fR,
+the directory will be created with mode 700 if necessary.
+The default is
+.B innduct/
+which means to create that directory in
+.I pathrun
+and listen on
+.RB \fIpathrun\fR /innduct/ \fIsite\fR.
+.TP
.BI \-\-help
Just print a brief usage message and list of the options to stdout.
.SH TUNING OPTIONS
.BR 10 .
There is no global limit on the number of connections.
.TP
-.BI \-\-max-queue-per-conn= max
+.BI \-\-max-queue-per-conn= per-conn-max
Restricts the maximum number of outstanding articles queued on any
-particular connection
+particular connection to
.IR max .
(Non-streaming connections can only handle one article at a time.)
The default is
.BR 200 .
.TP
+.BI \-\-max-queue-per-file= max
+Restricts the maximum number articles read into core from any one
+input file to
+.IR max .
+The default is twice the value of per-conn-max.
+.TP
.BI \-\-feedfile-flush-size= bytes
Specifies that innduct should flush the feed and start a new feedfile
when the existing feedfile size exceeds
control command, 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.
+.LP
innduct listens on an AF_UNIX socket, and provides a command-line
interface which can be used to trigger various events and for
-debugging.
-.LP
-The socket is called
-.IB feedfile _control
+debugging. innduct listens (by default on
+.IR pathrun \fB/innduct/\fR site )
and when connected reads and writes lines (with unix line endings).
-It can most easily be accessed with a program like
+The cli can most easily be accessed with a program like
.I netcat-openbsd
(eg
-.B nc.openbsd -U
-.IR feedfile \fB_control\fR)
+.B nc.openbsd -U /var/run/news/innduct/
+.IR site )
or
.IR socat .
-The CLI has as a prompt
+The prompt is
.IR site \fB|\fR.
.LP
-Because there is a fairly short limit on the length of pathnames used
-for AF_UNIX sockets, innduct actually creates the socket with a unique
-name in a different dedicated subdirectory of /tmp, and makes
-.IB feedfile _control
-a symlink to the real socket.
-.LP
The following control commands are supported:
.TP
.B h
not mess with the feedfile and other associated files, other than as
explained here:
.IX Header "FILES"
+.IP \fIpathrun\fR
+.IX Item "default directory"
+Default current working directory for innduct, and also default
+parent directory for the command line socket.
.IP \fIpathoutgoing\fR/\fIsite\fR
.IX Item "default feedfile"
Default
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 \fIpathrun\fR\fB/innduct/\fB\fIsite\fR
+.IX Item "control command line socket"
+Default AF_UNIX listening socket for the control command line. See
+CONTROLLING INNDUCT, above.
.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
+Used for
.IR pathoutgoing
-if none is specified, for finding how to communicate with innd,
-and also for
+(to compute default
+.IR feedfile
+and associated paths),
+.IR pathrun
+(to compute default
+.IR CLI-DIR
+and
+.IR CLI-PATH ),
+for finding how to communicate with innd, and also for
.IR sourceaddress
and/or
.IR sourceaddress6 .
~ian / inn-innduct.git / blobdiff