5c8cc2c2081341f362a0aead964bdc26df359d4b
[ngircd-alex.git] / README
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2016 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 a free, portable and lightweight Internet Relay Chat server for
16 small or private networks, developed under the GNU General Public License
17 (GPL; please see the file COPYING for details). It is simple to configure,
18 can cope with dynamic IP addresses, and supports IPv6 as well as SSL. It is
19 written from scratch and not based on the original IRCd.
20
21 The name ngIRCd means next generation IRC daemon, which is a little bit
22 exaggerated: lightweight Internet Relay Chat server most probably would be a
23 better name :-)
24
25 Please see the INSTALL document for installation and upgrade information!
26
27
28 II. Status
29 ~~~~~~~~~~~
30
31 It is not the goal of ngIRCd to implement all the nasty behaviors of the
32 original ircd, but to implement most of the useful commands and semantics
33 specified by the RFCs.
34
35 In the meantime ngIRCd should be quite feature complete and stable to be
36 used in real IRC networks.
37
38 Implemented IRC-commands are:
39
40 ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, GLINE, HELP, INFO,
41 INVITE, ISON, JOIN, KICK, KILL, KLINE, LINKS, LIST, LUSERS, MODE, MOTD,
42 NAMES, NICK, NJOIN, NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT,
43 REHASH, RESTART, SERVER, SERVICE, SERVLIST, SQUERY, SQUIT, STATS, SUMMON,
44 TIME, TOPIC, TRACE, USER, USERHOST, USERS, VERSION, WALLOPS, WEBIRC, WHO,
45 WHOIS, WHOWAS.
46
47 III. Features (or: why use ngIRCd?)
48 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
49
50 - well arranged (lean) configuration file
51 - simple to build/install, configure and maintain
52 - supports IPv6 and SSL
53 - no problems with servers that have dynamic IP addresses
54 - freely available, modern, portable and tidy C-source
55 - wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
56   IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
57 - ngIRCd is being actively developed since 2001.
58
59
60 IV. Documentation
61 ~~~~~~~~~~~~~~~~~
62
63 More documentation can be found in the "doc/" directory and the homepage of
64 the ngIRCd: <http://ngircd.barton.de/>.
65
66
67 V. Download
68 ~~~~~~~~~~~
69
70 The homepage of the ngIRCd is: <http://ngircd.barton.de/>; you will find
71 the newest information about the ngIRCd and the most recent ("stable")
72 releases there.
73
74 If you are interested in the latest development versions (which are not
75 always stable), then please read the section about "GIT" on the homepage and
76 the file "doc/GIT.txt" which describes the use of GIT, the version control
77 system used by ngIRCd (homepage: <http://git-scm.com/>).
78
79
80 VI. Bugs
81 ~~~~~~~~
82
83 If you find bugs in the ngIRCd (which might be there :-), please report
84 them at the following URL:
85
86 <https://github.com/ngircd/ngircd/issues>
87
88 There you can read about known bugs and limitations, too.
89
90 If you have comments, patches or something else, please feel free to post
91 a mail to the ngIRCd mailing list: <ngircd-ml@ngircd.barton.de> (please see
92 <http://ngircd.barton.de/support.php> for details) or join the ngIRCd IRC
93 channel: <irc://irc.barton.de/ngircd>.