New "chroot" feature (from Benjamin Pineau), introducing new configuration
[ngircd-alex.git] / README
1
2                      ngIRCd - Next Generation IRC Server
3
4                       (c)2001-2004 by Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                ngIRCd is free software and published under the
8                    terms of the GNU General Public License.
9
10                                 -- README --
11                            
12                       Ilja Osthoff, <ilja@glide.ath.cx>
13
14
15 I. Introduction
16 ~~~~~~~~~~~~~~~
17
18 ngIRCd is an Open-Source server for the Internet Relay Chat (IRC), which
19 is developed and published under the terms of the GNU General Public
20 Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
21 generation IRC daemon", it's written from scratch and not deduced from the
22 "grandfather of IRC daemons", the daemon of the IRCNet.
23
24
25 II. Status
26 ~~~~~~~~~~~
27
28 At present, the ngIRCd is under active development, some features are not
29 implemented, some only partly.
30
31 Till today (more or less complete) implemented IRC-commands:
32
33 ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INVITE, ISON,
34 JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN,
35 NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER,
36 SQUIT, STATS, TIME, TOPIC, TRACE, USER, USERHOST, VERSION, WHO, WHOIS.
37
38
39 III. Features (or: why use ngIRCd?)
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41
42 - no problems with servers which have dynamic IP addresses
43 - simple, easy understandable configuration file,
44 - freely published open-source C source code,
45 - ngIRCd will be developed on in the future.
46 - supported platforms (tested versions): AIX (3.2.5), A/UX (3.0.1), FreeBSD
47   (4.5), HP-UX (10.20), IRIX (6.5), Linux (2.x), Mac OS X (10.x), NetBSD
48   (1.5.2/i386, 1.5.3/m68k), Solaris (2.5.1, 2.6), Windows with Cygwin, and
49   OpenBSD (3.4/i386).
50
51
52 IV. Documentation
53 ~~~~~~~~~~~~~~~~~
54
55 More documentation can be found in the "doc/" directory and the homepage of
56 the ngIRCd: <http://arthur.ath.cx/~alex/ngircd/>.
57
58
59 V. Download
60 ~~~~~~~~~~~
61
62 The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
63 will find the newest information about the ngIRCd and the most recent
64 ("stable") releases there.
65
66 If you are interested in the latest development versions (which are not
67 always stable), then please read the section "CVS" on the homepage and
68 the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
69 Versioning System".
70
71
72 VI. Bugs
73 ~~~~~~~~
74
75 If you find bugs in the ngIRCd (which might be there :-), please report
76 them at the following URL:
77
78 <http://arthur.ath.cx/~alex/ngircd/#bugs>
79
80 There you can read about known bugs and limitations, too.
81
82 If you have critics, patches or something else, please feel free to post a
83 mail to: <alex@barton.de> or <alex@arthur.ath.cx>
84
85
86 -- 
87 $Id: README,v 1.19 2004/05/07 11:19:20 alex Exp $