ngIRCd - Next Generation IRC Server
+ http://ngircd.barton.de/
- (c)2001-2004 by Alexander Barton,
- alex@barton.de, http://www.barton.de/
-
+ (c)2001-2015 Alexander Barton and Contributors.
ngIRCd is free software and published under the
terms of the GNU General Public License.
-- README --
-
- Ilja Osthoff, <ilja@glide.ath.cx>
I. Introduction
~~~~~~~~~~~~~~~
-ngIRCd is an Open-Source server for the Internet Relay Chat (IRC), which
-is developed and published under the terms of the GNU General Public
-Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
-generation IRC daemon", it's written from scratch and not deduced from the
-"grandfather of IRC daemons", the daemon of the IRCNet.
+ngIRCd is a free, portable and lightweight Internet Relay Chat server for
+small or private networks, developed under the GNU General Public License
+(GPL; please see the file COPYING for details). It is simple to configure,
+can cope with dynamic IP addresses, and supports IPv6 as well as SSL. It is
+written from scratch and not based on the original IRCd.
+
+The name ngIRCd means next generation IRC daemon, which is a little bit
+exaggerated: lightweight Internet Relay Chat server most probably would be a
+better name :-)
+
+Please see the INSTALL document for installation and upgrade information!
II. Status
~~~~~~~~~~~
-At present, the ngIRCd is under active development, some features are not
-implemented, some only partly.
+It is not the goal of ngIRCd to implement all the nasty behaviors of the
+original ircd, but to implement most of the useful commands and semantics
+specified by the RFCs.
-Till today (more or less complete) implemented IRC-commands:
+In the meantime ngIRCd should be quite feature complete and stable to be
+used in real IRC networks.
-ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INVITE, ISON,
-JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN,
-NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER,
-SQUIT, STATS, TIME, TOPIC, TRACE, USER, USERHOST, VERSION, WHO, WHOIS.
+Implemented IRC-commands are:
+ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, GLINE, HELP, INFO,
+INVITE, ISON, JOIN, KICK, KILL, KLINE, LINKS, LIST, LUSERS, MODE, MOTD,
+NAMES, NICK, NJOIN, NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT,
+REHASH, RESTART, SERVER, SERVICE, SERVLIST, SQUERY, SQUIT, STATS, SUMMON,
+TIME, TOPIC, TRACE, USER, USERHOST, USERS, VERSION, WALLOPS, WEBIRC, WHO,
+WHOIS, WHOWAS.
III. Features (or: why use ngIRCd?)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- no problems with servers which have dynamic IP addresses
-- simple, easy understandable configuration file,
-- freely published open-source C source code,
-- ngIRCd will be developed on in the future.
-- supported platforms (tested versions): AIX (3.2.5), A/UX (3.0.1), FreeBSD
- (4.5), HP-UX (10.20), IRIX (6.5), Linux (2.x), Mac OS X (10.x), NetBSD
- (1.5.2/i386, 1.5.3/m68k), Solaris (2.5.1, 2.6), Windows with Cygwin, and
- OpenBSD (3.4/i386).
+- well arranged (lean) configuration file
+- simple to build/install, configure and maintain
+- supports IPv6 and SSL
+- no problems with servers that have dynamic IP addresses
+- freely available, modern, portable and tidy C-source
+- wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
+ IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
+- ngIRCd is being actively developed since 2001.
IV. Documentation
~~~~~~~~~~~~~~~~~
More documentation can be found in the "doc/" directory and the homepage of
-the ngIRCd: <http://arthur.ath.cx/~alex/ngircd/>.
+the ngIRCd: <http://ngircd.barton.de/>.
V. Download
~~~~~~~~~~~
-The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
-will find the newest information about the ngIRCd and the most recent
-("stable") releases there.
+The homepage of the ngIRCd is: <http://ngircd.barton.de/>; you will find
+the newest information about the ngIRCd and the most recent ("stable")
+releases there.
If you are interested in the latest development versions (which are not
-always stable), then please read the section "CVS" on the homepage and
-the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
-Versioning System".
+always stable), then please read the section about "GIT" on the homepage and
+the file "doc/GIT.txt" which describes the use of GIT, the version control
+system used by ngIRCd (homepage: <http://git-scm.com/>).
VI. Bugs
If you find bugs in the ngIRCd (which might be there :-), please report
them at the following URL:
-<http://arthur.ath.cx/~alex/ngircd/#bugs>
+<https://github.com/ngircd/ngircd/issues>
There you can read about known bugs and limitations, too.
-If you have critics, patches or something else, please feel free to post a
-mail to: <alex@barton.de> or <alex@arthur.ath.cx>
-
-
---
-$Id: README,v 1.19 2004/05/07 11:19:20 alex Exp $
+If you have comments, patches or something else, please feel free to post
+a mail to the ngIRCd mailing list: <ngircd-ml@ngircd.barton.de> (please see
+<http://ngircd.barton.de/support.php> for details) or join the ngIRCd IRC
+channel: <irc://irc.barton.de/ngircd>.
projects / ngircd-alex.git / blobdiff