/[svn]/ircd-hybrid-8/INSTALL
ViewVC logotype

Contents of /ircd-hybrid-8/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1402 - (show annotations)
Wed May 9 18:42:45 2012 UTC (8 years, 4 months ago) by michael
File size: 7010 byte(s)
- /info no longer sends information about the platform ircd is running on
- remove get_ircd_platform() function
- configure: --enable-efnet switch is no longer required

1 Hybrid INSTALL Document
2
3 $Id$
4
5 Copyright (c) 1997-2012 IRCD-Hybrid Development Team
6
7 ----------------------------------------------------------------------
8
9 +------------------------------------------------------------------------+
10 | Note for those who don't bother reading docs: |
11 | |
12 | Reading INSTALL is now a must, as the old DPATH is now specified when |
13 | configure is run. |
14 | |
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! |
20 +------------------------------------------------------------------------+
21
22 ***** EFNET NOTE *****
23 You should use the example.efnet.conf instead of example.conf.
24 **********************
25
26 ----------------------------------------------------------------------
27
28 HOW TO BUILD
29
30 As of hybrid-4, the distribution uses GNU autoconf instead of the old
31 Config script. You must run ./configure before you can (sanely) build
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, 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. 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
43 ./configure --prefix=/usr/local/ircd
44
45 The script will determine whichever of the following is best for
46 your system, but you may (unsupported) force their usage with
47 undefined results:
48
49 * --enable-kqueue - Use the superior kqueue(2) system call as
50 opposed to the default poll(2). This is currently only available
51 on FreeBSD 4.1 or higher.
52
53 * --enable-devpoll - Enable the superior /dev/poll support on
54 Solaris. Linux /dev/poll is broken and will not work with this
55 option.
56
57 * --enable-epoll - Enables epoll(4) Signal I/O system. This is
58 currently only available on 2.5.44 Linux kernel versions or
59 later.
60
61 * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
62 system. This is currently only available on 2.4 Linux kernel
63 versions or later.
64
65 * --enable-poll - Use POSIX poll(2).
66
67 * --enable-select - Use POSIX select(2).
68
69 Incidentally, the order of listing above is the order of auto-
70 detection in configure. So if you do have kqueue but wish to
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
78 (--enable-openssl=/path/to/openssl)
79
80
81 These are optional or have default values that may be overridden:
82
83 * --enable-assert - Enable use of numerous debugging checks. This
84 should not be used on any production servers for maximum speed
85 so as to prevent cores from things that shouldn't normally happen.
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-small-net - Tunes the server for smaller networks by
93 reducing the startup memory footprint. This should really only be
94 used for *small* networks, as this tends to be a performance hit
95 on larger networks.
96
97 * --with-nicklen,
98 --with-topiclen - Respectively, sets the maximum NICK length and
99 maximum TOPIC length. Note that this must be consistent across your
100 entire network. Defaults are 9 and 120, respectively.
101
102
103
104 3. Run 'make'; this should build the ircd.
105
106 4. Run 'make install'; this will install the server, modules, and tools
107 in the path with the prefix specified when configure was ran.
108
109 5. If you wish to install the contrib modules, run 'make install' in the
110 contrib/ folder to compile and install the modules and help pages.
111
112 6. If you are upgrading from Hybrid 5 or Hybrid 6, the config files
113 have changed drastically.
114
115 By default, the kline file is named kline.conf, the dline file is
116 named dline.conf, and the xline file is called xline.conf.
117
118 The nick resv file is named nresv.conf, channel resv file is named
119 cresv.conf.
120
121 The oper motd file is named opers.motd.
122
123 ----------------------------------------------------------------------
124
125 HOW TO GET HELP
126
127 - Send Check or Money Order to... just kidding! You're on your own for
128 support. Try asking other ircd-hybrid admins on EFnet if you can't
129 fix it yourself. If you do fix anything, however, please send context
130 or unified diffs to bugs@ircd-hybrid.org so the fixes can be
131 incorporated into the next release of ircd-hybrid. If hybrid crashes
132 on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
133 the core. The Hybrid team can't fix bugs if no one tells us about them!
134
135 - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
136 Here you can subscribe to a mailing list for general discussion of Hybrid.
137
138 ----------------------------------------------------------------------
139
140 NOTES
141
142 The best way to get a backtrace of the core is to follow this sequence of
143 instructions:
144
145 1. Change to the directory containing the core file
146
147 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
148 installation, an example command line is below (in the /usr/local/ircd
149 directory)
150
151 $ gdb bin/ircd ircd.core
152
153
154 3. At the "(gdb)" prompt, enter the command "bt full"
155
156 4. Save the output of the backtrace command and send it to
157 bugs@ircd-hybrid.org.
158
159 5. Be sure to save the ircd binary, the modules, and the core file in a
160 safe place in case the developers need to look deeper than a backtrace
161 provides.

Properties

Name Value
svn:eol-style native
svn:keywords Id Revision

svnadmin@ircd-hybrid.org
ViewVC Help
Powered by ViewVC 1.1.28