started innduct manpage

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
new file mode 100644 (file)
index 0000000..87c602a
--- /dev/null
+++ b/doc/man/innduct.8
@@ -0,0 +1,205 @@
+.TH INNDUCT 8
+.SH NAME
+innduct \- quickly and reliably stream Usenet articles to remote site
+.SH SYNOPSIS
+.B innduct
+.RI [ options ]
+[
+.I sitename
+.I fqdn
+]
+.SH DESCRIPTION
+.I Innduct
+is a 
+
+front-end that invokes
+.IR innxmit (1)
+to send Usenet articles to a remote NNTP site.
+.PP
+The sites to be fed may be specified by giving
+.I sitename
+.I fqdn
+pairs on the command line.
+If no such pairs are given,
+.I innduct
+defaults to the information given in the
+.I innduct.ctl
+config file.
+.PP
+The
+.I sitename
+should be the name of the site as specified in the
+.IR newsfeeds (5) 
+file.
+The 
+.I fqdn 
+should be the hostname or IP address of the remote site.
+.PP
+An
+.I innxmit
+is launched for sites with queued news.
+All
+.I innxmit
+processes are spawned in the background and the script waits for
+them all to finish before returning.
+Output is sent to the file
+.IR <pathlog\ in\ inn.conf>/innduct.log .
+In order to keep from overwhelming the local system, 
+.I innduct
+waits five seconds before spawning each child.
+.PP
+.I Innduct
+expects that the batchfile for a site is named
+.IR <pathoutgoing\ in\ inn.conf>/sitename .
+To prevent batchfile corruption,
+.IR shlock (1)
+is used to ``lock'' these files.
+.PP
+When
+.I sitename
+.I fqdn
+pairs are given on the command line, 
+any flags given on the command completely describe how
+.I innxmit
+and
+.I shrinkfile
+operate.
+When no such pairs are given on the command line, then
+the information found in
+.I innduct.ctl
+becomes the default flags for that site.
+Any flags given on the command line override the default flags
+for the site.
+.SH OPTIONS
+.TP
+.B "\-d \-D"
+The ``\-d'' flag causes
+.I innduct
+to send output to stdout rather than the log file
+.IR <pathlog\ in\ inn.conf>/innduct.log .
+The ``\-D'' flag does the same
+and it passes ``\-d'' to all
+.I innxmit
+invocations, which in turn causes
+.I innxmit
+to go into debug mode.
+.TP
+.B -n
+If the ``\-n'' flag is used, then
+.I innduct
+does not use
+.IR shlock (1)
+and does not lock batch files.
+.TP
+.B \-s size
+If the ``\-s'' flag is used, then
+.IR shrinkfile (1)
+will be invoked to perform a head truncation on the batchfile and the flag
+will be passed to it.
+.TP
+.B \-w delay
+If the ``\-w'' flag is used, then
+.I innduct
+waits for
+.I delay
+seconds after flushing the site before launching
+.IR innxmit .
+.TP
+.B "\-a \-c \-l \-N \-P \-p \-r \-S \-T \-t"
+The ``\fB\-a\fP'', ``\fB\-c\fP'', ``\fB\-l\fP'', ``\fB\-P\fP'', ``\fB\-p\fP'',
+``\fB\-r\fP'', \``\fB\-S\fP'', ``\fB\-T\fP'' and ``\fB\-t\fP''
+flags are passed on to the child
+.I innxmit
+program. The ``\-N'' flag is passed as ``\fB\-s\fP'' flag to the child
+.I innxmit
+program.
+See 
+.IR innxmit (8)
+for more details.
+Note that if the ``\-p'' flag is used then no connection is made and
+no articles are fed to the remote site.
+It is useful to have
+.IR cron (8)
+invoke
+.I innduct
+with this flag in case a site cannot be reached for an extended period of time.
+.SH EXAMPLES
+With the following
+.IR innduct.ctl (5)
+control file:
+.PP
+.RS
+.nf
+nsavax:erehwon.nsavax.gov::-S -t60
+group70:group70.org::
+walldrug:walldrug.com:4m-1m:-T1800 -t300
+kremvax:kremvax.cis:2m:
+.fi
+.RE
+.PP
+The command:
+.PP
+.RS
+innduct
+.PP
+.RE
+will result in the following:
+.PP
+.RS
+.nf
+Sitename        Truncation      Innxmit flags
+nsavax          (none)          \-a \-S \-t60
+group70         (none)          \-a \-t180
+walldrug        1m if >4m       \-a \-T1800 \-t300
+kremvax         2m              \-a \-t180
+.fi
+.RE
+.PP
+The command:
+.PP
+.RS
+innduct \-d \-T1200
+.RE
+.PP
+will result in the following:
+.PP
+.RS
+.nf
+Sitename        Truncation      Innxmit flags
+nsavax          (none)          \-a \-d \-S \-T1200 \-t60
+group70         (none)          \-a \-d \-T1200 \-t180
+walldrug        1m if >4m       \-a \-d \-T1200 \-t300
+kremvax         2m              \-a \-d \-T1200 \-t180
+.fi
+.RE
+.PP
+The command:
+.PP
+.RS
+innduct \-s 5m \-T1200 nsavax erehwon.nsavax.gov group70 group70.org
+.PP
+.RE
+will result in the following:
+.PP
+.RS
+.nf
+Sitename        Truncation      Innxmit flags
+nsavax          5m              \-a \-T1200 \-t180
+group70         5m              \-a \-T1200 \-t180
+.fi
+.RE
+.PP
+Remember that ``\-a'' is always given, and ``\-t'' defaults to 180.
+.SH HISTORY
+Written by Landon Curt Noll <chongo@toad.com>
+and Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
+.de R$
+This is revision \\$3, dated \\$4.
+..
+.R$ $Id: innduct.8 5909 2002-12-03 05:17:18Z vinocur $
+.SH "SEE ALSO"
+inn.conf(5),
+innxmit(1), 
+newsfeeds(5),
+innduct.ctl(5),
+shrinkfile(1).