ViewVC Help

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

root/svn/ircd-hybrid/trunk/INSTALL

Comparing:
ircd-hybrid-7.3/INSTALL (file contents), Revision 1029 by michael, Sun Nov 8 13:10:50 2009 UTC vs.
ircd-hybrid-8/INSTALL (file contents), Revision 1548 by michael, Mon Oct 1 16:37:20 2012 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2009 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2012 IRCD-Hybrid Development Team
6
7		----------------------------------------------------------------------
8
#	Line 16 | Line 16
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!  |
19	>	| - Important: The old config format WILL NOT WORK. Please see point 6!  |
20		+------------------------------------------------------------------------+
21
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.
23	>	You should use the example.efnet.conf instead of example.conf.
24		**********************
25
26		----------------------------------------------------------------------
#	Line 34 | Line 32
32		ircd-hybrid.
33
34		1.  Read the NEWS file to find out about the exciting new features in
35	<	this version. Other good reads are BUGS, etc/example.conf, and
36	<	README.FIRST.
39	<
40	<	An example.conf for EFnet is in etc/ with the values "approved" as of
41	<	October 12th, 2003 called example.efnet.conf.
35	>	this version. Other good reads are BUGS, doc/example.conf, and
36	>	README.
37
38		2.  Run the configure script. It will create config.h and the
39	<	Makefiles to match your system. In hybrid-7, the paths are now handled
39	>	Makefiles to match your system. The paths are now handled
40		with the --prefix option to configure.
41		/usr/local/ircd is the default if no prefix is specified.
42
#	Line 76 | Line 71
71		enable select(2) instead (bad idea), you must use --enable-select.
72
73		* --enable-openssl - Enable the openssl dependent crypto functions.
74	<	This will allow CHALLENGE to work and encrypted links. On systems
75	<	where the configure script can automatically detect OpenSSL, this
76	<	option is not necessary. If configure cannot find OpenSSL, you
77	<	must specify a path with this option
74	>	Required for the SSL Challenge controlled OPER feature, compressed
75	>	and/or SSL/TLS server links, as well as SSL/TLS client connections.
76	>
77	>	On systems where the configure script can automatically detect
78	>	OpenSSL, this option is not necessary. If configure cannot find
79	>	OpenSSL, you must specify a path with this option
80		(--enable-openssl=/path/to/openssl)
81
82
#	Line 94 | Line 91
91		may or may not kick/deop other halfops depending on if (+p) is
92		set. Halfops may not set (+/-p).
93
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	–
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
115	–	* --disable-zlib - Build the ircd without ziplinks support.
99
100
101		3.  Run 'make'; this should build the ircd.
102
103	<	4.  Run 'make install'; this will install the server, modules(1), and tools
103	>	4.  Run 'make install'; this will install the server, modules, and tools
104		in the path with the prefix specified when configure was ran.
105
123	–	(1) Unless the server was compiled without module support.
124	–
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 wish to enable the user log, oper log, and failed oper log,
110	<	kill log, kline log and the gline log issue these commands at the
130	<	shell prompt (in the prefix directory).
131	<
132	<	$ touch logs/userlog
133	<	$ touch logs/operlog
134	<	$ touch logs/foperlog
135	<	$ touch logs/kill
136	<	$ touch logs/kline
137	<	$ touch logs/gline
138	<
139	<	Note: If you use different names in ircd.conf, you must 'touch'
140	<	their specific names.
141	<
142	<	7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
143	<	have changed drastically...
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, the xline file is called xline.conf, and the gline
147	<	file is called gline.conf.
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
152	–	The oper motd file is named opers.motd.
153	–
118		----------------------------------------------------------------------
119
120		HOW TO GET HELP

Diff Legend

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