1
0

README 3.1 KB

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