chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / news2mail.8
1 .\" -*- nroff -*-
2 .\" $Revision: 5909 $
3 .TH NEWS2MAIL 8
4 .SH NAME
5 news2mail \- a channel script to gateway news into email.
6 .SH SYNOPSIS
7 .I news2mail
8 .SH DESCRIPTION
9 .I news2mail
10 runs as a channel process underneath innd. It is set up as channel feed in
11 newsfeeds, with different mailing lists as funnel entries pointing to it (see
12 below).
13 .PP
14 .I news2mail
15 uses a config file 
16 .PP
17 .RS
18 .I <pathetc\ in\ inn.conf>/news2mail.cf
19 .RE
20 .PP
21 to map mailing list names to email addresses.
22 .PP
23 .I news2mail
24 causes sendmail to queue the messages for later delivery (to avoid DOS attacks
25 by mass postings). You must run 'sendmail -q' periodically to get the queue
26 processed.
27 .SH CONFIG FILE
28 The config file format is simple: comments (start with ``#'') and blank lines
29 are ignored. All other lines have two fields on them. The first is the list
30 name and is what innd uses (i.e. the site field of the entry in the newsfeeds
31 file). The second field is the actual email address to send the article to. In
32 the email message, the ``To'' header will have the mailing list name (i.e. the
33 first field).
34 .PP
35 .RS
36 .nf
37 # list-name             address
38 big-red-ants@ucsd.edu   big-red-ants-digest@ucsd.edu            
39 news-software@ucsd.edu  news-software-digest@ucsd.edu
40 .fi
41 .RE
42 .PP
43 a set of newsfeeds entries for these lists would be:
44 .PP
45 .RS
46 .nf
47 .ds R$ <pathbin in inn.conf>
48 n2m!:!*:Tc,Ac,Wn*:\*(R$/news2mail
49
50 big-red-ants@ucsd.edu:rec.pets.redants.*:Tm:n2m!
51
52 news-software@ucsd.edu:news.software.nntp:Tm:n2m!
53 .fi
54 .RE
55 .PP
56 .I news2mail
57 strips most article headers from the article before mailing. It leaves: From, Subject
58 Date, Organization and Message-ID in there. It add a To header with the mailing 
59 list name in it.
60 .SH HISTORY
61 news2mail was written by Brian Kantor. This man page was written by James
62 Brister.
63 .de R$
64 This is revision \\$3, dated \\$4.
65 ..
66 .R$ $Id: news2mail.8 5909 2002-12-03 05:17:18Z vinocur $
67 .SH "SEE ALSO"
68 ctlinnd(8),
69 inn.conf(5),
70 innd(8),
71 newsfeeds(5),
72 shlock(1).
73