README.FIRST

   1 If you don't read this first, we won't help you.
   2 :-)
   3
   4 ******************************* IMPORTANT *************************************
   5
   6   *********** Note for those who dont bother reading docs *****************
   7   * - Reading INSTALL is now a must, as the old DPATH is now specified    *
   8   *   when configure is run.                                              *
   9   *   You now need to ./configure --prefix="/path/to/install/it"          *
  10   * - The old config format WILL NOT WORK.  Please see doc/example.conf ! *
  11   * - The old kline format WILL NOT WORK.  Please use convertklines which *
  12   *   will be installed with your ircd!                                   *
  13   *************************************************************************
  14
  15   ALSO, IF YOU ARE UPGRADING YOUR CURRENT SOURCE TREE, AND YOU TRY TO BUILD
  16   IN IT WITHOUT PERFORMING AT LEAST 'make clean', THINGS _WILL_ BREAK.  IT IS
  17   RECOMMENDED THAT YOU RUN 'make distclean' AND THEN RERUN './configure'!
  18
  19 ******************************* REQUIREMENTS **********************************
  20
  21 Necessary Requirements:
  22
  23 - A supported platform (look below)
  24
  25 - A working dynamic load library, unless
  26   compiling as static, without module
  27   support.
  28
  29 - A working lex.  Solaris /usr/ccs/bin/lex
  30   appears to be broken, on this system flex
  31   should be used.
  32
  33
  34 Feature Specific Requirements:
  35
  36 - For the SSL Challenge controlled OPER feature and encrypted server links,
  37   a working OpenSSL library
  38
  39 - For encrypted oper and (optional) server passwords, a working DES and/or
  40   MD5 library
  41
  42 *******************************************************************************
  43
  44 - To report bugs in ircd-ratbox, send the bug report to ircd-ratbox@lists.ratbox.org
  45
  46 - Known bugs are listed in the BUGS file
  47
  48 - See the INSTALL document for info on configuring and compiling
  49   ircd-ratbox.
  50
  51 - Please read doc/index.txt to get an overview of the current documentation.
  52
  53 - Old Hybrid 5/6 configuration files are no longer supported.  All conf
  54   files will have to be converted to the new format.  A convertconf
  55   utility is provided and installed into bin/.
  56
  57 - If you are wondering why config.h is practically empty, its because many
  58   things that were once in config.h are now specified in the 'general'
  59   block of ircd.conf.  Look at example.conf for more information about
  60   these options.
  61
  62 - The files, /etc/services, /etc/protocols, and /etc/resolv.conf, MUST be
  63   readable by the user running the server in order for ircd to start.
  64   Errors from adns causing the ircd to refuse to start up are often related
  65   to permission problems on these files.
  66
  67 - There is a mailing list for ircd-ratbox.  To subscribe to this list
  68   visit http://lists.ratbox.org/cgi-bin/mailman/listinfo/ircd-ratbox
  69   Note that this list also gets the commit emails from the CVS server.
  70
  71 - FREEBSD USERS: if you are compiling with ipv6 you may experience
  72   problems with ipv4 due to the way the socket code is written.  To
  73   fix this you must: "sysctl net.inet6.ip6.v6only=0"
  74
  75 - SOLARIS USERS: this code appears to tickle a bug in older gcc and
  76   egcs ONLY on 64-bit Solaris7.  gcc-2.95 and SunPro C on 64bit should
  77   work fine, and any gcc or SunPro compiled on 32bit.
  78
  79 - DARWIN AND MACOS X USERS: You must be using at least the December 2001
  80   Development Tools from Apple to build ircd-ratbox with shared modules.
  81   Before then you MUST disable shared modules, as we do not have the proper
  82   flags for cc(1) prior to that point to produce shared modules.
  83
  84 - SUPPORTED PLATFORMS: this code should compile without any warnings
  85   on FreeBSD 3.x/4.x, RedHat 6.2, Debian Potato and Solaris 7/8 sparc.
  86   Please let us know if you find otherwise.
  87   It probably does not compile on AIX, IRIX or libc5 Linux.
  88
  89 - TESTED PLATFORMS:  The code has been tested on the following platforms, and
  90   is known to run properly.
  91   FreeBSD 3.x/4.x
  92   Linux glibc
  93   Solaris 2.6/7/8
  94   OpenBSD 2.8
  95   NetBSD 1.4
  96
  97 - Please read doc/whats-new.txt for information about what is in this release
  98
  99 - Other files recommended for reading: BUGS, INSTALL
 100
 101 --------------------------------------------------------------------------------
 102 $Id: README.FIRST 1837 2006-08-22 14:05:58Z nenolod $