Mercurial > noffle

comparison docs/noffle.conf.5 @ 128:8897b7e3b108 noffle

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] Add article filtering
author bears
date Wed, 09 Aug 2000 22:19:17 +0100
parents 6f681d41734c
children 7dfbb1c20a81
comparison
equal deleted inserted replaced
127:3c71e28c8eef 128:8897b7e3b108
1 .TH noffle.conf 5 1 .TH noffle.conf 5
2 .\" $Id: noffle.conf.5 155 2000-06-24 20:28:01Z bears $ 2 .\" $Id: noffle.conf.5 189 2000-08-09 21:19:17Z bears $
3 3
4 .SH NAME 4 .SH NAME
5 noffle.conf \- Configuration file for NOFFLE news server 5 noffle.conf \- Configuration file for NOFFLE news server
6 6
7 .SH DESCRIPTION 7 .SH DESCRIPTION
200 until the first match occurs. If no pattern matches the group name, the 200 until the first match occurs. If no pattern matches the group name, the
201 .B default expiry period 201 .B default expiry period
202 is used. An expiry period of 0 means "never". 202 is used. An expiry period of 0 means "never".
203 .br 203 .br
204 Default: no 204 Default: no
205
206 .TP
207 .B filter <filter specification>
208 Add the specified filter to the list of filters to be applied to incoming
209 articles. Filters are applied in the order in which they appear in
210 .I /etc/noffle.conf
211 and are further described in the section
212 .B FILTERS
213 below.
214 .br
215 Default: No filters
205 216
206 .SH "GROUP NAME WILDCARDS" 217 .SH "GROUP NAME WILDCARDS"
207 218
208 .B NOFFLE 219 .B NOFFLE
209 uses a wildcard format that closely matches filename-style wildcards. 220 uses a wildcard format that closely matches filename-style wildcards.
252 which is interpreted as described above. 263 which is interpreted as described above.
253 For example, 264 For example,
254 .I [^]\-] 265 .I [^]\-]
255 matches any character other than a close bracket or minus sign. 266 matches any character other than a close bracket or minus sign.
256 267
268 .SH FILTERS
269
270 .B NOFFLE
271 supports basic filtering on incoming articles. Articles to be downloaded
272 can be matched against one or more criteria and matching articles are
273 marked for download using one of the group subscribe modes
274 .BR full ,
275 .B over
276 or
277 .BR thread .
278 Alternatively the filter may specify that the article mode is
279 .B discard
280 in which case neither the article nor the article overview will
281 be downloaded.
282
283 .PP
284 A
285 .B filter
286 configuration line consist of one or more filter specifications
287 following the
288 .B filter
289 keyword on the line. The available specifications are:
290
291 .PP
292 .B action
293 =
294 .IR "full|over|thread|discard" .
295 Specifies the action to be taken if the filter matches. If not specified,
296 the default action is as specified by the group's default subscription mode.
297 .PP
298 .B group
299 =
300 .IR "<group pattern>" .
301 Matches if any group in which the article appears matches the
302 specified group pattern.
303 .PP
304 .B subject
305 =
306 .IR "<regular expression>" .
307 Matches if the article subject matches the given regular expression.
308 See the section on regular expressions below.
309 .PP
310 .B from
311 =
312 .IR "<regular expression>" .
313 Matches if the article subject matches the given regular expression.
314 See the section on regular expressions below.
315 .PP
316 .B msgid
317 =
318 .IR "<regular expression>" .
319 Matches if the article message ID matches the given regular expression.
320 See the section on regular expressions below.
321 .PP
322 .B bytes
323 < or = or >
324 .IR <number> .
325 Matches if the number of bytes in the article is less than, equal to, or
326 greater than the given number.
327 .PP
328 .B lines
329 < or = or >
330 .IR <number> .
331 Matches if the number of lines in the article is less than, equal to, or
332 greater than the given number.
333 .PP
334 .B refs
335 < or = or >
336 .IR <number> .
337 Matches if the number of articles referenced by the article is less
338 than, equal to, or greater than the given number.
339 .PP
340 .B xposts
341 < or = or >
342 .IR <number> .
343 Matches if the number of groups the article is posted to is less
344 than, equal to, or greater than the given number.
345
346 .PP
347 For example, the following filters download all articles in groups
348 in the alt.binaries tree in full if they are < 10k in size, otherwise
349 downloads overviews.
350 .PP
351 .I filter group=alt.binaries.* bytes < 10240 action=full
352 .br
353 .I filter group=alt.binaries.* action=over
354 .PP
355 This filter discards all articles with a subject resembling
356 the infamous "$$$ Make Money Now! $$$".
357 .PP
358 \fIfilter subject="\\$*.*Make.*[M|m]oney.*\\$" action=discard\fR
359
360 .SH REGULAR EXPRESSIONS
361
362 .B NOFFLE
363 uses extended POSIX-style regular expressions in its filters. Regular
364 expressions are a powerful means of describing patterns that match
365 text. A full description is to be found in
366 .BR regex (7).
257 367
258 .SH SEE ALSO 368 .SH SEE ALSO
259 369
260 .BR noffle (1) 370 .BR noffle (1)
371 .BR regex (7)
261 372
262 .SH AUTHORS 373 .SH AUTHORS
263 374
264 Markus Enzenberger <markus.enzenberger@t-online.de> 375 Markus Enzenberger <markus.enzenberger@t-online.de>
265 .br 376 .br