ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/svn/ircd-hybrid/trunk/INSTALL

Comparing ircd-hybrid/trunk/INSTALL (file contents):
Revision 1592 by michael, Sat Oct 27 21:02:32 2012 UTC vs.
Revision 5347 by michael, Sun Jan 11 12:42:20 2015 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2012 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2015 ircd-hybrid development team
6
7		----------------------------------------------------------------------
8
#	Line 15 | Line 15
15		| - You now need to ./configure --prefix="/path/to/install/it" as a      |
16		|   minimum. Try ./configure --help or read this file for more info on   |
17		|   the possible options you can pass to configure.                      |
18	–	|                                                                        |
19	–	| - Important: The old config format WILL NOT WORK. Please see point 6!  |
18		+------------------------------------------------------------------------+
19
22	–	***** EFNET NOTE *****
23	–	You should use the example.efnet.conf instead of example.conf.
24	–	**********************
25	–
20		----------------------------------------------------------------------
21
22		HOW TO BUILD
#	Line 30 | Line 24
24		As of hybrid-4, the distribution uses GNU autoconf instead of the old
25		Config script. You must run ./configure before you can (sanely) build
26		ircd-hybrid.
27	<
27	>
28		1.  Read the NEWS file to find out about the exciting new features in
29	<	this version. Other good reads are BUGS, doc/example.conf, and
36	<	README.
29	>	this version. Other good reads are doc/reference.conf, and README.
30
31		2.  Run the configure script. It will create config.h and the
32		Makefiles to match your system. The paths are now handled
#	Line 42 | Line 35
35
36		./configure --prefix=/usr/local/ircd
37
38	<	The script will determine whichever of the following is best for
39	<	your system, but you may (unsupported) force their usage with
38	>	The script will determine whichever of the following is best for
39	>	your system, but you may (unsupported) force their usage with
40		undefined results:
41
42		* --enable-kqueue - Use the superior kqueue(2) system call as
43		opposed to the default poll(2). This is currently only available
44	<	on FreeBSD 4.1 or higher.
44	>	on FreeBSD, OpenBSD, NetBSD, and Mac OS X
45
46		* --enable-devpoll - Enable the superior /dev/poll support on
47		Solaris. Linux /dev/poll is broken and will not work with this
#	Line 58 | Line 51
51		currently only available on 2.5.44 Linux kernel versions or
52		later.
53
61	–	* --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
62	–	system. This is currently only available on 2.4 Linux kernel
63	–	versions or later.
64	–
54		* --enable-poll - Use POSIX poll(2).
55
67	–	* --enable-select - Use POSIX select(2).
68	–
56		Incidentally, the order of listing above is the order of auto-
57		detection in configure. So if you do have kqueue but wish to
58	<	enable select(2) instead (bad idea), you must use --enable-select.
58	>	enable poll(2) instead (bad idea), you must use --enable-poll.
59
60	<	* --enable-openssl - Enable the openssl dependent crypto functions.
60	>	* --enable-openssl - Enable the LibreSSL/OpenSSL dependent crypto functions.
61		Required for the SSL Challenge controlled OPER feature, compressed
62		and/or SSL/TLS server links, as well as SSL/TLS client connections.
63
64		On systems where the configure script can automatically detect
65	<	OpenSSL, this option is not necessary. If configure cannot find
66	<	OpenSSL, you must specify a path with this option
65	>	LibreSSL or OpenSSL, this option is not necessary. If configure cannot
66	>	find LibreSSL or OpenSSL, you must specify a path with this option
67		(--enable-openssl=/path/to/openssl)
68
69
70		These are optional or have default values that may be overridden:
71	<
71	>
72		* --enable-assert - Enable use of numerous debugging checks. This
73		should not be used on any production servers for maximum speed
74		so as to prevent cores from things that shouldn't normally happen.
75
76	<	* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
77	<	are similar to plain ops, but can't kick/deop plain ops. Halfops
78	<	may or may not kick/deop other halfops depending on if (+p) is
92	<	set. Halfops may not set (+/-p).
93	<
94	<	* --with-nicklen,
95	<	--with-topiclen - Respectively, sets the maximum NICK length and
96	<	maximum TOPIC length. Note that this must be consistent across your
97	<	entire network. Defaults are 9 and 120, respectively.
98	<
76	>	* --enable-debugging - Prepares Makefiles to compile the ircd sources
77	>	with proper settings that are required for debugging purposes.
78	>	This switch basically sets CFLAGS to "-g -O0".
79
80
81		3.  Run 'make'; this should build the ircd.
#	Line 103 | Line 83
83		4.  Run 'make install'; this will install the server, modules, and tools
84		in the path with the prefix specified when configure was ran.
85
106	–	5.  If you wish to install the contrib modules, run 'make install' in the
107	–	contrib/ folder to compile and install the modules and help pages.
108	–
109	–	6.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
110	–	have changed drastically.
111	–
112	–	By default, the kline file is named kline.conf, the dline file is
113	–	named dline.conf, and the xline file is called xline.conf.
114	–
115	–	The nick resv file is named nresv.conf, channel resv file is named
116	–	cresv.conf.
117	–
86		----------------------------------------------------------------------
87
88		HOW TO GET HELP
89
90		- Send Check or Money Order to... just kidding! You're on your own for
91	<	support. Try asking other ircd-hybrid admins on EFnet if you can't
91	>	support. Try asking other ircd-hybrid admins on EFnet if you can't
92		fix it yourself. If you do fix anything, however, please send context
93	<	or unified diffs to bugs@ircd-hybrid.org so the fixes can be
93	>	or unified diffs to bugs@ircd-hybrid.org so the fixes can be
94		incorporated into the next release of ircd-hybrid. If hybrid crashes
95		on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
96		the core. The Hybrid team can't fix bugs if no one tells us about them!
#	Line 130 | Line 98
98		- https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
99		Here you can subscribe to a mailing list for general discussion of Hybrid.
100
101	+	- IRC contact: #ircd-coders on irc.ircd-hybrid.org
102	+
103		----------------------------------------------------------------------
104
105		NOTES

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines (old)
>	Changed lines (new)