ViewVC Help

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

root/svn/ircd-hybrid/trunk/INSTALL

Comparing:
ircd-hybrid-8/INSTALL (file contents), Revision 1402 by michael, Wed May 9 18:42:45 2012 UTC vs.
ircd-hybrid/trunk/INSTALL (file contents), Revision 2345 by michael, Wed Jul 3 18:17:39 2013 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2012 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2013 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 7!  |
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
#	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
56		* --enable-select - Use POSIX select(2).
#	Line 71 | Line 60
60		enable select(2) instead (bad idea), you must use --enable-select.
61
62		* --enable-openssl - Enable the openssl dependent crypto functions.
63	<	This will allow CHALLENGE to work and encrypted links. On systems
64	<	where the configure script can automatically detect OpenSSL, this
65	<	option is not necessary. If configure cannot find OpenSSL, you
66	<	must specify a path with this option
63	>	Required for the SSL Challenge controlled OPER feature, compressed
64	>	and/or SSL/TLS server links, as well as SSL/TLS client connections.
65	>
66	>	On systems where the configure script can automatically detect
67	>	OpenSSL, this option is not necessary. If configure cannot find
68	>	OpenSSL, you must specify a path with this option
69		(--enable-openssl=/path/to/openssl)
70
71
72		These are optional or have default values that may be overridden:
73	<
73	>
74		* --enable-assert - Enable use of numerous debugging checks. This
75		should not be used on any production servers for maximum speed
76		so as to prevent cores from things that shouldn't normally happen.
77
78	+	* --enable-debugging - Prepares Makefiles to compile the ircd sources
79	+	with proper settings that are required for debugging purposes.
80	+	This switch basically sets CFLAGS to "-g -O0".
81	+
82		* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
83		are similar to plain ops, but can't kick/deop plain ops. Halfops
84		may or may not kick/deop other halfops depending on if (+p) is
85		set. Halfops may not set (+/-p).
86
92	–	* --enable-small-net - Tunes the server for smaller networks by
93	–	reducing the startup memory footprint. This should really only be
94	–	used for *small* networks, as this tends to be a performance hit
95	–	on larger networks.
96	–
97	–	* --with-nicklen,
98	–	--with-topiclen - Respectively, sets the maximum NICK length and
99	–	maximum TOPIC length. Note that this must be consistent across your
100	–	entire network. Defaults are 9 and 120, respectively.
101	–
102	–
87
88		3.  Run 'make'; this should build the ircd.
89
90		4.  Run 'make install'; this will install the server, modules, and tools
91		in the path with the prefix specified when configure was ran.
92
109	–	5.  If you wish to install the contrib modules, run 'make install' in the
110	–	contrib/ folder to compile and install the modules and help pages.
111	–
112	–	6.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
113	–	have changed drastically.
114	–
115	–	By default, the kline file is named kline.conf, the dline file is
116	–	named dline.conf, and the xline file is called xline.conf.
117	–
118	–	The nick resv file is named nresv.conf, channel resv file is named
119	–	cresv.conf.
120	–
121	–	The oper motd file is named opers.motd.
122	–
93		----------------------------------------------------------------------
94
95		HOW TO GET HELP
96
97		- Send Check or Money Order to... just kidding! You're on your own for
98	<	support. Try asking other ircd-hybrid admins on EFnet if you can't
98	>	support. Try asking other ircd-hybrid admins on EFnet if you can't
99		fix it yourself. If you do fix anything, however, please send context
100	<	or unified diffs to bugs@ircd-hybrid.org so the fixes can be
100	>	or unified diffs to bugs@ircd-hybrid.org so the fixes can be
101		incorporated into the next release of ircd-hybrid. If hybrid crashes
102		on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
103		the core. The Hybrid team can't fix bugs if no one tells us about them!

Diff Legend

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