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 1028 by michael, Sun Nov 8 13:03:38 2009 UTC

# Line 2 | Line 2
2  
3     $Id$
4  
5 <   Copyright (c) 1997-2007 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 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.
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.
# Line 52 | Line 52
52         undefined results:
53  
54            * --enable-kqueue - Use the superior kqueue(2) system call as
55 <            opposed to the default poll(2).  This is currently only available
55 >            opposed to the default poll(2). This is currently only available
56              on FreeBSD 4.1 or higher.
57  
58            * --enable-devpoll - Enable the superior /dev/poll support on
59 <            Solaris.  Linux /dev/poll is broken and will not work with this
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
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
67 >            system. This is currently only available on 2.4 Linux kernel
68              versions or later.
69  
70 <          * --enable-poll - Use POSIX poll(2).
70 >          * --enable-poll - Use POSIX poll(2).
71  
72 <          * --enable-select - Use POSIX select(2).
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
80              where the configure script can automatically detect OpenSSL, this
81 <            option is not necessary.  If configure cannot find OpenSSL, you
81 >            option is not necessary. If configure cannot find OpenSSL, you
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    
88 <          * --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
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.
90 >            so as to prevent cores from things that shouldn't normally happen.
91  
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).
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 <          * --disable-zlib - Build the ircd without ziplinks support.
116 <
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.
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 172 | 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  
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
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 188 | 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