--- ircd-hybrid/trunk/INSTALL 2012/11/01 13:16:37 1622 +++ ircd-hybrid/trunk/INSTALL 2013/07/03 18:17:39 2345 @@ -2,7 +2,7 @@ $Id$ - Copyright (c) 1997-2012 IRCD-Hybrid Development Team + Copyright (c) 1997-2013 IRCD-Hybrid Development Team ---------------------------------------------------------------------- @@ -15,14 +15,8 @@ | - You now need to ./configure --prefix="/path/to/install/it" as a | | minimum. Try ./configure --help or read this file for more info on | | the possible options you can pass to configure. | - | | - | - Important: The old config format WILL NOT WORK. Please see point 6! | +------------------------------------------------------------------------+ - ***** EFNET NOTE ***** - You should use the example.efnet.conf instead of example.conf. - ********************** - ---------------------------------------------------------------------- HOW TO BUILD @@ -30,10 +24,9 @@ As of hybrid-4, the distribution uses GNU autoconf instead of the old Config script. You must run ./configure before you can (sanely) build ircd-hybrid. - + 1. Read the NEWS file to find out about the exciting new features in - this version. Other good reads are BUGS, doc/example.conf, and - README. + this version. Other good reads are doc/reference.conf, and README. 2. Run the configure script. It will create config.h and the Makefiles to match your system. The paths are now handled @@ -42,8 +35,8 @@ ./configure --prefix=/usr/local/ircd - The script will determine whichever of the following is best for - your system, but you may (unsupported) force their usage with + The script will determine whichever of the following is best for + your system, but you may (unsupported) force their usage with undefined results: * --enable-kqueue - Use the superior kqueue(2) system call as @@ -58,10 +51,6 @@ currently only available on 2.5.44 Linux kernel versions or later. - * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O - system. This is currently only available on 2.4 Linux kernel - versions or later. - * --enable-poll - Use POSIX poll(2). * --enable-select - Use POSIX select(2). @@ -81,39 +70,34 @@ These are optional or have default values that may be overridden: - + * --enable-assert - Enable use of numerous debugging checks. This should not be used on any production servers for maximum speed so as to prevent cores from things that shouldn't normally happen. + * --enable-debugging - Prepares Makefiles to compile the ircd sources + with proper settings that are required for debugging purposes. + This switch basically sets CFLAGS to "-g -O0". + * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops are similar to plain ops, but can't kick/deop plain ops. Halfops may or may not kick/deop other halfops depending on if (+p) is set. Halfops may not set (+/-p). - * --with-nicklen, - --with-topiclen - Respectively, sets the maximum NICK length and - maximum TOPIC length. Note that this must be consistent across your - entire network. Defaults are 9 and 120, respectively. - - 3. Run 'make'; this should build the ircd. 4. Run 'make install'; this will install the server, modules, and tools in the path with the prefix specified when configure was ran. - 5. If you wish to install the contrib modules, run 'make install' in the - contrib/ folder to compile and install the modules and help pages. - ---------------------------------------------------------------------- HOW TO GET HELP - Send Check or Money Order to... just kidding! You're on your own for - support. Try asking other ircd-hybrid admins on EFnet if you can't + support. Try asking other ircd-hybrid admins on EFnet if you can't fix it yourself. If you do fix anything, however, please send context - or unified diffs to bugs@ircd-hybrid.org so the fixes can be + or unified diffs to bugs@ircd-hybrid.org so the fixes can be incorporated into the next release of ircd-hybrid. If hybrid crashes on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of the core. The Hybrid team can't fix bugs if no one tells us about them!