ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/INSTALL
(Generate patch)

Comparing ircd-hybrid/trunk/INSTALL (file contents):
Revision 1736 by michael, Sun Jan 13 09:31:46 2013 UTC vs.
Revision 8385 by michael, Fri Mar 16 20:09:55 2018 UTC

# Line 2 | Line 2
2  
3     $Id$
4  
5 <   Copyright (c) 1997-2012 IRCD-Hybrid Development Team
5 >   Copyright (c) 1997-2018 ircd-hybrid development team
6  
7       ----------------------------------------------------------------------
8  
# Line 17 | Line 17
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
20       ----------------------------------------------------------------------
21  
22                                    HOW TO BUILD
# Line 28 | Line 24
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 <  
27 >
28     1.  Read the NEWS file to find out about the exciting new features in
29 <       this version. Other good reads are BUGS, doc/example.conf, and
34 <       README.
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
# Line 40 | Line 35
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
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.
44 >            on FreeBSD, OpenBSD, NetBSD, and Mac OS X
45  
46            * --enable-devpoll - Enable the superior /dev/poll support on
47              Solaris. Linux /dev/poll is broken and will not work with this
# Line 58 | Line 53
53  
54            * --enable-poll - Use POSIX poll(2).
55  
61          * --enable-select - Use POSIX select(2).
62
56            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 <          enable select(2) instead (bad idea), you must use --enable-select.
58 >          enable poll(2) instead (bad idea), you must use --enable-poll.
59  
60 <          * --enable-openssl - Enable the openssl dependent crypto functions.
60 >          * --enable-openssl - Enable the LibreSSL/OpenSSL dependent crypto functions.
61              Required for the SSL Challenge controlled OPER feature, compressed
62              and/or SSL/TLS server links, as well as SSL/TLS client connections.
63  
64              On systems where the configure script can automatically detect
65 <            OpenSSL, this option is not necessary. If configure cannot find
66 <            OpenSSL, you must specify a path with this option
65 >            LibreSSL or OpenSSL, this option is not necessary. If configure cannot
66 >            find LibreSSL or OpenSSL, you must specify a path with this option
67              (--enable-openssl=/path/to/openssl)
68  
69  
70         These are optional or have default values that may be overridden:
71 <  
72 <          * --enable-assert - Enable use of numerous debugging checks. This
73 <            should not be used on any production servers for maximum speed
74 <            so as to prevent cores from things that shouldn't normally happen.
71 >
72 >          * --enable-assert - Enable use of numerous debugging checks. This is
73 >            considered a developer-only feature and should not be used on any
74 >            production servers for maximum speed so as to prevent cores from
75 >            things that shouldn't normally happen.
76  
77            * --enable-debugging - Prepares Makefiles to compile the ircd sources
78              with proper settings that are required for debugging purposes.
79              This switch basically sets CFLAGS to "-g -O0".
80  
81 <          * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
82 <            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 <          * --with-nicklen,
93 <            --with-topiclen - Respectively, sets the maximum NICK length and
94 <            maximum TOPIC length. Note that this must be consistent across your
95 <            entire network. Defaults are 9 and 120, respectively.
96 <
81 >          * --enable-efence - Allows easy linking with the electric fence memory
82 >            debugger library.
83  
84  
85     3.  Run 'make'; this should build the ircd.
# Line 105 | Line 91
91  
92                                  HOW TO GET HELP
93  
94 <   - Send Check or Money Order to... just kidding! You're on your own for
95 <     support. Try asking other ircd-hybrid admins on EFnet if you can't
96 <     fix it yourself. If you do fix anything, however, please send context
97 <     or unified diffs to bugs@ircd-hybrid.org so the fixes can be
98 <     incorporated into the next release of ircd-hybrid. If hybrid crashes
99 <     on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
100 <     the core. The Hybrid team can't fix bugs if no one tells us about them!
101 <
116 <   - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
117 <     Here you can subscribe to a mailing list for general discussion of Hybrid.
94 >   - Send Check or Money Order to... just kidding! For bugs, patches or crash
95 >     reports, contact bugs@ircd-hybrid.org. Please provide as much information
96 >     as possible, context or unified diffs or backtrace of the core.
97 >     The Hybrid team can't fix bugs if no one tells us about them!
98 >
99 >   - For general discussion or support, you can subscribe to our mailing list at
100 >     https://lists.ircd-hybrid.org/mailman/listinfo/hybrid. Alternatively,
101 >     you can find us on IRC in #ircd-coders on irc.ircd-hybrid.org.
102  
103       ----------------------------------------------------------------------
104  

Comparing ircd-hybrid/trunk/INSTALL (property svn:keywords):
Revision 1736 by michael, Sun Jan 13 09:31:46 2013 UTC vs.
Revision 8385 by michael, Fri Mar 16 20:09:55 2018 UTC

# Line 1 | Line 1
1 < Id Revision
1 > Id

Diff Legend

Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)