[solanum.git] / README.FIRST

******************************* IMPORTANT *************************************

  *********** Note for those who dont bother reading docs *****************
  * - Reading INSTALL is now a must, as the old DPATH is now specified    *
  *   when configure is run.                                              *
  *   You now need to ./configure --prefix="/path/to/install/it"          *
  *   to specify the path that will be installed with your ircd!          *
  *************************************************************************

  ALSO, IF YOU ARE UPGRADING YOUR CURRENT SOURCE TREE, AND YOU TRY TO BUILD
  IN IT WITHOUT PERFORMING AT LEAST 'make clean', THINGS _WILL_ BREAK.  IT IS
  RECOMMENDED THAT YOU RUN 'make distclean' AND THEN RERUN './configure'!

******************************* REQUIREMENTS **********************************

Necessary Requirements:

- A supported platform (look below)

- A working dynamic load library.

- A working lex.  Solaris /usr/ccs/bin/lex
  appears to be broken, on this system flex
  should be used.


Feature Specific Requirements:

- For SSL Clients, SSL Challenge controlled OPER feature, and encrypted server links,
  a working OpenSSL library or GnuTLS library.  CHALLENGE is not supported on GnuTLS
  yet.

- For encrypted oper and (optional) server passwords, a working DES, MD5, or SHA library
  implementing crypt().

*******************************************************************************

- To report bugs in charybdis, visit us at irc.atheme.org #charybdis

- See the INSTALL document for info on configuring and compiling
  charybdis.

- Please read doc/index.txt to get an overview of the current documentation.

- The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
  readable by the user running the server in order for ircd to start with
  the correct settings.  If these files are wrong, charybdis will try to use
  127.0.0.1 for a resolver as a last-ditch effort.

- FREEBSD USERS: if you are compiling with ipv6 you may experience
  problems with ipv4 due to the way the socket code is written.  To
  fix this you must: "sysctl net.inet6.ip6.v6only=0"

- SOLARIS USERS: this code appears to tickle a bug in older gcc and 
  egcs ONLY on 64-bit Solaris7.  gcc-2.95 and SunPro C on 64bit should
  work fine, and any gcc or SunPro compiled on 32bit.

- DARWIN AND MACOS X USERS: You must be using at least the December 2001
  Development Tools from Apple to build charybdis with shared modules.
  Before then you MUST disable shared modules, as we do not have the proper
  flags for cc(1) prior to that point to produce shared modules.

- SUPPORTED PLATFORMS: this code should compile without any warnings on:
    FreeBSD 6.x/7.x,
    Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd
    Fedora 8/9 / CentOS 4/5 / Redhat Enterprise 5
    Debian Etch, 
    OpenSuSE 10/11,
    OpenSolaris 2008.x?
    Solaris 10 sparc.
  
  Please let us know if you find otherwise.  
  It probably does not compile on AIX, IRIX or libc5 Linux.

- TESTED PLATFORMS:  The code has been tested on the following platforms, and
  is known to run properly.
  FreeBSD 6.x/7.x
  Linux glibc-2.6, glibc-2.7
  Solaris 2.6/7/8
  OpenBSD 2.8
  NetBSD 1.4

- Please read NEWS for information about what is in this release.

- Other files recommended for reading: BUGS, INSTALL
Commit	Line	Data
212380e3 AC	1	***************************** IMPORTANT ***********************************
	2
	3	********* Note for those who dont bother reading docs ***************
	4	* - Reading INSTALL is now a must, as the old DPATH is now specified *
	5	* when configure is run. *
	6	* You now need to ./configure --prefix="/path/to/install/it" *
10422884	7	* to specify the path that will be installed with your ircd! *
212380e3 AC	8	*************************************************************************
	9
	10	ALSO, IF YOU ARE UPGRADING YOUR CURRENT SOURCE TREE, AND YOU TRY TO BUILD
	11	IN IT WITHOUT PERFORMING AT LEAST 'make clean', THINGS _WILL_ BREAK. IT IS
	12	RECOMMENDED THAT YOU RUN 'make distclean' AND THEN RERUN './configure'!
	13
	14	***************************** REQUIREMENTS ********************************
	15
	16	Necessary Requirements:
	17
	18	- A supported platform (look below)
	19
101b7fcb	20	- A working dynamic load library.
212380e3 AC	21
	22	- A working lex. Solaris /usr/ccs/bin/lex
	23	appears to be broken, on this system flex
	24	should be used.
	25
	26
	27	Feature Specific Requirements:
	28
fbdcbb74	29	- For SSL Clients, SSL Challenge controlled OPER feature, and encrypted server links,
101b7fcb AC	30	a working OpenSSL library or GnuTLS library. CHALLENGE is not supported on GnuTLS
101b7fcb AC	31	yet.
212380e3	32
101b7fcb AC	33	- For encrypted oper and (optional) server passwords, a working DES, MD5, or SHA library
101b7fcb AC	34	implementing crypt().
212380e3 AC	35
	36	*******************************************************************************
	37
fbdcbb74	38	- To report bugs in charybdis, visit us at irc.atheme.org #charybdis
212380e3	39
212380e3	40	- See the INSTALL document for info on configuring and compiling
fbdcbb74	41	charybdis.
212380e3 AC	42
	43	- Please read doc/index.txt to get an overview of the current documentation.
	44
101b7fcb AC	45	- The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
	46	readable by the user running the server in order for ircd to start with
	47	the correct settings. If these files are wrong, charybdis will try to use
	48	127.0.0.1 for a resolver as a last-ditch effort.
212380e3	49
212380e3 AC	50	- FREEBSD USERS: if you are compiling with ipv6 you may experience
	51	problems with ipv4 due to the way the socket code is written. To
	52	fix this you must: "sysctl net.inet6.ip6.v6only=0"
	53
	54	- SOLARIS USERS: this code appears to tickle a bug in older gcc and
	55	egcs ONLY on 64-bit Solaris7. gcc-2.95 and SunPro C on 64bit should
	56	work fine, and any gcc or SunPro compiled on 32bit.
	57
	58	- DARWIN AND MACOS X USERS: You must be using at least the December 2001
fbdcbb74	59	Development Tools from Apple to build charybdis with shared modules.
212380e3 AC	60	Before then you MUST disable shared modules, as we do not have the proper
	61	flags for cc(1) prior to that point to produce shared modules.
	62
fbdcbb74 VY	63	- SUPPORTED PLATFORMS: this code should compile without any warnings on:
	64	FreeBSD 6.x/7.x,
	65	Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd
	66	Fedora 8/9 / CentOS 4/5 / Redhat Enterprise 5
	67	Debian Etch,
	68	OpenSuSE 10/11,
	69	OpenSolaris 2008.x?
	70	Solaris 10 sparc.
	71
212380e3 AC	72	Please let us know if you find otherwise.
	73	It probably does not compile on AIX, IRIX or libc5 Linux.
	74
	75	- TESTED PLATFORMS: The code has been tested on the following platforms, and
	76	is known to run properly.
fbdcbb74 VY	77	FreeBSD 6.x/7.x
fbdcbb74 VY	78	Linux glibc-2.6, glibc-2.7
212380e3 AC	79	Solaris 2.6/7/8
	80	OpenBSD 2.8
	81	NetBSD 1.4
	82
101b7fcb	83	- Please read NEWS for information about what is in this release.
212380e3 AC	84
212380e3 AC	85	- Other files recommended for reading: BUGS, INSTALL