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

Contents of /ircd-hybrid/trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1782 - (show annotations)
Thu Jan 24 18:41:01 2013 UTC (7 years, 5 months ago) by michael
File size: 5924 byte(s)
- Update INSTALL

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 ***** EFNET NOTE *****
21 You should use the example.efnet.conf instead of example.conf.
22 **********************
23
24 ----------------------------------------------------------------------
25
26 HOW TO BUILD
27
28 As of hybrid-4, the distribution uses GNU autoconf instead of the old
29 Config script. You must run ./configure before you can (sanely) build
30 ircd-hybrid.
31
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 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
41 ./configure --prefix=/usr/local/ircd
42
43 The script will determine whichever of the following is best for
44 your system, but you may (unsupported) force their usage with
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
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
53 option.
54
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-poll - Use POSIX poll(2).
60
61 * --enable-select - Use POSIX select(2).
62
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 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 * --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.
82
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
93 3. Run 'make'; this should build the ircd.
94
95 4. Run 'make install'; this will install the server, modules, and tools
96 in the path with the prefix specified when configure was ran.
97
98 ----------------------------------------------------------------------
99
100 HOW TO GET HELP
101
102 - Send Check or Money Order to... just kidding! You're on your own for
103 support. Try asking other ircd-hybrid admins on EFnet if you can't
104 fix it yourself. If you do fix anything, however, please send context
105 or unified diffs to bugs@ircd-hybrid.org so the fixes can be
106 incorporated into the next release of ircd-hybrid. If hybrid crashes
107 on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
108 the core. The Hybrid team can't fix bugs if no one tells us about them!
109
110 - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
111 Here you can subscribe to a mailing list for general discussion of Hybrid.
112
113 ----------------------------------------------------------------------
114
115 NOTES
116
117 The best way to get a backtrace of the core is to follow this sequence of
118 instructions:
119
120 1. Change to the directory containing the core file
121
122 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
123 installation, an example command line is below (in the /usr/local/ircd
124 directory)
125
126 $ gdb bin/ircd ircd.core
127
128
129 3. At the "(gdb)" prompt, enter the command "bt full"
130
131 4. Save the output of the backtrace command and send it to
132 bugs@ircd-hybrid.org.
133
134 5. Be sure to save the ircd binary, the modules, and the core file in a
135 safe place in case the developers need to look deeper than a backtrace
136 provides.

Properties

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

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