/[svn]/ircd-hybrid/branches/8.0.x/INSTALL
ViewVC logotype

Contents of /ircd-hybrid/branches/8.0.x/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1803 - (show annotations)
Mon Apr 1 11:56:24 2013 UTC (9 years, 10 months ago) by michael
File size: 6346 byte(s)
- Remove BUGS file

1 Hybrid INSTALL Document
2
3 $Id$
4
5 Copyright (c) 1997-2013 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 6! |
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 doc/example.conf, and README.
36
37 2. Run the configure script. It will create config.h and the
38 Makefiles to match your system. The paths are now handled
39 with the --prefix option to configure.
40 /usr/local/ircd is the default if no prefix is specified.
41
42 ./configure --prefix=/usr/local/ircd
43
44 The script will determine whichever of the following is best for
45 your system, but you may (unsupported) force their usage with
46 undefined results:
47
48 * --enable-kqueue - Use the superior kqueue(2) system call as
49 opposed to the default poll(2). This is currently only available
50 on FreeBSD 4.1 or higher.
51
52 * --enable-devpoll - Enable the superior /dev/poll support on
53 Solaris. Linux /dev/poll is broken and will not work with this
54 option.
55
56 * --enable-epoll - Enables epoll(4) Signal I/O system. This is
57 currently only available on 2.5.44 Linux kernel versions or
58 later.
59
60 * --enable-poll - Use POSIX poll(2).
61
62 * --enable-select - Use POSIX select(2).
63
64 Incidentally, the order of listing above is the order of auto-
65 detection in configure. So if you do have kqueue but wish to
66 enable select(2) instead (bad idea), you must use --enable-select.
67
68 * --enable-openssl - Enable the openssl dependent crypto functions.
69 Required for the SSL Challenge controlled OPER feature, compressed
70 and/or SSL/TLS server links, as well as SSL/TLS client connections.
71
72 On systems where the configure script can automatically detect
73 OpenSSL, this option is not necessary. If configure cannot find
74 OpenSSL, you must specify a path with this option
75 (--enable-openssl=/path/to/openssl)
76
77
78 These are optional or have default values that may be overridden:
79
80 * --enable-assert - Enable use of numerous debugging checks. This
81 should not be used on any production servers for maximum speed
82 so as to prevent cores from things that shouldn't normally happen.
83
84 * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
85 are similar to plain ops, but can't kick/deop plain ops. Halfops
86 may or may not kick/deop other halfops depending on if (+p) is
87 set. Halfops may not set (+/-p).
88
89
90
91 3. Run 'make'; this should build the ircd.
92
93 4. Run 'make install'; this will install the server, modules, and tools
94 in the path with the prefix specified when configure was ran.
95
96 5. If you wish to install the contrib modules, run 'make install' in the
97 contrib/ folder to compile and install the modules and help pages.
98
99 6. If you are upgrading from Hybrid 5 or Hybrid 6, the config files
100 have changed drastically.
101
102 By default, the kline file is named kline.conf, the dline file is
103 named dline.conf, and the xline file is called xline.conf.
104
105 The nick resv file is named nresv.conf, channel resv file is named
106 cresv.conf.
107
108 ----------------------------------------------------------------------
109
110 HOW TO GET HELP
111
112 - Send Check or Money Order to... just kidding! You're on your own for
113 support. Try asking other ircd-hybrid admins on EFnet if you can't
114 fix it yourself. If you do fix anything, however, please send context
115 or unified diffs to bugs@ircd-hybrid.org so the fixes can be
116 incorporated into the next release of ircd-hybrid. If hybrid crashes
117 on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
118 the core. The Hybrid team can't fix bugs if no one tells us about them!
119
120 - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
121 Here you can subscribe to a mailing list for general discussion of Hybrid.
122
123 ----------------------------------------------------------------------
124
125 NOTES
126
127 The best way to get a backtrace of the core is to follow this sequence of
128 instructions:
129
130 1. Change to the directory containing the core file
131
132 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
133 installation, an example command line is below (in the /usr/local/ircd
134 directory)
135
136 $ gdb bin/ircd ircd.core
137
138
139 3. At the "(gdb)" prompt, enter the command "bt full"
140
141 4. Save the output of the backtrace command and send it to
142 bugs@ircd-hybrid.org.
143
144 5. Be sure to save the ircd binary, the modules, and the core file in a
145 safe place in case the developers need to look deeper than a backtrace
146 provides.

Properties

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

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