Merge branch 'master' of login.chiark.greenend.org.uk:public-git/inn-innduct

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

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index a4c028f9a98922ea8243c02e62c49a72ed1ed479..f8ecbf0724faa009a4d65dfccb3965586352eea3 100644 (file)
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -9,7 +9,13 @@ innduct \- quickly and reliably stream Usenet articles to remote site
 .SH DESCRIPTION
 .B innduct
 implements NNTP peer-to-peer news transmission including the streaming
 .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
 
 You need to run one instance of innduct for each peer site.  innduct
 manages its interaction with innd, including flushing the feed as


@@ -20,11 +26,10 @@ locking necessary to avoid multiple simutaneous invocations.
 By default, innduct reads the default feedfile corresponding to
 the site
 .I site
 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 .
 .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
 If
 .I fqdn
 is not specified, it defaults to


@@ -35,10 +40,10 @@ error messages) are sent to syslog (facility
 .BR news ).
 
 The best way to run innduct is probably to periodically invoke innduct
 .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
 .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
 .SH INNDUCT VS INNFEED/NNTPSEND/INNXMIT
 .TP
 .B innfeed


@@ -71,15 +76,26 @@ feeding by looking in
 is the actual NNTP feeder program used by nntpsend.
 .SH GENERAL OPTIONS
 .TP
 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 /
 .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 \-q | \-\-quiet-multiple
 Makes innduct silently exit (with status 0) if another innduct holds