Mercurial > noffle

comparison docs/noffle.conf.5 @ 42:2467ff423c15 noffle

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html, NOTES.html, INSTALL.html: Removed files. * AUTHORS, COPYING, ChangeLog, README, INSTALL, NEWS, docs/FAQ, docs/NOTES: Added files. * TODO.TXT: Renamed to TODO. Slightly changed formatting. * README: Reformatted the file. Added info about CVS. Added a pointer to the file INSTALL. * noffle.1, noffle.conf.5: Moved to docs/ * LSM.TXT: Moved to docs/noffle.lsm. Small fix. * INSTALL: Adapted to autoconf build-system. A few minor fixes.
author uh1763
date Fri, 05 May 2000 21:26:14 +0100
parents
children 32ba1198c6fa
comparison
equal deleted inserted replaced
41:92b59cfcf364 42:2467ff423c15
1 .TH noffle.conf 5
2 .\" $Id: noffle.conf.5 48 2000-05-05 20:26:14Z uh1763 $
3 .SH NAME
4 noffle.conf \- Configuration file for NOFFLE news server
5
6 .SH DESCRIPTION
7
8 The
9 .B NOFFLE
10 news server - see
11 .BR noffle (1)
12 - takes its configuration from a configuration file.
13 By default this file is \fI/etc/noffle.conf\fP.
14
15 .PP
16 .B noffle.conf
17 is a normal text file containing
18 .B NOFFLE
19 settings, one per line.
20
21 .PP
22 Leading whitespace on a line is ignored, as is any comment
23 text. Comment text begins with a '#' character and continues to the
24 end of the line. Blank lines are permitted.
25
26 .SH SETTINGS
27
28 .TP
29 .B server <hostname>[:<port>] [<user> <pass>]
30 Name of the remote server. If no port given, port 119 is used.
31 Username and password for servers that need authentication
32 (Original AUTHINFO). The password may not contain white-spaces.
33 If there are multiple server entries in the config file, all of them are
34 used for getting groups. In this case the first server should be
35 the one of your main provider. Note that you must always
36 run 'noffle --query groups'
37 after making changes to the server entries.
38
39 .TP
40 .B max-fetch <n>
41 Never get more than <n> articles. If there are more, the oldest ones
42 are discarded.
43 .br
44 Default: 300
45
46 .TP
47 .B mail-to <address>
48 Receiver of failed postings. If empty then failed postings are returned
49 to the sender (taking the address from the article's Sender, X-Sender or
50 From field, in this order).
51 .br
52 Default: <empty string>
53
54 .TP
55 .B auto-unsubscribe yes|no
56 Automatically remove groups from fetch list if they have not been
57 accessed for a number days.
58 .br
59 Default: no
60
61 .TP
62 .B auto-unsubscribe-days <n>
63 Number of days used for auto-unsubscribe option.
64 .br
65 Default: 30
66
67 .TP
68 .B thread-follow-time <n>
69 Automatically mark articles for download in thread mode, if they
70 are referencing an article that has been opened by a reader within the last
71 <n> days.
72 .br
73 Default: 7
74
75 .TP
76 .B connect-timeout <n>
77 Timeout for connecting to remote server in seconds.
78 .br
79 Default: 30
80
81 .TP
82 .B auto-subscribe yes|no
83 Automatically put groups on fetch list if someone reads them.
84 <mode> can be full, over, thread (depending on the fetch mode) or
85 off (do not subscribe automatically). Condition for putting a group
86 on the list is that an article is opened. For this reason there is
87 always a pseudo article visible in groups that are not on the fetch list.
88 .br
89 Default: no
90
91 .TP
92 .B auto-subscribe-mode full|thread|over
93 Mode for auto-subscribe option.
94 .br
95 Default: over
96
97 .TP
98 .B remove-messageid yes|no
99 Remove Message-ID from posted articles. Some remote servers can generate
100 Message-IDs.
101 .br
102 Default: no
103
104 .TP
105 .B replace-messageid yes|no
106 Replace Message-ID of posted articles by a Message-ID generated by
107 NOFFLE. Some news readers generate Message-IDs that are not accepted by
108 some servers. For generating Message-IDs, the domain name of your system should
109 be a valid domain name. If you are in a local domain, set it to your
110 provider's domain name.
111 .br
112 Default: yes
113
114 .TP
115 .B default-expire <n>
116 The default expiry period, in days. An expiry period of 0 means "never".
117 .br
118 Default: 14
119
120 .TP
121 .B expire <group pattern> <n>
122 The expiry period for a newsgroup or set of newsgroups, in days. The
123 expiry pattern can contain \fIwildcards\fP, and there can be multiple
124 .B expire
125 lines. When checking the expiry period for a group, the expiry
126 patterns are checked in the order in which they appear in
127 .I /etc/noffle.conf
128 until the first match occurs. If no pattern matches the group name, the
129 .B default expiry period
130 is used. An expiry period of 0 means "never".
131 .br
132 Default: no
133
134 .SH "GROUP NAME WILDCARDS"
135
136 .B NOFFLE
137 uses a wildcard format that closely matches filename-style wildcards.
138 \fIalt.binaries.*\fP, for example, matches all newsgroups under the
139 .I alt.binaries
140 hierarchy. A full description of the fomat (known as
141 .B wildmat
142 patterns) is as follows.
143
144 .TP
145 .BI \e x
146 Turns off the special meaning of
147 .I x
148 and matches it directly; this is used mostly before a question mark or
149 asterisk, and is not special inside square brackets.
150 .TP
151 .B ?
152 Matches any single character.
153 .TP
154 .B *
155 Matches any sequence of zero or more characters.
156 .TP
157 .BI [ x...y ]
158 Matches any single character specified by the set
159 .IR x...y .
160 A minus sign may be used to indicate a range of characters.
161 That is,
162 .I [0\-5abc]
163 is a shorthand for
164 .IR [012345abc] .
165 More than one range may appear inside a character set;
166 .I [0-9a-zA-Z._]
167 matches almost all of the legal characters for a host name.
168 The close bracket,
169 .IR ] ,
170 may be used if it is the first character in the set.
171 The minus sign,
172 .IR \- ,
173 may be used if it is either the first or last character in the set.
174 .TP
175 .BI [^ x...y ]
176 This matches any character
177 .I not
178 in the set
179 .IR x...y ,
180 which is interpreted as described above.
181 For example,
182 .I [^]\-]
183 matches any character other than a close bracket or minus sign.
184
185
186 .SH SEE ALSO
187
188 .BR noffle (1)
189
190 .SH AUTHORS
191
192 Markus Enzenberger <markus.enzenberger@t-online.de>
193 .br
194 Volker Wysk <volker.wysk@student.uni-tuebingen.de>
195 .br
196 Jim Hague <jim.hague@acm.org>
197 .br
198 1998-2000.
199
200