From: Alexander Barton Date: Mon, 31 Dec 2001 15:32:26 +0000 (+0000) Subject: - Dokumentation ergaenzt und verbessert. X-Git-Tag: rel-0-0-1~4 X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=commitdiff_plain;h=194f18c8e69e42ea7476f21514642833e090c426 - Dokumentation ergaenzt und verbessert. --- diff --git a/AUTHORS b/AUTHORS index e69de29b..e2eadb0f 100644 --- a/AUTHORS +++ b/AUTHORS @@ -0,0 +1,13 @@ + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- AUTHORS / Autoren -- + + +Alexander Barton, alex@arthur.ath.cx diff --git a/ChangeLog b/ChangeLog index e69de29b..90c86152 100644 --- a/ChangeLog +++ b/ChangeLog @@ -0,0 +1,14 @@ + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- ChangeLog / Aenderungen -- + + +[Zur Zeit ist kein "ChangeLog" vorhanden. Bitte ziehe die CVS-Kommentare in +den einzelnen Dateien zu Rate ...] diff --git a/INSTALL b/INSTALL index b42a17ac..ae4abf40 100644 --- a/INSTALL +++ b/INSTALL @@ -1,182 +1,75 @@ -Basic Installation -================== - - These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, a file -`config.cache' that saves the results of its tests to speed up -reconfiguring, and a file `config.log' containing compiler output -(useful mainly for debugging `configure'). - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If at some point `config.cache' -contains results you don't want to keep, you may remove or edit it. - - The file `configure.in' is used to create `configure' by a program -called `autoconf'. You only need `configure.in' if you want to change -it or regenerate `configure' using a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes awhile. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. You can give `configure' -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Or on systems that have the `env' program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not supports the `VPATH' -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use `make distclean' before reconfiguring for another -architecture. - -Installation Names -================== - - By default, `make install' will install the package's files in -`/usr/local/bin', `/usr/local/man', etc. You can specify an -installation prefix other than `/usr/local' by giving `configure' the -option `--prefix=PATH'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=PATH' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - - There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the -`--host=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the `--target=TYPE' option to select the type of system they will -produce code for and the `--build=TYPE' option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Operation Controls -================== - - `configure' recognizes the following options to control how it -operates. - -`--cache-file=FILE' - Use and save the results of the tests in FILE instead of - `./config.cache'. Set FILE to `/dev/null' to disable caching, for - debugging `configure'. - -`--help' - Print a summary of the options to `configure', and exit. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`--version' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`configure' also accepts some other, not widely useful, options. + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- INSTALL / Installation -- + + +ngIRCd ist fuer UNIXoide-Systeme konzipiert. Dieser Text beschreibt den +"Standardfall": ein UNIX bzw. UNIX-aehnliches System, das von GNU automake +und GNU autoconf ("configure") unterstuetzt wird. + + +I. Quick Start +~~~~~~~~~~~~~~ + +In der Regel sind folgende Schritte ausreichend: + + 1) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen] + 2) ./configure + 3) make + + +zu 1) autogen.sh: + +Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script +noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen +in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS +bezogen wurde. + +Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant. + +autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's +sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche +Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen +Versionen!) benoetigt. + +(nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!) + + +zu 2) ./configure: + +Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das +lokale System angepasst und die erforderlichen Makefile's erzeugt. + +Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber +erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein, +so zeigt "./configure --help" moegliche Optionen. + + +zu 3) make: + +Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und +uebersetzt die comBase-Library und die Testprogramme. + + +II. Nuetzliche make-Targets +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden +nuetzlichen Targets: + + - clean: alle Erzeugnisse des Compilers/Linkers loeschen. + Naechster Schritt: -> make + + - distclean: zusaetzliche alle Makefile's loeschen. + Naechster Schritt: -> ./configure + + - maintainer-clean: alle automat. erzeugten Dateien loeschen. + Naechster Schritt: -> ./autogen.sh + diff --git a/NEWS b/NEWS index e69de29b..0f6e7e3c 100644 --- a/NEWS +++ b/NEWS @@ -0,0 +1,14 @@ + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- NEWS / Neuigkeiten -- + + +[Zur Zeit nicht vorhanden. Bitte die CVS-Kommentare in den einzelnen Dateien +zu Rate ziehen -- oder das ChangeLog, so es existent sein sollte ;-)] diff --git a/README b/README index e69de29b..1ca69870 100644 --- a/README +++ b/README @@ -0,0 +1,42 @@ + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- README / Liesmich -- + + +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. + +Zur Zeit befindet sich ngIRCd noch in Entwicklung, vieles ist noch nicht +implementiert bzw. nur "halbherzig": Channels gibt es noch nicht, genau so +wenig wie Server-Links. Das private Chatten (PRIVMSG) mit den Client-Befehlen +/msg und /query sollte hingegen funktionieren, ein wenig praktische Funk- +tionalitaet ist also tatsaechlich schon vorhanden ;-) + +Diese Version ist aber auf jeden Fall als "Preview" anzusehen! + +Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle: + +DIE, ISON, MODE, MOTD, NAMES, NICK, NOTICE, OPER, PASS, PING, PONG, PRIVMSG, +QUIT, RESTART, USER, USERHOST, WHOIS. + +Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut +in die Tasten! :-)) + +Via E-Mail erreichst du mich als bzw. . +Die Homepage des ngIRCd findest du unter . + +[ ... more to come ... ] + + +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 ,-) diff --git a/doc/CVS.txt b/doc/CVS.txt index e69de29b..cd9bab92 100644 --- a/doc/CVS.txt +++ b/doc/CVS.txt @@ -0,0 +1,21 @@ + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- CVS.txt -- + + +Die Sourcen des ngIRCd werden mit dem "Concurrent Versions System" (CVS) +verwaltet. Somit koennen ohne Probleme mehrere Leute gleichzeitig die Sourcen +bearbeitet. + +Dieser Text soll in Zukunft die Grundlagen beschreiben. Tut er aber leider +noch nicht, also frage einfach Alex direkt (siehe AUTHORS-Text), wenn du +daran interessiert bist, Zugriff auf den Quellcode via CVS zu bekommen! + +[ ... more to come ... ] diff --git a/doc/RFC.txt b/doc/RFC.txt index e69de29b..55cd74fc 100644 --- a/doc/RFC.txt +++ b/doc/RFC.txt @@ -0,0 +1,29 @@ + + ngIRCd - Next Generation IRC Server + + (c)2001 by Alexander Barton, + alex@barton.de, http://www.barton.de/ + + ngIRCd ist freie Software und steht unter + der GNU General Public License. + + -- RFC.txt -- + + +Das IRC-Protokoll ist in diesen RFC's (Request For Comments) dokumentiert: + + 1459 Oikarinen, J. & D. Reed, "Internet Relay Chat Protocol", + May 1993, [IRC]. + + 2810 Kalt, C., "Internet Relay Chat: Architecture", + April 2000, [IRC-ARCH]. + + 2811 Kalt, C., "Internet Relay Chat: Channel Management", + April 2000, [IRC-CHAN]. + + 2812 Kalt, C., "Internet Relay Chat: Client Protocol", + April 2000, [IRC-CLIENT]. + + 2813 Kalt, C., "Internet Relay Chat: Server Protocol", + April 2000, [IRC-SERVER]. +