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

Annotation of /ircd-hybrid-8/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1156 - (hide annotations)
Tue Aug 9 20:29:20 2011 UTC (9 years, 6 months ago) by michael
File size: 8134 byte(s)
- create ircd-hybrid-8 "branch"

1 adx 30 Hybrid INSTALL Document
2    
3 knight 31 $Id$
4 adx 30
5 michael 1134 Copyright (c) 1997-2011 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     | - Important: The old config format WILL NOT WORK. Please see point 7! |
20     +------------------------------------------------------------------------+
21    
22     ***** EFNET NOTE *****
23     You should run ./configure with the option '--enable-efnet' to tweak
24 michael 925 some options to be EFNet based. You must also use the example.efnet.conf
25 adx 30 instead of example.conf.
26     **********************
27    
28     ----------------------------------------------------------------------
29    
30     HOW TO BUILD
31    
32     As of hybrid-4, the distribution uses GNU autoconf instead of the old
33     Config script. You must run ./configure before you can (sanely) build
34     ircd-hybrid.
35    
36 michael 918 1. Read the NEWS file to find out about the exciting new features in
37 michael 920 this version. Other good reads are BUGS, etc/example.conf, and
38 michael 1138 README.
39 adx 30
40 michael 918 2. Run the configure script. It will create config.h and the
41 adx 30 Makefiles to match your system. In hybrid-7, the paths are now handled
42     with the --prefix option to configure.
43     /usr/local/ircd is the default if no prefix is specified.
44    
45     ./configure --prefix=/usr/local/ircd
46    
47     The script will determine whichever of the following is best for
48     your system, but you may (unsupported) force their usage with
49     undefined results:
50    
51     * --enable-kqueue - Use the superior kqueue(2) system call as
52 michael 925 opposed to the default poll(2). This is currently only available
53 adx 30 on FreeBSD 4.1 or higher.
54    
55     * --enable-devpoll - Enable the superior /dev/poll support on
56 michael 925 Solaris. Linux /dev/poll is broken and will not work with this
57 adx 30 option.
58    
59 michael 925 * --enable-epoll - Enables epoll(4) Signal I/O system. This is
60 michael 555 currently only available on 2.5.44 Linux kernel versions or
61     later.
62    
63 adx 30 * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
64 michael 925 system. This is currently only available on 2.4 Linux kernel
65 adx 30 versions or later.
66    
67 michael 925 * --enable-poll - Use POSIX poll(2).
68 adx 30
69 michael 925 * --enable-select - Use POSIX select(2).
70 adx 30
71 michael 925 Incidentally, the order of listing above is the order of auto-
72     detection in configure. So if you do have kqueue but wish to
73     enable select(2) instead (bad idea), you must use --enable-select.
74 adx 30
75     * --enable-openssl - Enable the openssl dependent crypto functions.
76     This will allow CHALLENGE to work and encrypted links. On systems
77     where the configure script can automatically detect OpenSSL, this
78 michael 925 option is not necessary. If configure cannot find OpenSSL, you
79 adx 30 must specify a path with this option
80     (--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     * --enable-small-net - Tunes the server for smaller networks by
95     reducing the startup memory footprint. This should really only be
96     used for *small* networks, as this tends to be a performance hit
97     on larger networks.
98    
99 michael 925 * --enable-syslog=kill/squit/connect/users/oper, separated by
100     spaces, in quotes - Enables syslog logging, with events you specify
101     (none is okay too, and logs the most essential messages only.)
102 adx 30
103 michael 925 * --enable-syslog-facility=FACILITY - Check with your sysadmin to see
104     what this should be; by default it is LOG_LOCAL4. If you get it wrong
105     initially, no problem; just edit the value in include/setup.h.
106 adx 30
107     * --with-nicklen,
108 michael 925 --with-topiclen - Respectively, sets the maximum NICK length and
109     maximum TOPIC length. Note that this must be consistent across your
110     entire network. Defaults are 9 and 120, respectively.
111 adx 30
112 michael 925 * --disable-zlib - Build the ircd without ziplinks support.
113 adx 30
114    
115     3. Run 'make'; this should build the ircd.
116    
117 michael 1138 4. Run 'make install'; this will install the server, modules, and tools
118 adx 30 in the path with the prefix specified when configure was ran.
119    
120     5. If you wish to install the contrib modules, run 'make install' in the
121     contrib/ folder to compile and install the modules and help pages.
122    
123     6. If you wish to enable the user log, oper log, and failed oper log,
124     kill log, kline log and the gline log issue these commands at the
125     shell prompt (in the prefix directory).
126    
127     $ touch logs/userlog
128     $ touch logs/operlog
129     $ touch logs/foperlog
130     $ touch logs/kill
131     $ touch logs/kline
132     $ touch logs/gline
133    
134     Note: If you use different names in ircd.conf, you must 'touch'
135     their specific names.
136    
137     7. If you are upgrading from Hybrid 5 or Hybrid 6, the config files
138 michael 1138 have changed drastically.
139 adx 30
140     By default, the kline file is named kline.conf, the dline file is
141 michael 1138 named dline.conf, and the xline file is called xline.conf.
142 adx 30
143     The nick resv file is named nresv.conf, channel resv file is named
144     cresv.conf.
145    
146     The oper motd file is named opers.motd.
147    
148     ----------------------------------------------------------------------
149    
150     HOW TO GET HELP
151    
152     - Send Check or Money Order to... just kidding! You're on your own for
153     support. Try asking other ircd-hybrid admins on EFnet if you can't
154     fix it yourself. If you do fix anything, however, please send context
155     or unified diffs to bugs@ircd-hybrid.org so the fixes can be
156     incorporated into the next release of ircd-hybrid. If hybrid crashes
157     on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
158     the core. The Hybrid team can't fix bugs if no one tells us about them!
159    
160     - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
161     Here you can subscribe to a mailing list for general discussion of Hybrid.
162    
163     ----------------------------------------------------------------------
164    
165     NOTES
166    
167     The best way to get a backtrace of the core is to follow this sequence of
168     instructions:
169    
170     1. Change to the directory containing the core file
171    
172 michael 974 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
173 adx 30 installation, an example command line is below (in the /usr/local/ircd
174     directory)
175    
176     $ gdb bin/ircd ircd.core
177    
178    
179     3. At the "(gdb)" prompt, enter the command "bt full"
180    
181     4. Save the output of the backtrace command and send it to
182     bugs@ircd-hybrid.org.
183    
184     5. Be sure to save the ircd binary, the modules, and the core file in a
185     safe place in case the developers need to look deeper than a backtrace
186     provides.

Properties

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

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