X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=4bcafb2ffbdf92048719850a4ad03014b169e82d;hp=6f17d5caafae4612984438358520ae2288db1bfa;hb=e73d70ce6fab3acdefe914520a4296acb6d50eac;hpb=e7214c151fb7d957c870d1ab169ede460687f034 diff --git a/README b/README index 6f17d5ca..4bcafb2f 100644 --- a/README +++ b/README @@ -1,68 +1,93 @@ - + 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 :-) - (c)2001,2002 by Alexander Barton, - alex@barton.de, http://www.barton.de/ +Please see the INSTALL document for installation and upgrade information! - ngIRCd ist freie Software und steht unter - der GNU General Public License. - -- README / Liesmich -- +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. -I. Einfuehrung -~~~~~~~~~~~~~~ +In the meantime ngIRCd should be quite feature complete and stable to be +used in real IRC networks. -ngIRCd ist ein Server fuer den Internet Relay Chat (IRC). Er ist von Grund -auf neu geschrieben, also nicht wie die meisten anderen IRCd's vom Urvater, -dem Daemon des IRCNet abgeleitet. +Implemented IRC-commands are: -Zur Zeit befindet sich der ngIRCd noch in Entwicklung, teilweise fehlen noch -Features oder sind noch nicht "final" implementiert. +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. -Channels sind inzwischen implementiert (seit Version 0.1.0), privates Chatten -mit /msg und /query funktioniert ebenso. Server-Links werden dabei unter- -stuetzt. Einige User- und Channel-Modes sind implementiert, hier kennt der -Server jedoch noch nicht alles. +III. Features (or: why use ngIRCd?) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle: +- 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. -AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LUSERS, MODE, MOTD, NAMES, NICK, -NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER, -SQUIT, TOPIC, USER, USERHOST, VERSION, WHOIS. -Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut -in die Tasten! :-)) +IV. Documentation +~~~~~~~~~~~~~~~~~ -Via E-Mail erreichst du mich als bzw. . -Die Homepage des ngIRCd findest du unter . +More documentation can be found in the "doc/" directory and the homepage of +the ngIRCd: . -Hinweise zur Installation findest du in der Datei INSTALL. -Alle Autoren von ngIRCd sind in AUTHORS aufgefuehrt. -In der Datei COPYING steht die GNU General Public License. -Das README liest du gerade ,-) +V. Download +~~~~~~~~~~~ +The homepage of the ngIRCd is: ; you will find +the newest information about the ngIRCd and the most recent ("stable") +releases there. -II. Vorteile -~~~~~~~~~~~~ +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/). -- keine Probleme mit Servern, deren IP-Adressen nicht statisch sind, -- übersichtliche ("schlanke") Konfigurationsdatei, -- frei verfügbarer, moderner und "aufgeräumter" C-Quellcode. -- ngIRCd wird aktiv weiter entwickelt. +VI. Bugs +~~~~~~~~ -III. Unterstuetzte Plattformen -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If you find bugs in the ngIRCd (which might be there :-), please report +them at the following URL: -- A/UX -- FreeBSD -- Linux -- Mac OS X -- NetBSD -- Windows mit Cygwin + +There you can read about known bugs and limitations, too. --- -$Id: README,v 1.6 2002/03/03 13:07:01 alex Exp $ +If you have critics, patches or something else, please feel free to post a +mail to the ngIRCd mailing list: (please see + for details) or join the ngIRCd +IRC channel: .