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