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

Comparing:
ircd-hybrid/INSTALL (file contents), Revision 1155 by michael, Tue Aug 9 20:27:45 2011 UTC vs.
ircd-hybrid/trunk/INSTALL (file contents), Revision 1736 by michael, Sun Jan 13 09:31:46 2013 UTC

# Line 2 | Line 2
2  
3     $Id$
4  
5 <   Copyright (c) 1997-2011 IRCD-Hybrid Development Team
5 >   Copyright (c) 1997-2012 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
33 >       this version. Other good reads are BUGS, doc/example.conf, and
34         README.
35  
36     2.  Run the configure script. It will create config.h and the
37 <       Makefiles to match your system. In hybrid-7, the paths are now handled
37 >       Makefiles to match your system. The paths are now handled
38         with the --prefix option to configure.
39         /usr/local/ircd is the default if no prefix is specified.
40  
# Line 60 | Line 56
56              currently only available on 2.5.44 Linux kernel versions or
57              later.
58  
63          * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
64            system. This is currently only available on 2.4 Linux kernel
65            versions or later.
66
59            * --enable-poll - Use POSIX poll(2).
60  
61            * --enable-select - Use POSIX select(2).
# Line 73 | Line 65
65            enable select(2) instead (bad idea), you must use --enable-select.
66  
67            * --enable-openssl - Enable the openssl dependent crypto functions.
68 <            This will allow CHALLENGE to work and encrypted links. On systems
69 <            where the configure script can automatically detect OpenSSL, this
70 <            option is not necessary. If configure cannot find OpenSSL, you
71 <            must specify a path with this option
68 >            Required for the SSL Challenge controlled OPER feature, compressed
69 >            and/or SSL/TLS server links, as well as SSL/TLS client connections.
70 >
71 >            On systems where the configure script can automatically detect
72 >            OpenSSL, this option is not necessary. If configure cannot find
73 >            OpenSSL, you must specify a path with this option
74              (--enable-openssl=/path/to/openssl)
75  
76  
# Line 86 | Line 80
80              should not be used on any production servers for maximum speed
81              so as to prevent cores from things that shouldn't normally happen.
82  
83 +          * --enable-debugging - Prepares Makefiles to compile the ircd sources
84 +            with proper settings that are required for debugging purposes.
85 +            This switch basically sets CFLAGS to "-g -O0".
86 +
87            * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
88              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  
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          * --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
103          * --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
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  
112          * --disable-zlib - Build the ircd without ziplinks support.
97  
98  
99     3.  Run 'make'; this should build the ircd.
# Line 117 | Line 101
101     4.  Run 'make install'; this will install the server, modules, and tools
102         in the path with the prefix specified when configure was ran.
103  
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       have changed drastically.
139
140       By default, the kline file is named kline.conf, the dline file is
141       named dline.conf, and the xline file is called xline.conf.
142
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
104       ----------------------------------------------------------------------
105  
106                                  HOW TO GET HELP

Diff Legend

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