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

Comparing:
ircd-hybrid-7.3/INSTALL (file contents), Revision 1029 by michael, Sun Nov 8 13:10:50 2009 UTC vs.
ircd-hybrid/trunk/INSTALL (file contents), Revision 1804 by michael, Mon Apr 1 11:58:39 2013 UTC

# Line 2 | Line 2
2  
3     $Id$
4  
5 <   Copyright (c) 1997-2009 IRCD-Hybrid Development Team
5 >   Copyright (c) 1997-2013 IRCD-Hybrid Development Team
6  
7       ----------------------------------------------------------------------
8  
# Line 15 | Line 15
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!  |
18     +------------------------------------------------------------------------+
19  
20     ***** EFNET NOTE *****
21 <   You should run ./configure with the option '--enable-efnet' to tweak
24 <   some options to be EFNet based. You must also use the example.efnet.conf
25 <   instead of example.conf.
21 >   You should use the example.efnet.conf instead of example.conf.
22     **********************
23  
24       ----------------------------------------------------------------------
# Line 34 | Line 30
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, etc/example.conf, and
38 <       README.FIRST.
39 <
40 <       An example.conf for EFnet is in etc/ with the values "approved" as of
41 <       October 12th, 2003 called example.efnet.conf.
33 >       this version. Other good reads are doc/example.conf, and README.
34  
35     2.  Run the configure script. It will create config.h and the
36 <       Makefiles to match your system. In hybrid-7, the paths are now handled
36 >       Makefiles to match your system. The paths are now handled
37         with the --prefix option to configure.
38         /usr/local/ircd is the default if no prefix is specified.
39  
# Line 63 | Line 55
55              currently only available on 2.5.44 Linux kernel versions or
56              later.
57  
66          * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
67            system. This is currently only available on 2.4 Linux kernel
68            versions or later.
69
58            * --enable-poll - Use POSIX poll(2).
59  
60            * --enable-select - Use POSIX select(2).
# Line 76 | Line 64
64            enable select(2) instead (bad idea), you must use --enable-select.
65  
66            * --enable-openssl - Enable the openssl dependent crypto functions.
67 <            This will allow CHALLENGE to work and encrypted links. On systems
68 <            where the configure script can automatically detect OpenSSL, this
69 <            option is not necessary. If configure cannot find OpenSSL, you
70 <            must specify a path with this option
67 >            Required for the SSL Challenge controlled OPER feature, compressed
68 >            and/or SSL/TLS server links, as well as SSL/TLS client connections.
69 >
70 >            On systems where the configure script can automatically detect
71 >            OpenSSL, this option is not necessary. If configure cannot find
72 >            OpenSSL, you must specify a path with this option
73              (--enable-openssl=/path/to/openssl)
74  
75  
# Line 89 | Line 79
79              should not be used on any production servers for maximum speed
80              so as to prevent cores from things that shouldn't normally happen.
81  
82 +          * --enable-debugging - Prepares Makefiles to compile the ircd sources
83 +            with proper settings that are required for debugging purposes.
84 +            This switch basically sets CFLAGS to "-g -O0".
85 +
86            * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
87              are similar to plain ops, but can't kick/deop plain ops. Halfops
88              may or may not kick/deop other halfops depending on if (+p) is
89              set. Halfops may not set (+/-p).
90  
97          * --enable-small-net - Tunes the server for smaller networks by
98            reducing the startup memory footprint. This should really only be
99            used for *small* networks, as this tends to be a performance hit
100            on larger networks.
101
102          * --enable-syslog=kill/squit/connect/users/oper, separated by
103            spaces, in quotes - Enables syslog logging, with events you specify
104            (none is okay too, and logs the most essential messages only.)
105
106          * --enable-syslog-facility=FACILITY - Check with your sysadmin to see
107            what this should be; by default it is LOG_LOCAL4. If you get it wrong
108            initially, no problem; just edit the value in include/setup.h.
109
110          * --with-nicklen,
111            --with-topiclen - Respectively, sets the maximum NICK length and
112            maximum TOPIC length. Note that this must be consistent across your
113            entire network. Defaults are 9 and 120, respectively.
114
115          * --disable-zlib - Build the ircd without ziplinks support.
116
91  
92     3.  Run 'make'; this should build the ircd.
93  
94 <   4.  Run 'make install'; this will install the server, modules(1), and tools
94 >   4.  Run 'make install'; this will install the server, modules, and tools
95         in the path with the prefix specified when configure was ran.
96  
123           (1) Unless the server was compiled without module support.
124
125   5.  If you wish to install the contrib modules, run 'make install' in the
126       contrib/ folder to compile and install the modules and help pages.
127
128   6.  If you wish to enable the user log, oper log, and failed oper log,
129       kill log, kline log and the gline log issue these commands at the
130       shell prompt (in the prefix directory).
131
132       $ touch logs/userlog
133       $ touch logs/operlog
134       $ touch logs/foperlog
135       $ touch logs/kill
136       $ touch logs/kline
137       $ touch logs/gline
138
139       Note: If you use different names in ircd.conf, you must 'touch'
140             their specific names.
141
142   7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
143       have changed drastically...
144
145       By default, the kline file is named kline.conf, the dline file is
146       named dline.conf, the xline file is called xline.conf, and the gline
147       file is called gline.conf.
148
149       The nick resv file is named nresv.conf, channel resv file is named
150       cresv.conf.
151
152       The oper motd file is named opers.motd.
153
97       ----------------------------------------------------------------------
98  
99                                  HOW TO GET HELP

Diff Legend

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