ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/INSTALL
Revision: 9857
Committed: Fri Jan 1 04:43:22 2021 UTC (5 years, 6 months ago) by michael
File size: 5341 byte(s)
Log Message: 
- Bump copyright years

File Contents

# User Rev Content
1 adx 30 Hybrid INSTALL Document
2    
3 knight 31 $Id$
4 adx 30
5 michael 9857 Copyright (c) 1997-2021 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    
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 michael 2345
28 michael 918 1. Read the NEWS file to find out about the exciting new features in
29 michael 1823 this version. Other good reads are doc/reference.conf, and README.
30 adx 30
31 michael 918 2. Run the configure script. It will create config.h and the
32 michael 1227 Makefiles to match your system. The paths are now handled
33 adx 30 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 michael 2345 The script will determine whichever of the following is best for
39     your system, but you may (unsupported) force their usage with
40 adx 30 undefined results:
41    
42     * --enable-kqueue - Use the superior kqueue(2) system call as
43 michael 925 opposed to the default poll(2). This is currently only available
44 michael 9207 on FreeBSD, OpenBSD, NetBSD, DragonFly BSD and macOS
45 adx 30
46     * --enable-devpoll - Enable the superior /dev/poll support on
47 michael 925 Solaris. Linux /dev/poll is broken and will not work with this
48 adx 30 option.
49    
50 michael 925 * --enable-epoll - Enables epoll(4) Signal I/O system. This is
51 michael 555 currently only available on 2.5.44 Linux kernel versions or
52     later.
53    
54 michael 925 * --enable-poll - Use POSIX poll(2).
55 adx 30
56 michael 925 Incidentally, the order of listing above is the order of auto-
57     detection in configure. So if you do have kqueue but wish to
58 michael 4333 enable poll(2) instead (bad idea), you must use --enable-poll.
59 adx 30
60 michael 9175 * --with-tls= - Controls TLS (Transport Layer Security) support.
61     Supported options are currently 'openssl, 'wolfssl', 'gnutls',
62     and 'none'.
63 michael 1548
64 michael 9175 If nothing has been specified, configure tries to autodetect in the
65     following order: openssl/libressl -> gnutls -> wolfssl.
66 adx 30
67 michael 925
68 adx 30 These are optional or have default values that may be overridden:
69 michael 2345
70 michael 8272 * --enable-assert - Enable use of numerous debugging checks. This is
71     considered a developer-only feature and should not be used on any
72     production servers for maximum speed so as to prevent cores from
73     things that shouldn't normally happen.
74 adx 30
75 michael 1663 * --enable-debugging - Prepares Makefiles to compile the ircd sources
76     with proper settings that are required for debugging purposes.
77     This switch basically sets CFLAGS to "-g -O0".
78    
79 michael 8359 * --enable-efence - Allows easy linking with the electric fence memory
80     debugger library.
81    
82    
83 adx 30 3. Run 'make'; this should build the ircd.
84    
85 michael 1138 4. Run 'make install'; this will install the server, modules, and tools
86 adx 30 in the path with the prefix specified when configure was ran.
87    
88     ----------------------------------------------------------------------
89    
90     HOW TO GET HELP
91    
92 michael 5616 - Send Check or Money Order to... just kidding! For bugs, patches or crash
93     reports, contact bugs@ircd-hybrid.org. Please provide as much information
94     as possible, context or unified diffs or backtrace of the core.
95     The Hybrid team can't fix bugs if no one tells us about them!
96 adx 30
97 michael 5616 - For general discussion or support, you can subscribe to our mailing list at
98     https://lists.ircd-hybrid.org/mailman/listinfo/hybrid. Alternatively,
99     you can find us on IRC in #ircd-coders on irc.ircd-hybrid.org.
100 adx 30
101     ----------------------------------------------------------------------
102    
103     NOTES
104    
105     The best way to get a backtrace of the core is to follow this sequence of
106     instructions:
107    
108     1. Change to the directory containing the core file
109    
110 michael 974 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
111 adx 30 installation, an example command line is below (in the /usr/local/ircd
112     directory)
113    
114     $ gdb bin/ircd ircd.core
115    
116    
117     3. At the "(gdb)" prompt, enter the command "bt full"
118    
119     4. Save the output of the backtrace command and send it to
120     bugs@ircd-hybrid.org.
121    
122     5. Be sure to save the ircd binary, the modules, and the core file in a
123     safe place in case the developers need to look deeper than a backtrace
124     provides.

Properties

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