X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=2eff7bce0c34d5fcd726dfd4a002179f2aeaec2b;hp=6f17d5caafae4612984438358520ae2288db1bfa;hb=0e4e22a7a671d1e8efbc44bffd80062191f75c38;hpb=e7214c151fb7d957c870d1ab169ede460687f034 diff --git a/README b/README index 6f17d5ca..2eff7bce 100644 --- a/README +++ b/README @@ -1,68 +1,87 @@ - + ngIRCd - Next Generation IRC Server - (c)2001,2002 by Alexander Barton, + (c)2001-2007 Alexander Barton, alex@barton.de, http://www.barton.de/ - ngIRCd ist freie Software und steht unter - der GNU General Public License. + ngIRCd is free software and published under the + terms of the GNU General Public License. + + -- README -- + + +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. + +Please see the INSTALL document for installation and upgrade information! + + +II. Status +~~~~~~~~~~~ - -- README / Liesmich -- +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. -I. Einfuehrung -~~~~~~~~~~~~~~ +Implemented IRC-commands are: -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. +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, WALLOPS, WHO, WHOIS, +WHOWAS. -Zur Zeit befindet sich der ngIRCd noch in Entwicklung, teilweise fehlen noch -Features oder sind noch nicht "final" implementiert. -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: +- 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. +- wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX, + IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin. -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.or.cz/). -- 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).