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 925 by michael, Mon Nov 12 20:59:02 2007 UTC vs.
ircd-hybrid-8/INSTALL (file contents), Revision 1521 by michael, Sun Sep 9 10:41:35 2012 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2007 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 94 | Line 89
89		may or may not kick/deop other halfops depending on if (+p) is
90		set. Halfops may not set (+/-p).
91
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	–
92		* --with-nicklen,
93		--with-topiclen - Respectively, sets the maximum NICK length and
94		maximum TOPIC length. Note that this must be consistent across your
95		entire network. Defaults are 9 and 120, respectively.
96
115	–	* --disable-zlib - Build the ircd without ziplinks support.
97
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.
98
99		3.  Run 'make'; this should build the ircd.
100
101	<	4.  Run 'make install'; this will install the server, modules(1), and tools
101	>	4.  Run 'make install'; this will install the server, modules, and tools
102		in the path with the prefix specified when configure was ran.
103
128	–	(1) Unless the server was compiled without module support.
129	–
104		5.  If you wish to install the contrib modules, run 'make install' in the
105		contrib/ folder to compile and install the modules and help pages.
106
107	<	6.  If you wish to enable the user log, oper log, and failed oper log,
108	<	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...
107	>	6.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
108	>	have changed drastically.
109
110		By default, the kline file is named kline.conf, the dline file is
111	<	named dline.conf, the xline file is called xline.conf, and the gline
152	<	file is called gline.conf.
111	>	named dline.conf, and the xline file is called xline.conf.
112
113		The nick resv file is named nresv.conf, channel resv file is named
114		cresv.conf.
115
157	–	The oper motd file is named opers.motd.
158	–
116		----------------------------------------------------------------------
117
118		HOW TO GET HELP
#	Line 168 | Line 125
125		on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
126		the core. The Hybrid team can't fix bugs if no one tells us about them!
127
171	–	- http://forum.ircd-hybrid.org/
172	–	We decided to create a phpBB-like forum about ircd-hybrid, where you
173	–	can get help from coders and admins, post your suggestions, modules etc.
174	–
128		- https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
129		Here you can subscribe to a mailing list for general discussion of Hybrid.
130
#	Line 184 | Line 137
137
138		1.  Change to the directory containing the core file
139
140	<	2.  Run gdb on the binary and the core file. With an unmodified Hybrid-7.2
140	>	2.  Run gdb on the binary and the core file. With an unmodified ircd-hybrid
141		installation, an example command line is below (in the /usr/local/ircd
142		directory)
143

Diff Legend

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