doc/man/innduct.8

   1 .TH INNDUCT 8
   2 .SH NAME
   3 innduct \- quickly and reliably stream Usenet articles to remote site
   4 .SH SYNOPSIS
   5 .B innduct
   6 .RI [ options ]
   7 [
   8 .I site
   9 [
  10 .I fqdn
  11 ]]
  12 .SH DESCRIPTION
  13 .B innduct
  14 implements NNTP peer-to-peer news transmission including the streaming
  15 extensions, for sending news articles to a remote site.
  16
  17 One instance of innduct is run for each peer site.  innduct manages
  18 its interaction with innd so that articles are transmitted quickly,
  19 and manages the retransmission its own backlog.  innduct includes the
  20 locking necessary to avoid multiple simutaneous invocations.
  21
  22 By default, innduct reads the default feed file name corresponding to
  23 the site
  24 .I site
  25 (as specified in
  26 .IR newsfeeds (5))
  27 and feeds it vian NNTP, streaming if possible, to the host
  28 .IR fqdn .
  29
  30 If
  31 .I fqdn
  32 is not specified, it defaults to
  33 .IR site .
  34
  35 Logging is sent to syslog.
  36 .SH OPTIONS
  37 .TP
  38 .B \-h fqdn
  39 Specifies the domain name of the host to connect to via NNTP.  The
  40 default is the site name.  The domain name may be specified with
  41 .B \-h
  42 or as a 2nd non-option argument, but not both.
  43 .SH FILES
  44 .IX Header "FILES"
  45 .IP \fIpathoutgoing\fR/\fIsite\fR
  46 .IX Item "default feedfile"
  47 Default
  48 .IR feedfile .
  49 .IP \fIfeedfile\fR
  50 .IX Item feedfile
  51 Main feed file as specified in
  52 .IR newsfeeds (5).
  53 This and other batchfiles used by innduct contains lines each of which
  54 is of the form
  55 \&    \fItoken\fR \fImessageid\fR
  56 where \fItoken\fR is the inn storage API token.  Such lines can be
  57 written by \fBTf,Wnm\fR in a \fInewsfeeds\fR(5) entry.  During
  58 processing, innduct overwrites lines in the batch files which
  59 correspond to articles it has processed: the line is replaced with
  60 one containing only spaces.  Only innd should create this file, and
  61 only innduct should remove it.
  62 .IP \fIfeedfile\fR_lock
  63 .IX Item "lock file"
  64 Lockfile, preventing multiple innduct invocations for the same
  65 feed.  A process holds this lock after it has opened the lockfile,
  66 made an fcntl F_SETLK call, and then checked with stat and fstat that
  67 the file it now has open and has locked still has the name
  68 \fIfeedfile\fR_lock.  (Only) the lockholder may delete the lockfile.
  69 .IP \fIfeedfile\fR_flushing
  70 .IX Item "flushing file"
  71 Batch file: the main feedfile is renamed to this filename by innduct
  72 before it asks inn to flush the feed.  Only innduct should create or
  73 remove this file.
  74 .IP \fIfeedfile\fR_defer
  75 .IX Item "flushing file"
  76 Batch file containing details of articles whose transmission has
  77 recently been deferred at the request of the recipient site.  Created,
  78 written, read and removed by innduct.
  79 .IP \fIfeedfile\fR_defer
  80 .IX Item "defer file"
  81 Batch file containing details of articles whose transmission has
  82 recently been deferred at the request of the recipient site.  Created,
  83 written, read and removed by innduct.
  84 .IP \fIfeedfile\fR_backlog.\fItime_t\fR.\fIinum\fR
  85 .IX Item "backlog file"
  86 Batch file containing details of articles whose transmission has less
  87 recently been deferred at the request of the recipient site.  Created
  88 by innduct, and will also be read and removed by innduct.  However the
  89 administrator may also safely remove backlog files.
  90 .IP \fIfeedfile\fR_backlog\fIsomething\fR
  91 .IX Item "manual backlog file"
  92 Batch file manually provided by the administrator.  The file should be
  93 complete and ready to process at the time it is renamed or hardlinked
  94 to this name.  innduct will then automatically find and read and
  95 process it and eventually remove it.  The administrator may also
  96 safely remove backlog files.  \fIsomething\fR should not contain
  97 \fB#\fR or \fB~\fR.
  98 .SH HISTORY
  99 Written by Ian Jackson <ijackson@chiark.greenend.org.uk>
 100 .SH "SEE ALSO"
 101 inn.conf(5),
 102 newsfeeds(5)