chiark / gitweb /
option for no inotify; manpage fix
[innduct.git] / doc / man / innxmit.8
1 .\" $Revision: 5909 $
2 .TH INNXMIT 8
3 .SH NAME
4 innxmit \- send Usenet articles to a remote NNTP server
5 .SH SYNOPSIS
6 .I innxmit
7 [
8 .B \-a
9 ]
10 [
11 .B \-c
12 ]
13 [
14 .B \-d
15 ]
16 [
17 .B \-H
18 ]
19 [
20 .B \-l
21 ]
22 [
23 .BI \-P " portnum"
24 ]
25 [
26 .B \-p
27 ]
28 [
29 .B \-r
30 ]
31 [
32 .B \-s
33 ]
34 [
35 .BI \-T " timeout"
36 ]
37 [
38 .BI \-t " timeout"
39 ]
40 .I host
41 .I file
42 .SH DESCRIPTION
43 .I Innxmit
44 connects to the NNTP server at the specified
45 .I host
46 (validating itself via
47 .IR passwd.nntp
48 if possible) 
49 and sends it the articles specified in the batchfile named
50 .IR file .
51 It is normally invoked by a script run out of
52 .IR cron (8)
53 that uses
54 .IR shlock (1)
55 to lock the host name, followed by a
56 .IR ctlinnd (8)
57 command to flush the batchfile.
58 .PP
59 If the
60 .I file
61 is not an absolute pathname, it is taken relative to the
62 .I <pathoutgoing in inn.conf>
63 directory.
64 It is normally written by specifying the ``Wnm'' flags in the
65 .I newsfeeds
66 file.
67 Each line in the batchfile should be in one of the following formats:
68 .PP
69 .RS
70 .nf
71 token Message-ID
72 token
73 .fi
74 .RE
75 .PP
76 The
77 .I token
78 field names the article to be sent.
79 If the
80 .I Message-ID
81 field is not specified, it will be obtained by scanning the article.
82 The
83 .I token
84 and
85 .I Message-Id
86 fields are separated by a space.
87 .PP
88 If a communication error such as a
89 .IR write (2)
90 failure occurs,
91 .I innxmit
92 will stop sending and rewrite the batchfile to contain the current
93 article and any other unsent articles.
94 .SH OPTIONS
95 .TP
96 .B \-a
97 If all articles were sent successfully,
98 .I innxmit
99 will remove the batchfile; otherwise it will rewrite it to contain the
100 list of unsent articles.
101 If no articles were sent or rejected, the file is left untouched.
102 This can cause the batchfile to grow excessively large if many articles
103 have been expired and there are communication problems.
104 To always rewrite the batchfile, use the ``\fB\-a\fP'' flag.
105 .TP
106 .B \-c
107 In streaming mode, a check of each message ID is still made to avoid sending
108 articles already on the server.
109 The ``\fB\-c\fP'' flag will, if streaming mode is supported,
110 result in sending articles without checking.
111 This results in slightly greater throughput and may be appropriate when
112 it is known that the site could not already have the articles such as in
113 the case of a "leaf" site.
114 .TP
115 .B \-d
116 Use the ``\fB\-d\fP'' flag to print debugging information on standard error.
117 This will show the protocol transactions between
118 .I innxmit
119 and the NNTP server on the remote host.
120 .TP
121 .B \-H
122 If the ``\fB\-H\fP'' flag is given, then only headers are sent to
123 .I host
124 for all articles except control messages.
125 And Bytes: header is also included even if it does not exist in the original
126 article.  ``\fB\-H\fP'' flag is useful for diablo reader.
127 .TP
128 .B \-l
129 The ``\fB\-l\fP'' flag is used to turn on logging of reasons the remote gives
130 for rejecting an article.
131 .TP
132 .B \-P portnum
133 To specify a port number other than the default, use the ``\fB\-P\fP'' flag.
134 .TP
135 .B \-p
136 If the ``\fB\-p\fP'' flag is given, then no connection is made and the batchfile
137 is purged of entries that refer to files that no longer exist.
138 This implies the ``\fB\-a\fP'' flag.
139 .TP
140 .B \-r
141 If the remote server sends an unexpected reply code,
142 .I innxmit
143 will requeue the article and proceed.
144 Use the ``\fB\-r\fP'' flag if the article should not be requeued.
145 .TP
146 .B \-s
147 .I Innxmit
148 will attempt to negotiate a streaming mode extension of the NNTP
149 protocol with the server at connect time.
150 If successful it will use a slightly different protocol that enhances
151 throughput.
152 If the server does not recognize the streaming mode negotiation
153 .I innxmit
154 will revert to normal NNTP transfer mode.
155 Use the ``\fB\-s\fP'' flag to disable the attempt to negotiate the streaming
156 mode extension.
157 .TP
158 .B \-T seconds
159 To specify the total amount of time that should be allowed for article
160 transfers, use the ``\fB\-T\fP'' flag.
161 The default is to wait until an I/O error occurs, or all the articles have
162 been transferred.
163 If the ``\fB\-T\fP'' flag is used, the time is checked just before each
164 article is started; it will not abort a transfer that is in progress.
165 .TP
166 .B \-t seconds
167 .I Innxmit
168 normally blocks until the connection is made.
169 To specify a timeout on how long to try to make the connection, use 
170 the ``\fB\-t\fP''
171 flag.
172 .TP
173 .B \-v
174 Upon exit,
175 .I innxmit
176 reports transfer and CPU usage statistics via
177 .IR syslog (3).
178 If the ``\fB\-v\fP'' flag is used, they will also be printed on the standard
179 output.
180 .SH HISTORY
181 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
182 .de R$
183 This is revision \\$3, dated \\$4.
184 ..
185 .R$ $Id: innxmit.8 5909 2002-12-03 05:17:18Z vinocur $
186 .SH "SEE ALSO"
187 ctlinnd(8),
188 inn.conf(5),
189 innd(8),
190 newsfeeds(5),
191 shlock(1).