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 555 by michael, Sat Apr 22 09:39:44 2006 UTC vs.
ircd-hybrid/trunk/INSTALL (file contents), Revision 1736 by michael, Sun Jan 13 09:31:46 2013 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2005 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2012 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
20		***** EFNET NOTE *****
21	<	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.
21	>	You should use the example.efnet.conf instead of example.conf.
22		**********************
23
24		----------------------------------------------------------------------
#	Line 33 | Line 29
29		Config script. You must run ./configure before you can (sanely) build
30		ircd-hybrid.
31
32	<	1.  Read the RELNOTES file to find out about the exciting new features in
33	<	this version. Other good reads are doc/whats-new.txt, BUGS,
34	<	etc/example.conf, and 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.
32	>	1.  Read the NEWS file to find out about the exciting new features in
33	>	this version. Other good reads are BUGS, doc/example.conf, and
34	>	README.
35
36	<	2.  Run the configure script. It will create include/setup.h and the
37	<	Makefiles to match your system. In hybrid-7, the paths are now handled
36	>	2.  Run the configure script. It will create config.h and the
37	>	Makefiles to match your system. The paths are now handled
38		with the --prefix option to configure.
39		/usr/local/ircd is the default if no prefix is specified.
40
#	Line 52 | Line 45
45		undefined results:
46
47		* --enable-kqueue - Use the superior kqueue(2) system call as
48	<	opposed to the default poll(2).  This is currently only available
48	>	opposed to the default poll(2). This is currently only available
49		on FreeBSD 4.1 or higher.
50
51		* --enable-devpoll - Enable the superior /dev/poll support on
52	<	Solaris.  Linux /dev/poll is broken and will not work with this
52	>	Solaris. Linux /dev/poll is broken and will not work with this
53		option.
54
55	<	* --enable-epoll - Enables epoll(4) Signal I/O system.  This is
55	>	* --enable-epoll - Enables epoll(4) Signal I/O system. This is
56		currently only available on 2.5.44 Linux kernel versions or
57		later.
58
59	<	* --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	<
70	<	* --enable-poll - Use POSIX poll(2).
59	>	* --enable-poll - Use POSIX poll(2).
60
61	<	* --enable-select - Use POSIX select(2).
61	>	* --enable-select - Use POSIX select(2).
62
63	<	* --enable-clobber - Don't preserve the old binaries on make install
64	<
65	<	Incidentally, the order of listing above is the order of auto-
77	<	detection in configure.  So if you do have kqueue but wish to
78	<	enable select(2) instead (bad idea), you must use --enable-select.
63	>	Incidentally, the order of listing above is the order of auto-
64	>	detection in configure. So if you do have kqueue but wish to
65	>	enable select(2) instead (bad idea), you must use --enable-select.
66
67		* --enable-openssl - Enable the openssl dependent crypto functions.
68	<	This will allow CHALLENGE to work and encrypted links. On systems
69	<	where the configure script can automatically detect OpenSSL, this
70	<	option is not necessary.  If configure cannot find OpenSSL, you
71	<	must specify a path with this option
68	>	Required for the SSL Challenge controlled OPER feature, compressed
69	>	and/or SSL/TLS server links, as well as SSL/TLS client connections.
70	>
71	>	On systems where the configure script can automatically detect
72	>	OpenSSL, this option is not necessary. If configure cannot find
73	>	OpenSSL, you must specify a path with this option
74		(--enable-openssl=/path/to/openssl)
75
76	+
77		These are optional or have default values that may be overridden:
78
79	<	* --disable-shared-modules - Disable module support.  This option is
90	<	more secure, but reduces a lot of the flexibility in hybrid-7.
91	<	This may need to be used on some systems without a working
92	<	dlopen/dlsym.
93	<
94	<	* --enable-assert - Enable use of numerous debugging checks.  This
79	>	* --enable-assert - Enable use of numerous debugging checks. This
80		should not be used on any production servers for maximum speed
81	<	so as to prevent cores from things that shouldn't normally happen.
97	<
98	<	* --enable-efence - Enable ElectricFence which is a memory debugger.
99	<
100	<	* --enable-profile - Enable profiling support in ircd-hybrid.
81	>	so as to prevent cores from things that shouldn't normally happen.
82
83	<	* --disable-block-alloc - Disable block allocations (only works with
84	<	ElectricFence).
83	>	* --enable-debugging - Prepares Makefiles to compile the ircd sources
84	>	with proper settings that are required for debugging purposes.
85	>	This switch basically sets CFLAGS to "-g -O0".
86	>
87	>	* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
88	>	are similar to plain ops, but can't kick/deop plain ops. Halfops
89	>	may or may not kick/deop other halfops depending on if (+p) is
90	>	set. Halfops may not set (+/-p).
91
92	<	* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
93	<	are similar to plain ops, but can't kick/deop plain ops. Halfops
94	<	may or may not kick/deop other halfops depending on if (+p) is
95	<	set. Halfops may not set (+/-p).
109	<
110	<	* --enable-small-net - Tunes the server for smaller networks by
111	<	reducing the startup memory footprint. This should really only be
112	<	used for *small* networks, as this tends to be a performance hit
113	<	on larger networks.
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	–	* --enable-syslog=kill/squit/connect/users/oper, separated by
116	–	spaces, in quotes - Enables syslog logging, with events you specify
117	–	(none is okay too, and logs the most essential messages only.)
97
119	–	* --enable-syslog-facility=FACILITY - Check with your sysadmin to see
120	–	what this should be; by default it is LOG_LOCAL4. If you get it wrong
121	–	initially, no problem; just edit the value in include/setup.h.
122	–
123	–	* --with-nicklen,
124	–	--with-topiclen - Respectively, sets the maximum NICK length and
125	–	maximum TOPIC length. Note that this must be consistent across your
126	–	entire network. Defaults are 9 and 120, respectively.
127	–
128	–	* --with-maxconn - Sets the maximum number of connections the ircd
129	–	can support. Note that this also twiddles the HARD_FDLIMIT.
130	–	If HARD_FDLIMIT ends up being larger that FD_SETSIZE when using
131	–	select() for your I/O loop, s_bsd_select.c will refuse to compile
132	–	(and tell you to use poll instead). Take this error's advice and
133	–	use --enable-poll or something a bit more efficient. You'll be
134	–	happier at the end of the day for it.
135	–
136	–	* --disable-zlib - Build the ircd without ziplinks support.
137	–
138	–	* --disable-gline-voting - This is good for small networks or where
139	–	G-Line voting is not necessary. Please understand that by disabling
140	–	this, it will allow any operator with G-Line permissions to G-Line
141	–	someone without requiring the approval of 2 other operators. However,
142	–	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
149	–	(1) Unless the server was compiled without module support.
150	–
151	–	5.  If you wish to install the contrib modules, run 'make install' in the
152	–	contrib/ folder to compile and install the modules and help pages.
153	–
154	–	6.  If you wish to enable the user log, oper log, and failed oper log,
155	–	kill log, kline log and the gline log issue these commands at the
156	–	shell prompt (in the prefix directory).
157	–
158	–	$ touch logs/userlog
159	–	$ touch logs/operlog
160	–	$ touch logs/foperlog
161	–	$ touch logs/kill
162	–	$ touch logs/kline
163	–	$ touch logs/gline
164	–
165	–	Note: If you use different names in ircd.conf, you must 'touch'
166	–	their specific names.
167	–
168	–	7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
169	–	have changed drastically...
170	–
171	–	By default, the kline file is named kline.conf, the dline file is
172	–	named dline.conf, the xline file is called xline.conf, and the gline
173	–	file is called gline.conf.
174	–
175	–	The nick resv file is named nresv.conf, channel resv file is named
176	–	cresv.conf.
177	–
178	–	The oper motd file is named opers.motd.
179	–
104		----------------------------------------------------------------------
105
106		HOW TO GET HELP
#	Line 189 | Line 113
113		on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
114		the core. The Hybrid team can't fix bugs if no one tells us about them!
115
192	–	- http://forum.ircd-hybrid.org/
193	–	We decided to create a phpBB-like forum about ircd-hybrid, where you
194	–	can get help from coders and admins, post your suggestions, modules etc.
195	–
116		- https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
117		Here you can subscribe to a mailing list for general discussion of Hybrid.
118
#	Line 205 | Line 125
125
126		1.  Change to the directory containing the core file
127
128	<	2.  Run gdb on the binary and the core file.  With an unmodified Hybrid-7.2
128	>	2.  Run gdb on the binary and the core file. With an unmodified ircd-hybrid
129		installation, an example command line is below (in the /usr/local/ircd
130		directory)
131

Diff Legend

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