Mercurial > noffle

comparison docs/noffle.1 @ 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 1
2 .\" $Id: noffle.1 48 2000-05-05 20:26:14Z uh1763 $
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
12 \-c | \-\-cancel <message id>
13 .br
14 .B noffle
15 \-C | \-\-create <local newsgroup name>
16 .br
17 .B noffle
18 \-d | \-\-database
19 .br
20 .B noffle
21 \-D | \-\-delete <newsgroup name>
22 .br
23 .B noffle
24 \-e | \-\-expire
25 .br
26 .B noffle
27 \-f | \-\-fetch
28 .br
29 .B noffle
30 \-g | \-\-groups
31 .br
32 .B noffle
33 \-h | \-\-help
34 .br
35 .B noffle
36 \-l | \-\-list
37 .br
38 .B noffle
39 \-m | \-\-modify desc <newsgroup name> <group description>
40 .br
41 .B noffle
42 \-m | \-\-modify post <local newsgroup name> (y|n)
43 .br
44 .B noffle
45 \-n | \-\-online
46 .br
47 .B noffle
48 \-o | \-\-offline
49 .br
50 .B noffle
51 \-q | \-\-query groups|desc|times
52 .br
53 .B noffle
54 \-R | \-\-requested
55 .br
56 .B noffle
57 \-r | \-\-server
58 .br
59 .B noffle
60 \-s | \-\-subscribe-over <group>
61 .br
62 .B noffle
63 \-S | \-\-subscribe-full <group>
64 .br
65 .B noffle
66 \-t | \-\-subscribe-thread <group>
67 .br
68 .B noffle
69 \-u | \-\-unsubscribe <group>
70
71 .SH DESCRIPTION
72
73 .B NOFFLE
74 is an Usenet package optimized for low speed dialup Internet connections
75 and few users.
76 The
77 .B noffle
78 program is used for running and steering of the proxy news server,
79 for retrieving new articles from the remote server and for
80 expiring old articles from the database.
81 .B NOFFLE
82 can fetch newsgroups in one of the following modes:
83 .TP
84 .B full
85 fetch full articles,
86 .TP
87 .B over
88 fetch only article overviews by default. Opening an article marks it
89 for download next time online,
90 .TP
91 .B thread
92 like
93 .B over,
94 but download articles full if an article of the same thread already has
95 been downloaded.
96
97 .PP
98 .B NOFFLE
99 also offers limited support for local news groups. Articles
100 posted to these appear in full in the database for the local group(s)
101 immediately. They are expired in the usual way.
102 .PP
103 If an article is cross-posted to a local group and a remote group, it
104 appears in the local group immediately and in the remote group after
105 the next fetch from the remove server.
106 .PP
107 Note that
108 .B NOFFLE
109 cannot exchange the contents of local groups with other news servers.
110
111 .SH OPTIONS
112
113 .TP
114 .B \-a, \-\-article <message id>|all
115 Write article <message id> to standard output. Message Id must contain
116 the leading '<' and trailing '>' (quote the argument to avoid shell
117 interpretation of '<' and '>').
118 .br
119 If "all" is given as message Id, all articles are shown.
120
121 .TP
122 .B \-c, \-\-cancel <message id>
123 Cancel the article from the database and remove it from the queue of
124 outbound messages if it has not already been sent. Message Id must
125 contain the leading '<' and trailing '>' (quote the argument to avoid
126 shell interpretation of '<' and '>').
127
128 .TP
129 .B \-C, \-\-create <local newsgroup name>
130 Create a new local newsgroup with the given name. The name should
131 conform to the usual newsgroup naming rules to avoid confusing
132 newsreaders.
133
134 .TP
135 .B \-d, \-\-database
136 Write the complete content of the article database to standard output.
137
138 .TP
139 .B \-D, \-\-delete <newsgroup name>
140 Delete the newsgroup with the given name. All articles that only
141 belong to the group are deleted as well.
142
143 .TP
144 .B \-e, \-\-expire
145 Delete all articles that have not been accessed recently from the
146 database.
147 Should be run regularily from
148 .BR crond (8).
149 .TP
150 The default expire period is 14 days. This can be changed and
151 custom expiry periods set for individual newsgroups or sets of
152 newsgroups in
153 .B /etc/noffle.conf.
154
155 .TP
156 .B \-f, \-\-fetch
157 Get new newsfeed from the remote server.
158 Updates the list of the existing newsgroups,
159 fetches new articles overviews or full articles from subscribed
160 groups (see
161 .B fetchlist
162 ),
163 delivers all posted articles to the remote server,
164 and retrieves all articles marked for download.
165 .B noffle --fetch
166 should be run in the
167 .B ip-up
168 script of
169 .BR pppd (8).
170
171 .TP
172 .B \-g, \-\-groups
173 List all groups available at remote server.
174 .br
175 Format (fields separated by tabs):
176 .br
177 <name> <server> <first> <last> <remote next> <post allowed> <created> <last access> <desc>
178
179 .TP
180 .B \-h, \-\-help
181 Print a list of all options.
182
183 .TP
184 .B \-l, \-\-list
185 List all groups that are presently to be fetched and their fetch mode.
186 .br
187 Format: <groupname> <server> full|thread|over
188
189 .TP
190 .B \-m | \-\-modify desc <newsgroup name> <group description>
191 Modify the description of the named newsgroup.
192
193 .TP
194 .B \-m | \-\-modify post <local newsgroup name> <permission>
195 Modify the posting permission on a local newsgroup. <permission> must
196 be either 'y' (yes, posting allowed) or 'n' (no, posting not allowed).
197 Attempts to post to a newsgroup with posting disabled will be rejected.
198
199 .TP
200 .B \-n, \-\-online
201 Put
202 .B NOFFLE
203 to online status. Requested articles or overviews of selected
204 groups are immediately fetched from the remote server.
205 Should be run in the
206 .B ip-up
207 script of
208 .BR pppd (8).
209
210 .TP
211 .B \-o, \-\-offline
212 Put
213 .B NOFFLE
214 to offline status. Requested articles not already in the
215 database are marked for download.
216 Should be run in the
217 .B ip-down
218 script of
219 .BR pppd (8).
220
221 .TP
222 .B \-q, \-\-query groups|desc|times
223 Query information about all groups from the remote server and merge it to
224 the
225 .B groupinfo
226 file. This must be run after installing
227 .B noffle
228 or sometimes after a change of the remote news server or corruption
229 of the file. It can take some time on slow connections.
230 .B groups
231 retrieves the list of the existing newsgroups
232 (resets all local article counters),
233 .B desc
234 retrieves all newsgroup descriptions,
235 .B times
236 retrieves the creation times of the newsgroups.
237
238 .TP
239 .B \-r, \-\-server
240 Run as NNTP server on standard input and standard output. This is
241 intended to be called by
242 .BR inetd (8)
243 and should be registered in
244 .B /etc/inetd.conf.
245 Error and logging messages are put to the
246 .BR syslogd (8)
247 daemon which is usually configured to write them to
248 .B /var/log/news.
249 A list of the NNTP commands that are understood by
250 .B noffle
251 can be retrieved by running the server and typing
252 .B HELP.
253
254 .TP
255 .B \-R, \-\-requested
256 List articles that are marked for download.
257
258 Format: <message-id> <server>
259
260 .TP
261 .B \-s, \-\-subscribe-over <group>
262 Add group with name <group> to list of groups that are presently to be fetched
263 (in over mode).
264
265 .TP
266 .B \-S, \-\-subscribe-full <group>
267 Add group with name <group> to list of groups that are presently to be fetched
268 (in full mode).
269
270 .TP
271 .B \-t, \-\-subscribe-thread <group>
272 Add group with name <group> to list of groups that are presently to be fetched
273 (in thread mode).
274
275 .TP
276 .B \-u, \-\-unsubscribe <group>
277 Remove group with name <group> from list of groups that are presently to
278 be fetched.
279
280 .SH FILES
281
282 .B NOFFLE
283 takes its configuration from a configuration file, by default
284 .I /etc/noffle.conf.
285 For a description of this file, see
286 .BR noffle.conf (5).
287 .
288
289 .B NOFFLE
290 keeps all its data files in a spool directory.
291 .I /var/spool/noffle
292 is the default location.
293
294 .TP
295 .B <spool dir>/fetchlist
296 List of newsgroups that are presently to be fetched.
297 .br
298
299 .TP
300 .B <spool dir>/data/groupinfo.gdbm
301 Database with groups in
302 .BR gdbm(3)
303 format.
304
305 .TP
306 .B <spool dir>/data/articles.gdbm
307 Database with articles in
308 .BR gdbm(3)
309 format.
310
311 .TP
312 .B <spool dir>/lock/
313 Lock files and files indicating online/offline status.
314
315 .TP
316 .B <spool dir>/outgoing/
317 Posted articles to be delivered to the remote server.
318
319 .TP
320 .B <spool dir>/overview/
321 Text file per group with article overviews.
322
323 .TP
324 .B <spool dir>/requested/
325 Message IDs of articles marked for download.
326
327
328 .SH SEE ALSO
329
330 .BR noffle.conf (5),
331 .BR crond (8),
332 .BR inetd (8),
333 .BR pppd (8)
334 .br
335 .B RFC 977,
336 .B RFC 1036,
337 .br
338 .B IETF drafts on common NNTP extensions:
339 .br
340 .B http://www.karlsruhe.org/
341 .br
342 .B NOFFLE home page:
343 .br
344 .B http://home.t-online.de/home/markus.enzenberger/noffle.html
345
346 .SH AUTHORS
347
348 Markus Enzenberger <markus.enzenberger@t-online.de>
349 .br
350 Volker Wysk <volker.wysk@student.uni-tuebingen.de>
351
352 1998-1999.