chiark / gitweb /
started innduct manpage
[innduct.git] / 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 sitename
9 .I fqdn
10 ]
11 .SH DESCRIPTION
12 .I Innduct
13 is a 
14
15 front-end that invokes
16 .IR innxmit (1)
17 to send Usenet articles to a remote NNTP site.
18 .PP
19 The sites to be fed may be specified by giving
20 .I sitename
21 .I fqdn
22 pairs on the command line.
23 If no such pairs are given,
24 .I innduct
25 defaults to the information given in the
26 .I innduct.ctl
27 config file.
28 .PP
29 The
30 .I sitename
31 should be the name of the site as specified in the
32 .IR newsfeeds (5) 
33 file.
34 The 
35 .I fqdn 
36 should be the hostname or IP address of the remote site.
37 .PP
38 An
39 .I innxmit
40 is launched for sites with queued news.
41 All
42 .I innxmit
43 processes are spawned in the background and the script waits for
44 them all to finish before returning.
45 Output is sent to the file
46 .IR <pathlog\ in\ inn.conf>/innduct.log .
47 In order to keep from overwhelming the local system, 
48 .I innduct
49 waits five seconds before spawning each child.
50 .PP
51 .I Innduct
52 expects that the batchfile for a site is named
53 .IR <pathoutgoing\ in\ inn.conf>/sitename .
54 To prevent batchfile corruption,
55 .IR shlock (1)
56 is used to ``lock'' these files.
57 .PP
58 When
59 .I sitename
60 .I fqdn
61 pairs are given on the command line, 
62 any flags given on the command completely describe how
63 .I innxmit
64 and
65 .I shrinkfile
66 operate.
67 When no such pairs are given on the command line, then
68 the information found in
69 .I innduct.ctl
70 becomes the default flags for that site.
71 Any flags given on the command line override the default flags
72 for the site.
73 .SH OPTIONS
74 .TP
75 .B "\-d \-D"
76 The ``\-d'' flag causes
77 .I innduct
78 to send output to stdout rather than the log file
79 .IR <pathlog\ in\ inn.conf>/innduct.log .
80 The ``\-D'' flag does the same
81 and it passes ``\-d'' to all
82 .I innxmit
83 invocations, which in turn causes
84 .I innxmit
85 to go into debug mode.
86 .TP
87 .B -n
88 If the ``\-n'' flag is used, then
89 .I innduct
90 does not use
91 .IR shlock (1)
92 and does not lock batch files.
93 .TP
94 .B \-s size
95 If the ``\-s'' flag is used, then
96 .IR shrinkfile (1)
97 will be invoked to perform a head truncation on the batchfile and the flag
98 will be passed to it.
99 .TP
100 .B \-w delay
101 If the ``\-w'' flag is used, then
102 .I innduct
103 waits for
104 .I delay
105 seconds after flushing the site before launching
106 .IR innxmit .
107 .TP
108 .B "\-a \-c \-l \-N \-P \-p \-r \-S \-T \-t"
109 The ``\fB\-a\fP'', ``\fB\-c\fP'', ``\fB\-l\fP'', ``\fB\-P\fP'', ``\fB\-p\fP'',
110 ``\fB\-r\fP'', \``\fB\-S\fP'', ``\fB\-T\fP'' and ``\fB\-t\fP''
111 flags are passed on to the child
112 .I innxmit
113 program. The ``\-N'' flag is passed as ``\fB\-s\fP'' flag to the child
114 .I innxmit
115 program.
116 See 
117 .IR innxmit (8)
118 for more details.
119 Note that if the ``\-p'' flag is used then no connection is made and
120 no articles are fed to the remote site.
121 It is useful to have
122 .IR cron (8)
123 invoke
124 .I innduct
125 with this flag in case a site cannot be reached for an extended period of time.
126 .SH EXAMPLES
127 With the following
128 .IR innduct.ctl (5)
129 control file:
130 .PP
131 .RS
132 .nf
133 nsavax:erehwon.nsavax.gov::-S -t60
134 group70:group70.org::
135 walldrug:walldrug.com:4m-1m:-T1800 -t300
136 kremvax:kremvax.cis:2m:
137 .fi
138 .RE
139 .PP
140 The command:
141 .PP
142 .RS
143 innduct
144 .PP
145 .RE
146 will result in the following:
147 .PP
148 .RS
149 .nf
150 Sitename        Truncation      Innxmit flags
151 nsavax          (none)          \-a \-S \-t60
152 group70         (none)          \-a \-t180
153 walldrug        1m if >4m       \-a \-T1800 \-t300
154 kremvax         2m              \-a \-t180
155 .fi
156 .RE
157 .PP
158 The command:
159 .PP
160 .RS
161 innduct \-d \-T1200
162 .RE
163 .PP
164 will result in the following:
165 .PP
166 .RS
167 .nf
168 Sitename        Truncation      Innxmit flags
169 nsavax          (none)          \-a \-d \-S \-T1200 \-t60
170 group70         (none)          \-a \-d \-T1200 \-t180
171 walldrug        1m if >4m       \-a \-d \-T1200 \-t300
172 kremvax         2m              \-a \-d \-T1200 \-t180
173 .fi
174 .RE
175 .PP
176 The command:
177 .PP
178 .RS
179 innduct \-s 5m \-T1200 nsavax erehwon.nsavax.gov group70 group70.org
180 .PP
181 .RE
182 will result in the following:
183 .PP
184 .RS
185 .nf
186 Sitename        Truncation      Innxmit flags
187 nsavax          5m              \-a \-T1200 \-t180
188 group70         5m              \-a \-T1200 \-t180
189 .fi
190 .RE
191 .PP
192 Remember that ``\-a'' is always given, and ``\-t'' defaults to 180.
193 .SH HISTORY
194 Written by Landon Curt Noll <chongo@toad.com>
195 and Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
196 .de R$
197 This is revision \\$3, dated \\$4.
198 ..
199 .R$ $Id: innduct.8 5909 2002-12-03 05:17:18Z vinocur $
200 .SH "SEE ALSO"
201 inn.conf(5),
202 innxmit(1), 
203 newsfeeds(5),
204 innduct.ctl(5),
205 shrinkfile(1).