annotate docs/noffle.conf.5 @ 212:21200ce10e68 noffle

[svn] filter post-status=mod|yes|no.
author mirkol
date Thu, 22 Nov 2001 12:04:45 +0000
parents 76460d98b2fb
children bf290632d29e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
1 .TH noffle.conf 5
212
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
2 .\" $Id: noffle.conf.5 331 2001-11-22 12:04:45Z mirkol $
85
dfcb28566d36 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 84
diff changeset
3
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
4 .SH NAME
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
5 noffle.conf \- Configuration file for NOFFLE news server
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
6
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
7 .SH DESCRIPTION
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
8
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
9 The
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
10 .B NOFFLE
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
11 news server - see
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
12 .BR noffle (1)
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
13 - takes its configuration from a configuration file.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
14 By default this file is \fI/etc/noffle.conf\fP.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
15
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
16 .PP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
17 .B noffle.conf
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
18 is a normal text file containing
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
19 .B NOFFLE
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
20 settings, one per line.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
21
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
22 .PP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
23 Leading whitespace on a line is ignored, as is any comment
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
24 text. Comment text begins with a '#' character and continues to the
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
25 end of the line. Blank lines are permitted.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
26
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
27 .SH SETTINGS
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
28
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
29 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
30 .B server <hostname>[:<port>] [<user> <pass>]
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
31 Name of the remote server. If no port given, port 119 is used.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
32 Username and password for servers that need authentication
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
33 (Original AUTHINFO). The password may not contain white-spaces.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
34 If there are multiple server entries in the config file, all of them are
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
35 used for getting groups. In this case the first server should be
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
36 the one of your main provider. Note that you must always
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
37 run 'noffle --query groups'
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
38 after making changes to the server entries.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
39
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
40 .TP
88
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
41 .B getgroups <group pattern> [, <group pattern> ...]
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
42 Only retrieve from the most recently specified server newsgroups that match
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
43 the specified patterns. The patterns can contain \fIwildcards\fP, and
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
44 there can be multiple
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
45 .B getgroups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
46 lines. For further details on
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
47 .B getgroups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
48 processing in tandem with \fBomitgroups\fP, see the section on
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
49 .B omitgroups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
50 following.
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
51 .br
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
52 Default: All groups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
53
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
54 .TP
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
55 .B omitgroups <group pattern> [, <group pattern> ...]
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
56 Don't retrieve from the most recently specified server newsgroups that match
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
57 the specified patterns. The patterns can contain \fIwildcards\fP, and
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
58 there can be multiple
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
59 .B omitgroups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
60 lines. When processing a new newsgroup name, it is checked first to see
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
61 if it appears on the
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
62 .B getgroups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
63 list (if any). If not, the group is rejected.
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
64 Then the group is checked to see if it appears on the
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
65 .B omitgroups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
66 list. If it does not, the group is accepted as a group
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
67 .B NOFFLE
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
68 will list and collect as required.
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
69 .br
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
70 Default: No groups
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
71
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
72 .TP
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
73 .B max-fetch <n>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
74 Never get more than <n> articles. If there are more, the oldest ones
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
75 are discarded.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
76 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
77 Default: 300
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
78
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
79 .TP
150
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
80 .B from-domain <domain>
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
81 When invoked as
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
82 .BR inews (1)
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
83 .B NOFFLE
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
84 will add a From: line to posts that lack one. The address given
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
85 uses the userid of the user who invoked
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
86 .B inews
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
87 and the specified domain.
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
88 .br
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
89 Default: The system domain
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
90
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
91 .TP
185
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
92 .B log-debug <log category> [<log category ...]
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
93 Log debugging information from the specified log category
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
94 or categories. Logging is via the system logging daemon
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
95 .BR syslogd (8)
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
96 (to the debug facility) and additionally to stderr when running
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
97 interactively. The available categories for logging are
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
98 .BR all ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
99 .BR none ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
100 .BR config ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
101 .BR control ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
102 .BR expire ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
103 .BR fetch ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
104 .BR filter ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
105 .BR newsbase ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
106 .BR noffle ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
107 .BR post ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
108 .BR protocol ,
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
109 .BR requests
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
110 and
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
111 .BR server.
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
112 The
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
113 .B noffle
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
114 category is automatically selected whenever any other category is
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
115 selected. These messages are in addition to messages logged to the
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
116 system logging daemon error, information and notification facilities.
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
117 .br
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
118 Default: none
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
119
fed1334d766b [svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents: 150
diff changeset
120 .TP
150
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
121 .B organization <organization>
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
122 When invoked as
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
123 .BR inews (1)
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
124 .B NOFFLE
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
125 will, unless the -O flag is specified, add an Organization: line to
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
126 posts that lack one. If no
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
127 .B organization
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
128 is specified, the line is not added.
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
129 .br
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
130 Default: <empty string>
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
131
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
132 .TP
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
133 .B mail-to <address>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
134 Receiver of failed postings. If empty then failed postings are returned
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
135 to the sender (taking the address from the article's Sender, X-Sender or
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
136 From field, in this order).
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
137 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
138 Default: <empty string>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
139
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
140 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
141 .B auto-unsubscribe yes|no
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
142 Automatically remove groups from fetch list if they have not been
194
a4e9a20e50e5 [svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents: 192
diff changeset
143 accessed for a number of days. Groups are only unsubscribed if there
192
b9ef99708d1c [svn] * docs/noffle.conf.5,src/noffle.c: Duh! Do unsubscribing the simple way.
bears
parents: 185
diff changeset
144 are fresh articles arriving and remaining unread.
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
145 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
146 Default: no
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
147
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
148 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
149 .B auto-unsubscribe-days <n>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
150 Number of days used for auto-unsubscribe option.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
151 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
152 Default: 30
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
153
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
154 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
155 .B thread-follow-time <n>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
156 Automatically mark articles for download in thread mode, if they
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
157 are referencing an article that has been opened by a reader within the last
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
158 <n> days.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
159 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
160 Default: 7
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
161
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
162 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
163 .B connect-timeout <n>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
164 Timeout for connecting to remote server in seconds.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
165 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
166 Default: 30
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
167
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
168 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
169 .B auto-subscribe yes|no
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
170 Automatically put groups on fetch list if someone reads them.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
171 <mode> can be full, over, thread (depending on the fetch mode) or
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
172 off (do not subscribe automatically). Condition for putting a group
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
173 on the list is that an article is opened. For this reason there is
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
174 always a pseudo article visible in groups that are not on the fetch list.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
175 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
176 Default: no
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
177
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
178 .TP
107
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
179 .B auto-subscribe-mode <group pattern> full|thread|over
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
180 Mode for auto-subscribe option for groups that match the given
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
181 pattern.
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
182 .br
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
183 Default: none
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
184
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
185 .TP
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
186 .B default-auto-subscribe-mode full|thread|over
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
187 Default mode for auto-subscribe option. Used for all groups that do
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
188 not match a pattern specified with
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
189 .B auto-subscribe-mode
2869baa02f3c [svn] Auto subscribe mode by group
bears
parents: 88
diff changeset
190 entries (if any).
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
191 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
192 Default: over
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
193
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
194 .TP
82
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
195 .B info-always-unread yes|no
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
196 An information article is presented for all unsubscribed
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
197 newsgroups. If auto-subscribe mode is off, there is a possibility of
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
198 someone reading the article but forgetting the instructions therein
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
199 and not knowing how to return to a read article. This option causes
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
200 the information article always to be present as an unread article in a
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
201 group when auto-subscribe if off. It does this by incrementing the
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
202 article number of the information article every time it is read.
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
203 .br
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
204 Default: yes
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
205
1eb0cdd17c76 [svn] info-always-unread config/doc/implementation
bears
parents: 45
diff changeset
206 .TP
88
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
207 .B post-locally yes|no
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
208 Place articles posted to external servers in the local aticle database
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
209 immediately. Some servers may rewrite Message-IDs, which will cause
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
210 duplicate postings of this option is enabled. Also, if for some reason
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
211 the post to the remote server fails, the article still exist in the local
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
212 database, which may be a source of some confusion.
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
213 .br
1fcdced0246e [svn] Move posting code to post.c, add command line posting
bears
parents: 85
diff changeset
214 Default: no
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
215
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
216 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
217 .B replace-messageid yes|no
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
218 Replace Message-ID of posted articles by a Message-ID generated by
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
219 NOFFLE. Some news readers generate Message-IDs that are not accepted by
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
220 some servers. For generating Message-IDs, the domain name of your system should
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
221 be a valid domain name. If you are in a local domain, set it to your
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
222 provider's domain name.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
223 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
224 Default: yes
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
225
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
226 .TP
195
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
227 .B hostname <fully.qualified.domain.name>
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
228 Specify right-hand side of Message-IDs generated by NOFFLE.
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
229 If omitted, the fully qualified domain name of your system will be used.
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
230 If you do not have a fully qualified domain name, your upstream
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
231 newsserver or someone else might allow you to use a subdomain name.
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
232 .br
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
233 Default: <the fully qualified domain name of your system>
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
234
76460d98b2fb [svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents: 194
diff changeset
235 .TP
111
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
236 .B path-header <path header content>
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
237 Articles posted without a Path: header have one added by NOFFLE.
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
238 When
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
239 .B path-header
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
240 has its default value (empty) the header content
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
241 is "<hostname>!not-for-mail".
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
242 Use the
150
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents: 134
diff changeset
243 .B path-header
111
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
244 setting to provide alternate content for the Path: header.
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
245 This will very rarely be necessary.
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
246 .br
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
247 Default: <empty string>
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
248
6f681d41734c [svn] path-header added.
bears
parents: 107
diff changeset
249 .TP
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
250 .B default-expire <n>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
251 The default expiry period, in days. An expiry period of 0 means "never".
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
252 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
253 Default: 14
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
254
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
255 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
256 .B expire <group pattern> <n>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
257 The expiry period for a newsgroup or set of newsgroups, in days. The
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
258 expiry pattern can contain \fIwildcards\fP, and there can be multiple
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
259 .B expire
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
260 lines. When checking the expiry period for a group, the expiry
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
261 patterns are checked in the order in which they appear in
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
262 .I /etc/noffle.conf
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
263 until the first match occurs. If no pattern matches the group name, the
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
264 .B default expiry period
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
265 is used. An expiry period of 0 means "never".
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
266 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
267 Default: no
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
268
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
269 .TP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
270 .B filter <filter specification>
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
271 Add the specified filter to the list of filters to be applied to incoming
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
272 articles. Filters are applied in the order in which they appear in
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
273 .I /etc/noffle.conf
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
274 and are further described in the section
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
275 .B FILTERS
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
276 below.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
277 .br
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
278 Default: No filters
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
279
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
280 .SH "GROUP NAME WILDCARDS"
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
281
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
282 .B NOFFLE
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
283 uses a wildcard format that closely matches filename-style wildcards.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
284 \fIalt.binaries.*\fP, for example, matches all newsgroups under the
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
285 .I alt.binaries
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
286 hierarchy. A full description of the fomat (known as
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
287 .B wildmat
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
288 patterns) is as follows.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
289
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
290 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
291 .BI \e x
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
292 Turns off the special meaning of
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
293 .I x
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
294 and matches it directly; this is used mostly before a question mark or
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
295 asterisk, and is not special inside square brackets.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
296 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
297 .B ?
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
298 Matches any single character.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
299 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
300 .B *
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
301 Matches any sequence of zero or more characters.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
302 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
303 .BI [ x...y ]
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
304 Matches any single character specified by the set
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
305 .IR x...y .
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
306 A minus sign may be used to indicate a range of characters.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
307 That is,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
308 .I [0\-5abc]
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
309 is a shorthand for
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
310 .IR [012345abc] .
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
311 More than one range may appear inside a character set;
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
312 .I [0-9a-zA-Z._]
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
313 matches almost all of the legal characters for a host name.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
314 The close bracket,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
315 .IR ] ,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
316 may be used if it is the first character in the set.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
317 The minus sign,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
318 .IR \- ,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
319 may be used if it is either the first or last character in the set.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
320 .TP
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
321 .BI [^ x...y ]
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
322 This matches any character
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
323 .I not
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
324 in the set
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
325 .IR x...y ,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
326 which is interpreted as described above.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
327 For example,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
328 .I [^]\-]
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
329 matches any character other than a close bracket or minus sign.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
330
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
331 .SH FILTERS
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
332
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
333 .B NOFFLE
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
334 supports basic filtering on incoming articles. Articles to be downloaded
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
335 can be matched against one or more criteria and matching articles are
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
336 marked for download using one of the group subscribe modes
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
337 .BR full ,
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
338 .B over
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
339 or
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
340 .BR thread .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
341 Alternatively the filter may specify that the article mode is
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
342 .B discard
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
343 in which case neither the article nor the article overview will
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
344 be downloaded.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
345
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
346 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
347 A
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
348 .B filter
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
349 configuration line consist of one or more filter specifications
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
350 following the
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
351 .B filter
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
352 keyword on the line. The available specifications are:
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
353
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
354 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
355 .B action
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
356 =
194
a4e9a20e50e5 [svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents: 192
diff changeset
357 .IR "full|over|thread|discard|default" .
a4e9a20e50e5 [svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents: 192
diff changeset
358 Specifies the action to be taken if the filter matches. If not specified
a4e9a20e50e5 [svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents: 192
diff changeset
359 or specified as
a4e9a20e50e5 [svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents: 192
diff changeset
360 .BR default ,
a4e9a20e50e5 [svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents: 192
diff changeset
361 the action is as specified by the group's subscription mode.
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
362 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
363 .B group
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
364 =
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
365 .IR "<group pattern>" .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
366 Matches if any group in which the article appears matches the
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
367 specified group pattern.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
368 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
369 .B subject
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
370 =
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
371 .IR "<regular expression>" .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
372 Matches if the article subject matches the given regular expression.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
373 See the section on regular expressions below.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
374 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
375 .B from
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
376 =
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
377 .IR "<regular expression>" .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
378 Matches if the article subject matches the given regular expression.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
379 See the section on regular expressions below.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
380 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
381 .B msgid
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
382 =
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
383 .IR "<regular expression>" .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
384 Matches if the article message ID matches the given regular expression.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
385 See the section on regular expressions below.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
386 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
387 .B bytes
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
388 < or = or >
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
389 .IR <number> .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
390 Matches if the number of bytes in the article is less than, equal to, or
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
391 greater than the given number.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
392 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
393 .B lines
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
394 < or = or >
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
395 .IR <number> .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
396 Matches if the number of lines in the article is less than, equal to, or
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
397 greater than the given number.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
398 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
399 .B refs
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
400 < or = or >
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
401 .IR <number> .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
402 Matches if the number of articles referenced by the article is less
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
403 than, equal to, or greater than the given number.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
404 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
405 .B xposts
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
406 < or = or >
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
407 .IR <number> .
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
408 Matches if the number of groups the article is posted to is less
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
409 than, equal to, or greater than the given number.
212
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
410 .PP
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
411 .B post-status
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
412 =
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
413 .IR "mod|yes|no" .
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
414 Matches if the current newsgroup is moderated, not moderated or closed.
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
415 Unlike the
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
416 .B group
21200ce10e68 [svn] filter post-status=mod|yes|no.
mirkol
parents: 195
diff changeset
417 filter, only the current newsgroup is checked.
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
418
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
419 .PP
134
7dfbb1c20a81 [svn] k and m suffices on filter numbers
bears
parents: 128
diff changeset
420 Numbers may have a suffix of 'k' or 'm'. As you might expect, 'k'
7dfbb1c20a81 [svn] k and m suffices on filter numbers
bears
parents: 128
diff changeset
421 indicates the number is to be multiplied by 1024 and 'm' indicates
7dfbb1c20a81 [svn] k and m suffices on filter numbers
bears
parents: 128
diff changeset
422 it is to be multiplied by 1024*1024. Thus 10k is 10240 and 1m is 1048576.
7dfbb1c20a81 [svn] k and m suffices on filter numbers
bears
parents: 128
diff changeset
423
7dfbb1c20a81 [svn] k and m suffices on filter numbers
bears
parents: 128
diff changeset
424 .PP
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
425 For example, the following filters download all articles in groups
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
426 in the alt.binaries tree in full if they are < 10k in size, otherwise
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
427 downloads overviews.
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
428 .PP
134
7dfbb1c20a81 [svn] k and m suffices on filter numbers
bears
parents: 128
diff changeset
429 .I filter group=alt.binaries.* bytes < 10k action=full
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
430 .br
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
431 .I filter group=alt.binaries.* action=over
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
432 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
433 This filter discards all articles with a subject resembling
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
434 the infamous "$$$ Make Money Now! $$$".
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
435 .PP
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
436 \fIfilter subject="\\$*.*Make.*[M|m]oney.*\\$" action=discard\fR
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
437
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
438 .SH REGULAR EXPRESSIONS
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
439
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
440 .B NOFFLE
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
441 uses extended POSIX-style regular expressions in its filters. Regular
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
442 expressions are a powerful means of describing patterns that match
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
443 text. A full description is to be found in
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
444 .BR regex (7).
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
445
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
446 .SH SEE ALSO
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
447
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
448 .BR noffle (1)
128
8897b7e3b108 [svn] Add article filtering
bears
parents: 111
diff changeset
449 .BR regex (7)
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
450
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
451 .SH AUTHORS
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
452
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
453 Markus Enzenberger <markus.enzenberger@t-online.de>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
454 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
455 Volker Wysk <volker.wysk@student.uni-tuebingen.de>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
456 .br
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
457 Jim Hague <jim.hague@acm.org>
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
458 .br
45
32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents: 42
diff changeset
459 Uwe Hermann <uh1763@bingo-ev.de>
32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents: 42
diff changeset
460
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
461 1998-2000.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
462
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
463