ViewVC Help

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

root/svn/ircd-hybrid/trunk/INSTALL

Comparing:
ircd-hybrid-7.2/INSTALL (file contents), Revision 974 by michael, Mon Aug 3 07:40:21 2009 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-2009 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 run ./configure with the option '--enable-efnet' to tweak
24	–	some options to be EFNet based. You must also use the example.efnet.conf
25	–	instead of example.conf.
26	–	**********************
27	–
20		----------------------------------------------------------------------
21
22		HOW TO BUILD
#	Line 32 | 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.
35	–
36	–	1.  Read the NEWS file to find out about the exciting new features in
37	–	this version. Other good reads are BUGS, etc/example.conf, and
38	–	README.FIRST.
27
28	<	An example.conf for EFnet is in etc/ with the values "approved" as of
29	<	October 12th, 2003 called example.efnet.conf.
28	>	1.  Read the NEWS file to find out about the exciting new features in
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. In hybrid-7, the paths are now handled
32	>	Makefiles to match your system. The paths are now handled
33		with the --prefix option to configure.
34		/usr/local/ircd is the default if no prefix is specified.
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 63 | Line 51
51		currently only available on 2.5.44 Linux kernel versions or
52		later.
53
66	–	* --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
67	–	system. This is currently only available on 2.4 Linux kernel
68	–	versions or later.
69	–
54		* --enable-poll - Use POSIX poll(2).
55
56		* --enable-select - Use POSIX select(2).
#	Line 76 | 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
97	–	* --enable-small-net - Tunes the server for smaller networks by
98	–	reducing the startup memory footprint. This should really only be
99	–	used for *small* networks, as this tends to be a performance hit
100	–	on larger networks.
101	–
102	–	* --enable-syslog=kill/squit/connect/users/oper, separated by
103	–	spaces, in quotes - Enables syslog logging, with events you specify
104	–	(none is okay too, and logs the most essential messages only.)
105	–
106	–	* --enable-syslog-facility=FACILITY - Check with your sysadmin to see
107	–	what this should be; by default it is LOG_LOCAL4. If you get it wrong
108	–	initially, no problem; just edit the value in include/setup.h.
109	–
110	–	* --with-nicklen,
111	–	--with-topiclen - Respectively, sets the maximum NICK length and
112	–	maximum TOPIC length. Note that this must be consistent across your
113	–	entire network. Defaults are 9 and 120, respectively.
114	–
115	–	* --disable-zlib - Build the ircd without ziplinks support.
116	–
117	–	* --disable-gline-voting - This is good for small networks or where
118	–	G-Line voting is not necessary. Please understand that by disabling
119	–	this, it will allow any operator with G-Line permissions to G-Line
120	–	someone without requiring the approval of 2 other operators. However,
121	–	it is useful if you use proxy scanners or services that do G-Lines.
87
88		3.  Run 'make'; this should build the ircd.
89
90	<	4.  Run 'make install'; this will install the server, modules(1), and tools
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
128	–	(1) Unless the server was compiled without module support.
129	–
130	–	5.  If you wish to install the contrib modules, run 'make install' in the
131	–	contrib/ folder to compile and install the modules and help pages.
132	–
133	–	6.  If you wish to enable the user log, oper log, and failed oper log,
134	–	kill log, kline log and the gline log issue these commands at the
135	–	shell prompt (in the prefix directory).
136	–
137	–	$ touch logs/userlog
138	–	$ touch logs/operlog
139	–	$ touch logs/foperlog
140	–	$ touch logs/kill
141	–	$ touch logs/kline
142	–	$ touch logs/gline
143	–
144	–	Note: If you use different names in ircd.conf, you must 'touch'
145	–	their specific names.
146	–
147	–	7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
148	–	have changed drastically...
149	–
150	–	By default, the kline file is named kline.conf, the dline file is
151	–	named dline.conf, the xline file is called xline.conf, and the gline
152	–	file is called gline.conf.
153	–
154	–	The nick resv file is named nresv.conf, channel resv file is named
155	–	cresv.conf.
156	–
157	–	The oper motd file is named opers.motd.
158	–
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)