Mercurial > noffle

annotate README @ 500:614a3177b15c noffle tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add mail-from option. Some modern mail systems will try and ensure the sender email is a legitimate address. Which will fail if there isn't such an address.
author Jim Hague <jim.hague@acm.org>
date Wed, 14 Aug 2013 12:04:39 +0100
parents d33568bb18ab
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
1 -------------------------------------------------------------------------------
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
2 The Noffle News Server
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
3 -------------------------------------------------------------------------------
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
4
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
5 Features
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
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
8 Noffle is a Usenet news server optimized for few users and low speed dial-up
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
9 connections to the Internet. It acts as a server to news clients running on
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
10 the local host, but gets its news feed by acting as a client to a remote
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
11 server. Noffle is written for the GNU/Linux operating system and freely
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
12 available under the terms of the GPL. See COPYING for details.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
13
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
14 * Allows reading news offline with many news clients, even if they do not
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
15 support offline reading by themselves.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
16
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
17 * Groups can be retrieved in overview, full or thread mode.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
18 * In overview mode, opened articles that have not been completely
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
19 downloaded yet are marked for download. Noffle generates a pseudo
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
20 article body telling the human about this.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
21 * In full mode, complete articles are fetched at once.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
22 * Thread mode is like overview mode, but opening an article marks the whole
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
23 thread for download (all later articles for some time that are
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
24 referencing the original article).
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
25
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
26 * The news feed is invoked automatically next online time by calling Noffle
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
27 in the ip-up script.
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 * Groups can be put on the fetch list via the 'noffle' command or
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
30 automatically when someone tries to read them. Groups can be automatically
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
31 removed from the fetch list, when nobody accesses them for some time.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
32
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
33 * Noffle also offers limited support for local groups. Articles posted in
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
34 local groups appear in the news database for those groups immediately,
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
35 and are expired in the same way as other articles.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
36
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
37 Compatibility with News Clients
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
38 -------------------------------
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
39
45
32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in:
uh1763
parents: 42
diff changeset
40 See docs/NOTES for information about news client software.
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
41
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
42
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
43 Getting Noffle
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
44 --------------
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
45
197
24d4cd032da5 [svn] * AUTHORS,INSTALL,NEWS,README,TODO,docs/NOTES,src/client.c,src/protocol.c,
bears
parents: 84
diff changeset
46 The current stable release is: 1.0.1
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
47
484
d33568bb18ab [svn] * Makefile.in,NEWS,README,aclocal.m4,configure,configure.in,
bears
parents: 266
diff changeset
48 The current development release is: 1.2.0rc1
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
49
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
50 The Noffle homepage is at:
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
51
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
52 http://noffle.sourceforge.net/
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
53
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
54 Official releases can be downloaded at the File Releases section
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
55 of the Noffle project page:
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
56
197
24d4cd032da5 [svn] * AUTHORS,INSTALL,NEWS,README,TODO,docs/NOTES,src/client.c,src/protocol.c,
bears
parents: 84
diff changeset
57 http://sourceforge.net/projects/noffle
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
58
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
59 The latest development snapshot is available via CVS at:
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
60
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
61 http://sourceforge.net/cvs/?group_id=1044
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
62
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
63
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
64 Installation
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
65 ------------
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
66
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
67 Read INSTALL for information about compiling and installing Noffle.
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
68
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
69
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
70 Documentation
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
71 -------------
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
72
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
73 Read the files in the subdirectory docs/ and the manual pages
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
74 noffle(1) and noffle.conf(5) for more information on Noffle.
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
75
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
76 There is a noffle-users mailing list at SourceForge:
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
77
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
78 http://sourceforge.net/mail/?group_id=1044
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
79
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
80 Bugs should be submitted here:
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
81
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
82 http://sourceforge.net/bugs/?group_id=1044
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
83
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
84
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
85 Acknowledgements
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
86 ----------------
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
87
84
8c6dbce3b178 [svn] Merged in changes from release-1-0 up to release-1-0-merge-1.
enz
parents: 45
diff changeset
88 The wildmat newsgroup pattern matching software used by Noffle was developed
42
2467ff423c15 [svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
uh1763
parents:
diff changeset
89 by Rich Salz, and is distributed with INN v2.2.