Mercurial > noffle
annotate docs/noffle.conf.5 @ 338:fa7a42b18bc8 noffle
[svn] transition to po-debconf
author | godisch |
---|---|
date | Tue, 04 Mar 2003 20:47:54 +0000 |
parents | f35a7d45efd5 |
children | b0ee77fa24d4 |
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 |
290
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
2 .\" $Id: noffle.conf.5 422 2003-01-11 09:30:05Z bears $ |
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 , |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
101 .BR auth , |
185
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
102 .BR control , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
103 .BR expire , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
104 .BR fetch , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
105 .BR filter , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
106 .BR newsbase , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
107 .BR noffle , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
108 .BR post , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
109 .BR protocol , |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
110 .BR requests |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
111 and |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
112 .BR server. |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
113 The |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
114 .B noffle |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
115 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
|
116 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
|
117 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
|
118 .br |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
119 Default: none |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
120 |
fed1334d766b
[svn] * src/client.c: Change variable only used on constant to 'const'.
bears
parents:
150
diff
changeset
|
121 .TP |
150
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
122 .B organization <organization> |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
123 When invoked as |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
124 .BR inews (1) |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
125 .B NOFFLE |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
126 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
|
127 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
|
128 .B organization |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
129 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
|
130 .br |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
131 Default: <empty string> |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
132 |
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
133 .TP |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
134 .B mail-to <address> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
135 Receiver of failed postings. If empty then failed postings are returned |
290
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
136 to the sender (taking the address from the article's Reply-To, Sender, |
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
137 X-Sender or From field, in this order). |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
138 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
139 Default: <empty string> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
140 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
141 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
142 .B auto-unsubscribe yes|no |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
143 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
|
144 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
|
145 are fresh articles arriving and remaining unread. |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
146 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
147 Default: no |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
148 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
149 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
150 .B auto-unsubscribe-days <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
151 Number of days used for auto-unsubscribe option. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
152 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
153 Default: 30 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
154 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
155 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
156 .B thread-follow-time <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
157 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
|
158 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
|
159 <n> days. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
160 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
161 Default: 7 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
162 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
163 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
164 .B connect-timeout <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
165 Timeout for connecting to remote server in seconds. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
166 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
167 Default: 30 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
168 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
169 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
170 .B auto-subscribe yes|no |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
171 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
|
172 <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
|
173 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
|
174 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
|
175 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
|
176 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
177 Default: no |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
178 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
179 .TP |
107 | 180 .B auto-subscribe-mode <group pattern> full|thread|over |
181 Mode for auto-subscribe option for groups that match the given | |
182 pattern. | |
183 .br | |
184 Default: none | |
185 | |
186 .TP | |
187 .B default-auto-subscribe-mode full|thread|over | |
188 Default mode for auto-subscribe option. Used for all groups that do | |
189 not match a pattern specified with | |
190 .B auto-subscribe-mode | |
191 entries (if any). | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
192 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
193 Default: over |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
194 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
195 .TP |
82 | 196 .B info-always-unread yes|no |
197 An information article is presented for all unsubscribed | |
198 newsgroups. If auto-subscribe mode is off, there is a possibility of | |
199 someone reading the article but forgetting the instructions therein | |
200 and not knowing how to return to a read article. This option causes | |
201 the information article always to be present as an unread article in a | |
202 group when auto-subscribe if off. It does this by incrementing the | |
203 article number of the information article every time it is read. | |
204 .br | |
205 Default: yes | |
206 | |
207 .TP | |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
208 .B authenticate-client yes|no |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
209 Insist that clients authenticate themselves using the NNTP |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
210 AUTHINFO USER/AUTHINFO PASS transaction before any news is served. |
290
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
211 This option is recognised only when NOFFLE has been built with |
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
212 authentication enabled. |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
213 The form of the authentication is determined at compile time; either |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
214 PAM is used (with a service name "noffle"), or the userlist |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
215 file is scanned. This file, by default \fI/etc/noffle.users\fP, |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
216 is a text file. Spaces, comments starting with '#' and blank lines are |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
217 ignored. Other lines must contain space-separated 'username password' |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
218 pairs. For security reasons the userlist file must be a regular file, |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
219 not a link, and must be owner readable only. Finally, note that the |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
220 NNTP AUTHINFO USER/AUTHINFO PASS transaction is not encrypted in any |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
221 way, and so must itself be considered insecure. |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
222 .br |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
223 Default: no |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
224 |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
225 .TP |
88
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
226 .B post-locally yes|no |
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
227 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
|
228 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
|
229 duplicate postings of this option is enabled. Also, if for some reason |
222
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
230 the post to the remote server fails, the article still exists in the local |
88
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
231 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
|
232 .br |
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
233 Default: no |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
234 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
235 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
236 .B replace-messageid yes|no |
222
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
237 Always replace the Message-ID of a posted article with a Message-ID |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
238 generated by NOFFLE. NOFFLE will always add a Message-ID if none is |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
239 present, or replace a Message-ID that does not meet the basic |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
240 formatting and content requirements for a Message-ID. However, some |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
241 news readers may generate Message-IDs that are not accepted by some |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
242 servers (for example the server may insist the Message-ID domain is |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
243 part of the server domain) or may not always be unique. In either of |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
244 these cases you may prefer to have NOFFLE always replace the |
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
245 Message-ID. |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
246 .br |
222
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
247 Default: no |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
248 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
249 .TP |
195
76460d98b2fb
[svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents:
194
diff
changeset
|
250 .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
|
251 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
|
252 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
|
253 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
|
254 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
|
255 .br |
76460d98b2fb
[svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents:
194
diff
changeset
|
256 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
|
257 |
76460d98b2fb
[svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents:
194
diff
changeset
|
258 .TP |
111 | 259 .B path-header <path header content> |
260 Articles posted without a Path: header have one added by NOFFLE. | |
261 When | |
262 .B path-header | |
263 has its default value (empty) the header content | |
264 is "<hostname>!not-for-mail". | |
265 Use the | |
150
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
266 .B path-header |
111 | 267 setting to provide alternate content for the Path: header. |
268 This will very rarely be necessary. | |
269 .br | |
270 Default: <empty string> | |
271 | |
272 .TP | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
273 .B default-expire <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
274 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
|
275 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
276 Default: 14 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
277 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
278 .TP |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
279 .B noffle-user <n> |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
280 The username under which NOFFLE normally runs. If NOFFLE is invoked by |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
281 root, it will drop its real and effective UID to this user as soon as |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
282 possible. |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
283 .br |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
284 Default: news |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
285 |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
286 .TP |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
287 .B noffle-group <n> |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
288 The group under which NOFFLE normally runs. NOFFLE will change to this |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
289 real and effective GID as soon as possible. |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
290 .br |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
291 Default: news |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
292 |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
293 .TP |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
294 .B expire <group pattern> <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
295 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
|
296 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
|
297 .B expire |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
298 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
|
299 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
|
300 .I /etc/noffle.conf |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
301 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
|
302 .B default expiry period |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
303 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
|
304 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
305 Default: no |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
306 |
128 | 307 .TP |
308 .B filter <filter specification> | |
309 Add the specified filter to the list of filters to be applied to incoming | |
310 articles. Filters are applied in the order in which they appear in | |
311 .I /etc/noffle.conf | |
312 and are further described in the section | |
313 .B FILTERS | |
314 below. | |
315 .br | |
316 Default: No filters | |
317 | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
318 .SH "GROUP NAME WILDCARDS" |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
319 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
320 .B NOFFLE |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
321 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
|
322 \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
|
323 .I alt.binaries |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
324 hierarchy. A full description of the format (known as |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
325 .B wildmat |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
326 patterns) is as follows. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
327 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
328 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
329 .BI \e x |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
330 Turns off the special meaning of |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
331 .I x |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
332 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
|
333 asterisk, and is not special inside square brackets. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
334 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
335 .B ? |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
336 Matches any single character. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
337 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
338 .B * |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
339 Matches any sequence of zero or more characters. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
340 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
341 .BI [ x...y ] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
342 Matches any single character specified by the set |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
343 .IR x...y . |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
344 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
|
345 That is, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
346 .I [0\-5abc] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
347 is a shorthand for |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
348 .IR [012345abc] . |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
349 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
|
350 .I [0-9a-zA-Z._] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
351 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
|
352 The close bracket, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
353 .IR ] , |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
354 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
|
355 The minus sign, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
356 .IR \- , |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
357 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
|
358 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
359 .BI [^ x...y ] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
360 This matches any character |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
361 .I not |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
362 in the set |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
363 .IR x...y , |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
364 which is interpreted as described above. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
365 For example, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
366 .I [^]\-] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
367 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
|
368 |
128 | 369 .SH FILTERS |
370 | |
371 .B NOFFLE | |
372 supports basic filtering on incoming articles. Articles to be downloaded | |
373 can be matched against one or more criteria and matching articles are | |
374 marked for download using one of the group subscribe modes | |
375 .BR full , | |
376 .B over | |
377 or | |
378 .BR thread . | |
379 Alternatively the filter may specify that the article mode is | |
380 .B discard | |
381 in which case neither the article nor the article overview will | |
382 be downloaded. | |
383 | |
384 .PP | |
385 A | |
386 .B filter | |
387 configuration line consist of one or more filter specifications | |
388 following the | |
389 .B filter | |
390 keyword on the line. The available specifications are: | |
391 | |
392 .PP | |
393 .B action | |
394 = | |
194
a4e9a20e50e5
[svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents:
192
diff
changeset
|
395 .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
|
396 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
|
397 or specified as |
a4e9a20e50e5
[svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents:
192
diff
changeset
|
398 .BR default , |
a4e9a20e50e5
[svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents:
192
diff
changeset
|
399 the action is as specified by the group's subscription mode. |
128 | 400 .PP |
401 .B group | |
402 = | |
403 .IR "<group pattern>" . | |
404 Matches if any group in which the article appears matches the | |
405 specified group pattern. | |
406 .PP | |
407 .B subject | |
408 = | |
409 .IR "<regular expression>" . | |
410 Matches if the article subject matches the given regular expression. | |
411 See the section on regular expressions below. | |
412 .PP | |
413 .B from | |
414 = | |
415 .IR "<regular expression>" . | |
234
a16ee4b00b66
[svn] * docs/noffle.conf.5: Correct typo in From: filter description.
bears
parents:
222
diff
changeset
|
416 Matches if the article From: address matches the given regular expression. |
128 | 417 See the section on regular expressions below. |
418 .PP | |
419 .B msgid | |
420 = | |
421 .IR "<regular expression>" . | |
422 Matches if the article message ID matches the given regular expression. | |
423 See the section on regular expressions below. | |
424 .PP | |
425 .B bytes | |
426 < or = or > | |
427 .IR <number> . | |
428 Matches if the number of bytes in the article is less than, equal to, or | |
429 greater than the given number. | |
430 .PP | |
431 .B lines | |
432 < or = or > | |
433 .IR <number> . | |
434 Matches if the number of lines in the article is less than, equal to, or | |
435 greater than the given number. | |
436 .PP | |
437 .B refs | |
438 < or = or > | |
439 .IR <number> . | |
440 Matches if the number of articles referenced by the article is less | |
441 than, equal to, or greater than the given number. | |
442 .PP | |
249 | 443 .B reference |
444 = | |
445 .IR "<regular expression>" . | |
446 Matches if one of the message IDs in the reference line matches the | |
447 given regular expression. See the section on regular expressions below. | |
448 .PP | |
128 | 449 .B xposts |
450 < or = or > | |
451 .IR <number> . | |
452 Matches if the number of groups the article is posted to is less | |
453 than, equal to, or greater than the given number. | |
212 | 454 .PP |
249 | 455 .B date |
456 < or = or > | |
457 .IR "<date expression>" . | |
458 Matches if the article is older, from the same day or newer than the | |
459 given date expression. See the section on date expressions below. | |
460 .PP | |
461 .B older | |
462 = | |
463 .IR "<date expression>" . | |
464 Equals | |
465 .B date < | |
466 . | |
467 .PP | |
468 .B newer | |
469 = | |
470 .IR "<date expression>" . | |
471 Equals | |
472 .B date > | |
473 . | |
474 .PP | |
212 | 475 .B post-status |
476 = | |
477 .IR "mod|yes|no" . | |
478 Matches if the current newsgroup is moderated, not moderated or closed. | |
479 Unlike the | |
480 .B group | |
481 filter, only the current newsgroup is checked. | |
128 | 482 |
483 .PP | |
134 | 484 Numbers may have a suffix of 'k' or 'm'. As you might expect, 'k' |
485 indicates the number is to be multiplied by 1024 and 'm' indicates | |
486 it is to be multiplied by 1024*1024. Thus 10k is 10240 and 1m is 1048576. | |
487 | |
488 .PP | |
128 | 489 For example, the following filters download all articles in groups |
490 in the alt.binaries tree in full if they are < 10k in size, otherwise | |
491 downloads overviews. | |
492 .PP | |
134 | 493 .I filter group=alt.binaries.* bytes < 10k action=full |
128 | 494 .br |
495 .I filter group=alt.binaries.* action=over | |
496 .PP | |
497 This filter discards all articles with a subject resembling | |
498 the infamous "$$$ Make Money Now! $$$". | |
499 .PP | |
500 \fIfilter subject="\\$*.*Make.*[M|m]oney.*\\$" action=discard\fR | |
501 | |
502 .SH REGULAR EXPRESSIONS | |
503 | |
504 .B NOFFLE | |
505 uses extended POSIX-style regular expressions in its filters. Regular | |
506 expressions are a powerful means of describing patterns that match | |
507 text. A full description is to be found in | |
508 .BR regex (7). | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
509 |
249 | 510 .SH DATE EXPRESSIONS |
511 | |
512 .B NOFFLE | |
513 uses very simple date expressions. You can use fixed dates in rfc-2822 style | |
514 or variable dates: | |
515 .PP | |
516 .I date="14 May 2002 18:32:50 +0200" | |
517 matches any article sent up to 24 hours before or after the above fixed date. | |
518 Please don't forget the timezone specification. | |
519 .PP | |
520 .I date>"now+1.5" | |
521 matches any article newer than 36 hours from the current date. | |
522 .PP | |
523 .I date="lastupdate-14" | |
524 matches any article older than 14 days since the date of the last | |
525 .B noffle --fetch | |
526 or | |
527 .B noffle --query groups | |
528 from the current newsserver. | |
529 .PP | |
530 .I date="invalid" | |
531 matches any article with an invalid date header. | |
532 .PP | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
533 .SH SEE ALSO |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
534 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
535 .BR noffle (1) |
128 | 536 .BR regex (7) |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
537 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
538 .SH AUTHORS |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
539 |
290
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
540 Markus Enzenberger <me@markus-enzenberger.de> |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
541 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
542 Volker Wysk <volker.wysk@student.uni-tuebingen.de> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
543 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
544 Jim Hague <jim.hague@acm.org> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
545 .br |
45
32ba1198c6fa
[svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents:
42
diff
changeset
|
546 Uwe Hermann <uh1763@bingo-ev.de> |
290
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
547 .br |
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
548 Mirko Liss <mirko.liss@web.de> |
45
32ba1198c6fa
[svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents:
42
diff
changeset
|
549 |
290
f35a7d45efd5
[svn] * docs/noffle.1,docs/noffle.conf.5: Correct footer date, add new RFCs,
bears
parents:
288
diff
changeset
|
550 1998-2003. |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
551 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
552 |