Mercurial > noffle
annotate noffle.1 @ 29:4d455c29bfd1 noffle
[svn] Send MODE READER for INN
author | enz |
---|---|
date | Sun, 30 Apr 2000 12:17:40 +0100 |
parents | 526a4c34ee2e |
children | 8e972daaeab9 |
rev | line source |
---|---|
0 | 1 .TH noffle 1 |
26
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
2 .\" $Id: noffle.1 32 2000-04-29 14:45:56Z enz $ |
0 | 3 .SH NAME |
4 noffle \- Usenet package optimized for dialup connections. | |
5 | |
6 .SH SYNOPSIS | |
7 | |
8 .B noffle | |
9 \-a | \-\-article <message id>|all | |
10 .br | |
11 .B noffle | |
26
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
12 \-c | \-\-cancel <message id> |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
13 .br |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
14 .B noffle |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
15 \-C | \-\-create <local newsgroup name> |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
16 .br |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
17 .B noffle |
0 | 18 \-d | \-\-database |
19 .br | |
20 .B noffle | |
21 \-e | \-\-expire <days> | |
22 .br | |
23 .B noffle | |
24 \-f | \-\-fetch | |
25 .br | |
26 .B noffle | |
27 \-g | \-\-groups | |
28 .br | |
29 .B noffle | |
30 \-h | \-\-help | |
31 .br | |
32 .B noffle | |
33 \-l | \-\-list | |
34 .br | |
35 .B noffle | |
36 \-n | \-\-online | |
37 .br | |
38 .B noffle | |
39 \-o | \-\-offline | |
40 .br | |
41 .B noffle | |
42 \-q | \-\-query groups|desc|times | |
43 .br | |
44 .B noffle | |
45 \-R | \-\-requested | |
46 .br | |
47 .B noffle | |
48 \-r | \-\-server | |
49 .br | |
50 .B noffle | |
51 \-s | \-\-subscribe-over <group> | |
52 .br | |
53 .B noffle | |
54 \-S | \-\-subscribe-full <group> | |
55 .br | |
56 .B noffle | |
57 \-t | \-\-subscribe-thread <group> | |
58 .br | |
59 .B noffle | |
60 \-u | \-\-unsubscribe <group> | |
61 | |
62 .SH DESCRIPTION | |
63 | |
64 .B NOFFLE | |
65 is an Usenet package optimized for low speed dialup Internet connections | |
66 and few users. | |
67 The | |
68 .B noffle | |
69 program is used for running and steering of the proxy news server, | |
70 for retrieving new articles from the remote server and for | |
71 expiring old articles from the database. | |
72 .B NOFFLE | |
73 can fetch newsgroups in one of the following modes: | |
74 .TP | |
75 .B full | |
76 fetch full articles, | |
77 .TP | |
78 .B over | |
79 fetch only article overviews by default. Opening an article marks it | |
80 for download next time online, | |
81 .TP | |
82 .B thread | |
83 like | |
84 .B over, | |
85 but download articles full if an article of the same thread already has | |
86 been downloaded. | |
87 | |
26
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
88 .PP |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
89 .B NOFFLE |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
90 also offers limited support for local news groups. Articles |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
91 posted to these appear in full in the database for the local group(s) |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
92 immediately. They are expired in the usual way. |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
93 .PP |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
94 If an article is cross-posted to a local group and a remote group, it |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
95 appears in the local group immediately and in the remote group after |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
96 the next fetch from the remove server. |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
97 .PP |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
98 Note that |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
99 .B NOFFLE |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
100 cannot exchange the contents of local groups with other news servers. |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
101 |
0 | 102 .SH OPTIONS |
103 | |
104 .TP | |
105 .B \-a, \-\-article <message id>|all | |
106 Write article <message id> to standard output. Message Id must contain | |
23 | 107 the leading '<' and trailing '>' (quote the argument with single quotes to |
108 avoid shell interpretation of characters like '<' and '>' and '$'). | |
0 | 109 .br |
110 If "all" is given as message Id, all articles are shown. | |
111 | |
112 .TP | |
26
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
113 .B \-c, \-\-cancel <message id> |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
114 Cancel the article from the database and remove it from the queue of |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
115 outbound messages if it has not already been sent. Message Id must |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
116 contain the leading '<' and trailing '>' (quote the argument to avoid |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
117 shell interpretation of '<' and '>'). |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
118 |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
119 .TP |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
120 .B \-C, \-\-create <local newsgroup name> |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
121 Create a new local newsgroup with the given name. The name should |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
122 conform to the usual newsgroup naming rules to avoid confusing |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
123 newsreaders. |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
124 |
526a4c34ee2e
[svn] Applied patch from Jim Hague: support for local groups / new command
enz
parents:
23
diff
changeset
|
125 .TP |
0 | 126 .B \-d, \-\-database |
127 Write the complete content of the article database to standard output. | |
128 | |
129 .TP | |
130 .B \-e, \-\-expire <days> | |
131 Delete all articles older than <days> days from the database. | |
132 Should be run regularily from | |
133 .BR crond (8). | |
134 | |
135 .TP | |
136 .B \-f, \-\-fetch | |
137 Get new newsfeed from the remote server. | |
138 Updates the list of the existing newsgroups, | |
139 fetches new articles overviews or full articles from subscribed | |
140 groups (see | |
141 .B fetchlist | |
142 ), | |
143 delivers all posted articles to the remote server, | |
144 and retrieves all articles marked for download. | |
145 .B noffle --fetch | |
146 should be run in the | |
147 .B ip-up | |
148 script of | |
149 .BR pppd (8). | |
150 | |
151 .TP | |
152 .B \-g, \-\-groups | |
153 List all groups available at remote server. | |
154 .br | |
155 Format (fields separated by tabs): | |
156 .br | |
157 <name> <server> <first> <last> <remote next> <created> <last access> <desc> | |
158 | |
159 .TP | |
160 .B \-h, \-\-help | |
161 Print a list of all options. | |
162 | |
163 .TP | |
164 .B \-l, \-\-list | |
165 List all groups that are presently to be fetched and their fetch mode. | |
166 .br | |
167 Format: <groupname> <server> full|thread|over | |
168 | |
169 .TP | |
170 .B \-n, \-\-online | |
171 Put | |
172 .B NOFFLE | |
173 to online status. Requested articles or overviews of selected | |
174 groups are immediately fetched from the remote server. | |
175 Should be run in the | |
176 .B ip-up | |
177 script of | |
178 .BR pppd (8). | |
179 | |
180 .TP | |
181 .B \-o, \-\-offline | |
182 Put | |
183 .B NOFFLE | |
184 to offline status. Requested articles not already in the | |
185 database are marked for download. | |
186 Should be run in the | |
187 .B ip-down | |
188 script of | |
189 .BR pppd (8). | |
190 | |
191 .TP | |
192 .B \-q, \-\-query groups|desc|times | |
193 Query information about all groups from the remote server and merge it to | |
194 the | |
195 .B groupinfo | |
196 file. This must be run after installing | |
197 .B noffle | |
198 or sometimes after a change of the remote news server or corruption | |
199 of the file. It can take some time on slow connections. | |
200 .B groups | |
201 retrieves the list of the existing newsgroups | |
202 (resets all local article counters), | |
203 .B desc | |
204 retrieves all newsgroup descriptions, | |
205 .B times | |
206 retrieves the creation times of the newsgroups. | |
207 | |
208 .TP | |
209 .B \-r, \-\-server | |
210 Run as NNTP server on standard input and standard output. This is | |
211 intended to be called by | |
212 .BR inetd (8) | |
213 and should be registered in | |
214 .B /etc/inetd.conf. | |
215 Error and logging messages are put to the | |
216 .BR syslogd (8) | |
217 daemon which is usually configured to write them to | |
218 .B /var/log/news. | |
219 A list of the NNTP commands that are understood by | |
220 .B noffle | |
221 can be retrieved by running the server and typing | |
222 .B HELP. | |
223 | |
224 .TP | |
225 .B \-R, \-\-requested | |
226 List articles that are marked for download. | |
227 | |
228 Format: <message-id> <server> | |
229 | |
230 .TP | |
231 .B \-s, \-\-subscribe-over <group> | |
232 Add group with name <group> to list of groups that are presently to be fetched | |
233 (in over mode). | |
234 | |
235 .TP | |
236 .B \-S, \-\-subscribe-full <group> | |
237 Add group with name <group> to list of groups that are presently to be fetched | |
238 (in full mode). | |
239 | |
240 .TP | |
241 .B \-t, \-\-subscribe-thread <group> | |
242 Add group with name <group> to list of groups that are presently to be fetched | |
243 (in thread mode). | |
244 | |
245 .TP | |
246 .B \-u, \-\-unsubscribe <group> | |
247 Remove group with name <group> from list of groups that are presently to | |
248 be fetched. | |
249 | |
250 .SH FILES | |
251 | |
252 There exists a spool directory (default | |
23 | 253 .I /var/spool/noffle), |
0 | 254 and a config file (default |
255 .I /etc/noffle.conf). | |
256 | |
257 .PP | |
258 | |
259 .TP | |
260 .B <config file> | |
261 Configuration file. Comment lines begin with | |
262 .I #. | |
263 Definition lines may contain: | |
264 .br | |
265 .B server <hostname>[:<port>] [<user> <pass>] | |
23 | 266 Name of the remote server. If no port is given, port 119 is used. |
0 | 267 Username and password for servers that need authentication |
268 (Original AUTHINFO). The password may not contain white-spaces. | |
269 If there are multiple server entries in the config file, all of them are | |
270 used for getting groups. In this case the first server should be | |
271 the one of your main provider. Note that you must always run | |
272 "noffle --query groups" after making changes to the server entries. | |
273 .br | |
274 .B max-fetch <n> | |
275 Never get more than <n> articles. If there are more, the oldest ones | |
276 are discarded. | |
277 .br | |
278 Default: 300 | |
279 .br | |
280 .B mail-to <address> | |
281 Receiver of failed postings. If empty then failed postings are returned | |
282 to the sender (taking the address from the article's Sender, X-Sender or | |
283 From field, in this order). | |
284 .br | |
285 Default: <empty string> | |
286 .br | |
287 .B auto-unsubscribe yes|no | |
288 Automatically remove groups from fetch list if they have not been | |
23 | 289 accessed for a number of days. |
0 | 290 .br |
291 Default: no | |
292 .br | |
293 .B auto-unsubscribe-days <n> | |
294 Number of days used for auto-unsubscribe option. | |
295 .br | |
296 Default: 30 | |
297 .br | |
298 .B thread-follow-time <n> | |
299 Automatically mark articles for download in thread mode, if they | |
300 are referencing an article that has been opened by a reader within the last | |
301 <n> days. | |
302 .br | |
3
0838ae9606b2
[svn] Documented default value for thread-follow-time option.
enz
parents:
0
diff
changeset
|
303 Default: 7 |
0838ae9606b2
[svn] Documented default value for thread-follow-time option.
enz
parents:
0
diff
changeset
|
304 .br |
0 | 305 .B connect-timeout <n> |
306 Timeout for connecting to remote server in seconds. | |
307 .br | |
308 Default: 30 | |
309 .br | |
310 .B auto-subscribe yes|no | |
311 Automatically put groups on fetch list if someone reads them. | |
312 <mode> can be full, over, thread (depending on the fetch mode) or | |
313 off (do not subscribe automatically). Condition for putting a group | |
314 on the list is that an article is opened. For this reason there is | |
315 always a pseudo article visible in groups that are not on the fetch list. | |
316 .br | |
317 Default: no | |
318 .br | |
319 .B auto-subscribe-mode full|thread|over | |
320 Mode for auto-subscribe option. | |
321 .br | |
322 Default: over | |
323 .br | |
324 .B remove-messageid yes|no | |
325 Remove Message-ID from posted articles. Some remote servers can generate | |
326 Message-IDs. | |
327 .br | |
328 Default: no | |
329 .br | |
330 .B replace-messageid yes|no | |
331 Replace Message-ID of posted articles by a Message-ID generated by | |
332 NOFFLE. Some news readers generate Message-IDs that are not accepted by | |
333 some servers. For generating Message-IDs, the domain name of your system should | |
334 be a valid domain name. If you are in a local domain, set it to your | |
335 provider's domain name. | |
336 .br | |
337 Default: yes | |
338 .br | |
339 | |
340 .TP | |
341 .B <spool dir>/fetchlist | |
342 List of newsgroups that are presently to be fetched. | |
343 .br | |
344 | |
345 .TP | |
346 .B <spool dir>/data/groupinfo.gdbm | |
347 Database with groups in | |
348 .BR gdbm(3) | |
349 format. | |
350 | |
351 .TP | |
352 .B <spool dir>/data/articles.gdbm | |
353 Database with articles in | |
354 .BR gdbm(3) | |
355 format. | |
356 | |
357 .TP | |
358 .B <spool dir>/lock/ | |
359 Lock files and files indicating online/offline status. | |
360 | |
361 .TP | |
362 .B <spool dir>/outgoing/ | |
363 Posted articles to be delivered to the remote server. | |
364 | |
365 .TP | |
366 .B <spool dir>/overview/ | |
367 Text file per group with article overviews. | |
368 | |
369 .TP | |
370 .B <spool dir>/requested/ | |
371 Message IDs of articles marked for download. | |
372 | |
373 | |
374 .SH SEE ALSO | |
375 | |
376 .BR crond (8) | |
377 .BR inetd (8), | |
378 .BR pppd (8), | |
379 .br | |
380 .B RFC 977, | |
381 .B RFC 1036, | |
382 .br | |
383 .B IETF drafts on common NNTP extensions: | |
384 .br | |
385 .B http://www.karlsruhe.org/ | |
386 .br | |
387 .B NOFFLE home page: | |
388 .br | |
389 .B http://home.t-online.de/home/markus.enzenberger/noffle.html | |
390 | |
391 .SH AUTHORS | |
392 | |
393 Markus Enzenberger <markus.enzenberger@t-online.de> | |
394 .br | |
395 Volker Wysk <volker.wysk@student.uni-tuebingen.de> | |
396 | |
397 1998-1999. |