mirror of
				https://github.com/osmarks/ngircd.git
				synced 2025-11-03 23:43:00 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			94 lines
		
	
	
		
			3.2 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			94 lines
		
	
	
		
			3.2 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
 | 
						|
                     ngIRCd - Next Generation IRC Server
 | 
						|
                           http://ngircd.barton.de/
 | 
						|
 | 
						|
               (c)2001-2014 Alexander Barton and Contributors.
 | 
						|
               ngIRCd is free software and published under the
 | 
						|
                   terms of the GNU General Public License.
 | 
						|
 | 
						|
                                -- README --
 | 
						|
 | 
						|
 | 
						|
I. Introduction
 | 
						|
~~~~~~~~~~~~~~~
 | 
						|
 | 
						|
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
 | 
						|
~~~~~~~~~~~
 | 
						|
 | 
						|
It is not the goal of ngIRCd to implement all the nasty behaviours of the
 | 
						|
original ircd, but to implement most of the useful commands and semantics
 | 
						|
specified by the RFCs.
 | 
						|
 | 
						|
In the meantime ngIRCd should be quite feature complete and stable to be
 | 
						|
used in real IRC networks.
 | 
						|
 | 
						|
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?)
 | 
						|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
						|
 | 
						|
- 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://ngircd.barton.de/>.
 | 
						|
 | 
						|
 | 
						|
V. Download
 | 
						|
~~~~~~~~~~~
 | 
						|
 | 
						|
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 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://ngircd.barton.de/bugtracker.php>
 | 
						|
 | 
						|
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 the ngIRCd mailing list: <ngircd-ml@arthur.barton.de> (please see
 | 
						|
<http://ngircd.barton.de/support.php#ml> for details) or join the ngIRCd
 | 
						|
IRC channel: <irc://irc.barton.de/ngircd>.
 |