Mercurial > noffle
annotate docs/noffle.conf.5 @ 288:c02c4eb95f95 noffle
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
and noffle-group configs.
* src/configfile.c,src/fetch.c,src/fetchlist.c,src/protocol.c,
src/server.c: Replace strcpy() with Utl_cpyStr() where appropriate.
See Debian bug 168128.
* src/control.c,src/configfile.c,src/noffle.c: Replace [s]scanf("%s")
with [s]scanf(MAXCHAR_FMT).
* src/noffle.c: Log warning if noffle.conf is world readable.
* src/noffle.c: Restrict most options to news admins; i.e. those who
are root or news on running Noffle.
* Makefile.in,acconfig.h,aclocal.m4,config.h.in,configure,configure.in,
docs/Makefile.in,docs/noffle.conf.5,packages/Makefile.in,
packages/redhat/Makefile.in,src/Makefile.am,src/Makefile.in,
src/authenticate.c,src/authenticate.h,src/noffle.c,src/server.c:
Add basic authentication using either Noffle-specific user file
or authenticating via PAM (service 'noffle'). PAM authentication
needs to run as root, so a Noffle server that needs PAM
must be started by root. Helpful (?) error messages will be logged
if not. Noffle will switch ruid and euid to 'news' (or whatever
is configured) ASAP.
* src/noffle.c: Add uid checking.
author | bears |
---|---|
date | Fri, 10 Jan 2003 23:25:45 +0000 |
parents | 0340b9c17edc |
children | f35a7d45efd5 |
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 |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
2 .\" $Id: noffle.conf.5 420 2003-01-10 23:25:45Z 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 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
136 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
|
137 From field, in this order). |
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. |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
211 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
|
212 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
|
213 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
|
214 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
|
215 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
|
216 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
|
217 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
|
218 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
|
219 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
|
220 .br |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
221 Default: no |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
222 |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
223 .TP |
88
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
224 .B post-locally yes|no |
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
225 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
|
226 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
|
227 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
|
228 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
|
229 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
|
230 .br |
1fcdced0246e
[svn] Move posting code to post.c, add command line posting
bears
parents:
85
diff
changeset
|
231 Default: no |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
232 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
233 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
234 .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
|
235 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
|
236 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
|
237 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
|
238 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
|
239 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
|
240 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
|
241 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
|
242 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
|
243 Message-ID. |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
244 .br |
222
bf290632d29e
[svn] * src/post.c: Always replace message ID in posted message if existing
bears
parents:
212
diff
changeset
|
245 Default: no |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
246 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
247 .TP |
195
76460d98b2fb
[svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents:
194
diff
changeset
|
248 .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
|
249 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
|
250 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
|
251 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
|
252 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
|
253 .br |
76460d98b2fb
[svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents:
194
diff
changeset
|
254 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
|
255 |
76460d98b2fb
[svn] * noffle.conf.example,docs/noffle.conf.5,src/configfile.h,src/configfile.c,
bears
parents:
194
diff
changeset
|
256 .TP |
111 | 257 .B path-header <path header content> |
258 Articles posted without a Path: header have one added by NOFFLE. | |
259 When | |
260 .B path-header | |
261 has its default value (empty) the header content | |
262 is "<hostname>!not-for-mail". | |
263 Use the | |
150
1c7303c71f66
[svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line
bears
parents:
134
diff
changeset
|
264 .B path-header |
111 | 265 setting to provide alternate content for the Path: header. |
266 This will very rarely be necessary. | |
267 .br | |
268 Default: <empty string> | |
269 | |
270 .TP | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
271 .B default-expire <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
272 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
|
273 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
274 Default: 14 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
275 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
276 .TP |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
277 .B noffle-user <n> |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
278 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
|
279 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
|
280 possible. |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
281 .br |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
282 Default: news |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
283 |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
284 .TP |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
285 .B noffle-group <n> |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
286 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
|
287 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
|
288 .br |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
289 Default: news |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
290 |
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
291 .TP |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
292 .B expire <group pattern> <n> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
293 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
|
294 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
|
295 .B expire |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
296 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
|
297 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
|
298 .I /etc/noffle.conf |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
299 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
|
300 .B default expiry period |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
301 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
|
302 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
303 Default: no |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
304 |
128 | 305 .TP |
306 .B filter <filter specification> | |
307 Add the specified filter to the list of filters to be applied to incoming | |
308 articles. Filters are applied in the order in which they appear in | |
309 .I /etc/noffle.conf | |
310 and are further described in the section | |
311 .B FILTERS | |
312 below. | |
313 .br | |
314 Default: No filters | |
315 | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
316 .SH "GROUP NAME WILDCARDS" |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
317 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
318 .B NOFFLE |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
319 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
|
320 \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
|
321 .I alt.binaries |
288
c02c4eb95f95
[svn] * src/configfile.h,src/configfile.c,docs/noffle.conf.5: Add noffle-user
bears
parents:
249
diff
changeset
|
322 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
|
323 .B wildmat |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
324 patterns) is as follows. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
325 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
326 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
327 .BI \e x |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
328 Turns off the special meaning of |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
329 .I x |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
330 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
|
331 asterisk, and is not special inside square brackets. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
332 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
333 .B ? |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
334 Matches any single character. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
335 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
336 .B * |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
337 Matches any sequence of zero or more characters. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
338 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
339 .BI [ x...y ] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
340 Matches any single character specified by the set |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
341 .IR x...y . |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
342 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
|
343 That is, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
344 .I [0\-5abc] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
345 is a shorthand for |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
346 .IR [012345abc] . |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
347 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
|
348 .I [0-9a-zA-Z._] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
349 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
|
350 The close bracket, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
351 .IR ] , |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
352 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
|
353 The minus sign, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
354 .IR \- , |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
355 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
|
356 .TP |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
357 .BI [^ x...y ] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
358 This matches any character |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
359 .I not |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
360 in the set |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
361 .IR x...y , |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
362 which is interpreted as described above. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
363 For example, |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
364 .I [^]\-] |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
365 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
|
366 |
128 | 367 .SH FILTERS |
368 | |
369 .B NOFFLE | |
370 supports basic filtering on incoming articles. Articles to be downloaded | |
371 can be matched against one or more criteria and matching articles are | |
372 marked for download using one of the group subscribe modes | |
373 .BR full , | |
374 .B over | |
375 or | |
376 .BR thread . | |
377 Alternatively the filter may specify that the article mode is | |
378 .B discard | |
379 in which case neither the article nor the article overview will | |
380 be downloaded. | |
381 | |
382 .PP | |
383 A | |
384 .B filter | |
385 configuration line consist of one or more filter specifications | |
386 following the | |
387 .B filter | |
388 keyword on the line. The available specifications are: | |
389 | |
390 .PP | |
391 .B action | |
392 = | |
194
a4e9a20e50e5
[svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents:
192
diff
changeset
|
393 .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
|
394 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
|
395 or specified as |
a4e9a20e50e5
[svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents:
192
diff
changeset
|
396 .BR default , |
a4e9a20e50e5
[svn] * docs/noffle.conf.5,src/configfile.c,src/filter.h,src/filter.c:
bears
parents:
192
diff
changeset
|
397 the action is as specified by the group's subscription mode. |
128 | 398 .PP |
399 .B group | |
400 = | |
401 .IR "<group pattern>" . | |
402 Matches if any group in which the article appears matches the | |
403 specified group pattern. | |
404 .PP | |
405 .B subject | |
406 = | |
407 .IR "<regular expression>" . | |
408 Matches if the article subject matches the given regular expression. | |
409 See the section on regular expressions below. | |
410 .PP | |
411 .B from | |
412 = | |
413 .IR "<regular expression>" . | |
234
a16ee4b00b66
[svn] * docs/noffle.conf.5: Correct typo in From: filter description.
bears
parents:
222
diff
changeset
|
414 Matches if the article From: address matches the given regular expression. |
128 | 415 See the section on regular expressions below. |
416 .PP | |
417 .B msgid | |
418 = | |
419 .IR "<regular expression>" . | |
420 Matches if the article message ID matches the given regular expression. | |
421 See the section on regular expressions below. | |
422 .PP | |
423 .B bytes | |
424 < or = or > | |
425 .IR <number> . | |
426 Matches if the number of bytes in the article is less than, equal to, or | |
427 greater than the given number. | |
428 .PP | |
429 .B lines | |
430 < or = or > | |
431 .IR <number> . | |
432 Matches if the number of lines in the article is less than, equal to, or | |
433 greater than the given number. | |
434 .PP | |
435 .B refs | |
436 < or = or > | |
437 .IR <number> . | |
438 Matches if the number of articles referenced by the article is less | |
439 than, equal to, or greater than the given number. | |
440 .PP | |
249 | 441 .B reference |
442 = | |
443 .IR "<regular expression>" . | |
444 Matches if one of the message IDs in the reference line matches the | |
445 given regular expression. See the section on regular expressions below. | |
446 .PP | |
128 | 447 .B xposts |
448 < or = or > | |
449 .IR <number> . | |
450 Matches if the number of groups the article is posted to is less | |
451 than, equal to, or greater than the given number. | |
212 | 452 .PP |
249 | 453 .B date |
454 < or = or > | |
455 .IR "<date expression>" . | |
456 Matches if the article is older, from the same day or newer than the | |
457 given date expression. See the section on date expressions below. | |
458 .PP | |
459 .B older | |
460 = | |
461 .IR "<date expression>" . | |
462 Equals | |
463 .B date < | |
464 . | |
465 .PP | |
466 .B newer | |
467 = | |
468 .IR "<date expression>" . | |
469 Equals | |
470 .B date > | |
471 . | |
472 .PP | |
212 | 473 .B post-status |
474 = | |
475 .IR "mod|yes|no" . | |
476 Matches if the current newsgroup is moderated, not moderated or closed. | |
477 Unlike the | |
478 .B group | |
479 filter, only the current newsgroup is checked. | |
128 | 480 |
481 .PP | |
134 | 482 Numbers may have a suffix of 'k' or 'm'. As you might expect, 'k' |
483 indicates the number is to be multiplied by 1024 and 'm' indicates | |
484 it is to be multiplied by 1024*1024. Thus 10k is 10240 and 1m is 1048576. | |
485 | |
486 .PP | |
128 | 487 For example, the following filters download all articles in groups |
488 in the alt.binaries tree in full if they are < 10k in size, otherwise | |
489 downloads overviews. | |
490 .PP | |
134 | 491 .I filter group=alt.binaries.* bytes < 10k action=full |
128 | 492 .br |
493 .I filter group=alt.binaries.* action=over | |
494 .PP | |
495 This filter discards all articles with a subject resembling | |
496 the infamous "$$$ Make Money Now! $$$". | |
497 .PP | |
498 \fIfilter subject="\\$*.*Make.*[M|m]oney.*\\$" action=discard\fR | |
499 | |
500 .SH REGULAR EXPRESSIONS | |
501 | |
502 .B NOFFLE | |
503 uses extended POSIX-style regular expressions in its filters. Regular | |
504 expressions are a powerful means of describing patterns that match | |
505 text. A full description is to be found in | |
506 .BR regex (7). | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
507 |
249 | 508 .SH DATE EXPRESSIONS |
509 | |
510 .B NOFFLE | |
511 uses very simple date expressions. You can use fixed dates in rfc-2822 style | |
512 or variable dates: | |
513 .PP | |
514 .I date="14 May 2002 18:32:50 +0200" | |
515 matches any article sent up to 24 hours before or after the above fixed date. | |
516 Please don't forget the timezone specification. | |
517 .PP | |
518 .I date>"now+1.5" | |
519 matches any article newer than 36 hours from the current date. | |
520 .PP | |
521 .I date="lastupdate-14" | |
522 matches any article older than 14 days since the date of the last | |
523 .B noffle --fetch | |
524 or | |
525 .B noffle --query groups | |
526 from the current newsserver. | |
527 .PP | |
528 .I date="invalid" | |
529 matches any article with an invalid date header. | |
530 .PP | |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
531 .SH SEE ALSO |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
532 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
533 .BR noffle (1) |
128 | 534 .BR regex (7) |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
535 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
536 .SH AUTHORS |
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 Markus Enzenberger <markus.enzenberger@t-online.de> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
539 .br |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
540 Volker Wysk <volker.wysk@student.uni-tuebingen.de> |
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 Jim Hague <jim.hague@acm.org> |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
543 .br |
45
32ba1198c6fa
[svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents:
42
diff
changeset
|
544 Uwe Hermann <uh1763@bingo-ev.de> |
32ba1198c6fa
[svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents:
42
diff
changeset
|
545 |
42
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
546 1998-2000. |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
547 |
2467ff423c15
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff
changeset
|
548 |