Mercurial > noffle

comparison docs/noffle.conf.5 @ 472:fb8cadeed4d4 noffle

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] fixed manual dashes, see Debian #218448
author godisch
date Fri, 31 Oct 2003 15:54:59 +0000
parents b0ee77fa24d4
children 372f8b55506e
comparison
equal deleted inserted replaced
471:b798fa611c99 472:fb8cadeed4d4
1 .TH noffle.conf 5 1 .TH noffle.conf 5
2 .\" $Id: noffle.conf.5 495 2003-03-24 23:32:48Z bears $ 2 .\" $Id: noffle.conf.5 619 2003-10-31 15:54:59Z godisch $
3 3
4 .SH NAME 4 .SH NAME
5 noffle.conf \- Configuration file for NOFFLE news server 5 noffle.conf \- Configuration file for NOFFLE news server
6 6
7 .SH DESCRIPTION 7 .SH DESCRIPTION
32 Username and password for servers that need authentication 32 Username and password for servers that need authentication
33 (Original AUTHINFO). The password may not contain white-spaces. 33 (Original AUTHINFO). The password may not contain white-spaces.
34 If there are multiple server entries in the config file, all of them are 34 If there are multiple server entries in the config file, all of them are
35 used for getting groups. In this case the first server should be 35 used for getting groups. In this case the first server should be
36 the one of your main provider. Note that you must always 36 the one of your main provider. Note that you must always
37 run 'noffle --query groups' 37 run 'noffle \-\-query groups'
38 after making changes to the server entries. 38 after making changes to the server entries.
39 39
40 .TP 40 .TP
41 .B getgroups <group pattern> [, <group pattern> ...] 41 .B getgroups <group pattern> [, <group pattern> ...]
42 Only retrieve from the most recently specified server newsgroups that match 42 Only retrieve from the most recently specified server newsgroups that match
68 will list and collect as required. 68 will list and collect as required.
69 .br 69 .br
70 Default: No groups 70 Default: No groups
71 71
72 .TP 72 .TP
73 .B max-fetch <n> 73 .B max\-fetch <n>
74 Never get more than <n> articles. If there are more, the oldest ones 74 Never get more than <n> articles. If there are more, the oldest ones
75 are discarded. 75 are discarded.
76 .br 76 .br
77 Default: 300 77 Default: 300
78 78
79 .TP 79 .TP
80 .B from-domain <domain> 80 .B from\-domain <domain>
81 When invoked as 81 When invoked as
82 .BR inews (1) 82 .BR inews (1)
83 .B NOFFLE 83 .B NOFFLE
84 will add a From: line to posts that lack one. The address given 84 will add a From: line to posts that lack one. The address given
85 uses the userid of the user who invoked 85 uses the userid of the user who invoked
87 and the specified domain. 87 and the specified domain.
88 .br 88 .br
89 Default: The system domain 89 Default: The system domain
90 90
91 .TP 91 .TP
92 .B log-debug <log category> [<log category ...] 92 .B log\-debug <log category> [<log category ...]
93 Log debugging information from the specified log category 93 Log debugging information from the specified log category
94 or categories. Logging is via the system logging daemon 94 or categories. Logging is via the system logging daemon
95 .BR syslogd (8) 95 .BR syslogd (8)
96 (to the debug facility) and additionally to stderr when running 96 (to the debug facility) and additionally to stderr when running
97 interactively. The available categories for logging are 97 interactively. The available categories for logging are
121 .TP 121 .TP
122 .B organization <organization> 122 .B organization <organization>
123 When invoked as 123 When invoked as
124 .BR inews (1) 124 .BR inews (1)
125 .B NOFFLE 125 .B NOFFLE
126 will, unless the -O flag is specified, add an Organization: line to 126 will, unless the \-O flag is specified, add an Organization: line to
127 posts that lack one. If no 127 posts that lack one. If no
128 .B organization 128 .B organization
129 is specified, the line is not added. 129 is specified, the line is not added.
130 .br 130 .br
131 Default: <empty string> 131 Default: <empty string>
132 132
133 .TP 133 .TP
134 .B mail-to <address> 134 .B mail\-to <address>
135 Receiver of failed postings. If empty then failed postings are returned 135 Receiver of failed postings. If empty then failed postings are returned
136 to the sender (taking the address from the article's Reply-To, Sender, 136 to the sender (taking the address from the article's Reply-To, Sender,
137 X-Sender or From field, in this order). 137 X-Sender or From field, in this order).
138 .br 138 .br
139 Default: <empty string> 139 Default: <empty string>
140 140
141 .TP 141 .TP
142 .B auto-unsubscribe yes|no 142 .B auto\-unsubscribe yes|no
143 Automatically remove groups from fetch list if they have not been 143 Automatically remove groups from fetch list if they have not been
144 accessed for a number of days. Groups are only unsubscribed if there 144 accessed for a number of days. Groups are only unsubscribed if there
145 are fresh articles arriving and remaining unread. 145 are fresh articles arriving and remaining unread.
146 .br 146 .br
147 Default: no 147 Default: no
148 148
149 .TP 149 .TP
150 .B auto-unsubscribe-days <n> 150 .B auto\-unsubscribe\-days <n>
151 Number of days used for auto-unsubscribe option. 151 Number of days used for auto-unsubscribe option.
152 .br 152 .br
153 Default: 30 153 Default: 30
154 154
155 .TP 155 .TP
156 .B thread-follow-time <n> 156 .B thread\-follow\-time <n>
157 Automatically mark articles for download in thread mode, if they 157 Automatically mark articles for download in thread mode, if they
158 are referencing an article that has been opened by a reader within the last 158 are referencing an article that has been opened by a reader within the last
159 <n> days. 159 <n> days.
160 .br 160 .br
161 Default: 7 161 Default: 7
162 162
163 .TP 163 .TP
164 .B connect-timeout <n> 164 .B connect\-timeout <n>
165 Timeout for connecting to remote server in seconds. 165 Timeout for connecting to remote server in seconds.
166 .br 166 .br
167 Default: 30 167 Default: 30
168 168
169 .TP 169 .TP
170 .B auto-subscribe yes|no 170 .B auto\-subscribe yes|no
171 Automatically put groups on fetch list if someone reads them. 171 Automatically put groups on fetch list if someone reads them.
172 <mode> can be full, over, thread (depending on the fetch mode) or 172 <mode> can be full, over, thread (depending on the fetch mode) or
173 off (do not subscribe automatically). Condition for putting a group 173 off (do not subscribe automatically). Condition for putting a group
174 on the list is that an article is opened. For this reason there is 174 on the list is that an article is opened. For this reason there is
175 always a pseudo article visible in groups that are not on the fetch list. 175 always a pseudo article visible in groups that are not on the fetch list.
176 .br 176 .br
177 Default: no 177 Default: no
178 178
179 .TP 179 .TP
180 .B auto-subscribe-mode <group pattern> full|thread|over 180 .B auto\-subscribe\-mode <group pattern> full|thread|over
181 Mode for auto-subscribe option for groups that match the given 181 Mode for auto-subscribe option for groups that match the given
182 pattern. 182 pattern.
183 .br 183 .br
184 Default: none 184 Default: none
185 185
186 .TP 186 .TP
187 .B default-auto-subscribe-mode full|thread|over 187 .B default\-auto\-subscribe\-mode full|thread|over
188 Default mode for auto-subscribe option. Used for all groups that do 188 Default mode for auto-subscribe option. Used for all groups that do
189 not match a pattern specified with 189 not match a pattern specified with
190 .B auto-subscribe-mode 190 .B auto\-subscribe\-mode
191 entries (if any). 191 entries (if any).
192 .br 192 .br
193 Default: over 193 Default: over
194 194
195 .TP 195 .TP
196 .B info-always-unread yes|no 196 .B info\-always\-unread yes|no
197 An information article is presented for all unsubscribed 197 An information article is presented for all unsubscribed
198 newsgroups. If auto-subscribe mode is off, there is a possibility of 198 newsgroups. If auto-subscribe mode is off, there is a possibility of
199 someone reading the article but forgetting the instructions therein 199 someone reading the article but forgetting the instructions therein
200 and not knowing how to return to a read article. This option causes 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 201 the information article always to be present as an unread article in a
203 article number of the information article every time it is read. 203 article number of the information article every time it is read.
204 .br 204 .br
205 Default: yes 205 Default: yes
206 206
207 .TP 207 .TP
208 .B authenticate-client yes|no 208 .B authenticate\-client yes|no
209 Insist that clients authenticate themselves using the NNTP 209 Insist that clients authenticate themselves using the NNTP
210 AUTHINFO USER/AUTHINFO PASS transaction before any news is served. 210 AUTHINFO USER/AUTHINFO PASS transaction before any news is served.
211 This option is recognised only when NOFFLE has been built with 211 This option is recognised only when NOFFLE has been built with
212 authentication enabled. 212 authentication enabled.
213 The form of the authentication is determined at compile time; either 213 The form of the authentication is determined at compile time; either
221 way, and so must itself be considered insecure. 221 way, and so must itself be considered insecure.
222 .br 222 .br
223 Default: no 223 Default: no
224 224
225 .TP 225 .TP
226 .B post-locally yes|no 226 .B post\-locally yes|no
227 Place articles posted to external servers in the local aticle database 227 Place articles posted to external servers in the local aticle database
228 immediately. Some servers may rewrite Message-IDs, which will cause 228 immediately. Some servers may rewrite Message-IDs, which will cause
229 duplicate postings of this option is enabled. Also, if for some reason 229 duplicate postings of this option is enabled. Also, if for some reason
230 the post to the remote server fails, the article still exists in the local 230 the post to the remote server fails, the article still exists in the local
231 database, which may be a source of some confusion. 231 database, which may be a source of some confusion.
232 .br 232 .br
233 Default: no 233 Default: no
234 234
235 .TP 235 .TP
236 .B replace-messageid yes|no 236 .B replace\-messageid yes|no
237 Always replace the Message-ID of a posted article with a Message-ID 237 Always replace the Message-ID of a posted article with a Message-ID
238 generated by NOFFLE. NOFFLE will always add a Message-ID if none is 238 generated by NOFFLE. NOFFLE will always add a Message-ID if none is
239 present, or replace a Message-ID that does not meet the basic 239 present, or replace a Message-ID that does not meet the basic
240 formatting and content requirements for a Message-ID. However, some 240 formatting and content requirements for a Message-ID. However, some
241 news readers may generate Message-IDs that are not accepted by some 241 news readers may generate Message-IDs that are not accepted by some
254 newsserver or someone else might allow you to use a subdomain name. 254 newsserver or someone else might allow you to use a subdomain name.
255 .br 255 .br
256 Default: <the fully qualified domain name of your system> 256 Default: <the fully qualified domain name of your system>
257 257
258 .TP 258 .TP
259 .B append-reply-to yes|no 259 .B append\-reply\-to yes|no
260 Append a 'Reply-To:' header to messages posted without it. 260 Append a 'Reply-To:' header to messages posted without it.
261 The address from the 'From:' header is used. Though this might seem 261 The address from the 'From:' header is used. Though this might seem
262 pretty useless at first glance it may be desireable as some providers were 262 pretty useless at first glance it may be desireable as some providers were
263 known to overwrite the 'From:' header. 263 known to overwrite the 'From:' header.
264 .br 264 .br
265 Default: yes 265 Default: yes
266 266
267 .TP 267 .TP
268 .B path-header <path header content> 268 .B path\-header <path header content>
269 Articles posted without a Path: header have one added by NOFFLE. 269 Articles posted without a Path: header have one added by NOFFLE.
270 When 270 When
271 .B path-header 271 .B path\-header
272 has its default value (empty) the header content 272 has its default value (empty) the header content
273 is "<hostname>!not-for-mail". 273 is "<hostname>!not-for-mail".
274 Use the 274 Use the
275 .B path-header 275 .B path\-header
276 setting to provide alternate content for the Path: header. 276 setting to provide alternate content for the Path: header.
277 This will very rarely be necessary. 277 This will very rarely be necessary.
278 .br 278 .br
279 Default: <empty string> 279 Default: <empty string>
280 280
281 .TP 281 .TP
282 .B default-expire <n> 282 .B default\-expire <n>
283 The default expiry period, in days. An expiry period of 0 means "never". 283 The default expiry period, in days. An expiry period of 0 means "never".
284 .br 284 .br
285 Default: 14 285 Default: 14
286 286
287 .TP 287 .TP
288 .B noffle-user <n> 288 .B noffle\-user <n>
289 The username under which NOFFLE normally runs. If NOFFLE is invoked by 289 The username under which NOFFLE normally runs. If NOFFLE is invoked by
290 root, it will drop its real and effective UID to this user as soon as 290 root, it will drop its real and effective UID to this user as soon as
291 possible. 291 possible.
292 .br 292 .br
293 Default: news 293 Default: news
294 294
295 .TP 295 .TP
296 .B noffle-group <n> 296 .B noffle\-group <n>
297 The group under which NOFFLE normally runs. NOFFLE will change to this 297 The group under which NOFFLE normally runs. NOFFLE will change to this
298 real and effective GID as soon as possible. 298 real and effective GID as soon as possible.
299 .br 299 .br
300 Default: news 300 Default: news
301 301
527 Please don't forget the timezone specification. 527 Please don't forget the timezone specification.
528 .PP 528 .PP
529 .I date>"now+1.5" 529 .I date>"now+1.5"
530 matches any article newer than 36 hours from the current date. 530 matches any article newer than 36 hours from the current date.
531 .PP 531 .PP
532 .I date="lastupdate-14" 532 .I date="lastupdate\-14"
533 matches any article older than 14 days since the date of the last 533 matches any article older than 14 days since the date of the last
534 .B noffle --fetch 534 .B noffle \-\-fetch
535 or 535 or
536 .B noffle --query groups 536 .B noffle \-\-query groups
537 from the current newsserver. 537 from the current newsserver.
538 .PP 538 .PP
539 .I date="invalid" 539 .I date="invalid"
540 matches any article with an invalid date header. 540 matches any article with an invalid date header.
541 .PP 541 .PP
544 .BR noffle (1) 544 .BR noffle (1)
545 .BR regex (7) 545 .BR regex (7)
546 546
547 .SH AUTHORS 547 .SH AUTHORS
548 548
549 Markus Enzenberger <me@markus-enzenberger.de> 549 Markus Enzenberger <me@markus\-enzenberger.de>
550 .br 550 .br
551 Volker Wysk <volker.wysk@student.uni-tuebingen.de> 551 Volker Wysk <volker.wysk@student.uni\-tuebingen.de>
552 .br 552 .br
553 Jim Hague <jim.hague@acm.org> 553 Jim Hague <jim.hague@acm.org>
554 .br 554 .br
555 Uwe Hermann <uh1763@bingo-ev.de> 555 Uwe Hermann <uh1763@bingo\-ev.de>
556 .br 556 .br
557 Mirko Liss <mirko.liss@web.de> 557 Mirko Liss <mirko.liss@web.de>
558 558
559 1998-2003. 559 1998-2003.
560 560