Mercurial > noffle
diff docs/noffle.conf.5 @ 128:8897b7e3b108 noffle
[svn] Add article filtering
author | bears |
---|---|
date | Wed, 09 Aug 2000 22:19:17 +0100 |
parents | 6f681d41734c |
children | 7dfbb1c20a81 |
line wrap: on
line diff
--- a/docs/noffle.conf.5 Tue Jul 25 13:14:54 2000 +0100 +++ b/docs/noffle.conf.5 Wed Aug 09 22:19:17 2000 +0100 @@ -1,5 +1,5 @@ .TH noffle.conf 5 -.\" $Id: noffle.conf.5 155 2000-06-24 20:28:01Z bears $ +.\" $Id: noffle.conf.5 189 2000-08-09 21:19:17Z bears $ .SH NAME noffle.conf \- Configuration file for NOFFLE news server @@ -203,6 +203,17 @@ .br Default: no +.TP +.B filter <filter specification> +Add the specified filter to the list of filters to be applied to incoming +articles. Filters are applied in the order in which they appear in +.I /etc/noffle.conf +and are further described in the section +.B FILTERS +below. +.br +Default: No filters + .SH "GROUP NAME WILDCARDS" .B NOFFLE @@ -254,10 +265,110 @@ .I [^]\-] matches any character other than a close bracket or minus sign. +.SH FILTERS + +.B NOFFLE +supports basic filtering on incoming articles. Articles to be downloaded +can be matched against one or more criteria and matching articles are +marked for download using one of the group subscribe modes +.BR full , +.B over +or +.BR thread . +Alternatively the filter may specify that the article mode is +.B discard +in which case neither the article nor the article overview will +be downloaded. + +.PP +A +.B filter +configuration line consist of one or more filter specifications +following the +.B filter +keyword on the line. The available specifications are: + +.PP +.B action += +.IR "full|over|thread|discard" . +Specifies the action to be taken if the filter matches. If not specified, +the default action is as specified by the group's default subscription mode. +.PP +.B group += +.IR "<group pattern>" . +Matches if any group in which the article appears matches the +specified group pattern. +.PP +.B subject += +.IR "<regular expression>" . +Matches if the article subject matches the given regular expression. +See the section on regular expressions below. +.PP +.B from += +.IR "<regular expression>" . +Matches if the article subject matches the given regular expression. +See the section on regular expressions below. +.PP +.B msgid += +.IR "<regular expression>" . +Matches if the article message ID matches the given regular expression. +See the section on regular expressions below. +.PP +.B bytes +< or = or > +.IR <number> . +Matches if the number of bytes in the article is less than, equal to, or +greater than the given number. +.PP +.B lines +< or = or > +.IR <number> . +Matches if the number of lines in the article is less than, equal to, or +greater than the given number. +.PP +.B refs +< or = or > +.IR <number> . +Matches if the number of articles referenced by the article is less +than, equal to, or greater than the given number. +.PP +.B xposts +< or = or > +.IR <number> . +Matches if the number of groups the article is posted to is less +than, equal to, or greater than the given number. + +.PP +For example, the following filters download all articles in groups +in the alt.binaries tree in full if they are < 10k in size, otherwise +downloads overviews. +.PP +.I filter group=alt.binaries.* bytes < 10240 action=full +.br +.I filter group=alt.binaries.* action=over +.PP +This filter discards all articles with a subject resembling +the infamous "$$$ Make Money Now! $$$". +.PP +\fIfilter subject="\\$*.*Make.*[M|m]oney.*\\$" action=discard\fR + +.SH REGULAR EXPRESSIONS + +.B NOFFLE +uses extended POSIX-style regular expressions in its filters. Regular +expressions are a powerful means of describing patterns that match +text. A full description is to be found in +.BR regex (7). .SH SEE ALSO .BR noffle (1) +.BR regex (7) .SH AUTHORS