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

Contents of /ircd-hybrid/trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1823 - (show annotations)
Sun Apr 14 18:24:38 2013 UTC (7 years, 2 months ago) by michael
File size: 5794 byte(s)
- Renamed example.conf to reference.conf
- Due to upcoming feature implementation, resv{} blocks are no longer stackable

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
20 ----------------------------------------------------------------------
21
22 HOW TO BUILD
23
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.
27
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 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
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.
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-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 * --enable-select - Use POSIX select(2).
57
58 Incidentally, the order of listing above is the order of auto-
59 detection in configure. So if you do have kqueue but wish to
60 enable select(2) instead (bad idea), you must use --enable-select.
61
62 * --enable-openssl - Enable the openssl dependent crypto functions.
63 Required for the SSL Challenge controlled OPER feature, compressed
64 and/or SSL/TLS server links, as well as SSL/TLS client connections.
65
66 On systems where the configure script can automatically detect
67 OpenSSL, this option is not necessary. If configure cannot find
68 OpenSSL, you must specify a path with this option
69 (--enable-openssl=/path/to/openssl)
70
71
72 These are optional or have default values that may be overridden:
73
74 * --enable-assert - Enable use of numerous debugging checks. This
75 should not be used on any production servers for maximum speed
76 so as to prevent cores from things that shouldn't normally happen.
77
78 * --enable-debugging - Prepares Makefiles to compile the ircd sources
79 with proper settings that are required for debugging purposes.
80 This switch basically sets CFLAGS to "-g -O0".
81
82 * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
83 are similar to plain ops, but can't kick/deop plain ops. Halfops
84 may or may not kick/deop other halfops depending on if (+p) is
85 set. Halfops may not set (+/-p).
86
87
88 3. Run 'make'; this should build the ircd.
89
90 4. Run 'make install'; this will install the server, modules, and tools
91 in the path with the prefix specified when configure was ran.
92
93 ----------------------------------------------------------------------
94
95 HOW TO GET HELP
96
97 - Send Check or Money Order to... just kidding! You're on your own for
98 support. Try asking other ircd-hybrid admins on EFnet if you can't
99 fix it yourself. If you do fix anything, however, please send context
100 or unified diffs to bugs@ircd-hybrid.org so the fixes can be
101 incorporated into the next release of ircd-hybrid. If hybrid crashes
102 on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
103 the core. The Hybrid team can't fix bugs if no one tells us about them!
104
105 - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
106 Here you can subscribe to a mailing list for general discussion of Hybrid.
107
108 ----------------------------------------------------------------------
109
110 NOTES
111
112 The best way to get a backtrace of the core is to follow this sequence of
113 instructions:
114
115 1. Change to the directory containing the core file
116
117 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
118 installation, an example command line is below (in the /usr/local/ircd
119 directory)
120
121 $ gdb bin/ircd ircd.core
122
123
124 3. At the "(gdb)" prompt, enter the command "bt full"
125
126 4. Save the output of the backtrace command and send it to
127 bugs@ircd-hybrid.org.
128
129 5. Be sure to save the ircd binary, the modules, and the core file in a
130 safe place in case the developers need to look deeper than a backtrace
131 provides.

Properties

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

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