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 1156 by michael, Tue Aug 9 20:29:20 2011 UTC vs.
ircd-hybrid/trunk/INSTALL (file contents), Revision 2962 by michael, Thu Jan 30 17:13:29 2014 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2011 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2014 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.
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, etc/example.conf, and
38	<	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. 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 60 | Line 51
51		currently only available on 2.5.44 Linux kernel versions or
52		later.
53
63	–	* --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
64	–	system. This is currently only available on 2.4 Linux kernel
65	–	versions or later.
66	–
54		* --enable-poll - Use POSIX poll(2).
55
56		* --enable-select - Use POSIX select(2).
#	Line 73 | 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
94	–	* --enable-small-net - Tunes the server for smaller networks by
95	–	reducing the startup memory footprint. This should really only be
96	–	used for *small* networks, as this tends to be a performance hit
97	–	on larger networks.
98	–
99	–	* --enable-syslog=kill/squit/connect/users/oper, separated by
100	–	spaces, in quotes - Enables syslog logging, with events you specify
101	–	(none is okay too, and logs the most essential messages only.)
102	–
103	–	* --enable-syslog-facility=FACILITY - Check with your sysadmin to see
104	–	what this should be; by default it is LOG_LOCAL4. If you get it wrong
105	–	initially, no problem; just edit the value in include/setup.h.
106	–
107	–	* --with-nicklen,
108	–	--with-topiclen - Respectively, sets the maximum NICK length and
109	–	maximum TOPIC length. Note that this must be consistent across your
110	–	entire network. Defaults are 9 and 120, respectively.
111	–
112	–	* --disable-zlib - Build the ircd without ziplinks support.
113	–
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
120	–	5.  If you wish to install the contrib modules, run 'make install' in the
121	–	contrib/ folder to compile and install the modules and help pages.
122	–
123	–	6.  If you wish to enable the user log, oper log, and failed oper log,
124	–	kill log, kline log and the gline log issue these commands at the
125	–	shell prompt (in the prefix directory).
126	–
127	–	$ touch logs/userlog
128	–	$ touch logs/operlog
129	–	$ touch logs/foperlog
130	–	$ touch logs/kill
131	–	$ touch logs/kline
132	–	$ touch logs/gline
133	–
134	–	Note: If you use different names in ircd.conf, you must 'touch'
135	–	their specific names.
136	–
137	–	7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
138	–	have changed drastically.
139	–
140	–	By default, the kline file is named kline.conf, the dline file is
141	–	named dline.conf, and the xline file is called xline.conf.
142	–
143	–	The nick resv file is named nresv.conf, channel resv file is named
144	–	cresv.conf.
145	–
146	–	The oper motd file is named opers.motd.
147	–
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)