chiark / gitweb /
Merge branch 'master' of login.chiark.greenend.org.uk:public-git/inn-innduct
authorIan Jackson <ian@liberator.relativity.greenend.org.uk>
Mon, 3 May 2010 16:10:52 +0000 (17:10 +0100)
committerIan Jackson <ian@liberator.relativity.greenend.org.uk>
Mon, 3 May 2010 16:10:52 +0000 (17:10 +0100)
1  2 
doc/man/innduct.8

diff --combined doc/man/innduct.8
index 28420502f1c56108c85f4fcb4f60a6996162d1ff,a294372dd022f3a2e877282789dcd1f435cf3d54..f8ecbf0724faa009a4d65dfccb3965586352eea3
@@@ -9,13 -9,7 +9,13 @@@ innduct \- quickly and reliably stream 
  .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
@@@ -26,10 -20,11 +26,10 @@@ locking necessary to avoid multiple sim
  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
@@@ -40,10 -35,10 +40,10 @@@ error messages) are sent to syslog (fac
  .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
@@@ -76,15 -71,26 +76,26 @@@ feeding by looking i
  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