annotate INSTALL.html @ 10:d3fb34cb8198 noffle

[svn] Added comment
author enz
date Tue, 11 Apr 2000 07:50:16 +0100
parents 04124a4423d4
children 8e972daaeab9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
1 <html>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
2
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
3 <head>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
4 <title>NOFFLE Installation</title>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
5 </head>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
6
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
7 <body bgcolor=white>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
8 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
9
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
10 <center>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
11 <h1>NOFFLE Installation</h1>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
12 </center>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
13
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
14 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
15 <hr>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
16 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
17
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
18 For compiling NOFFLE there are the following requirements:
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
19 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
20
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
21 <ul>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
22
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
23 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
24 The gdbm library must be installed on your system (standard with
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
25 most distributions).
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
26 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
27 Please use the same compiler for compiling NOFFLE that was
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
28 used for compiling the gdbm library!
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
29 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
30 The reason for this warning is that there is an incompatibility between
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
31 egcs and gcc that causes programs to crash on some distributions,
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
32 depending on the optimisation level.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
33 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
34
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
35 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
36 The program "mail" must be available, because failed postings are
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
37 returned to the sender by calling it (with option -s and by piping
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
38 message text into it).
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
39 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
40
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
41 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
42 The program "sort" must be available (standard with most distributions).
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
43 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
44
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
45 </ul>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
46
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
47 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
48 For installing NOFFLE on your system, the following steps are necessary:
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
49 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
50
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
51 <ul>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
52
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
53 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
54 Edit the Makefile. Change SPOOLDIR and PREFIX, if you do not
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
55 like the defaults.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
56 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
57
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
58 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
59 Type 'make'.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
60 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
61
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
62 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
63 Log in as root and type 'make install'.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
64 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
65
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
66 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
67 Copy '&lt;PREFIX&gt;/doc/noffle/noffle.conf.example' to '/etc/noffle.conf' and
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
68 edit it. Write in the name of the remote news server.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
69 <br>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
70 Change the owner to 'news':
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
71 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
72 chown news.news /etc/noffle.conf
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
73 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
74 Make it unreadable by others, if it contains a username and a password:
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
75 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
76 chmod o-r /etc/noffle.conf
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
77 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
78 Now you can leave the root account.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
79 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
80
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
81 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
82 Go online and run
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
83 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
84 noffle --query groups # required
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
85 noffle --query desc # optional group descriptions
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
86 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
87 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
88 to retrieve newsgroup information.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
89 <br>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
90 This may take a while depending on the number of active newsgroups
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
91 at the remote news server.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
92 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
93 Subscribe to some groups by running
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
94 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
95 noffle --subscribe-over <groupname>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
96 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
97 or
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
98 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
99 noffle --subscribe-thread <groupname>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
100 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
101 or
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
102 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
103 noffle --subscribe-full <groupname>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
104 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
105 Then run
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
106 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
107 noffle --fetch
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
108 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
109 for testing the retrieving of overviews/articles of the groups subscribed.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
110 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
111
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
112 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
113 Add a line for 'noffle' to '/etc/inetd.conf':
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
114 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
115 nntp stream tcp nowait news /usr/sbin/tcpd /usr/local/bin/noffle -r
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
116 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
117 (Change the path of noffle if necessary)
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
118 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
119
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
120 <li>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
121 Add the following lines to your 'ip-up' script:
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
122 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
123 /usr/local/bin/noffle --fetch
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
124 /usr/local/bin/noffle --online
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
125 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
126 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
127 Add the following line to your 'ip-down' script:
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
128 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
129 /usr/local/bin/noffle --offline
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
130 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
131 Add a line for running noffle to the crontab of news (by running
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
132 'crontab -u news -e' as root):
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
133 <pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
134 0 19 * * 1 /usr/local/bin/noffle --expire 14
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
135 </pre>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
136 (if you want to run 'noffle' on Monday (1st day of week) at
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
137 19.00 and delete all articles not accessed within the last 14 days).
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
138 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
139
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
140 </ul>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
141
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
142 Now you are ready, configure the client readers to use "localhost" port 119
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
143 as news server and/or set the environment variable NNTPSERVER to
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
144 "localhost" and/or create the file /etc/nntpserver containing "localhost".
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
145 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
146 If something goes wrong, have a look at '/var/log/news' for error and
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
147 logging messages.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
148 <p>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
149 It can be helpful to recompile NOFFLE with the
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
150 -DDEBUG option to increase the level of logged details. Additionally,
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
151 the -DDEBUG option will create a core file in the spool directory if NOFFLE
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
152 should crash. This will allow those of you familiar with a debugger to send
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
153 me a detailed bug report :-)
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
154
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
155 </body>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
156 </html>