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