ViewVC Help

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

root/svn/ircd-hybrid/trunk/INSTALL

Comparing:
ircd-hybrid/INSTALL (file contents), Revision 32 by knight, Sun Oct 2 20:41:23 2005 UTC vs.
ircd-hybrid/trunk/INSTALL (file contents), Revision 8752 by michael, Tue Jan 1 11:07:01 2019 UTC

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

Comparing:
ircd-hybrid/INSTALL (property svn:keywords), Revision 32 by knight, Sun Oct 2 20:41:23 2005 UTC vs.
ircd-hybrid/trunk/INSTALL (property svn:keywords), Revision 8752 by michael, Tue Jan 1 11:07:01 2019 UTC

#	Line 1 | Line 1
1	<	Revision
1	>	Id

Diff Legend

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