chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / moderators.5
1 .\" $Revision: 5909 $
2 .TH MODERATORS 5
3 .SH NAME
4 moderators \- submission addresses for moderated newsgroups
5 .SH DESCRIPTION
6 When an unapproved article is posted locally to a moderated newsgroup,
7 it is not passed off to
8 .IR innd (8)
9 for normal handling; instead it's instead sent via e-mail to the submission
10 address for that newsgroup.  The file
11 .I <pathetc in inn.conf>/moderators
12 lists the submission addresses for moderated newsgroups.
13 This file is used by
14 .IR nnrpd "(8), " inews (1),
15 and any other program that uses the GetModeratorAddress() routine (see
16 .IR libinn (3)).
17 .PP
18 The moderators file is a list of associations between
19 .IR uwildmat(3)
20 patterns matching newsgroups and the submission address for those
21 newsgroups.
22 Blank lines and lines starting with a number sign (``#'') are ignored.
23 All other lines should consist of two fields separated by a colon.
24 .PP
25 The first field specifies the group or groups to match using
26 .IR uwildmat(3).
27 The first matching line is used, so more specific patterns should occur
28 earlier than general patterns.
29 .PP
30 The second field, the submission address, may have at most one
31 .I %s
32 anywhere in it; if present, this will be replaced by the name of the
33 newsgroup with periods replaced by dashes.  If there is a literal ``%'' in
34 the submission address, it must be written as ``%%'' (even if not followed
35 by an ``s'').
36 .PP
37 Here is a sample file:
38 .RS
39 .nf
40
41 example.important:announce-request@example.com
42 example.*:%s@smtp.example.com
43 gnu.*:%s@prep.ai.mit.edu
44 *:%s@moderators.isc.org
45
46 .fi
47 .RE
48 Using the above file, postings to the moderated newsgroup in the left
49 column will be sent to the address shown in the right column:
50 .RS
51 .nf
52
53 .ta \w'example.x.announce   'u
54 example.important       announce-request@example.com
55 example.x.announce      example-x-announce@smtp.example.com
56 gnu.emacs.sources       gnu-emacs-sources@prep.ai.mit.edu
57 comp.sources.unix       comp-sources-unix@moderators.isc.org
58
59 .fi
60 .RE
61 Periods are converted to dashes for historical reasons, from back in the
62 days when periods in the local part of addresses were not always handled
63 correctly.  It's probably no longer necessary, but so much now depends on
64 it that it can't be easily changed.
65 .PP
66 It's intended that the sample moderators file included in the INN
67 distribution always be sufficient for all world-wide newsgroups.  The
68 hosts behind moderators.isc.org have graciously volunteered to handle
69 forwarding tasks for all world-wide newsgroups so that individual sites
70 don't have to keep track of the submission addresses for moderated groups.
71 The forwarding database used by moderators.isc.org is coordinated by
72 moderators-request@isc.org; if you know of a world-wide newsgroup
73 hierarchy that is not correctly handled by moderators.isc.org, please send
74 the details to that address.
75 .PP
76 Given that, the only thing you should have to add to the sample file under
77 normal circumstances are the forwarding addresses for local or 
78 limited-distribution moderated groups.
79 .SH HISTORY
80 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
81 .de R$
82 This is revision \\$3, dated \\$4.
83 ..
84 .R$ $Id: moderators.5 5909 2002-12-03 05:17:18Z vinocur $
85 .SH "SEE ALSO"
86 inews(1), inn.conf(5), libinn(3), uwildmat(3).