chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / man / send-uucp.8
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "SEND-UUCP 8"
132 .TH SEND-UUCP 8 "2008-04-06" "INN 2.4.4" "InterNetNews Documentation"
133 .SH "NAME"
134 send\-uucp \- Send Usenet articles via UUCP
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBsend-uucp\fR [\fI\s-1SITE\s0\fR ...]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 The \fBsend-uucp\fR program processes batch files written by \fIinnd\fR\|(8) to send
141 Usenet articles to \s-1UUCP\s0 sites.  It reads a configuration file to control how
142 it behaves with various sites.  Normally, it's run periodically out of cron
143 to put together batches and send them to remote \s-1UUCP\s0 sites.
144 .SH "OPTIONS"
145 .IX Header "OPTIONS"
146 Any arguments provided to the program are interpreted as a list of sites
147 specfied in \fIsend\-uucp.cf\fR for which batches should be generated.  If no
148 arguments are supplied then batches will be generated for all sites listed
149 in that configuration file.
150 .SH "CONFIGURATION"
151 .IX Header "CONFIGURATION"
152 The sites to which articles are to be sent must be configured in the
153 configuration file \fIsend\-uucp.cf\fR.  Each site is specified with a line of
154 the form:
155 .PP
156 .Vb 1
157 \&    site[:host[:funnel]] [compressor [maxsize [batchtime]]]
158 .Ve
159 .IP "\fIsite\fR" 4
160 .IX Item "site"
161 The news site name being configured.  This must match a site name 
162 from \fInewsfeeds\fR\|(5).
163 .IP "\fIhost\fR" 4
164 .IX Item "host"
165 The \s-1UUCP\s0 host name to which batches should be sent for this site.
166 If omitted, the news site name will be used as the \s-1UUCP\s0 host name.
167 .IP "\fIfunnel\fR" 4
168 .IX Item "funnel"
169 In the case of a site configured as a funnel, \fBsend-uucp\fR needs to flush
170 the channel (or exploder) being used as the target of the funnel instead of
171 flushing the site.  This is the way to tell \fBsend-uucp\fR the name of the
172 channel or exploder to flush for this site.  If not specified, default to
173 flushing the site.
174 .IP "\fIcompressor\fR" 4
175 .IX Item "compressor"
176 The compression method to use for batches.  This should be one of compress,
177 gzip or none.  Arguments for the compression command may be specified by
178 using \f(CW\*(C`_\*(C'\fR instead of spaces. For example, \f(CW\*(C`gzip_\-9\*(C'\fR.  The default value is
179 \&\f(CW\*(C`compress\*(C'\fR.
180 .IP "\fImaxsize\fR" 4
181 .IX Item "maxsize"
182 The maximum size of a single batch before compression.  The default value is
183 500,000 bytes.
184 .IP "\fIbatchtime\fR" 4
185 .IX Item "batchtime"
186 A comma separated list of hours during which batches should be generated for
187 a given site.  When \fBsend-uucp\fR runs, a site will only be processed if the
188 current hour matches one of the hours in \fIbatchtime\fR.  The default is no
189 limitation on when to generate batches.
190 .PP
191 Fields are seperated by spaces and only the site name needs to be specified,
192 with defaults being used for unspecified values.  If the first character on
193 a line is a \f(CW\*(C`#\*(C'\fR then the rest of the line is ignored.
194 .SH "EXAMPLE"
195 .IX Header "EXAMPLE"
196 Here is an example send\-uucp.cf configuration file:
197 .PP
198 .Vb 8
199 \&    zoetermeer      gzip            1048576         5,18,22
200 \&    hoofddorp       gzip            1048576         5,18,22
201 \&    pa3ebv          gzip            1048576         5,18,22
202 \&    drinkel         gzip            1048576         5,6,18,20,22,0,2
203 \&    manhole         compress        1048576         5,18,22
204 \&    owl             compress        1048576
205 \&    able
206 \&    pern::MYFUNNEL!
207 .Ve
208 .PP
209 This defines eight \s-1UUCP\s0 sites.  The first four use gzip compression and the
210 last three use compress.  The first six use a batch size of 1MB, and the
211 last site (able) uses the default of 500,000 bytes.  The zoetermeer,
212 hoofddorp, pa3ebv, and manhole sites will only have batches generated for
213 them during the hours of 05:00, 18:00, and 22:00, and the drinkel site will
214 only have batches generated during those hours and 20:00, 00:00, and 02:00.
215 There are no restrictions on when batches will be generated for owl or able.
216 .PP
217 The pern site is configured as a funnel into \f(CW\*(C`MYFUNNEL!\*(C'\fR.  \fBsend-uucp\fR will
218 issue \f(CW\*(C`ctlinnd flush MYFUNNEL!\*(C'\fR instead of \f(CW\*(C`ctlinnd flush pern\*(C'\fR.
219 .SH "FILES"
220 .IX Header "FILES"
221 .IP "\fIpathetc\fR/send\-uucp.cf" 4
222 .IX Item "pathetc/send-uucp.cf"
223 Configuration file specifying a list of sites to be processed.  
224 .SH "NOTES"
225 .IX Header "NOTES"
226 The usual flags used for a \s-1UUCP\s0 feed in the \fInewsfeeds\fR file are \f(CW\*(C`Tf,Wfb\*(C'\fR.
227 .SH "SEE ALSO"
228 .IX Header "SEE ALSO"
229 \&\fIinnd\fR\|(8), \fInewsfeeds\fR\|(5), \fIuucp\fR\|(8)
230 .SH "AUTHOR"
231 .IX Header "AUTHOR"
232 This program was originally written by Edvard Tuinder <ed@elm.net> and then
233 maintained and extended by Miquel van Smoorenburg <miquels@cistron.nl>.
234 Marco d'Itri <md@linux.it> cleaned up the code for inclusion in \s-1INN\s0.  This
235 manual page was written by Mark Brown <broonie@sirena.org.uk>.