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 242 by adx, Sun Nov 6 11:20:44 2005 UTC vs.
ircd-hybrid-7.3/INSTALL (file contents), Revision 1029 by michael, Sun Nov 8 13:10:50 2009 UTC

# Line 2 | Line 2
2  
3     $Id$
4  
5 <   Copyright (c) 1997-2005 IRCD-Hybrid Development Team
5 >   Copyright (c) 1997-2009 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 33 | Line 33
33     Config script. You must run ./configure before you can (sanely) build
34     ircd-hybrid.
35    
36 <   1.  Read the RELNOTES 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.
36 >   1.  Read the NEWS file to find out about the exciting new features in
37 >       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.
42  
43 <   2.  Run the configure script. It will create include/setup.h and the
43 >   2.  Run the configure script. It will create config.h and the
44         Makefiles to match your system. In hybrid-7, the paths are now handled
45         with the --prefix option to configure.
46         /usr/local/ircd is the default if no prefix is specified.
# Line 59 | Line 59
59              Solaris. Linux /dev/poll is broken and will not work with this
60              option.
61  
62 +          * --enable-epoll - Enables epoll(4) Signal I/O system. This is
63 +            currently only available on 2.5.44 Linux kernel versions or
64 +            later.
65 +
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  
70 <          * --enable-poll - Use POSIX poll(2).
67 <
68 <          * --enable-select - Use POSIX select(2).
70 >          * --enable-poll - Use POSIX poll(2).
71  
72 <          * --enable-clobber - Don't preserve the old binaries on make install
72 >          * --enable-select - Use POSIX select(2).
73  
74 <          Incidentally, the order of listing above is the order of auto-
75 <          detection in configure. So if you do have kqueue but wish to
76 <          enable select(2) instead (bad idea), you must use --enable-select.
74 >          Incidentally, the order of listing above is the order of auto-
75 >          detection in configure. So if you do have kqueue but wish to
76 >          enable select(2) instead (bad idea), you must use --enable-select.
77  
78            * --enable-openssl - Enable the openssl dependent crypto functions.
79              This will allow CHALLENGE to work and encrypted links. On systems
# Line 80 | Line 82
82              must specify a path with this option
83              (--enable-openssl=/path/to/openssl)
84  
85 +
86         These are optional or have default values that may be overridden:
87    
85          * --disable-shared-modules - Disable module support. This option is
86            more secure, but reduces a lot of the flexibility in hybrid-7.
87            This may need to be used on some systems without a working
88            dlopen/dlsym.
89
88            * --enable-assert - Enable use of numerous debugging checks. This
89              should not be used on any production servers for maximum speed
90 <            so as to prevent cores from things that shouldn't normally happen.
93 <
94 <          * --enable-efence - Enable ElectricFence which is a memory debugger.
90 >            so as to prevent cores from things that shouldn't normally happen.
91  
92 <          * --enable-profile - Enable profiling support in ircd-hybrid.
93 <
94 <          * --disable-block-alloc - Disable block allocations (only works with
95 <            ElectricFence).
100 <
101 <          * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
102 <            are similar to plain ops, but can't kick/deop plain ops. Halfops
103 <            may or may not kick/deop other halfops depending on if (+p) is
104 <            set. Halfops may not set (+/-p).
92 >          * --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
93 >            are similar to plain ops, but can't kick/deop plain ops. Halfops
94 >            may or may not kick/deop other halfops depending on if (+p) is
95 >            set. Halfops may not set (+/-p).
96  
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.
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 <          * --with-maxconn - Sets the maximum number of connections the ircd
116 <            can support. Note that this also twiddles the HARD_FDLIMIT.
126 <            If HARD_FDLIMIT ends up being larger that FD_SETSIZE when using
127 <            select() for your I/O loop, s_bsd_select.c will refuse to compile
128 <            (and tell you to use poll instead). Take this error's advice and
129 <            use --enable-poll or something a bit more efficient. You'll be
130 <            happier at the end of the day for it.
131 <
132 <          * --disable-zlib - Build the ircd without ziplinks support.
133 <
134 <          * --disable-gline-voting - This is good for small networks or where
135 <            G-Line voting is not necessary. Please understand that by disabling
136 <            this, it will allow any operator with G-Line permissions to G-Line
137 <            someone without requiring the approval of 2 other operators. However,
138 <            it is useful if you use proxy scanners or services that do G-Lines.
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 >
117  
118     3.  Run 'make'; this should build the ircd.
119  
# Line 185 | Line 163
163       on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
164       the core. The Hybrid team can't fix bugs if no one tells us about them!
165  
188   - http://forum.ircd-hybrid.org/
189     We decided to create a phpBB-like forum about ircd-hybrid, where you
190     can get help from coders and admins, post your suggestions, modules etc.
191
166     - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
167       Here you can subscribe to a mailing list for general discussion of Hybrid.
168  
# Line 201 | Line 175
175  
176     1.  Change to the directory containing the core file
177  
178 <   2.  Run gdb on the binary and the core file. With an unmodified Hybrid-7.2
178 >   2.  Run gdb on the binary and the core file. With an unmodified ircd-hybrid
179         installation, an example command line is below (in the /usr/local/ircd
180         directory)
181  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines