chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / perl-nocem.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 "PERL-NOCEM 8"
132 .TH PERL-NOCEM 8 "2008-04-06" "INN 2.4.4" "InterNetNews Documentation"
133 .SH "NAME"
134 perl\-nocem \- A NoCeM\-on\-spool implementation for INN\ 2.x
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 perl-nocem
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 NoCeM, which is pronounced \fINo See 'Em\fR, is a protocol enabling
141 authenticated third-parties to issue notices which can be used
142 to cancel unwanted articles (like spam and articles in moderated
143 newsgroups which were not approved by their moderators).  It can
144 also be used by readers as a \fIthird-party killfile\fR.  It is
145 intended to eventually replace the protocol for third-party cancel
146 messages.
147 .PP
148 \&\fBperl-nocem\fR processes third\-party, PGP-signed article cancellation
149 notices.  It is possible not to honour all NoCeM notices but only those
150 which are sent by people whom you trust (that is to say if you trust
151 the \s-1PGP\s0 key they use to sign their NoCeM notices).  Indeed, it is up
152 to you to decide whether you wish to honour their notices, depending
153 on the criteria they use.
154 .PP
155 Processing NoCeM notices is easy to set up:
156 .IP "1." 4
157 Import the keys of the NoCeM issuers you trust in order to check
158 the authenticity of their notices.  You can do:
159 .Sp
160 .Vb 3
161 \&    gpg \-\-no\-default\-keyring \-\-primary\-keyring=/etc/news/pgp/ncmring.gpg \e
162 \&        \-\-no\-options \-\-allow\-non\-selfsigned\-uid \-\-no\-permission\-warning \e
163 \&        \-\-batch \-\-import <key\-file>
164 .Ve
165 .Sp
166 where <pathetc> is the value of the \fIpathetc\fR parameter set in \fIinn.conf\fR
167 and <key\-file> the file containing the key(s) to import.  The keyring
168 must be located in \fIpathetc\fR/pgp/ncmring.gpg (create the directory
169 before using \fBgpg\fR).  For old PGP-generated keys, you may have to use
170 \&\fB\-\-allow\-non\-selfsigned\-uid\fR if they are not properly self\-signed,
171 but anyone creating a key really should self-sign the key.  Current
172 \&\s-1PGP\s0 implementations do this automatically.
173 .Sp
174 The keys of NoCeM issuers can be found in the web site of \fIThe NoCeM Registry\fR:
175 <http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html>.  You can even
176 download there a unique file which contains all the keys.
177 .IP "2." 4
178 Create a \fInocem.ctl\fR config file in \fIpathetc\fR indicating the NoCeM issuers
179 and notices you want to follow.  This permission file contains lines like:
180 .Sp
181 .Vb 3
182 \&    annihilator\-1:*
183 \&    clewis@ferret.ocunix:mmf
184 \&    stephane@asynchrone:mmf,openproxy,spam
185 .Ve
186 .Sp
187 This will remove all articles for which the issuer (first part of the line,
188 before the colon \f(CW\*(C`:\*(C'\fR) has issued NoCeM notices corresponding to the
189 criteria specified after the colon.
190 .Sp
191 You will also find information about that on the web site of
192 \&\fIThe NoCeM Registry\fR.
193 .IP "3." 4
194 Add to the \fInewsfeeds\fR file an entry like this one in order to feed
195 \&\fBperl-nocem\fR the NoCeM notices posted to alt.nocem.misc and
196 news.lists.filters:
197 .Sp
198 .Vb 3
199 \&    nocem!\e
200 \&        :!*,alt.nocem.misc,news.lists.filters\e
201 \&        :Tc,Wf,Ap:<pathbin>/perl\-nocem
202 .Ve
203 .Sp
204 with the correct path to \fBperl-nocem\fR, located in <pathbin>.  Then, reload
205 the \fInewsfeeds\fR file (\f(CW\*(C`ctlinnd reload newsfeeds 'NoCeM channel feed'\*(C'\fR).
206 .Sp
207 Note that you should at least carry news.lists.filters on your news
208 server (or other newsgroups where NoCeM notices are sent) if you wish
209 to process them.
210 .IP "4." 4
211 Everything should now work.  However, do not hesitate to manually test
212 \&\fBperl-nocem\fR with a NoCeM notice, using:
213 .Sp
214 .Vb 1
215 \&    grephistory '<Message\-ID>' | perl\-nocem
216 .Ve
217 .Sp
218 Indeed, \fBperl-nocem\fR expects tokens on its standard input, and
219 \&\fBgrephistory\fR can easily give it the token of a known article,
220 thanks to its Message\-ID.
221 .PP
222 When you have verified that everything works, you can eventually turn
223 off regular spam cancels, if you want, not processing any longer
224 cancels containing \f(CW\*(C`cyberspam\*(C'\fR in the Path: header (see the
225 \&\fIrefusecybercancels\fR parameter in \fIinn.conf\fR).
226 .SH "FILES"
227 .IX Header "FILES"
228 .IP "\fIpathbin\fR/perl\-nocem" 4
229 .IX Item "pathbin/perl-nocem"
230 The Perl script itself used to process NoCeM notices.
231 .IP "\fIpathetc\fR/nocem.ctl" 4
232 .IX Item "pathetc/nocem.ctl"
233 The configuration file which specifies the NoCeM notices to be processed.
234 .IP "\fIpathetc\fR/pgp/ncmring.gpg" 4
235 .IX Item "pathetc/pgp/ncmring.gpg"
236 The keyring which contains the public keys of trusted NoCeM issuers.
237 .SH "BUGS"
238 .IX Header "BUGS"
239 The Subject: header is not checked for the @@NCM string and there is no
240 check for the presence of the References: header.
241 .PP
242 The Newsgroups: pseudo header is not checked, but this can be done in
243 \&\fIlocal_want_cancel_id()\fR.
244 .PP
245 The Hierarchies: header is ignored.
246 .SH "HISTORY"
247 .IX Header "HISTORY"
248 Copyright 2000 by Miquel van Smoorenburg <miquels@cistron.nl>.
249 .PP
250 Copyright 2001 by Marco d'Itri <md@linux.it>.
251 .PP
252 $Id: perl-nocem.8 7733 2008-04-06 09:16:20Z iulius $
253 .SH "SEE ALSO"
254 .IX Header "SEE ALSO"
255 \&\fIgpgv\fR\|(1), \fIgrephistory\fR\|(1), \fIinn.conf\fR\|(5), \fInewsfeeds\fR\|(5), \fIpgp\fR\|(1).