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

Annotation of /ircd-hybrid-8/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1548 - (hide annotations)
Mon Oct 1 16:37:20 2012 UTC (7 years, 11 months ago) by michael
File size: 6793 byte(s)
- Update INSTALL file

1 adx 30 Hybrid INSTALL Document
2    
3 knight 31 $Id$
4 adx 30
5 michael 1292 Copyright (c) 1997-2012 IRCD-Hybrid Development Team
6 adx 30
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 michael 1434 | - Important: The old config format WILL NOT WORK. Please see point 6! |
20 adx 30 +------------------------------------------------------------------------+
21    
22     ***** EFNET NOTE *****
23 michael 1402 You should use the example.efnet.conf instead of example.conf.
24 adx 30 **********************
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 michael 918 1. Read the NEWS file to find out about the exciting new features in
35 michael 1314 this version. Other good reads are BUGS, doc/example.conf, and
36 michael 1138 README.
37 adx 30
38 michael 918 2. Run the configure script. It will create config.h and the
39 michael 1227 Makefiles to match your system. The paths are now handled
40 adx 30 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 michael 925 opposed to the default poll(2). This is currently only available
51 adx 30 on FreeBSD 4.1 or higher.
52    
53     * --enable-devpoll - Enable the superior /dev/poll support on
54 michael 925 Solaris. Linux /dev/poll is broken and will not work with this
55 adx 30 option.
56    
57 michael 925 * --enable-epoll - Enables epoll(4) Signal I/O system. This is
58 michael 555 currently only available on 2.5.44 Linux kernel versions or
59     later.
60    
61 adx 30 * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
62 michael 925 system. This is currently only available on 2.4 Linux kernel
63 adx 30 versions or later.
64    
65 michael 925 * --enable-poll - Use POSIX poll(2).
66 adx 30
67 michael 925 * --enable-select - Use POSIX select(2).
68 adx 30
69 michael 925 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 adx 30
73     * --enable-openssl - Enable the openssl dependent crypto functions.
74 michael 1548 Required for the SSL Challenge controlled OPER feature, compressed
75     and/or SSL/TLS server links, as well as SSL/TLS client connections.
76    
77     On systems where the configure script can automatically detect
78     OpenSSL, this option is not necessary. If configure cannot find
79     OpenSSL, you must specify a path with this option
80 adx 30 (--enable-openssl=/path/to/openssl)
81    
82 michael 925
83 adx 30 These are optional or have default values that may be overridden:
84    
85 michael 925 * --enable-assert - Enable use of numerous debugging checks. This
86 adx 30 should not be used on any production servers for maximum speed
87 michael 925 so as to prevent cores from things that shouldn't normally happen.
88 adx 30
89 michael 925 * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
90     are similar to plain ops, but can't kick/deop plain ops. Halfops
91     may or may not kick/deop other halfops depending on if (+p) is
92     set. Halfops may not set (+/-p).
93 adx 30
94     * --with-nicklen,
95 michael 925 --with-topiclen - Respectively, sets the maximum NICK length and
96     maximum TOPIC length. Note that this must be consistent across your
97     entire network. Defaults are 9 and 120, respectively.
98 adx 30
99    
100    
101     3. Run 'make'; this should build the ircd.
102    
103 michael 1138 4. Run 'make install'; this will install the server, modules, and tools
104 adx 30 in the path with the prefix specified when configure was ran.
105    
106     5. If you wish to install the contrib modules, run 'make install' in the
107     contrib/ folder to compile and install the modules and help pages.
108    
109 michael 1292 6. If you are upgrading from Hybrid 5 or Hybrid 6, the config files
110 michael 1138 have changed drastically.
111 adx 30
112     By default, the kline file is named kline.conf, the dline file is
113 michael 1138 named dline.conf, and the xline file is called xline.conf.
114 adx 30
115     The nick resv file is named nresv.conf, channel resv file is named
116     cresv.conf.
117    
118     ----------------------------------------------------------------------
119    
120     HOW TO GET HELP
121    
122     - Send Check or Money Order to... just kidding! You're on your own for
123     support. Try asking other ircd-hybrid admins on EFnet if you can't
124     fix it yourself. If you do fix anything, however, please send context
125     or unified diffs to bugs@ircd-hybrid.org so the fixes can be
126     incorporated into the next release of ircd-hybrid. If hybrid crashes
127     on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
128     the core. The Hybrid team can't fix bugs if no one tells us about them!
129    
130     - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
131     Here you can subscribe to a mailing list for general discussion of Hybrid.
132    
133     ----------------------------------------------------------------------
134    
135     NOTES
136    
137     The best way to get a backtrace of the core is to follow this sequence of
138     instructions:
139    
140     1. Change to the directory containing the core file
141    
142 michael 974 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
143 adx 30 installation, an example command line is below (in the /usr/local/ircd
144     directory)
145    
146     $ gdb bin/ircd ircd.core
147    
148    
149     3. At the "(gdb)" prompt, enter the command "bt full"
150    
151     4. Save the output of the backtrace command and send it to
152     bugs@ircd-hybrid.org.
153    
154     5. Be sure to save the ircd binary, the modules, and the core file in a
155     safe place in case the developers need to look deeper than a backtrace
156     provides.

Properties

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

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