--- ircd-hybrid-7.2/INSTALL 2005/11/06 11:20:44 242 +++ ircd-hybrid-8/INSTALL 2012/03/21 17:48:54 1302 @@ -2,7 +2,7 @@ $Id$ - Copyright (c) 1997-2005 IRCD-Hybrid Development Team + Copyright (c) 1997-2012 IRCD-Hybrid Development Team ---------------------------------------------------------------------- @@ -21,7 +21,7 @@ ***** EFNET NOTE ***** You should run ./configure with the option '--enable-efnet' to tweak - some options to be EFNet based. You must also use the example.efnet.conf + some options to be EFNet based. You must also use the example.efnet.conf instead of example.conf. ********************** @@ -33,15 +33,12 @@ Config script. You must run ./configure before you can (sanely) build ircd-hybrid. - 1. Read the RELNOTES file to find out about the exciting new features in - this version. Other good reads are doc/whats-new.txt, BUGS, - etc/example.conf, and README.FIRST. + 1. Read the NEWS file to find out about the exciting new features in + this version. Other good reads are BUGS, etc/example.conf, and + README. - An example.conf for EFnet is in etc/ with the values "approved" as of - October 12th, 2003 called example.efnet.conf. - - 2. Run the configure script. It will create include/setup.h and the - Makefiles to match your system. In hybrid-7, the paths are now handled + 2. Run the configure script. It will create config.h and the + Makefiles to match your system. The paths are now handled with the --prefix option to configure. /usr/local/ircd is the default if no prefix is specified. @@ -59,19 +56,21 @@ Solaris. Linux /dev/poll is broken and will not work with this option. + * --enable-epoll - Enables epoll(4) Signal I/O system. This is + 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-poll - Use POSIX poll(2). - * --enable-select - Use POSIX select(2). + * --enable-select - Use POSIX select(2). - * --enable-clobber - Don't preserve the old binaries on make install - - Incidentally, the order of listing above is the order of auto- - detection in configure. So if you do have kqueue but wish to - enable select(2) instead (bad idea), you must use --enable-select. + Incidentally, the order of listing above is the order of auto- + detection in configure. So if you do have kqueue but wish to + enable select(2) instead (bad idea), you must use --enable-select. * --enable-openssl - Enable the openssl dependent crypto functions. This will allow CHALLENGE to work and encrypted links. On systems @@ -80,93 +79,43 @@ must specify a path with this option (--enable-openssl=/path/to/openssl) + These are optional or have default values that may be overridden: - * --disable-shared-modules - Disable module support. This option is - more secure, but reduces a lot of the flexibility in hybrid-7. - This may need to be used on some systems without a working - dlopen/dlsym. - * --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-efence - Enable ElectricFence which is a memory debugger. - - * --enable-profile - Enable profiling support in ircd-hybrid. - - * --disable-block-alloc - Disable block allocations (only works with - ElectricFence). + so as to prevent cores from things that shouldn't normally happen. - * --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). + * --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). * --enable-small-net - Tunes the server for smaller networks by reducing the startup memory footprint. This should really only be used for *small* networks, as this tends to be a performance hit on larger networks. - * --enable-syslog=kill/squit/connect/users/oper, separated by - spaces, in quotes - Enables syslog logging, with events you specify - (none is okay too, and logs the most essential messages only.) - - * --enable-syslog-facility=FACILITY - Check with your sysadmin to see - what this should be; by default it is LOG_LOCAL4. If you get it wrong - initially, no problem; just edit the value in include/setup.h. - * --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. - - * --with-maxconn - Sets the maximum number of connections the ircd - can support. Note that this also twiddles the HARD_FDLIMIT. - If HARD_FDLIMIT ends up being larger that FD_SETSIZE when using - select() for your I/O loop, s_bsd_select.c will refuse to compile - (and tell you to use poll instead). Take this error's advice and - use --enable-poll or something a bit more efficient. You'll be - happier at the end of the day for it. - - * --disable-zlib - Build the ircd without ziplinks support. - - * --disable-gline-voting - This is good for small networks or where - G-Line voting is not necessary. Please understand that by disabling - this, it will allow any operator with G-Line permissions to G-Line - someone without requiring the approval of 2 other operators. However, - it is useful if you use proxy scanners or services that do G-Lines. + --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(1), and tools + 4. Run 'make install'; this will install the server, modules, and tools in the path with the prefix specified when configure was ran. - (1) Unless the server was compiled without module support. - 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. - 6. If you wish to enable the user log, oper log, and failed oper log, - kill log, kline log and the gline log issue these commands at the - shell prompt (in the prefix directory). - - $ touch logs/userlog - $ touch logs/operlog - $ touch logs/foperlog - $ touch logs/kill - $ touch logs/kline - $ touch logs/gline - - Note: If you use different names in ircd.conf, you must 'touch' - their specific names. - - 7. If you are upgrading from Hybrid 5 or Hybrid 6, the config files - have changed drastically... + 6. If you are upgrading from Hybrid 5 or Hybrid 6, the config files + have changed drastically. By default, the kline file is named kline.conf, the dline file is - named dline.conf, the xline file is called xline.conf, and the gline - file is called gline.conf. + named dline.conf, and the xline file is called xline.conf. The nick resv file is named nresv.conf, channel resv file is named cresv.conf. @@ -185,10 +134,6 @@ 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! - - http://forum.ircd-hybrid.org/ - We decided to create a phpBB-like forum about ircd-hybrid, where you - can get help from coders and admins, post your suggestions, modules etc. - - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid Here you can subscribe to a mailing list for general discussion of Hybrid. @@ -201,7 +146,7 @@ 1. Change to the directory containing the core file - 2. Run gdb on the binary and the core file. With an unmodified Hybrid-7.2 + 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid installation, an example command line is below (in the /usr/local/ircd directory)