Mercurial > noffle

comparison INSTALL @ 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 24d4cd032da5
comparison
equal deleted inserted replaced
41:92b59cfcf364 42:2467ff423c15
1 -------------------------------------------------------------------------------
2 NOFFLE Installation
3 -------------------------------------------------------------------------------
4
5 Requirements
6 ------------
7
8 * The gdbm library must be installed on your system (standard with most
9 distributions).
10
11 * Please use the same compiler for compiling NOFFLE that was used for
12 compiling the gdbm library!
13 The reason for this warning is that there is an incompatibility between
14 egcs and gcc that causes programs to crash on some distributions, depending
15 on the optimization level.
16
17 * The program "mail" must be available, because failed postings are returned
18 to the sender by calling it (with option -s and by piping message text
19 into it).
20
21 * The program "sort" must be available (standard with most distributions).
22
23
24 Compilation and installation
25 ----------------------------
26
27 For installing NOFFLE on your system, the following steps are necessary:
28
29 * ./configure
30 make
31 make install
32
33 You can type './configure --help' to get a list of possible options for
34 configure.
35 Apart from the standard ones, the following options can be used:
36
37 --enable-debug Turn on debugging (default=yes)
38 --with-docdir=PATH Specify where to put the documentation.
39 Default is /usr/local/doc/noffle.
40
41 * Copy '/etc/noffle.conf.example' to '/etc/noffle.conf' and edit it.
42 Write in the name of the remote news server.
43
44 Change the owner to 'news':
45 chown news.news /etc/noffle.conf
46
47 Make it unreadable by others, if it contains a username and a password:
48 chmod o-r /etc/noffle.conf
49
50 Now you can leave the root account.
51
52 * Go online and run
53
54 noffle --query groups # required
55 noffle --query desc # optional group descriptions
56
57 to retrieve newsgroup information. This may take a while depending on the
58 number of active newsgroups at the remote news server.
59
60 * Subscribe to some groups by running
61
62 noffle --subscribe-over <newsgroup>
63 or
64 noffle --subscribe-thread <newsgroup>
65 or
66 noffle --subscribe-full <newsgroup>
67
68 * Now run
69
70 noffle --fetch
71
72 for testing the retrieving of overviews/articles of the groups subscribed.
73
74 * Add a line for 'noffle' to '/etc/inetd.conf':
75
76 nntp stream tcp nowait news /usr/sbin/tcpd /usr/local/bin/noffle -r
77
78 (Change the path of noffle if necessary)
79
80 * Add the following lines to your 'ip-up' script:
81
82 /usr/local/bin/noffle --fetch
83 /usr/local/bin/noffle --online
84
85 Add the following line to your 'ip-down' script:
86
87 /usr/local/bin/noffle --offline
88
89 * Add a line for running noffle to the crontab of news (by running
90 'crontab -u news -e' as root):
91
92 0 19 * * 1 /usr/local/bin/noffle --expire
93
94 (if you want to run 'noffle' on Monday (1st day of week) at 19.00 and
95 delete all articles not accessed recently. The default expiry period is
96 14 days, but this can be changed in /etc/noffle.conf.
97
98
99 Now you are ready, configure the client readers to use "localhost" port 119
100 as news server and/or set the environment variable NNTPSERVER to "localhost"
101 and/or create the file /etc/nntpserver containing "localhost".
102
103 If something goes wrong, have a look at '/var/log/news' for error and
104 logging messages.
105
106
107 It can be helpful to recompile NOFFLE with
108
109 ./configure --enable-debug
110 make
111 make install
112
113 to increase the level of logged details. Additionally, this will create
114 a core file in the spool directory if NOFFLE should crash.
115 This will allow those of you familiar with a debugger to send me a detailed
116 bug report :-)
117
118
119 Read below for more (generic) information about ./configure.
120
121 -------------------------------------------------------------------------------
122
123
124 Basic Installation
125 ==================
126
127 These are generic installation instructions.
128
129 The `configure' shell script attempts to guess correct values for
130 various system-dependent variables used during compilation. It uses
131 those values to create a `Makefile' in each directory of the package.
132 It may also create one or more `.h' files containing system-dependent
133 definitions. Finally, it creates a shell script `config.status' that
134 you can run in the future to recreate the current configuration, a file
135 `config.cache' that saves the results of its tests to speed up
136 reconfiguring, and a file `config.log' containing compiler output
137 (useful mainly for debugging `configure').
138
139 If you need to do unusual things to compile the package, please try
140 to figure out how `configure' could check whether to do them, and mail
141 diffs or instructions to the address given in the `README' so they can
142 be considered for the next release. If at some point `config.cache'
143 contains results you don't want to keep, you may remove or edit it.
144
145 The file `configure.in' is used to create `configure' by a program
146 called `autoconf'. You only need `configure.in' if you want to change
147 it or regenerate `configure' using a newer version of `autoconf'.
148
149 The simplest way to compile this package is:
150
151 1. `cd' to the directory containing the package's source code and type
152 `./configure' to configure the package for your system. If you're
153 using `csh' on an old version of System V, you might need to type
154 `sh ./configure' instead to prevent `csh' from trying to execute
155 `configure' itself.
156
157 Running `configure' takes awhile. While running, it prints some
158 messages telling which features it is checking for.
159
160 2. Type `make' to compile the package.
161
162 3. Optionally, type `make check' to run any self-tests that come with
163 the package.
164
165 4. Type `make install' to install the programs and any data files and
166 documentation.
167
168 5. You can remove the program binaries and object files from the
169 source code directory by typing `make clean'. To also remove the
170 files that `configure' created (so you can compile the package for
171 a different kind of computer), type `make distclean'. There is
172 also a `make maintainer-clean' target, but that is intended mainly
173 for the package's developers. If you use it, you may have to get
174 all sorts of other programs in order to regenerate files that came
175 with the distribution.
176
177 Compilers and Options
178 =====================
179
180 Some systems require unusual options for compilation or linking that
181 the `configure' script does not know about. You can give `configure'
182 initial values for variables by setting them in the environment. Using
183 a Bourne-compatible shell, you can do that on the command line like
184 this:
185 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
186
187 Or on systems that have the `env' program, you can do it like this:
188 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
189
190 Compiling For Multiple Architectures
191 ====================================
192
193 You can compile the package for more than one kind of computer at the
194 same time, by placing the object files for each architecture in their
195 own directory. To do this, you must use a version of `make' that
196 supports the `VPATH' variable, such as GNU `make'. `cd' to the
197 directory where you want the object files and executables to go and run
198 the `configure' script. `configure' automatically checks for the
199 source code in the directory that `configure' is in and in `..'.
200
201 If you have to use a `make' that does not supports the `VPATH'
202 variable, you have to compile the package for one architecture at a time
203 in the source code directory. After you have installed the package for
204 one architecture, use `make distclean' before reconfiguring for another
205 architecture.
206
207 Installation Names
208 ==================
209
210 By default, `make install' will install the package's files in
211 `/usr/local/bin', `/usr/local/man', etc. You can specify an
212 installation prefix other than `/usr/local' by giving `configure' the
213 option `--prefix=PATH'.
214
215 You can specify separate installation prefixes for
216 architecture-specific files and architecture-independent files. If you
217 give `configure' the option `--exec-prefix=PATH', the package will use
218 PATH as the prefix for installing programs and libraries.
219 Documentation and other data files will still use the regular prefix.
220
221 In addition, if you use an unusual directory layout you can give
222 options like `--bindir=PATH' to specify different values for particular
223 kinds of files. Run `configure --help' for a list of the directories
224 you can set and what kinds of files go in them.
225
226 If the package supports it, you can cause programs to be installed
227 with an extra prefix or suffix on their names by giving `configure' the
228 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
229
230 Optional Features
231 =================
232
233 Some packages pay attention to `--enable-FEATURE' options to
234 `configure', where FEATURE indicates an optional part of the package.
235 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
236 is something like `gnu-as' or `x' (for the X Window System). The
237 `README' should mention any `--enable-' and `--with-' options that the
238 package recognizes.
239
240 For packages that use the X Window System, `configure' can usually
241 find the X include and library files automatically, but if it doesn't,
242 you can use the `configure' options `--x-includes=DIR' and
243 `--x-libraries=DIR' to specify their locations.
244
245 Specifying the System Type
246 ==========================
247
248 There may be some features `configure' can not figure out
249 automatically, but needs to determine by the type of host the package
250 will run on. Usually `configure' can figure that out, but if it prints
251 a message saying it can not guess the host type, give it the
252 `--host=TYPE' option. TYPE can either be a short name for the system
253 type, such as `sun4', or a canonical name with three fields:
254 CPU-COMPANY-SYSTEM
255
256 See the file `config.sub' for the possible values of each field. If
257 `config.sub' isn't included in this package, then this package doesn't
258 need to know the host type.
259
260 If you are building compiler tools for cross-compiling, you can also
261 use the `--target=TYPE' option to select the type of system they will
262 produce code for and the `--build=TYPE' option to select the type of
263 system on which you are compiling the package.
264
265 Sharing Defaults
266 ================
267
268 If you want to set default values for `configure' scripts to share,
269 you can create a site shell script called `config.site' that gives
270 default values for variables like `CC', `cache_file', and `prefix'.
271 `configure' looks for `PREFIX/share/config.site' if it exists, then
272 `PREFIX/etc/config.site' if it exists. Or, you can set the
273 `CONFIG_SITE' environment variable to the location of the site script.
274 A warning: not all `configure' scripts look for a site script.
275
276 Operation Controls
277 ==================
278
279 `configure' recognizes the following options to control how it
280 operates.
281
282 `--cache-file=FILE'
283 Use and save the results of the tests in FILE instead of
284 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
285 debugging `configure'.
286
287 `--help'
288 Print a summary of the options to `configure', and exit.
289
290 `--quiet'
291 `--silent'
292 `-q'
293 Do not print messages saying which checks are being made. To
294 suppress all normal output, redirect it to `/dev/null' (any error
295 messages will still be shown).
296
297 `--srcdir=DIR'
298 Look for the package's source code in directory DIR. Usually
299 `configure' can determine that directory automatically.
300
301 `--version'
302 Print the version of Autoconf used to generate the `configure'
303 script, and exit.
304
305 `configure' also accepts some other, not widely useful, options.