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

Comparing:
ircd-hybrid-7.2/INSTALL (file contents), Revision 918 by michael, Thu Nov 8 06:56:42 2007 UTC vs.
ircd-hybrid/INSTALL (file contents), Revision 1155 by michael, Tue Aug 9 20:27:45 2011 UTC

# Line 2 | Line 2
2  
3     $Id$
4  
5 <   Copyright (c) 1997-2007 IRCD-Hybrid Development Team
5 >   Copyright (c) 1997-2011 IRCD-Hybrid Development Team
6  
7       ----------------------------------------------------------------------
8  
# Line 21 | Line 21
21  
22     ***** EFNET NOTE *****
23     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
24 >   some options to be EFNet based. You must also use the example.efnet.conf
25     instead of example.conf.
26     **********************
27  
# Line 34 | Line 34
34     ircd-hybrid.
35    
36     1.  Read the NEWS file to find out about the exciting new features in
37 <       this version. Other good reads are doc/whats-new.txt, BUGS,
38 <       etc/example.conf, and 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.
37 >       this version. Other good reads are BUGS, etc/example.conf, and
38 >       README.
39  
40     2.  Run the configure script. It will create config.h and the
41         Makefiles to match your system. In hybrid-7, the paths are now handled
# Line 52 | Line 49
49         undefined results:
50  
51            * --enable-kqueue - Use the superior kqueue(2) system call as
52 <            opposed to the default poll(2).  This is currently only available
52 >            opposed to the default poll(2). This is currently only available
53              on FreeBSD 4.1 or higher.
54  
55            * --enable-devpoll - Enable the superior /dev/poll support on
56 <            Solaris.  Linux /dev/poll is broken and will not work with this
56 >            Solaris. Linux /dev/poll is broken and will not work with this
57              option.
58  
59 <          * --enable-epoll - Enables epoll(4) Signal I/O system.  This is
59 >          * --enable-epoll - Enables epoll(4) Signal I/O system. This is
60              currently only available on 2.5.44 Linux kernel versions or
61              later.
62  
63            * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
64 <            system.  This is currently only available on 2.4 Linux kernel
64 >            system. This is currently only available on 2.4 Linux kernel
65              versions or later.
66  
67 <          * --enable-poll - Use POSIX poll(2).
67 >          * --enable-poll - Use POSIX poll(2).
68  
69 <          * --enable-select - Use POSIX select(2).
69 >          * --enable-select - Use POSIX select(2).
70  
71 <          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.
71 >          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  
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 <            option is not necessary.  If configure cannot find OpenSSL, you
78 >            option is not necessary. If configure cannot find OpenSSL, you
79              must specify a path with this option
80              (--enable-openssl=/path/to/openssl)
81  
82 +
83         These are optional or have default values that may be overridden:
84    
85 <          * --disable-shared-modules - Disable module support.  This option is
88 <            more secure, but reduces a lot of the flexibility in hybrid-7.
89 <            This may need to be used on some systems without a working
90 <            dlopen/dlsym.
91 <
92 <          * --enable-assert - Enable use of numerous debugging checks.  This
85 >          * --enable-assert - Enable use of numerous debugging checks. This
86              should not be used on any production servers for maximum speed
87 <            so as to prevent cores from things that shouldn't normally happen.
87 >            so as to prevent cores from things that shouldn't normally happen.
88  
89 <          * --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).
89 >          * --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  
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.
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  
107            * --with-nicklen,
108 <            --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 <
112 <          * --disable-zlib - Build the ircd without ziplinks support.
113 <
121 <          * --disable-gline-voting - This is good for small networks or where
122 <            G-Line voting is not necessary. Please understand that by disabling
123 <            this, it will allow any operator with G-Line permissions to G-Line
124 <            someone without requiring the approval of 2 other operators. However,
125 <            it is useful if you use proxy scanners or services that do G-Lines.
108 >            --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 >
112 >          * --disable-zlib - Build the ircd without ziplinks support.
113 >
114  
115     3.  Run 'make'; this should build the ircd.
116  
117 <   4.  Run 'make install'; this will install the server, modules(1), and tools
117 >   4.  Run 'make install'; this will install the server, modules, and tools
118         in the path with the prefix specified when configure was ran.
119  
132           (1) Unless the server was compiled without module support.
133
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  
# Line 149 | Line 135
135               their specific names.
136  
137     7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
138 <       have changed drastically...
138 >       have changed drastically.
139  
140         By default, the kline file is named kline.conf, the dline file is
141 <       named dline.conf, the xline file is called xline.conf, and the gline
156 <       file is called gline.conf.
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.
# Line 172 | Line 157
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  
175   - http://forum.ircd-hybrid.org/
176     We decided to create a phpBB-like forum about ircd-hybrid, where you
177     can get help from coders and admins, post your suggestions, modules etc.
178
160     - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
161       Here you can subscribe to a mailing list for general discussion of Hybrid.
162  
# Line 188 | Line 169
169  
170     1.  Change to the directory containing the core file
171  
172 <   2.  Run gdb on the binary and the core file. With an unmodified Hybrid-7.2
172 >   2.  Run gdb on the binary and the core file. With an unmodified ircd-hybrid
173         installation, an example command line is below (in the /usr/local/ircd
174         directory)
175  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines