.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
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
instead of the default
.BR inn.conf .
.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
or
.I CLI-PATH
(if it doesn't). See CONTROLLING INNDUCT, below.
-This option may be essential, if
-.I pathrun
-or
-.I site
-is too long, as there is a fairly short limit on the paths to AF_UNIX
+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
-.IB pathrun /innduct/
-which means to create that directory and listen on
+.B innduct/
+which means to create that directory in
+.I pathrun
+and listen on
.RB \fIpathrun\fR /innduct/ \fIsite\fR.
.TP
-.BI \-\-port= PORT
-Connect to port
-.I PORT
-at the remote site rather than to the NNTP port (119).
-.TP
.BI \-\-help
Just print a brief usage message and list of the options to stdout.
.SH TUNING OPTIONS
.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. innduct listens on
-.IB pathrun /innduct/ site
+debugging. innduct listens (by default on
+.IR pathrun \fB/innduct/\fR site )
and when connected reads and writes lines (with unix line endings).
The cli can most easily be accessed with a program like
.I netcat-openbsd
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
~ian / inn-innduct.git / blobdiff