Update copyright notices for 2010 :)
[ngircd-alex.git] / README
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2011 Alexander Barton and Contributors.
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                 -- README --
10
11
12 I. Introduction
13 ~~~~~~~~~~~~~~~
14
15 ngIRCd is an Open Source server for the Internet Relay Chat (IRC), which
16 is developed and published under the terms of the GNU General Public
17 Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
18 generation IRC daemon", it's written from scratch and not deduced from the
19 "grandfather of IRC daemons", the daemon of the IRCNet.
20
21 Please see the INSTALL document for installation and upgrade information!
22
23
24 II. Status
25 ~~~~~~~~~~~
26
27 It is not the goal of ngIRCd to implement all the nasty behaviours of the
28 original ircd, but to implement most of the useful commands and semantics
29 specified by the RFCs.
30
31 In the meantime ngIRCd should be quite feature complete and stable to be
32 used in real IRC networks.
33
34 Implemented IRC-commands are:
35
36 ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INFO, INVITE,
37 ISON, JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN,
38 NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER,
39 SERVICE, SERVLIST, SQUERY, SQUIT,  STATS, SUMMON, TIME, TOPIC, TRACE, USER,
40 USERHOST, USERS, VERSION, WALLOPS, WEBIRC, WHO, WHOIS, WHOWAS.
41
42
43 III. Features (or: why use ngIRCd?)
44 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46 - no problems with servers which have dynamic IP addresses
47 - simple, easy understandable configuration file,
48 - freely published open-source C source code,
49 - ngIRCd will be developed on in the future.
50 - wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
51   IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
52
53
54 IV. Documentation
55 ~~~~~~~~~~~~~~~~~
56
57 More documentation can be found in the "doc/" directory and the homepage of
58 the ngIRCd: <http://ngircd.barton.de/>.
59
60
61 V. Download
62 ~~~~~~~~~~~
63
64 The homepage of the ngIRCd is: <http://ngircd.barton.de/>; you will find
65 the newest information about the ngIRCd and the most recent ("stable")
66 releases there.
67
68 If you are interested in the latest development versions (which are not
69 always stable), then please read the section about "GIT" on the homepage and
70 the file "doc/GIT.txt" which describes the use of GIT, the version control
71 system used by ngIRCd (homepage: http://git.or.cz/).
72
73
74 VI. Bugs
75 ~~~~~~~~
76
77 If you find bugs in the ngIRCd (which might be there :-), please report
78 them at the following URL:
79
80 <http://ngircd.barton.de/bugtracker.php>
81
82 There you can read about known bugs and limitations, too.
83
84 If you have critics, patches or something else, please feel free to post a
85 mail to the ngIRCd mailing list: <ngircd-ml@arthur.ath.cx> (please see
86 <http://ngircd.barton.de/support.php#ml> for details).