Author: Kev <klmitch@mit.edu>
[ircu2.10.12-pk.git] / README
1 README for the ircu2.10.11 series
2 PLEASE READ THIS COMPLETELY BEFORE RUNNING THE SERVER!
3
4 The u2.10.11 is the most advanced version of Undernet ircd to date.
5 There are still plenty of rough edges, but many things have been
6 cleaned up and redone.  The major changes for this version are
7 documented in RELEASE.NOTES, in this directory.  A good description of
8 compiling and installing the server is included in INSTALL.  Further
9 documentation on many aspects of ircu is contained in the doc
10 subdirectory.
11
12 IF YOU ARE PLANNING ON USING IRCU IN A CHROOT "JAIL," YOU MUST READ
13 doc/readme.chroot!  This document describes the intricacies of using
14 the Undernet ircd daemon in such an environment.
15
16 This version of ircd no longer has the "make compile" step; most
17 compile-time options have become features which can be set in the
18 configuration file, or on the fly online through the SET and RESET
19 commands; the current values may be obtained with GET.  The remaining
20 compile-time options are set through arguments to ./configure.  A list
21 of the compile-time options may be obtained with "./configure --help";
22 see RELEASE.NOTES for a more comprehensive description of each
23 option.  All features are documented in doc/readme.features, and log
24 configuration is documented in doc/readme.log.
25
26 This server version is not compatible with Undernet ircd releases
27 prior to u2.10.10, nor is it compatible with any other version of
28 ircd.  Also note that this version incorporates the features requested
29 by the Undernet administrators in CFV 165; if you don't want these
30 hiding features enabled, you must add -DINCLUDED_ircd_policy_h to
31 CFLAGS prior to running ./configure.
32
33 For more information on the changes in this release, see RELEASE.NOTES
34 and ChangeLog, both in this directory.  You may also reference the CVS
35 log on the Undernet Coder Committee web page at
36 http://coder-com.undernet.org/.